package client

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

Dependency Relation
	imports 25 packages, and imported by 3 packages

Involved Source Files

	    ASExchange.go
	    TGSExchange.go
	    cache.go
	  d client.go
		Package client provides a client library and methods for Kerberos 5 authentication.

	    network.go
	    passwd.go
	    session.go
	    settings.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Cache (struct)
		Cache for service tickets held by the client.

		Fields (only one)
			Entries map[string]CacheEntry
		Methods (total 2)
			(*Cache) JSON() (string, error)
				JSON returns information about the cached service tickets in a JSON format.

			(*Cache) RemoveEntry(spn string)
				RemoveEntry removes the cache entry for the defined SPN.

		As Outputs Of (at least one exported)
			func NewCache() *Cache

	 type CacheEntry (struct)
		CacheEntry holds details for a cache entry.

		Fields (total 7)
			AuthTime time.Time
			EndTime time.Time
			RenewTill time.Time
			SPN string
			SessionKey types.EncryptionKey
			StartTime time.Time
			Ticket messages.Ticket

	 type Client (struct)
		Client side configuration and state.

		Fields (total 2)
			Config *config.Config
			Credentials *credentials.Credentials
		Methods (total 14)
			(*Client) ASExchange(realm string, ASReq messages.ASReq, referral int) (messages.ASRep, error)
				ASExchange performs an AS exchange for the client to retrieve a TGT.

			(*Client) AffirmLogin() error
				AffirmLogin will only perform an AS exchange with the KDC if the client does not already have a TGT.

			(*Client) ChangePasswd(newPasswd string) (bool, error)
				ChangePasswd changes the password of the client to the value provided.

			(*Client) Destroy()
				Destroy stops the auto-renewal of all sessions and removes the sessions and cache entries from the client.

			(*Client) Diagnostics(w io.Writer) error
				Diagnostics runs a set of checks that the client is properly configured and writes details to the io.Writer provided.

			(*Client) GetCachedTicket(spn string) (messages.Ticket, types.EncryptionKey, bool)
				GetCachedTicket returns a ticket from the cache for the SPN.
				Only a ticket that is currently valid will be returned.

			(*Client) GetServiceTicket(spn string) (messages.Ticket, types.EncryptionKey, error)
				GetServiceTicket makes a request to get a service ticket for the SPN specified
				SPN format: <SERVICE>/<FQDN> Eg. HTTP/www.example.com
				The ticket will be added to the client's ticket cache

			(*Client) IsConfigured() (bool, error)
				IsConfigured indicates if the client has the values required set.

			(*Client) Key(etype etype.EType, kvno int, krberr *messages.KRBError) (types.EncryptionKey, int, error)
				Key returns the client's encryption key for the specified encryption type and its kvno (kvno of zero will find latest).
				The key can be retrieved either from the keytab or generated from the client's password.
				If the client has both a keytab and a password defined the keytab is favoured as the source for the key
				A KRBError can be passed in the event the KDC returns one of type KDC_ERR_PREAUTH_REQUIRED and is required to derive
				the key for pre-authentication from the client's password. If a KRBError is not available, pass nil to this argument.

			(*Client) Log(format string, v ...interface{})
				Log will write to the service's logger if it is configured.

			(*Client) Login() error
				Login the client with the KDC via an AS exchange.

			(*Client) Print(w io.Writer)
				Print writes the details of the client to the io.Writer provided.

			(*Client) TGSExchange(tgsReq messages.TGSReq, kdcRealm string, tgt messages.Ticket, sessionKey types.EncryptionKey, referral int) (messages.TGSReq, messages.TGSRep, error)
				TGSExchange exchanges the provided TGS_REQ with the KDC to retrieve a TGS_REP.
				Referrals are automatically handled.
				The client's cache is updated with the ticket received.

			(*Client) TGSREQGenerateAndExchange(spn types.PrincipalName, kdcRealm string, tgt messages.Ticket, sessionKey types.EncryptionKey, renewal bool) (tgsReq messages.TGSReq, tgsRep messages.TGSRep, err error)
				TGSREQGenerateAndExchange generates the TGS_REQ and performs a TGS exchange to retrieve a ticket to the specified SPN.

		As Outputs Of (at least 3)
			func NewFromCCache(c *credentials.CCache, krb5conf *config.Config, settings ...func(*Settings)) (*Client, error)
			func NewWithKeytab(username, realm string, kt *keytab.Keytab, krb5conf *config.Config, settings ...func(*Settings)) *Client
			func NewWithPassword(username, realm, password string, krb5conf *config.Config, settings ...func(*Settings)) *Client
		As Inputs Of (at least 5)
			func github.com/jcmturner/gokrb5/v8/spnego.NewClient(krb5Cl *Client, httpCl *http.Client, spn string) *spnego.Client
			func github.com/jcmturner/gokrb5/v8/spnego.NewKRB5TokenAPREQ(cl *Client, tkt messages.Ticket, sessionKey types.EncryptionKey, GSSAPIFlags []int, APOptions []int) (spnego.KRB5Token, error)
			func github.com/jcmturner/gokrb5/v8/spnego.NewNegTokenInitKRB5(cl *Client, tkt messages.Ticket, sessionKey types.EncryptionKey) (spnego.NegTokenInit, error)
			func github.com/jcmturner/gokrb5/v8/spnego.SetSPNEGOHeader(cl *Client, r *http.Request, spn string) error
			func github.com/jcmturner/gokrb5/v8/spnego.SPNEGOClient(cl *Client, spn string) *spnego.SPNEGO

	 type Settings (struct)
		Settings holds optional client settings.

		Methods (total 4)
			(*Settings) AssumePreAuthentication() bool
				AssumePreAuthentication indicates if the client should proactively assume using pre-authentication.

			(*Settings) DisablePAFXFAST() bool
				DisablePAFXFAST indicates is the client should disable the use of PA_FX_FAST.

			(*Settings) JSON() (string, error)
				JSON returns a JSON representation of the settings.

			(*Settings) Logger() *log.Logger
				Logger returns the client logger instance.

		As Outputs Of (at least one exported)
			func NewSettings(settings ...func(*Settings)) *Settings
		As Inputs Of (at least one exported)
			func github.com/jcmturner/gokrb5/v8/service.NewKRB5BasicAuthenticator(headerVal string, krb5conf *config.Config, serviceSettings *service.Settings, clientSettings *Settings) service.KRB5BasicAuthenticator


Package-Level Functions (total 8)

	 func AssumePreAuthentication(b bool) func(*Settings)
		AssumePreAuthentication used to configure the client to assume pre-authentication is required.
		
		s := NewSettings(AssumePreAuthentication(true))

	 func DisablePAFXFAST(b bool) func(*Settings)
		DisablePAFXFAST used to configure the client to not use PA_FX_FAST.
		
		s := NewSettings(DisablePAFXFAST(true))

	 func Logger(l *log.Logger) func(*Settings)
		Logger used to configure client with a logger.
		
		s := NewSettings(kt, Logger(l))

	 func NewCache() *Cache
		NewCache creates a new client ticket cache instance.

	 func NewFromCCache(c *credentials.CCache, krb5conf *config.Config, settings ...func(*Settings)) (*Client, error)
		NewFromCCache create a client from a populated client cache.
		
		WARNING: A client created from CCache does not automatically renew TGTs and a failure will occur after the TGT expires.

	 func NewSettings(settings ...func(*Settings)) *Settings
		NewSettings creates a new client settings struct.

	 func NewWithKeytab(username, realm string, kt *keytab.Keytab, krb5conf *config.Config, settings ...func(*Settings)) *Client
		NewWithKeytab creates a new client from a keytab credential.

	 func NewWithPassword(username, realm, password string, krb5conf *config.Config, settings ...func(*Settings)) *Client
		NewWithPassword creates a new client from a password credential.
		Set the realm to empty string to use the default realm from config.


Package-Level Constants (total 8)

	const KRB5_KPASSWD_ACCESSDENIED = 5
		Kpasswd server response codes.

	const KRB5_KPASSWD_AUTHERROR = 3
		Kpasswd server response codes.

	const KRB5_KPASSWD_BAD_VERSION = 6
		Kpasswd server response codes.

	const KRB5_KPASSWD_HARDERROR = 2
		Kpasswd server response codes.

	const KRB5_KPASSWD_INITIAL_FLAG_NEEDED = 7
		Kpasswd server response codes.

	const KRB5_KPASSWD_MALFORMED = 1
		Kpasswd server response codes.

	const KRB5_KPASSWD_SOFTERROR = 4
		Kpasswd server response codes.

	const KRB5_KPASSWD_SUCCESS = 0
		Kpasswd server response codes.

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.