auth

type APIKeyAuthConfig ¶

type APIKeyAuthConfig struct {
	Name        string
	FieldName   string
	In          oapi.In
	Description string
}

type APIKeyAuthHandlerFunc ¶

type APIKeyAuthHandlerFunc[AuthModel any] func(ctx context.Context, apiKey string) (AuthModel, error)

APIKeyAuthHandlerFunc is a function that handles API key authentication. This is the function that should be implemented by the user. It should return the user model if the API key is valid, otherwise it should return an error.

type APIKeyAuthType ¶

type APIKeyAuthType[AuthModel any] struct {
	Name        string
	FieldName   string
	In          oapi.In
	Description string
	Handler     APIKeyAuthHandlerFunc[AuthModel]
}

func (t APIKeyAuthType[AuthModel]) GetDescription() string

func (t APIKeyAuthType[AuthModel]) GetFieldName() string

func (t APIKeyAuthType[AuthModel]) GetFormat() string

func (t APIKeyAuthType[AuthModel]) GetHandler() AuthHandlerFunc[AuthModel]

func (t APIKeyAuthType[AuthModel]) GetIn() oapi.In

func (t APIKeyAuthType[AuthModel]) GetName() string

func (t APIKeyAuthType[AuthModel]) GetType() openapiModels.AuthType

type AuthHandlerFunc ¶

type AuthHandlerFunc[AuthModel any] func(r *http.Request) (AuthModel, error)

AuthHandlerFunc is a function that handles authentication for a route.

type BasicAuthConfig ¶

type BasicAuthConfig struct {
	Name        string
	Description string
}

type BasicAuthHandlerFunc ¶

type BasicAuthHandlerFunc[AuthModel any] func(ctx context.Context, username, password string) (AuthModel, error)

BasicAuthHandlerFunc is a function that handles basic auth. This is the function that should be implemented by the user. It should return the user model if the username and password are valid, otherwise it should return an error.

type BasicAuthType ¶

type BasicAuthType[AuthModel any] struct {
	Name        string
	Description string
	Handler     BasicAuthHandlerFunc[AuthModel]
}

func (t BasicAuthType[AuthModel]) GetDescription() string

func (t BasicAuthType[AuthModel]) GetFieldName() string

func (t BasicAuthType[AuthModel]) GetFormat() string

func (t BasicAuthType[AuthModel]) GetHandler() AuthHandlerFunc[AuthModel]

func (t BasicAuthType[AuthModel]) GetIn() oapi.In

func (t BasicAuthType[AuthModel]) GetName() string

func (t BasicAuthType[AuthModel]) GetType() openapiModels.AuthType

type BearerAuthConfig ¶

type BearerAuthConfig struct {
	Name        string
	Format      string
	Description string
}

type BearerAuthHandlerFunc ¶

type BearerAuthHandlerFunc[AuthModel any] func(ctx context.Context, token string) (AuthModel, error)

BearerAuthHandlerFunc is a function that handles bearer token authentication. This is the function that should be implemented by the user. It should return the user model if the token is valid, otherwise it should return an error.

type BearerAuthType ¶

type BearerAuthType[AuthModel any] struct {
	Name        string
	Format      string
	Description string
	Handler     BearerAuthHandlerFunc[AuthModel]
}

func (t BearerAuthType[AuthModel]) GetDescription() string

func (t BearerAuthType[AuthModel]) GetFieldName() string

func (t BearerAuthType[AuthModel]) GetFormat() string

func (t BearerAuthType[AuthModel]) GetHandler() AuthHandlerFunc[AuthModel]

func (t BearerAuthType[AuthModel]) GetIn() oapi.In

func (t BearerAuthType[AuthModel]) GetName() string

func (t BearerAuthType[AuthModel]) GetType() openapiModels.AuthType

type Handler ¶

type Handler[AuthModel any] interface {
	GetType() openapiModels.AuthType
	GetName() string
	GetFieldName() string
	GetFormat() string
	GetDescription() string
	GetIn() oapi.In
	GetHandler() AuthHandlerFunc[AuthModel]
}

func APIKeyAuth[AuthModel any](
	handler APIKeyAuthHandlerFunc[AuthModel],
	config APIKeyAuthConfig,
) Handler[AuthModel]

func BasicAuth[AuthModel any](
	handler BasicAuthHandlerFunc[AuthModel],
	config BasicAuthConfig,
) Handler[AuthModel]

func BearerAuth[AuthModel any](
	handler BearerAuthHandlerFunc[AuthModel],
	config BearerAuthConfig,
) Handler[AuthModel]

func SessionCookieAuth[AuthModel any](
	handler SessionCookieAuthHandlerFunc[AuthModel],
	config SessionCookieAuthConfig[AuthModel],
) Handler[AuthModel]

type SessionCookieAuthConfig ¶

type SessionCookieAuthConfig[AuthModel any] struct {
	CookieName  string
	Description string
}

type SessionCookieAuthHandlerFunc ¶

type SessionCookieAuthHandlerFunc[AuthModel any] func(ctx context.Context, cookie string) (AuthModel, error)

SessionCookieAuthHandlerFunc is a function that handles session cookie authentication. This is the function that should be implemented by the user. It should return the user model if the API key is valid, otherwise it should return an error.

type SessionCookieAuthType ¶

type SessionCookieAuthType[AuthModel any] struct {
	CookieName  string
	Description string
	Handler     SessionCookieAuthHandlerFunc[AuthModel]
}

func (t SessionCookieAuthType[AuthModel]) GetDescription() string

func (t SessionCookieAuthType[AuthModel]) GetFieldName() string

func (t SessionCookieAuthType[AuthModel]) GetFormat() string

func (t SessionCookieAuthType[AuthModel]) GetHandler() AuthHandlerFunc[AuthModel]

func (t SessionCookieAuthType[AuthModel]) GetIn() oapi.In

func (t SessionCookieAuthType[AuthModel]) GetName() string

func (t SessionCookieAuthType[AuthModel]) GetType() openapiModels.AuthType