package credentials

Import Path
	github.com/jcmturner/gokrb5/v8/credentials (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 5 packages

Involved Source Files

	    ccache.go
	  d credentials.go
		Package credentials provides credentials management for Kerberos 5 authentication.
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type ADCredentials (struct)
		ADCredentials contains information obtained from the PAC.

		Fields (total 11)
			EffectiveName string
			FullName string
			GroupMembershipSIDs []string
			LogOffTime time.Time
			LogOnTime time.Time
			LogonDomainID string
			LogonDomainName string
			LogonServer string
			PasswordLastSet time.Time
			PrimaryGroupID int
			UserID int
		As Outputs Of (at least one exported)
			func (*Credentials).GetADCredentials() ADCredentials
		As Inputs Of (at least one exported)
			func (*Credentials).SetADCredentials(a ADCredentials)

	 type CCache (struct)
		CCache is the file credentials cache as define here: https://web.mit.edu/kerberos/krb5-latest/doc/formats/ccache_file_format.html

		Fields (total 5)
			Credentials []*Credential
			DefaultPrincipal principal
			Header header
			Path string
			Version uint8
		Methods (total 7)
			(*CCache) Contains(p types.PrincipalName) bool
				Contains tests if the cache contains a credential for the provided server PrincipalName

			(*CCache) GetClientCredentials() *Credentials
				GetClientCredentials returns a Credentials object representing the client of the credentials cache.

			(*CCache) GetClientPrincipalName() types.PrincipalName
				GetClientPrincipalName returns a PrincipalName type for the client the credentials cache is for.

			(*CCache) GetClientRealm() string
				GetClientRealm returns the reals of the client the credentials cache is for.

			(*CCache) GetEntries() []*Credential
				GetEntries filters out configuration entries an returns a slice of credentials.

			(*CCache) GetEntry(p types.PrincipalName) (*Credential, bool)
				GetEntry returns a specific credential for the PrincipalName provided.

			(*CCache) Unmarshal(b []byte) error
				Unmarshal a byte slice of credential cache data into CCache type.

		As Outputs Of (at least one exported)
			func LoadCCache(cpath string) (*CCache, error)
		As Inputs Of (at least one exported)
			func github.com/jcmturner/gokrb5/v8/client.NewFromCCache(c *CCache, krb5conf *config.Config, settings ...func(*client.Settings)) (*client.Client, error)

	 type Credential (struct)
		Credential holds a Kerberos client's ccache credential information.

		Fields (total 13)
			Addresses []types.HostAddress
			AuthData []types.AuthorizationDataEntry
			AuthTime time.Time
			Client principal
			EndTime time.Time
			IsSKey bool
			Key types.EncryptionKey
			RenewTill time.Time
			SecondTicket []byte
			Server principal
			StartTime time.Time
			Ticket []byte
			TicketFlags asn1.BitString
		As Outputs Of (at least 2)
			func (*CCache).GetEntries() []*Credential
			func (*CCache).GetEntry(p types.PrincipalName) (*Credential, bool)

	 type Credentials (struct)
		Credentials struct for a user.
		Contains either a keytab, password or both.
		Keytabs are used over passwords if both are defined.

		Methods (total 41)
			(*Credentials) AddAuthzAttribute(a string)
				AddAuthzAttribute adds an authorization attribute to the credential.

			(*Credentials) Attributes() map[string]interface{}
				Attributes returns the Credentials' attributes map.

			(*Credentials) AuthTime() time.Time
				AuthTime returns the time the credential was authenticated.

			(*Credentials) Authenticated() bool
				Authenticated indicates if the credential has been successfully authenticated or not.

			(*Credentials) Authorized(a string) bool
				Authorized indicates if the credential has the specified authorizing attribute.

			(*Credentials) AuthzAttributes() []string
				AuthzAttributes returns the credentials authorizing attributes.

			(*Credentials) CName() types.PrincipalName
				CName returns the credential's client principal name.

			(*Credentials) DisableAuthzAttribute(a string)
				DisableAuthzAttribute toggles an authorization attribute to a disabled state on the credential.

			(*Credentials) DisplayName() string
				DisplayName returns the credential's display name.

			(*Credentials) Domain() string
				Domain returns the credential's domain.

			(*Credentials) EnableAuthzAttribute(a string)
				EnableAuthzAttribute toggles an authorization attribute to an enabled state on the credential.

			(*Credentials) Expired() bool
				Expired indicates if the credential has expired.

			(*Credentials) GetADCredentials() ADCredentials
				GetADCredentials returns ADCredentials attributes sorted in the credential

			(*Credentials) HasKeytab() bool
				HasKeytab queries if the Credentials has a keytab defined.

			(*Credentials) HasPassword() bool
				HasPassword queries if the Credentials has a password defined.

			(*Credentials) Human() bool
				Human returns if the  credential represents a human or not.

			(*Credentials) JSON() (string, error)
				JSON return details of the Credentials in a JSON format.

			(*Credentials) Keytab() *keytab.Keytab
				Keytab returns the credential's Keytab.

			(*Credentials) Marshal() ([]byte, error)
				Marshal the Credentials into a byte slice

			(*Credentials) Password() string
				Password returns the credential's password.

			(*Credentials) Realm() string
				Realm returns the credential's realm. Same as the domain.

			(*Credentials) RemoveAttribute(k string)
				RemoveAttribute deletes an attribute from the attribute map that has the key provided.

			(*Credentials) RemoveAuthzAttribute(a string)
				RemoveAuthzAttribute removes an authorization attribute from the credential.

			(*Credentials) SessionID() string
				SessionID returns the credential's session ID.

			(*Credentials) SetADCredentials(a ADCredentials)
				SetADCredentials adds ADCredentials attributes to the credentials

			(*Credentials) SetAttribute(k string, v interface{})
				SetAttribute sets the value of an attribute.

			(*Credentials) SetAttributes(a map[string]interface{})
				SetAttributes replaces the attributes map with the one provided.

			(*Credentials) SetAuthTime(t time.Time)
				SetAuthTime sets the time the credential was authenticated.

			(*Credentials) SetAuthenticated(b bool)
				SetAuthenticated sets the credential as having been successfully authenticated.

			(*Credentials) SetCName(pn types.PrincipalName)
				SetCName sets the client principal name on the credential.

			(*Credentials) SetDisplayName(s string)
				SetDisplayName sets the display name value on the credential.

			(*Credentials) SetDomain(s string)
				SetDomain sets the domain value on the credential.

			(*Credentials) SetHuman(b bool)
				SetHuman sets the credential as human.

			(*Credentials) SetRealm(s string)
				SetRealm sets the realm value on the credential. Same as the domain

			(*Credentials) SetUserName(s string)
				SetUserName sets the username value on the credential.

			(*Credentials) SetValidUntil(t time.Time)
				SetValidUntil sets the expiry time of the credentials

			(*Credentials) Unmarshal(b []byte) error
				Unmarshal a byte slice into Credentials

			(*Credentials) UserName() string
				UserName returns the credential's username.

			(*Credentials) ValidUntil() time.Time
				ValidUntil returns the credential's valid until date

			(*Credentials) WithKeytab(kt *keytab.Keytab) *Credentials
				WithKeytab sets the Keytab in the Credentials struct.

			(*Credentials) WithPassword(password string) *Credentials
				WithPassword sets the password in the Credentials struct.

		Implements (at least one exported)
			*Credentials : github.com/jcmturner/goidentity/v6.Identity
		As Outputs Of (at least 6)
			func New(username string, realm string) *Credentials
			func NewFromPrincipalName(cname types.PrincipalName, realm string) *Credentials
			func (*CCache).GetClientCredentials() *Credentials
			func (*Credentials).WithKeytab(kt *keytab.Keytab) *Credentials
			func (*Credentials).WithPassword(password string) *Credentials
			func github.com/jcmturner/gokrb5/v8/service.VerifyAPREQ(APReq *messages.APReq, s *service.Settings) (bool, *Credentials, error)
		As Inputs Of (at least 2)
			func github.com/jcmturner/gokrb5/v8/messages.(*ASRep).DecryptEncPart(c *Credentials) (types.EncryptionKey, error)
			func github.com/jcmturner/gokrb5/v8/messages.(*ASRep).Verify(cfg *config.Config, creds *Credentials, asReq messages.ASReq) (bool, error)


Package-Level Functions (total 3)

	 func LoadCCache(cpath string) (*CCache, error)
		LoadCCache loads a credential cache file into a CCache type.

	 func New(username string, realm string) *Credentials
		New creates a new Credentials instance.

	 func NewFromPrincipalName(cname types.PrincipalName, realm string) *Credentials
		NewFromPrincipalName creates a new Credentials instance with the user details provides as a PrincipalName type.


Package-Level Constants (only one)

	const AttributeKeyADCredentials = "gokrb5AttributeKeyADCredentials"
		AttributeKeyADCredentials assigned number for AD credentials.

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.