tok

Documentation

Overview

Package tok provides AuthN token (structure and methods) for validation by AIS gateways

• Copyright (c) 2018-2022, NVIDIA CORPORATION. All rights reserved.

Index

• Variables
• func AdminJWT(expires time.Time, userID, secret string) (string, error)
• func ExtractToken(hdr http.Header) (string, error)
• func JWT(expires time.Time, userID string, bucketACLs []*authn.BckACL, ...) (string, error)
• type Token
  • func DecryptToken(tokenStr, secret string) (*Token, error)
  • func (tk *Token) CheckPermissions(clusterID string, bck *cmn.Bck, perms apc.AccessAttrs) error
  • func (tk *Token) String() string

Variables

var (
	ErrNoPermissions = errors.New("insufficient permissions")
	ErrInvalidToken  = errors.New("invalid token")
	ErrNoToken       = errors.New("token required")
	ErrNoBearerToken = errors.New("invalid token: no bearer")
	ErrTokenExpired  = errors.New("token expired")
	ErrTokenRevoked  = errors.New("token revoked")
)

Functions

func AdminJWT

func AdminJWT(expires time.Time, userID, secret string) (string, error)

func ExtractToken

func ExtractToken(hdr http.Header) (string, error)

Header format: 'Authorization: Bearer <token>'

func JWT

func JWT(expires time.Time, userID string, bucketACLs []*authn.BckACL, clusterACLs []*authn.CluACL,
	secret string) (string, error)

Types

type Token

type Token struct {
	UserID      string          `json:"username"`
	Expires     time.Time       `json:"expires"`
	Token       string          `json:"token"`
	ClusterACLs []*authn.CluACL `json:"clusters"`
	BucketACLs  []*authn.BckACL `json:"buckets,omitempty"`
	IsAdmin     bool            `json:"admin"`
}

func DecryptToken

func DecryptToken(tokenStr, secret string) (*Token, error)

func (*Token) CheckPermissions

func (tk *Token) CheckPermissions(clusterID string, bck *cmn.Bck, perms apc.AccessAttrs) error

func (*Token) String

func (tk *Token) String() string