security

type Claims struct {
	ID        string                 `json:"jti,omitempty"`
	Issuer    string                 `json:"iss,omitempty"`
	Subject   string                 `json:"sub,omitempty"`
	Audience  []string               `json:"aud,omitempty"`
	ExpiresAt int64                  `json:"exp,omitempty"`
	NotBefore int64                  `json:"nbf,omitempty"`
	IssuedAt  int64                  `json:"iat,omitempty"`
	Custom    map[string]interface{} `json:"custom,omitempty"`
}

type Decoder interface {
	Decode(string) (string, bool)
}

type Encoder interface {
	Encode(args ...any) (string, error)
}

type Security interface {
	// GenerateToken Generate a JWT (JSON Web HeaderToken) with the provided subject.
	GenerateToken(ctx context.Context, subject string) (Token, error)
	// ValidateAccess Validate if a token is valid.
	ValidateAccess(ctx context.Context, tokenStr string) error
	// DestroyToken Invalidate a token by removing it from the token store.
	DestroyToken(ctx context.Context, tokenStr string) error
	// ParseSubject Parse the subject (or user identifier) from a given access token.
	ParseSubject(ctx context.Context, tokenStr string) (string, error)
	// Release any resources held by the authorize instance.
	Release(ctx context.Context) error
}

type Setting = func(s *security)

type StorageOption struct {
	Cache     cache.Cache
	Namespace string
}

type StorageSetting = func(*StorageOption)

type Token struct {
	AccessToken  string    `json:"access_token"`
	TokenType    string    `json:"token_type,omitempty"`
	RefreshToken string    `json:"refresh_token,omitempty"`
	Expiry       time.Time `json:"expiry,omitempty"`
	ExpiresIn    int64     `json:"expires_in,omitempty"`
	Claims       *Claims   `json:"-"`
}

type TokenSerializer interface {
	Generate(subject string, expires ...time.Duration) Token
	Parse(token string) (Token, error)
}

type TokenStorage interface {
	// Set stores the token with a specific expiration time
	Set(ctx context.Context, tokenStr string, expiration time.Duration) error
	// Delete deletes the token from the tokenStorage
	Delete(ctx context.Context, tokenStr string) error
	// Validate checks if the token exists in the tokenStorage
	Validate(ctx context.Context, tokenStr string) error
	// Close closes the tokenStorage
	Close(ctx context.Context) error
}