auth

Documentation

Index

• Constants
• Variables
• func DeleteStoredToken() error
• func EnsureTokenValidAt(ctx context.Context, issue IssueShortTermFunc, 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 StoredToken) error
• type IssueCertFunc
• type IssueShortTermFunc
• type StoredToken
  • func (t *StoredToken) UnmarshalJSON(data []byte) error
• type Token
  • func FetchTokenFromSpec(ctx context.Context, issue IssueShortTermFunc, spec string) (*Token, error)
  • func LoadTenantToken(ctx context.Context, issue IssueShortTermFunc) (*Token, error)
  • func LoadTokenFromPath(ctx context.Context, issue IssueShortTermFunc, path string, validAt time.Time) (*Token, error)
  • func (t *Token) Claims(ctx context.Context) (*auth.TokenClaims, error)
  • func (t *Token) ExchangeForSessionClientCert(ctx context.Context, publicKeyPem string, issueFromSession IssueCertFunc) (string, error)
  • func (t *Token) ExpiresAt(ctx context.Context) (time.Time, bool, error)
  • func (t *Token) IsSessionToken() bool
  • func (t *Token) IssueToken(ctx context.Context, minDur time.Duration, skipCache bool) (string, error)
  • func (t *Token) PreferredRegion(ctx context.Context) (string, error)
• type UserAuth
  • func LoadUser() (*UserAuth, error)

Constants

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

Variables

var Workspace string

Functions

func DeleteStoredToken

func DeleteStoredToken() error

func EnsureTokenValidAt

func EnsureTokenValidAt(ctx context.Context, issue IssueShortTermFunc, 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 StoredToken) error

Types

type IssueCertFunc

type IssueCertFunc func(context.Context, string, string) (string, error)

type IssueShortTermFunc

type IssueShortTermFunc func(context.Context, *Token, time.Duration) (string, error)

type StoredToken

type StoredToken struct {
	TenantToken  string `json:"bearer_token,omitempty"`
	SessionToken string `json:"session_token,omitempty"`
}

func (*StoredToken) UnmarshalJSON

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

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

type Token

type Token struct {
	ReIssue IssueShortTermFunc

	StoredToken
	// contains filtered or unexported fields
}

func FetchTokenFromSpec

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

func LoadTenantToken

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

func LoadTokenFromPath

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

func (*Token) Claims

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

func (*Token) ExchangeForSessionClientCert

func (t *Token) ExchangeForSessionClientCert(ctx context.Context, publicKeyPem string, issueFromSession IssueCertFunc) (string, error)

func (*Token) ExpiresAt

func (t *Token) ExpiresAt(ctx context.Context) (time.Time, bool, error)

func (*Token) IsSessionToken

func (t *Token) IsSessionToken() bool

func (*Token) IssueToken

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

func (*Token) PreferredRegion

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

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)