auth

Documentation

Index

• Constants
• Variables
• func EnsureTokenValidAt(ctx context.Context, target time.Time) error
• func SetupFlags(flags *pflag.FlagSet)
• func StoreMarshalledUser(ctx context.Context, userAuthData []byte) error
• func StoreTenantToken(token string) error
• func StoreToken(token Token) error
• type Token
  • func FetchTokenFromSpec(ctx context.Context, spec string) (*Token, error)
  • func LoadTenantToken(ctx context.Context) (*Token, error)
  • func LoadTokenFromPath(ctx context.Context, path string, validAt time.Time) (*Token, error)
  • func (t *Token) Claims(ctx context.Context) (*TokenClaims, error)
  • func (t *Token) IsSessionToken() bool
  • func (t *Token) IssueToken(ctx context.Context, minDur time.Duration, ...) (string, error)
  • func (t *Token) PrimaryRegion(ctx context.Context) (string, error)
  • func (t *Token) UnmarshalJSON(data []byte) error
• type TokenClaims
• type UserAuth
  • func LoadUser() (*UserAuth, error)

Constants

const (
	GithubJWTAudience = "nscloud.dev/inline-token"
)

Variables

var Workspace string

Functions

func EnsureTokenValidAt

func EnsureTokenValidAt(ctx context.Context, target time.Time) error

func SetupFlags

func SetupFlags(flags *pflag.FlagSet)

func StoreMarshalledUser

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

func StoreTenantToken

func StoreTenantToken(token string) error

func StoreToken

func StoreToken(token Token) error

Types

type Token

type Token struct {
	BearerToken  string `json:"bearer_token,omitempty"`
	SessionToken string `json:"session_token,omitempty"`
	// contains filtered or unexported fields
}

func FetchTokenFromSpec

func FetchTokenFromSpec(ctx context.Context, spec string) (*Token, error)

func LoadTenantToken

func LoadTenantToken(ctx context.Context) (*Token, error)

func LoadTokenFromPath

func LoadTokenFromPath(ctx context.Context, path string, validAt time.Time) (*Token, error)

func (*Token) Claims

func (t *Token) Claims(ctx context.Context) (*TokenClaims, error)

func (*Token) IsSessionToken

func (t *Token) IsSessionToken() bool

func (*Token) IssueToken

func (t *Token) IssueToken(ctx context.Context, minDur time.Duration, issueShortTerm func(context.Context, string, time.Duration) (string, error), skipCache bool) (string, error)

func (*Token) PrimaryRegion

func (t *Token) PrimaryRegion(ctx context.Context) (string, error)

func (*Token) UnmarshalJSON

func (t *Token) UnmarshalJSON(data []byte) error

TODO: remove when legacy token.json format is not used anymore.

type TokenClaims

type TokenClaims struct {
	jwt.RegisteredClaims

	TenantID      string `json:"tenant_id"`
	InstanceID    string `json:"instance_id"`
	OwnerID       string `json:"owner_id"`
	PrimaryRegion string `json:"primary_region"`
}

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)