package goidentity

Import Path
	github.com/jcmturner/goidentity/v6 (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 2 packages

Involved Source Files

	    authenticator.go
	    identity.go
	    user.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Authenticator (interface)

		Methods (total 2)
			( Authenticator) Authenticate() (Identity, bool, error)
			( Authenticator) Mechanism() string
				// gives the name of the type of authentication mechanism

		Implemented By (at least one exported)
			 github.com/jcmturner/gokrb5/v8/service.KRB5BasicAuthenticator

	 type Identity (interface)

		Methods (total 24)
			( Identity) AddAuthzAttribute(a string)
			( Identity) Attributes() map[string]interface{}
			( Identity) AuthTime() time.Time
			( Identity) Authenticated() bool
			( Identity) Authorized(a string) bool
			( Identity) AuthzAttributes() []string
			( Identity) DisplayName() string
			( Identity) Domain() string
			( Identity) Expired() bool
			( Identity) Human() bool
			( Identity) Marshal() ([]byte, error)
			( Identity) RemoveAttribute(k string)
			( Identity) RemoveAuthzAttribute(a string)
			( Identity) SessionID() string
			( Identity) SetAttribute(k string, v interface{})
			( Identity) SetAttributes(map[string]interface{})
			( Identity) SetAuthTime(t time.Time)
			( Identity) SetAuthenticated(b bool)
			( Identity) SetDisplayName(s string)
			( Identity) SetDomain(s string)
			( Identity) SetHuman(b bool)
			( Identity) SetUserName(s string)
			( Identity) Unmarshal([]byte) error
			( Identity) UserName() string
		Implemented By (at least 2)
			*User
			*github.com/jcmturner/gokrb5/v8/credentials.Credentials
		As Outputs Of (at least 3)
			func FromHTTPRequestContext(r *http.Request) Identity
			func Authenticator.Authenticate() (Identity, bool, error)
			func github.com/jcmturner/gokrb5/v8/service.KRB5BasicAuthenticator.Authenticate() (i Identity, ok bool, err error)
		As Inputs Of (at least one exported)
			func AddToHTTPRequestContext(id Identity, r *http.Request) *http.Request

	 type User (struct)

		Methods (total 27)
			(*User) AddAuthzAttribute(a string)
			(*User) Attributes() map[string]interface{}
			(*User) AuthTime() time.Time
			(*User) Authenticated() bool
			(*User) Authorized(a string) bool
			(*User) AuthzAttributes() []string
			(*User) DisableAuthzAttribute(a string)
			(*User) DisplayName() string
			(*User) Domain() string
			(*User) EnableAuthzAttribute(a string)
			(*User) Expired() bool
			(*User) Human() bool
			(*User) Marshal() ([]byte, error)
			(*User) RemoveAttribute(k string)
			(*User) RemoveAuthzAttribute(a string)
			(*User) SessionID() string
			(*User) SetAttribute(k string, v interface{})
			(*User) SetAttributes(a map[string]interface{})
			(*User) SetAuthTime(t time.Time)
			(*User) SetAuthenticated(b bool)
			(*User) SetDisplayName(s string)
			(*User) SetDomain(s string)
			(*User) SetExpiry(t time.Time)
			(*User) SetHuman(b bool)
			(*User) SetUserName(s string)
			(*User) Unmarshal(b []byte) error
			(*User) UserName() string
		Implements (at least one exported)
			*User : Identity
		As Outputs Of (at least one exported)
			func NewUser(username string) User


Package-Level Functions (total 3)

	 func AddToHTTPRequestContext(id Identity, r *http.Request) *http.Request
	 func FromHTTPRequestContext(r *http.Request) Identity
	 func NewUser(username string) User
Package-Level Constants (only one)

	const CTXKey = "jcmturner/goidentity"

The pages are generated with Golds v0.6.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.