package messages

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

Dependency Relation
	imports 24 packages, and imported by 4 packages

Involved Source Files

	    APRep.go
	    APReq.go
	    KDCRep.go
	    KDCReq.go
	    KRBCred.go
	  d KRBError.go
		Package messages implements Kerberos 5 message types and methods.

	    KRBPriv.go
	    KRBSafe.go
	    Ticket.go
Package-Level Type Names (total 23)

	/* sort by: alphabet | popularity */
	 type APRep (struct)
		APRep implements RFC 4120 KRB_AP_REP: https://tools.ietf.org/html/rfc4120#section-5.5.2.

		Fields (total 3)
			EncPart types.EncryptedData
			MsgType int
			PVNO int
		Methods (only one)
			(*APRep) Unmarshal(b []byte) error
				Unmarshal bytes b into the APRep struct.


	 type APReq (struct)
		APReq implements RFC 4120 KRB_AP_REQ: https://tools.ietf.org/html/rfc4120#section-5.5.1.

		Fields (total 6)
			APOptions asn1.BitString
			Authenticator types.Authenticator
			EncryptedAuthenticator types.EncryptedData
			MsgType int
			PVNO int
			Ticket Ticket
		Methods (total 4)
			(*APReq) DecryptAuthenticator(sessionKey types.EncryptionKey) error
				DecryptAuthenticator decrypts the Authenticator within the AP_REQ.
				sessionKey may simply be the key within the decrypted EncPart of the ticket within the AP_REQ.

			(*APReq) Marshal() ([]byte, error)
				Marshal APReq struct.

			(*APReq) Unmarshal(b []byte) error
				Unmarshal bytes b into the APReq struct.

			(*APReq) Verify(kt *keytab.Keytab, d time.Duration, cAddr types.HostAddress, snameOverride *types.PrincipalName) (bool, error)
				Verify an AP_REQ using service's keytab, spn and max acceptable clock skew duration.
				The service ticket encrypted part and authenticator will be decrypted as part of this operation.

		As Outputs Of (at least one exported)
			func NewAPReq(tkt Ticket, sessionKey types.EncryptionKey, auth types.Authenticator) (APReq, error)
		As Inputs Of (at least one exported)
			func github.com/jcmturner/gokrb5/v8/service.VerifyAPREQ(APReq *APReq, s *service.Settings) (bool, *credentials.Credentials, error)

	 type ASRep (struct)
		ASRep implements RFC 4120 KRB_AS_REP: https://tools.ietf.org/html/rfc4120#section-5.4.2.

		Fields (total 9)
			KDCRepFields KDCRepFields
			KDCRepFields.CName types.PrincipalName
			KDCRepFields.CRealm string
			KDCRepFields.DecryptedEncPart EncKDCRepPart
			KDCRepFields.EncPart types.EncryptedData
			KDCRepFields.MsgType int
			KDCRepFields.PAData []types.PAData
			KDCRepFields.PVNO int
			KDCRepFields.Ticket Ticket
		Methods (total 4)
			(*ASRep) DecryptEncPart(c *credentials.Credentials) (types.EncryptionKey, error)
				DecryptEncPart decrypts the encrypted part of an AS_REP.

			(*ASRep) Marshal() ([]byte, error)
				Marshal ASRep struct.

			(*ASRep) Unmarshal(b []byte) error
				Unmarshal bytes b into the ASRep struct.

			(*ASRep) Verify(cfg *config.Config, creds *credentials.Credentials, asReq ASReq) (bool, error)
				Verify checks the validity of AS_REP message.

		As Outputs Of (at least one exported)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).ASExchange(realm string, ASReq ASReq, referral int) (ASRep, error)

	 type ASReq (struct)
		ASReq implements RFC 4120 KRB_AS_REQ: https://tools.ietf.org/html/rfc4120#section-5.4.1.

		Fields (total 6)
			KDCReqFields KDCReqFields
			KDCReqFields.MsgType int
			KDCReqFields.PAData types.PADataSequence
			KDCReqFields.PVNO int
			KDCReqFields.Renewal bool
			KDCReqFields.ReqBody KDCReqBody
		Methods (total 2)
			(*ASReq) Marshal() ([]byte, error)
				Marshal ASReq struct.

			(*ASReq) Unmarshal(b []byte) error
				Unmarshal bytes b into the ASReq struct.

		As Outputs Of (at least 3)
			func NewASReq(realm string, c *config.Config, cname, sname types.PrincipalName) (ASReq, error)
			func NewASReqForChgPasswd(realm string, c *config.Config, cname types.PrincipalName) (ASReq, error)
			func NewASReqForTGT(realm string, c *config.Config, cname types.PrincipalName) (ASReq, error)
		As Inputs Of (at least 2)
			func (*ASRep).Verify(cfg *config.Config, creds *credentials.Credentials, asReq ASReq) (bool, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).ASExchange(realm string, ASReq ASReq, referral int) (ASRep, error)

	 type EncAPRepPart (struct)
		EncAPRepPart is the encrypted part of KRB_AP_REP.

		Fields (total 4)
			CTime time.Time
			Cusec int
			SequenceNumber int64
			Subkey types.EncryptionKey
		Methods (only one)
			(*EncAPRepPart) Unmarshal(b []byte) error
				Unmarshal bytes b into the APRep encrypted part struct.


	 type EncKDCRepPart (struct)
		EncKDCRepPart is the encrypted part of KRB_KDC_REP.

		Fields (total 13)
			AuthTime time.Time
			CAddr []types.HostAddress
			EncPAData types.PADataSequence
			EndTime time.Time
			Flags asn1.BitString
			Key types.EncryptionKey
			KeyExpiration time.Time
			LastReqs []LastReq
			Nonce int
			RenewTill time.Time
			SName types.PrincipalName
			SRealm string
			StartTime time.Time
		Methods (total 2)
			(*EncKDCRepPart) Marshal() ([]byte, error)
				Marshal encrypted part of KRB_KDC_REP.

			(*EncKDCRepPart) Unmarshal(b []byte) error
				Unmarshal bytes b into encrypted part of KRB_KDC_REP.


	 type EncKrbCredPart (struct)
		EncKrbCredPart is the encrypted part of KRB_CRED.

		Fields (total 6)
			Nouce int
			RAddress types.HostAddress
			SAddress types.HostAddress
			TicketInfo []KrbCredInfo
			Timestamp time.Time
			Usec int
		Methods (only one)
			(*EncKrbCredPart) Unmarshal(b []byte) error
				Unmarshal bytes b into the encrypted part of KRB_CRED.


	 type EncKrbPrivPart (struct)
		EncKrbPrivPart is the encrypted part of KRB_PRIV.

		Fields (total 6)
			RAddress types.HostAddress
			SAddress types.HostAddress
			SequenceNumber int64
			Timestamp time.Time
			Usec int
			UserData []byte
		Methods (only one)
			(*EncKrbPrivPart) Unmarshal(b []byte) error
				Unmarshal bytes b into the EncKrbPrivPart struct.

		As Inputs Of (at least one exported)
			func NewKRBPriv(part EncKrbPrivPart) KRBPriv

	 type EncTicketPart (struct)
		EncTicketPart is the encrypted part of the Ticket.

		Fields (total 11)
			AuthTime time.Time
			AuthorizationData types.AuthorizationData
			CAddr types.HostAddresses
			CName types.PrincipalName
			CRealm string
			EndTime time.Time
			Flags asn1.BitString
			Key types.EncryptionKey
			RenewTill time.Time
			StartTime time.Time
			Transited TransitedEncoding
		Methods (only one)
			(*EncTicketPart) Unmarshal(b []byte) error
				Unmarshal bytes b into the EncTicketPart struct.


	 type KDCRepFields (struct)
		KDCRepFields represents the KRB_KDC_REP fields.

		Fields (total 8)
			CName types.PrincipalName
			CRealm string
			DecryptedEncPart EncKDCRepPart
			EncPart types.EncryptedData
			MsgType int
			PAData []types.PAData
			PVNO int
			Ticket Ticket

	 type KDCReqBody (struct)
		KDCReqBody implements the KRB_KDC_REQ request body.

		Fields (total 12)
			AdditionalTickets []Ticket
			Addresses []types.HostAddress
			CName types.PrincipalName
			EType []int32
			EncAuthData types.EncryptedData
			From time.Time
			KDCOptions asn1.BitString
			Nonce int
			RTime time.Time
			Realm string
			SName types.PrincipalName
			Till time.Time
		Methods (total 2)
			(*KDCReqBody) Marshal() ([]byte, error)
				Marshal KRB_KDC_REQ body struct.

			(*KDCReqBody) Unmarshal(b []byte) error
				Unmarshal bytes b into the KRB_KDC_REQ body struct.


	 type KDCReqFields (struct)
		KDCReqFields represents the KRB_KDC_REQ fields.

		Fields (total 5)
			MsgType int
			PAData types.PADataSequence
			PVNO int
			Renewal bool
			ReqBody KDCReqBody

	 type KRBCred (struct)
		KRBCred implements RFC 4120 KRB_CRED: https://tools.ietf.org/html/rfc4120#section-5.8.1.

		Fields (total 5)
			DecryptedEncPart EncKrbCredPart
			EncPart types.EncryptedData
			MsgType int
			PVNO int
			Tickets []Ticket
		Methods (total 2)
			(*KRBCred) DecryptEncPart(key types.EncryptionKey) error
				DecryptEncPart decrypts the encrypted part of a KRB_CRED.

			(*KRBCred) Unmarshal(b []byte) error
				Unmarshal bytes b into the KRBCred struct.


	 type KrbCredInfo (struct)
		KrbCredInfo is the KRB_CRED_INFO part of KRB_CRED.

		Fields (total 11)
			AuthTime time.Time
			CAddr types.HostAddresses
			EndTime time.Time
			Flags asn1.BitString
			Key types.EncryptionKey
			PName types.PrincipalName
			PRealm string
			RenewTill time.Time
			SName types.PrincipalName
			SRealm string
			StartTime time.Time

	 type KRBError (struct)
		KRBError implements RFC 4120 KRB_ERROR: https://tools.ietf.org/html/rfc4120#section-5.9.1.

		Fields (total 13)
			CName types.PrincipalName
			CRealm string
			CTime time.Time
			Cusec int
			EData []byte
			EText string
			ErrorCode int32
			MsgType int
			PVNO int
			Realm string
			SName types.PrincipalName
			STime time.Time
			Susec int
		Methods (total 3)
			( KRBError) Error() string
				Error method implementing error interface on KRBError struct.

			(*KRBError) Marshal() ([]byte, error)
				Marshal a KRBError into bytes.

			(*KRBError) Unmarshal(b []byte) error
				Unmarshal bytes b into the KRBError struct.

		Implements (at least one exported)
			 KRBError : error
		As Outputs Of (at least one exported)
			func NewKRBError(sname types.PrincipalName, realm string, code int32, etext string) KRBError
		As Inputs Of (at least one exported)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).Key(etype etype.EType, kvno int, krberr *KRBError) (types.EncryptionKey, int, error)

	 type KRBPriv (struct)
		KRBPriv implements RFC 4120 type: https://tools.ietf.org/html/rfc4120#section-5.7.1.

		Fields (total 4)
			DecryptedEncPart EncKrbPrivPart
				// Not part of ASN1 bytes so marked as optional so unmarshalling works

			EncPart types.EncryptedData
			MsgType int
			PVNO int
		Methods (total 4)
			(*KRBPriv) DecryptEncPart(key types.EncryptionKey) error
				DecryptEncPart decrypts the encrypted part of the KRBPriv message.

			(*KRBPriv) EncryptEncPart(key types.EncryptionKey) error
				EncryptEncPart encrypts the DecryptedEncPart within the KRBPriv.
				Use to prepare for marshaling.

			(*KRBPriv) Marshal() ([]byte, error)
				Marshal the KRBPriv.

			(*KRBPriv) Unmarshal(b []byte) error
				Unmarshal bytes b into the KRBPriv struct.

		As Outputs Of (at least one exported)
			func NewKRBPriv(part EncKrbPrivPart) KRBPriv

	 type KRBSafe (struct)
		KRBSafe implements RFC 4120 KRB_SAFE: https://tools.ietf.org/html/rfc4120#section-5.6.1.

		Fields (total 4)
			Cksum types.Checksum
			MsgType int
			PVNO int
			SafeBody KRBSafeBody
		Methods (only one)
			(*KRBSafe) Unmarshal(b []byte) error
				Unmarshal bytes b into the KRBSafe struct.


	 type KRBSafeBody (struct)
		KRBSafeBody implements the KRB_SAFE_BODY of KRB_SAFE.

		Fields (total 6)
			RAddress types.HostAddress
			SAddress types.HostAddress
			SequenceNumber int64
			Timestamp time.Time
			Usec int
			UserData []byte

	 type LastReq (struct)
		LastReq part of KRB_KDC_REP.

		Fields (total 2)
			LRType int32
			LRValue time.Time

	 type TGSRep (struct)
		TGSRep implements RFC 4120 KRB_TGS_REP: https://tools.ietf.org/html/rfc4120#section-5.4.2.

		Fields (total 9)
			KDCRepFields KDCRepFields
			KDCRepFields.CName types.PrincipalName
			KDCRepFields.CRealm string
			KDCRepFields.DecryptedEncPart EncKDCRepPart
			KDCRepFields.EncPart types.EncryptedData
			KDCRepFields.MsgType int
			KDCRepFields.PAData []types.PAData
			KDCRepFields.PVNO int
			KDCRepFields.Ticket Ticket
		Methods (total 4)
			(*TGSRep) DecryptEncPart(key types.EncryptionKey) error
				DecryptEncPart decrypts the encrypted part of an TGS_REP.

			(*TGSRep) Marshal() ([]byte, error)
				Marshal TGSRep struct.

			(*TGSRep) Unmarshal(b []byte) error
				Unmarshal bytes b into the TGSRep struct.

			(*TGSRep) Verify(cfg *config.Config, tgsReq TGSReq) (bool, error)
				Verify checks the validity of the TGS_REP message.

		As Outputs Of (at least 2)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSExchange(tgsReq TGSReq, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, referral int) (TGSReq, TGSRep, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSREQGenerateAndExchange(spn types.PrincipalName, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, renewal bool) (tgsReq TGSReq, tgsRep TGSRep, err error)

	 type TGSReq (struct)
		TGSReq implements RFC 4120 KRB_TGS_REQ: https://tools.ietf.org/html/rfc4120#section-5.4.1.

		Fields (total 6)
			KDCReqFields KDCReqFields
			KDCReqFields.MsgType int
			KDCReqFields.PAData types.PADataSequence
			KDCReqFields.PVNO int
			KDCReqFields.Renewal bool
			KDCReqFields.ReqBody KDCReqBody
		Methods (total 2)
			(*TGSReq) Marshal() ([]byte, error)
				Marshal TGSReq struct.

			(*TGSReq) Unmarshal(b []byte) error
				Unmarshal bytes b into the TGSReq struct.

		As Outputs Of (at least 4)
			func NewTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, tgt Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool) (TGSReq, error)
			func NewUser2UserTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, clientTGT Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool, verifyingTGT Ticket) (TGSReq, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSExchange(tgsReq TGSReq, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, referral int) (TGSReq, TGSRep, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSREQGenerateAndExchange(spn types.PrincipalName, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, renewal bool) (tgsReq TGSReq, tgsRep TGSRep, err error)
		As Inputs Of (at least 2)
			func (*TGSRep).Verify(cfg *config.Config, tgsReq TGSReq) (bool, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSExchange(tgsReq TGSReq, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, referral int) (TGSReq, TGSRep, error)

	 type Ticket (struct)
		Ticket implements the Kerberos ticket.

		Fields (total 5)
			DecryptedEncPart EncTicketPart
				// Not part of ASN1 bytes so marked as optional so unmarshalling works

			EncPart types.EncryptedData
			Realm string
			SName types.PrincipalName
			TktVNO int
		Methods (total 6)
			(*Ticket) Decrypt(key types.EncryptionKey) error
				Decrypt decrypts the encrypted part of the ticket using the key provided.

			(*Ticket) DecryptEncPart(keytab *keytab.Keytab, sname *types.PrincipalName) error
				DecryptEncPart decrypts the encrypted part of the ticket.
				The sname argument can be used to specify which service principal's key should be used to decrypt the ticket.
				If nil is passed as the sname then the service principal specified within the ticket it used.

			(*Ticket) GetPACType(keytab *keytab.Keytab, sname *types.PrincipalName, l *log.Logger) (bool, pac.PACType, error)
				GetPACType returns a Microsoft PAC that has been extracted from the ticket and processed.

			(*Ticket) Marshal() ([]byte, error)
				Marshal the Ticket.

			(*Ticket) Unmarshal(b []byte) error
				Unmarshal bytes b into a Ticket struct.

			(*Ticket) Valid(d time.Duration) (bool, error)
				Valid checks it the ticket is currently valid. Max duration passed endtime passed in as argument.

		As Outputs Of (at least 3)
			func NewTicket(cname types.PrincipalName, crealm string, sname types.PrincipalName, srealm string, flags asn1.BitString, sktab *keytab.Keytab, eTypeID int32, kvno int, authTime, startTime, endTime, renewTill time.Time) (Ticket, types.EncryptionKey, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).GetCachedTicket(spn string) (Ticket, types.EncryptionKey, bool)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).GetServiceTicket(spn string) (Ticket, types.EncryptionKey, error)
		As Inputs Of (at least 10)
			func MarshalTicketSequence(tkts []Ticket) (asn1.RawValue, error)
			func NewAPReq(tkt Ticket, sessionKey types.EncryptionKey, auth types.Authenticator) (APReq, error)
			func NewTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, tgt Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool) (TGSReq, error)
			func NewUser2UserTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, clientTGT Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool, verifyingTGT Ticket) (TGSReq, error)
			func NewUser2UserTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, clientTGT Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool, verifyingTGT Ticket) (TGSReq, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSExchange(tgsReq TGSReq, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, referral int) (TGSReq, TGSRep, error)
			func github.com/jcmturner/gokrb5/v8/client.(*Client).TGSREQGenerateAndExchange(spn types.PrincipalName, kdcRealm string, tgt Ticket, sessionKey types.EncryptionKey, renewal bool) (tgsReq TGSReq, tgsRep TGSRep, err error)
			func github.com/jcmturner/gokrb5/v8/kadmin.ChangePasswdMsg(cname types.PrincipalName, realm, password string, tkt Ticket, sessionKey types.EncryptionKey) (r kadmin.Request, k types.EncryptionKey, err error)
			func github.com/jcmturner/gokrb5/v8/spnego.NewKRB5TokenAPREQ(cl *client.Client, tkt Ticket, sessionKey types.EncryptionKey, GSSAPIFlags []int, APOptions []int) (spnego.KRB5Token, error)
			func github.com/jcmturner/gokrb5/v8/spnego.NewNegTokenInitKRB5(cl *client.Client, tkt Ticket, sessionKey types.EncryptionKey) (spnego.NegTokenInit, error)

	 type TransitedEncoding (struct)
		TransitedEncoding part of the ticket's encrypted part.

		Fields (total 2)
			Contents []byte
			TRType int32


Package-Level Functions (total 10)

	 func MarshalTicketSequence(tkts []Ticket) (asn1.RawValue, error)
		MarshalTicketSequence marshals a slice of Tickets returning an ASN1 raw value containing the ticket sequence.

	 func NewAPReq(tkt Ticket, sessionKey types.EncryptionKey, auth types.Authenticator) (APReq, error)
		NewAPReq generates a new KRB_AP_REQ struct.

	 func NewASReq(realm string, c *config.Config, cname, sname types.PrincipalName) (ASReq, error)
		NewASReq generates a new KRB_AS_REQ struct for a given SNAME.

	 func NewASReqForChgPasswd(realm string, c *config.Config, cname types.PrincipalName) (ASReq, error)
		NewASReqForChgPasswd generates a new KRB_AS_REQ struct for a change password request.

	 func NewASReqForTGT(realm string, c *config.Config, cname types.PrincipalName) (ASReq, error)
		NewASReqForTGT generates a new KRB_AS_REQ struct for a TGT request.

	 func NewKRBError(sname types.PrincipalName, realm string, code int32, etext string) KRBError
		NewKRBError creates a new KRBError.

	 func NewKRBPriv(part EncKrbPrivPart) KRBPriv
		NewKRBPriv returns a new KRBPriv type.

	 func NewTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, tgt Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool) (TGSReq, error)
		NewTGSReq generates a new KRB_TGS_REQ struct.

	 func NewTicket(cname types.PrincipalName, crealm string, sname types.PrincipalName, srealm string, flags asn1.BitString, sktab *keytab.Keytab, eTypeID int32, kvno int, authTime, startTime, endTime, renewTill time.Time) (Ticket, types.EncryptionKey, error)
		NewTicket creates a new Ticket instance.

	 func NewUser2UserTGSReq(cname types.PrincipalName, kdcRealm string, c *config.Config, clientTGT Ticket, sessionKey types.EncryptionKey, sname types.PrincipalName, renewal bool, verifyingTGT Ticket) (TGSReq, error)
		NewUser2UserTGSReq returns a TGS-REQ suitable for user-to-user authentication (https://tools.ietf.org/html/rfc4120#section-3.7)

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.