libauth

Documentation

Index

• Variables
• func NewClaims() jwtv4.Claims
• func RawFromContext(ctx context.Context) string
• type Auth
  • func NewAuth(config *conf.Auth) (*Auth, error)
  • func (a *Auth) GeneratePassword(password string) (string, error)
  • func (a *Auth) GenerateToken(uid model.InternalID, pid model.InternalID, claimsType ClaimsType, ...) (string, error)
  • func (a *Auth) KeyFunc(t ClaimsType) jwtv4.Keyfunc
• type Claims
  • func FromContext(ctx context.Context) *Claims
  • func FromContextAssertUserType(ctx context.Context, userTypes ...UserType) *Claims
• type ClaimsType
• type UserType

Variables

var ProviderSet = wire.NewSet(NewAuth)

Functions

func NewClaims

func NewClaims() jwtv4.Claims

func RawFromContext

func RawFromContext(ctx context.Context) string

Types

type Auth

type Auth struct {
	// contains filtered or unexported fields
}

func NewAuth

func NewAuth(config *conf.Auth) (*Auth, error)

func (*Auth) GeneratePassword

func (a *Auth) GeneratePassword(password string) (string, error)

func (*Auth) GenerateToken

func (a *Auth) GenerateToken(
	uid model.InternalID,
	pid model.InternalID,
	claimsType ClaimsType,
	userType UserType,
	transferMetadata any,
	expire time.Duration,
) (string, error)

func (*Auth) KeyFunc

func (a *Auth) KeyFunc(t ClaimsType) jwtv4.Keyfunc

type Claims

type Claims struct {
	UserID           model.InternalID `json:"uid,string"`
	PorterID         model.InternalID `json:"pid,string,omitempty"`
	Type             ClaimsType       `json:"ct"`
	UserType         UserType         `json:"ut"`
	TransferMetadata any              `json:"tm,omitempty"`
	jwtv4.RegisteredClaims
}

func FromContext

func FromContext(ctx context.Context) *Claims

func FromContextAssertUserType

func FromContextAssertUserType(ctx context.Context, userTypes ...UserType) *Claims

type ClaimsType

type ClaimsType int

const (
	ClaimsTypeUnspecified ClaimsType = iota
	ClaimsTypeAccessToken
	ClaimsTypeRefreshToken
	ClaimsTypeUploadToken
	ClaimsTypeDownloadToken
)

type UserType

type UserType int

const (
	UserTypeUnspecified UserType = iota
	UserTypeAdmin
	UserTypeNormal
	UserTypeSentinel
	UserTypePorter
)