auth

package

v0.0.0-...-9d47661 Latest Latest Go to latest Published: Jan 12, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aleury/service

Links

Open Source Insights

Documentation ¶

Overview ¶

Package auth provides authentication and authorization support. Authentication: You are who you say you are. Authorization: You have permission to do what you are requesting to do.

Index ¶

Constants
Variables
func GetUserID(ctx context.Context) uuid.UUID
func IsAuthError(err error) bool
func NewAuthError(format string, args ...any) error
func SetClaims(ctx context.Context, claims Claims) context.Context
func SetUserID(ctx context.Context, userID uuid.UUID) context.Context
type Auth
- func New(cfg Config) (*Auth, error)
type AuthError
- func (ae *AuthError) Error() string
type Claims
- func GetClaims(ctx context.Context) Claims
type Config
type KeyLookup

Constants ¶

View Source

const (
	RuleAuthenticate   = "auth"
	RuleAny            = "ruleAny"
	RuleAdminOnly      = "ruleAdminOnly"
	RuleUserOnly       = "ruleUserOnly"
	RuleAdminOrSubject = "ruleAdminOrSubject"
)

These are the current set of rules we have for auth.

Variables ¶

View Source

var ErrForbidden = errors.New("attempted action is not allowed")

ErrForbidden is returned when an auth issue is identified.

Functions ¶

func GetUserID ¶

func GetUserID(ctx context.Context) uuid.UUID

GetUserID returns the user id from the context.

func IsAuthError ¶

func IsAuthError(err error) bool

IsAuthError checks if an error of the type AuthError exists.

func NewAuthError ¶

func NewAuthError(format string, args ...any) error

NewAuthError creates an AuthError for the provided message.

func SetClaims ¶

func SetClaims(ctx context.Context, claims Claims) context.Context

SetClaims stores the claims in the context.

func SetUserID ¶

func SetUserID(ctx context.Context, userID uuid.UUID) context.Context

SetUserID stores the user id in the context.

Types ¶

type Auth ¶

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

Auth is used to authenticate clients. It can generate a token for a set of user claims and recreate the claims by parsing the token.

func New ¶

func New(cfg Config) (*Auth, error)

New creates an Auth to support authentication/authorization.

func (*Auth) Authenticate ¶

func (a *Auth) Authenticate(ctx context.Context, bearerToken string) (Claims, error)

Authenticate processes the token to validate the sender's token is valid.

func (*Auth) Authorize ¶

func (a *Auth) Authorize(ctx context.Context, claims Claims, rule string) error

Authorize attempts to authorize the user with the provide input roles, if none of the input roles are within the user's claimsk, we return an error otherwise the user is authorized.

func (*Auth) GenerateToken ¶

func (a *Auth) GenerateToken(kid string, claims Claims) (string, error)

GenerateToken generates a signed JWT token string representing the user Claims.

type AuthError ¶

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

AuthError is used to pass an error during the request through the application with auth specific context.

func (*AuthError) Error ¶

func (ae *AuthError) Error() string

Error implements the error interface. It uses the default message of the wrapped error. this is what will be shown in the services' logs.

type Claims ¶

type Claims struct {
	jwt.RegisteredClaims
	Roles []user.Role `json:"roles"`
}

Claims represents the authorization claims transmitted via a JWT.

func GetClaims ¶

func GetClaims(ctx context.Context) Claims

GetClaims returns the claims from the context.

type Config ¶

type Config struct {
	Log       *zap.SugaredLogger
	KeyLookup KeyLookup
	Issuer    string
}

Config represents information required to initialize auth.

type KeyLookup ¶

type KeyLookup interface {
	PrivateKey(kid string) (key string, err error)
	PublicKey(kid string) (key string, err error)
}

KeyLookup declares a method set of behavior for looking up private and public keys for JWT use. The return could be a PEM encoded string for a JWS based key.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL