obtainer

Documentation

Overview

Package obtainer provides an interface for OpenID Connect token obtainment from a provider

Index

• func Register(name string, driver Driver)
• type Client
  • func NewClient(providerName, providerURL, username, password, clientID string) (*Client, error)
  • func (c *Client) Obtain() (tokenString string, err error)
  • func (c *Client) Renew() (tokenString string, err error)
  • func (c *Client) Revoke() error
• type Conf
  • func (c Conf) Validate() error
• type Driver
• type Obtainer
  • func Setup(name, serverAddr string) (*Obtainer, error)
  • func (o *Obtainer) ObtainToken(username, password, clientID string) (token interface{}, err error)
  • func (o *Obtainer) RenewToken(token interface{}, clientID string) (newToken interface{}, err error)
  • func (o *Obtainer) RevokeToken(token interface{}) error
  • func (o *Obtainer) TokenString(token interface{}) (tokenString string, err error)

Functions

func Register

func Register(name string, driver Driver)

Register registers a driver (called by a the driver package)

Types

type Client

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewClient

func NewClient(providerName, providerURL, username, password, clientID string) (*Client, error)

func (*Client) Obtain

func (c *Client) Obtain() (tokenString string, err error)

Obtain obtains a new token and returns the token string. If token is already available, it just returns the token string

func (*Client) Renew

func (c *Client) Renew() (tokenString string, err error)

Renew renews the token and returns the token string

func (*Client) Revoke

func (c *Client) Revoke() error

Revoke revokes the token

type Conf

type Conf struct {
	// Enabled is to toggle obtainer client
	Enabled bool `json:"enabled"`
	// Provider is the authentication provider name
	Provider string `json:"provider"`
	// ProviderURL is the authentication provider URL
	ProviderURL string `json:"providerURL"`
	// ClientID is the authentication client id.
	ClientID string `json:"clientID"`
	// Username is the client's username
	Username string `json:"username"`
	// Password is the client's password
	Password string `json:"password"`
}

Conf is a reference configuration struct for Obtainer

func (Conf) Validate

func (c Conf) Validate() error

Validate validates the configuration object

type Driver

type Driver interface {
	// ObtainToken requests a token in exchange for user credentials
	ObtainToken(serverAddr string, username, password, clientID string) (token interface{}, err error)
	// TokenString returns the string part of token object (e.g. access_token, id_token strings)
	TokenString(token interface{}) (tokenString string, err error)
	// RenewToken renews the token (when applicable) using information inside the token (e.g. refresh_token)
	RenewToken(serverAddr string, token interface{}, clientID string) (newToken interface{}, err error)
	// RevokeToken revokes a previously obtained token
	RevokeToken(serverAddr string, token interface{}) error
}

Interface methods to login, obtain Service Ticket, and logout

type Obtainer

type Obtainer struct {
	// contains filtered or unexported fields
}

Obtainer struct

func Setup

func Setup(name, serverAddr string) (*Obtainer, error)

Setup configures and returns the Obtainer

func (*Obtainer) ObtainToken

func (o *Obtainer) ObtainToken(username, password, clientID string) (token interface{}, err error)

func (*Obtainer) RenewToken

func (o *Obtainer) RenewToken(token interface{}, clientID string) (newToken interface{}, err error)

func (*Obtainer) RevokeToken

func (o *Obtainer) RevokeToken(token interface{}) error

func (*Obtainer) TokenString

func (o *Obtainer) TokenString(token interface{}) (tokenString string, err error)