auth

Documentation

Index

• Variables
• func GenerateToken(ctx context.Context, opts ...AuthOpt) (string, error)
• func StoreMarshalledUser(ctx context.Context, userAuthData []byte) error
• func StoreUser(ctx context.Context, userAuth *UserAuth) (string, error)
• type AuthOpt
  • func WithGithubOIDC(useGithubOIDC bool) AuthOpt
  • func WithUserAuth(userAuth *UserAuth) AuthOpt
• type UserAuth
  • func LoadUser() (*UserAuth, error)

Variables

var ErrRelogin = fnerrors.New("not logged in, please run `ns login`")

Functions

func GenerateToken

func GenerateToken(ctx context.Context, opts ...AuthOpt) (string, error)

GenerateToken generates token based on provided options. If no options provided an error would be returned.

func StoreMarshalledUser

func StoreMarshalledUser(ctx context.Context, userAuthData []byte) error

func StoreUser

func StoreUser(ctx context.Context, userAuth *UserAuth) (string, error)

Types

type AuthOpt

type AuthOpt func(*authConfig)

func WithGithubOIDC

func WithGithubOIDC(useGithubOIDC bool) AuthOpt

WithGithubOIDC an option to use Github OIDC provider to generate JWT.

func WithUserAuth

func WithUserAuth(userAuth *UserAuth) AuthOpt

WithUserAuth an option to use existing `UserAuth` credentials to get JWT.

type UserAuth

type UserAuth struct {
	Username       string `json:"username,omitempty"`
	Org            string `json:"org,omitempty"` // The organization this user is acting as. Only really relevant for robot accounts which authenticate against a repository.
	InternalOpaque []byte `json:"opaque,omitempty"`

	Clerk          *clerk.State `json:"clerk,omitempty"`
	IsGithubAction bool         `json:"is_github_action,omitempty"`
}

func LoadUser

func LoadUser() (*UserAuth, error)