tokenutils

Documentation

Overview

Package tokenutils contains various utilities used to interact with Aporeto JWTs.

Index

• Constants
• func ExtractQuota(token string) (int, error)
• func SigAlg(token string) (string, error)
• func Snip(err error, token string) error
• func UnsecureClaimsMap(token string) (claims map[string]interface{}, err error)
• type Audience
  • func (a Audience) String() string
  • func (a Audience) Verify(operation elemental.Operation, identity elemental.Identity, namespace string) bool
• type AudiencesList
  • func ParseAudience(audString string, modelManager elemental.ModelManager) (AudiencesList, error)
  • func UnsecureAudience(token string, modelManager elemental.ModelManager) (AudiencesList, error)
  • func (a AudiencesList) String() string
  • func (a AudiencesList) Verify(operation elemental.Operation, identity elemental.Identity, namespace string) bool

Constants

const AudienceAny = "*"

AudienceAny represents any operation, identity or namespace.

Functions

func ExtractQuota

func ExtractQuota(token string) (int, error)

ExtractQuota extracts the eventual quota from a token. Not that the token is not verified in the process, you the verification must be done before trusting the extracted quota value.

func SigAlg

func SigAlg(token string) (string, error)

SigAlg returns the signature used by the token

func Snip

func Snip(err error, token string) error

Snip snips the given token from the given error.

func UnsecureClaimsMap

func UnsecureClaimsMap(token string) (claims map[string]interface{}, err error)

UnsecureClaimsMap decodes the claims in the given JWT token without verifying its validity. Only use or trust this after proper validation.

Types

type Audience

type Audience struct {
	Operations []string
	Identities []string
	Namespaces []string
}

Audience represents a parsed audience string.

func (Audience) String

func (a Audience) String() string

func (Audience) Verify

func (a Audience) Verify(operation elemental.Operation, identity elemental.Identity, namespace string) bool

Verify verifies the audience is valid for the given operation, identity and namespace.

type AudiencesList

type AudiencesList []Audience

AudiencesList is a list of audiences.

func ParseAudience

func ParseAudience(audString string, modelManager elemental.ModelManager) (AudiencesList, error)

ParseAudience parses the audience string and returns an AudiencesList.

func UnsecureAudience

func UnsecureAudience(token string, modelManager elemental.ModelManager) (AudiencesList, error)

UnsecureAudience extracts the audience list from a token string without verifying its validity. Only use or trust this after proper validation.

func (AudiencesList) String

func (a AudiencesList) String() string

func (AudiencesList) Verify

func (a AudiencesList) Verify(operation elemental.Operation, identity elemental.Identity, namespace string) bool

Verify verifies at least one audience in the list is valid for the given operation, identity and namespace.