goidentity

package module

v6.0.1 Latest Latest Go to latest Published: Jan 19, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jcmturner/goidentity

Links

Open Source Insights

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

Constants ¶

View Source

const (
	CTXKey = "jcmturner/goidentity"
)

Variables ¶

This section is empty.

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL