credentials

Documentation

Index

• Constants
• func DecodeTokenWithKey(nerdToken string, key *ecdsa.PublicKey) (*payload.NerdClaims, error)
• func DecodeTokenWithPEM(nerdToken, pem string) (*payload.NerdClaims, error)
• func ParseECDSAPublicKeyFromPemBytes(pemb []byte) (*ecdsa.PublicKey, error)
• type NerdAPI
  • func NewNerdAPI(pub *ecdsa.PublicKey, provider Provider) *NerdAPI
  • func (n *NerdAPI) Get() (*NerdAPIValue, error)
  • func (n *NerdAPI) GetClaims() (*payload.NerdClaims, error)
• type NerdAPIValue
• type Provider

Constants

const (
	NerdTokenEnvVar = "NERD_TOKEN"
)

Functions

func DecodeTokenWithKey

func DecodeTokenWithKey(nerdToken string, key *ecdsa.PublicKey) (*payload.NerdClaims, error)

DecodeTokenWithKey decodes a nerd token (JWT) and verifies it with the given public key.

func DecodeTokenWithPEM

func DecodeTokenWithPEM(nerdToken, pem string) (*payload.NerdClaims, error)

DecodeTokenWithPEM decodes a nerd token (JWT) and verifies it with the given public key in PEM format.

func ParseECDSAPublicKeyFromPemBytes

func ParseECDSAPublicKeyFromPemBytes(pemb []byte) (*ecdsa.PublicKey, error)

ParseECDSAPublicKeyFromPemBytes returns an ECDSA public key from pem bytes

Types

type NerdAPI

type NerdAPI struct {
	PublicKey *ecdsa.PublicKey
	// contains filtered or unexported fields
}

NerdAPI holds a reference to a nerdalize auth token. A credentials provider is needed to provide this value.

func NewNerdAPI

func NewNerdAPI(pub *ecdsa.PublicKey, provider Provider) *NerdAPI

NewNerdAPI creates a new credentials.NerdAPI struct.

func (*NerdAPI) Get

func (n *NerdAPI) Get() (*NerdAPIValue, error)

Get the nerd token. This function checks with the provider whether the token is expired and if so retrieves a new token from the provider.

func (*NerdAPI) GetClaims

func (n *NerdAPI) GetClaims() (*payload.NerdClaims, error)

GetClaims calls Get() and decodes the token string into a NerdClaims object.

type NerdAPIValue

type NerdAPIValue struct {
	NerdToken string
}

NerdAPIValue is the value struct that contains credential values.

type Provider

type Provider interface {
	IsExpired() bool
	Retrieve(*ecdsa.PublicKey) (*NerdAPIValue, error)
}

Provider is a credential provider that gives a NerdAPIValue when Retrieve is called. A provider can define it's own logic of where to fetch this NerdAPIValue from.