auth

Documentation

Index

• Constants
• Variables
• func CreateUnsigned(pubkey, challenge B, relayURL string) (ev *event.T)
• func Validate(evt *event.T, challenge B, relayURL string) (ok bool, err error)
• type B
  • func GenerateChallenge() (b B)
• type S

Constants

const Required = "auth-required"

Variables

var ChallengeTag = B("challenge")

var RelayTag = B("relay")

Functions

func CreateUnsigned

func CreateUnsigned(pubkey, challenge B, relayURL string) (ev *event.T)

CreateUnsigned creates an event which should be sent via an "AUTH" command. If the authentication succeeds, the user will be authenticated as pubkey.

func Validate

func Validate(evt *event.T, challenge B,
	relayURL string) (ok bool, err error)

Validate checks whether event is a valid NIP-42 event for given challenge and relayURL. The result of the validation is encoded in the ok bool.

Types

type B

type B = []byte

func GenerateChallenge

func GenerateChallenge() (b B)

GenerateChallenge creates a reasonable, 96 byte base64 challenge string

type S

type S = string