tokens

Documentation

Index

• Constants
• func GenerateAPIToken(dataDir, tokenFilename string) (string, error)
• func GetAndValidateAPIToken(dataDir, tokenFilename string) (string, error)
• func ValidateAPIToken(apiToken string) error
• func ValidateOrGenerateAPIToken(dataDir, tokenFilename string) (apiToken string, wroteToken bool, err error)

Constants

const (
	AlgodTokenFilename      = "algod.token"
	AlgodAdminTokenFilename = "algod.admin.token"
	KmdTokenFilename        = "kmd.token"
)

API tokens that live in the datadirs of their respective daemons

Functions

func GenerateAPIToken

func GenerateAPIToken(dataDir, tokenFilename string) (string, error)

GenerateAPIToken writes a cryptographically secure APIToken to disk

func GetAndValidateAPIToken

func GetAndValidateAPIToken(dataDir, tokenFilename string) (string, error)

GetAndValidateAPIToken reads the APIToken from the token file and validates it. Always returns the potentially invalid token along with the error

func ValidateAPIToken

func ValidateAPIToken(apiToken string) error

ValidateAPIToken returns a non-nil error if the passed APIToken fails our validation checks

func ValidateOrGenerateAPIToken

func ValidateOrGenerateAPIToken(dataDir, tokenFilename string) (apiToken string, wroteToken bool, err error)

ValidateOrGenerateAPIToken generates an APIToken if it does not exist, and checks that any set token is valid