surl

Nov 8, 2023

Changes in this version

type Option

+ func SkipScheme() Option

Nov 28, 2022

Changes in this version

+ var ErrInvalidFormat = errors.New("invalid format")

Nov 28, 2022

Changes in this version

+ var DefaultExpiryFormatter = WithDecimalExpiry()

type Option

+ func WithBase58Expiry() Option

+ func WithDecimalExpiry() Option

Nov 1, 2022

Changes in this version

+ var DefaultFormatter = WithQueryFormatter()

+ var ErrExpired = errors.New("URL has expired")

+ var ErrInvalidSignature = errors.New("invalid signature")

+ var ErrInvalidSignedURL = errors.New("invalid signed URL")

+ type Formatter interface

+ AddExpiry func(*url.URL, time.Time)

+ AddSignature func(*url.URL, []byte)

+ ExtractExpiry func(*url.URL) (*url.URL, time.Time, error)

+ ExtractSignature func(*url.URL) (*url.URL, []byte, error)

+ type Option func(*Signer)

+ func PrefixPath(prefix string) Option

+ func SkipQuery() Option

+ func WithPathFormatter() Option

+ func WithQueryFormatter() Option

+ type PathFormatter struct

+ func (*PathFormatter) ExtractExpiry(u *url.URL) (*url.URL, time.Time, error)

+ func (f *PathFormatter) AddExpiry(unsigned *url.URL, expiry time.Time)

+ func (f *PathFormatter) AddSignature(payload *url.URL, sig []byte)

+ func (f *PathFormatter) ExtractSignature(u *url.URL) (*url.URL, []byte, error)

+ type QueryFormatter struct

+ func (f *QueryFormatter) AddExpiry(unsigned *url.URL, exp time.Time)

+ func (f *QueryFormatter) AddSignature(payload *url.URL, sig []byte)

+ func (f *QueryFormatter) ExtractExpiry(u *url.URL) (*url.URL, time.Time, error)

+ func (f *QueryFormatter) ExtractSignature(u *url.URL) (*url.URL, []byte, error)

+ type Signer struct

+ func New(key []byte, opts ...Option) *Signer

+ func (s *Signer) Sign(unsigned string, lifespan time.Duration) (string, error)

+ func (s *Signer) Verify(signed string) error