lnurlauth

README

LN Url

A golang lnurl example implementation by entropy. As per the lnurl-rfc this library also provides:

1. auth: A canonical way to authenticate users with lnurl

This library is based on passport-ln-url-auth and utilizes go-lnurl.

Documentation

Index

• func Authenticate(r *http.Request) (key, k1 string, err error)
• func GenerateLnUrl(callbackUrl string) (encoded string, rawurl string, err error)
• func GenerateQrCode(lnurl string) ([]byte, error)
• type RequestStore
• type SessionData
• type SessionStore

Functions

func Authenticate

func Authenticate(r *http.Request) (key, k1 string, err error)

authenticate a request, return key if successful otherwise an error

func GenerateLnUrl

func GenerateLnUrl(callbackUrl string) (encoded string, rawurl string, err error)

generate an ln url string

func GenerateQrCode

func GenerateQrCode(lnurl string) ([]byte, error)

generate a qr code from an lnurl

Types

type RequestStore

type RequestStore interface {
	// store request data
	Set(name, value string)
	// get data
	Get(name string) string
	// remove from request store, return removed value
	Remove(name string) string
}

store for reading/storing data into the client

type SessionData

type SessionData struct {
	LnUrl  string `json:"ln_url"`
	RawUrl string `json:"raw_url"`
	Key    string `json:"key"`
}

type SessionStore

type SessionStore interface {
	// store session data
	Set(k1 string, value SessionData)
	// get data
	Get(k1 string) *SessionData
	// remove from session storage
	Remove(name string) *SessionData
}

persistent store for authenticating users cross-request