fs

Documentation

Overview

Package fs implements a filesystem-based auth.Authenticator.

Index

• type Credentials
• type Folder
  • func (f Folder) Authenticate(credentials json.RawMessage) (json.RawMessage, error)
  • func (f Folder) ExchangeToken(token json.RawMessage) (*auth.Key, error)
  • func (f Folder) RenewToken(oldToken json.RawMessage) (json.RawMessage, error)
• type Token

Types

type Credentials

type Credentials struct {
	FilePath   []string `json:"filepath"`
	Passphrase string   `json:"passphrase"`
}

Credentials is the authentication JSON structure used in Folder.Authenticate

type Folder

type Folder string

Folder is an implementation of auth.Authenticator that serves private keys from a folder path.

func (Folder) Authenticate

func (f Folder) Authenticate(credentials json.RawMessage) (json.RawMessage, error)

Authenticate parses credentials as Credentials and attempts to authenticate them. It follows the rules specified in auth.Authenticator.

func (Folder) ExchangeToken

func (f Folder) ExchangeToken(token json.RawMessage) (*auth.Key, error)

ExchangeToken exchanges a previously issued Token for an auth.Key. It follows the rules specified in auth.Authenticator.

func (Folder) RenewToken

func (f Folder) RenewToken(oldToken json.RawMessage) (json.RawMessage, error)

type Token

type Token struct {
	Secret  []byte    `json:"secret"`
	Expires time.Time `json:"expires"`
}

Token represents the carrier token structure returned by Folder.Authenticate