rpcauth

Documentation

Index

• func GetTokenFromHTTPHeaders(headers http.Header) (string, error)
• func GetTokenFromHeader(ctx context.Context) (string, error)
• func WithContextUser(ctx context.Context, user *User) context.Context
• func WithToken(ctx context.Context, token string) context.Context
• func WithTokenIfNoneSet(ctx context.Context, token string) context.Context
• type Authenticator
• type AuthenticatorFunc
  • func (f AuthenticatorFunc) Authenticate(ctx context.Context, token string) (*User, error)
• type User
  • func GetUser(ctx context.Context) (*User, bool)

Functions

func GetTokenFromHTTPHeaders

func GetTokenFromHTTPHeaders(headers http.Header) (string, error)

GetTokenFromHTTPHeaders gets the current authentication token from the HTTP headers, if there is one.

func GetTokenFromHeader

func GetTokenFromHeader(ctx context.Context) (string, error)

GetTokenFromHeader gets the current authentication token, if there is one.

func WithContextUser

func WithContextUser(ctx context.Context, user *User) context.Context

WithContextUser sets the user on the context. It is intended to be used by interceptors following token authentication.

func WithToken

func WithToken(ctx context.Context, token string) context.Context

WithToken adds the token to the context via a header.

func WithTokenIfNoneSet

func WithTokenIfNoneSet(ctx context.Context, token string) context.Context

WithTokenIfNoneSet adds the token to the context via a header if none is already set. If a token is already set on the header, this function just returns the context as is.

Types

type Authenticator

type Authenticator interface {
	Authenticate(ctx context.Context, token string) (*User, error)
}

Authenticator defines the interface used to authenticate a token.

type AuthenticatorFunc

type AuthenticatorFunc func(context.Context, string) (*User, error)

AuthenticatorFunc is a function that implements Authenticator

func (AuthenticatorFunc) Authenticate

func (f AuthenticatorFunc) Authenticate(ctx context.Context, token string) (*User, error)

Authenticate implements Authenticator.

type User

type User struct {
	Subject string
}

User describes an authenticated user.

func GetUser

func GetUser(ctx context.Context) (*User, bool)

GetUser gets the currently authenticated user, if there is one. It returns nil, false, if there is no authenticated user.