basicauthpassword

Documentation

Overview

Implements authenticator.Password by making a BasicAuth call to a remote endpoint, and extracting user information from a JSON response.

Index

• func New(url string) authenticator.Password
• type Authenticator
  • func (a *Authenticator) AuthenticatePassword(user, password string) (api.UserInfo, bool, error)
• type RemoteError
• type RemoteUserData

Functions

func New

func New(url string) authenticator.Password

New returns an authenticator which will make a basic auth call to the given url.

Types

type Authenticator

type Authenticator struct {
	URL string
}

Authenticator uses basic auth to make a request to a JSON-returning URL. A 401 status indicate failed auth. A non-200 status or the presence of an "error" key with a non-empty

value indicates an error:
{"error":"Error message"}

A 200 status with an "id" key indicates success:

{"id":"userid"}

A successful response may also include name and/or email:

{"id":"userid", "name": "User Name", "email":"user@example.com"}

func (*Authenticator) AuthenticatePassword

func (a *Authenticator) AuthenticatePassword(user, password string) (api.UserInfo, bool, error)

type RemoteError

type RemoteError struct {
	Error string
}

RemoteError holds error data returned from a remote authentication request

type RemoteUserData

type RemoteUserData struct {
	ID    string
	Name  string
	Email string
}

RemoteUserData holds user data returned from a remote basic-auth protected endpoint. These field names can not be changed unless external integrators are also updated.