goidentity

README

goidentity

Standard interface for holding authenticated identities and their attributes.

This project has now been converted to use Go modules. Please refer to the latest major version sub directory. This follows the practice outlines at https://blog.golang.org/v2-go-modules

Documentation

Index

• Constants
• func AddToHTTPRequestContext(id Identity, r *http.Request) *http.Request
• type Authenticator
• type Identity
  • func FromHTTPRequestContext(r *http.Request) Identity
• type User
  • func NewUser(username string) User
  • func (u *User) AddAuthzAttribute(a string)
  • func (u *User) Attributes() map[string]interface{}
  • func (u *User) AuthTime() time.Time
  • func (u *User) Authenticated() bool
  • func (u *User) Authorized(a string) bool
  • func (u *User) AuthzAttributes() []string
  • func (u *User) DisableAuthzAttribute(a string)
  • func (u *User) DisplayName() string
  • func (u *User) Domain() string
  • func (u *User) EnableAuthzAttribute(a string)
  • func (u *User) Expired() bool
  • func (u *User) Human() bool
  • func (u *User) Marshal() ([]byte, error)
  • func (u *User) RemoveAttribute(k string)
  • func (u *User) RemoveAuthzAttribute(a string)
  • func (u *User) SessionID() string
  • func (u *User) SetAttribute(k string, v interface{})
  • func (u *User) SetAttributes(a map[string]interface{})
  • func (u *User) SetAuthTime(t time.Time)
  • func (u *User) SetAuthenticated(b bool)
  • func (u *User) SetDisplayName(s string)
  • func (u *User) SetDomain(s string)
  • func (u *User) SetExpiry(t time.Time)
  • func (u *User) SetHuman(b bool)
  • func (u *User) SetUserName(s string)
  • func (u *User) Unmarshal(b []byte) error
  • func (u *User) UserName() string

Constants

const (
	CTXKey = "jcmturner/goidentity"
)

Functions

func AddToHTTPRequestContext

func AddToHTTPRequestContext(id Identity, r *http.Request) *http.Request

Types

type Authenticator

type Authenticator interface {
	Authenticate() (Identity, bool, error)
	Mechanism() string // gives the name of the type of authentication mechanism
}

type Identity

type Identity interface {
	UserName() string
	SetUserName(s string)
	Domain() string
	SetDomain(s string)
	DisplayName() string
	SetDisplayName(s string)
	Human() bool
	SetHuman(b bool)
	AuthTime() time.Time
	SetAuthTime(t time.Time)
	AuthzAttributes() []string
	AddAuthzAttribute(a string)
	RemoveAuthzAttribute(a string)
	Authenticated() bool
	SetAuthenticated(b bool)
	Authorized(a string) bool
	SessionID() string
	Expired() bool
	Attributes() map[string]interface{}
	SetAttribute(k string, v interface{})
	SetAttributes(map[string]interface{})
	RemoveAttribute(k string)
	Marshal() ([]byte, error)
	Unmarshal([]byte) error
}

func FromHTTPRequestContext

func FromHTTPRequestContext(r *http.Request) Identity

type User

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

func NewUser

func NewUser(username string) User

func (*User) AddAuthzAttribute

func (u *User) AddAuthzAttribute(a string)

func (*User) Attributes

func (u *User) Attributes() map[string]interface{}

func (*User) AuthTime

func (u *User) AuthTime() time.Time

func (*User) Authenticated

func (u *User) Authenticated() bool

func (*User) Authorized

func (u *User) Authorized(a string) bool

func (*User) AuthzAttributes

func (u *User) AuthzAttributes() []string

func (*User) DisableAuthzAttribute

func (u *User) DisableAuthzAttribute(a string)

func (*User) DisplayName

func (u *User) DisplayName() string

func (*User) Domain

func (u *User) Domain() string

func (*User) EnableAuthzAttribute

func (u *User) EnableAuthzAttribute(a string)

func (*User) Expired

func (u *User) Expired() bool

func (*User) Human

func (u *User) Human() bool

func (*User) Marshal

func (u *User) Marshal() ([]byte, error)

func (*User) RemoveAttribute

func (u *User) RemoveAttribute(k string)

func (*User) RemoveAuthzAttribute

func (u *User) RemoveAuthzAttribute(a string)

func (*User) SessionID

func (u *User) SessionID() string

func (*User) SetAttribute

func (u *User) SetAttribute(k string, v interface{})

func (*User) SetAttributes

func (u *User) SetAttributes(a map[string]interface{})

func (*User) SetAuthTime

func (u *User) SetAuthTime(t time.Time)

func (*User) SetAuthenticated

func (u *User) SetAuthenticated(b bool)

func (*User) SetDisplayName

func (u *User) SetDisplayName(s string)

func (*User) SetDomain

func (u *User) SetDomain(s string)

func (*User) SetExpiry

func (u *User) SetExpiry(t time.Time)

func (*User) SetHuman

func (u *User) SetHuman(b bool)

func (*User) SetUserName

func (u *User) SetUserName(s string)

func (*User) Unmarshal

func (u *User) Unmarshal(b []byte) error

func (*User) UserName

func (u *User) UserName() string