package crypto

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

Dependency Relation
	imports 24 packages, and imported by 6 packages

Involved Source Files

	    aes128-cts-hmac-sha1-96.go
	    aes128-cts-hmac-sha256-128.go
	    aes256-cts-hmac-sha1-96.go
	    aes256-cts-hmac-sha384-192.go
	  d crypto.go
		Package crypto implements cryptographic functions for Kerberos 5 implementation.

	    des3-cbc-sha1-kd.go
	    rc4-hmac.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type Aes128CtsHmacSha256128 (struct)
		Aes128CtsHmacSha256128 implements Kerberos encryption type aes128-cts-hmac-sha256-128

		Methods (total 21)
			( Aes128CtsHmacSha256128) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( Aes128CtsHmacSha256128) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( Aes128CtsHmacSha256128) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( Aes128CtsHmacSha256128) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( Aes128CtsHmacSha256128) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( Aes128CtsHmacSha256128) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( Aes128CtsHmacSha256128) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( Aes128CtsHmacSha256128) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( Aes128CtsHmacSha256128) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( Aes128CtsHmacSha256128) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( Aes128CtsHmacSha256128) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( Aes128CtsHmacSha256128) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( Aes128CtsHmacSha256128) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( Aes128CtsHmacSha256128) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( Aes128CtsHmacSha256128) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( Aes128CtsHmacSha256128) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( Aes128CtsHmacSha256128) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( Aes128CtsHmacSha256128) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( Aes128CtsHmacSha256128) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( Aes128CtsHmacSha256128) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( Aes128CtsHmacSha256128) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the ciphertext message.
				As the hash is calculated over the iv concatenated with the AES cipher output not the plaintext the pt value to this
				interface method is not use. Pass any []byte.

		Implements (at least one exported)
			 Aes128CtsHmacSha256128 : github.com/jcmturner/gokrb5/v8/crypto/etype.EType

	 type Aes128CtsHmacSha96 (struct)
		Aes128CtsHmacSha96 implements Kerberos encryption type aes128-cts-hmac-sha1-96

		Methods (total 21)
			( Aes128CtsHmacSha96) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( Aes128CtsHmacSha96) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( Aes128CtsHmacSha96) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( Aes128CtsHmacSha96) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( Aes128CtsHmacSha96) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( Aes128CtsHmacSha96) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( Aes128CtsHmacSha96) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( Aes128CtsHmacSha96) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( Aes128CtsHmacSha96) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( Aes128CtsHmacSha96) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( Aes128CtsHmacSha96) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( Aes128CtsHmacSha96) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( Aes128CtsHmacSha96) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( Aes128CtsHmacSha96) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( Aes128CtsHmacSha96) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( Aes128CtsHmacSha96) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( Aes128CtsHmacSha96) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( Aes128CtsHmacSha96) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( Aes128CtsHmacSha96) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( Aes128CtsHmacSha96) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( Aes128CtsHmacSha96) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the plaintext message.

		Implements (at least one exported)
			 Aes128CtsHmacSha96 : github.com/jcmturner/gokrb5/v8/crypto/etype.EType

	 type Aes256CtsHmacSha384192 (struct)
		Aes256CtsHmacSha384192 implements Kerberos encryption type aes256-cts-hmac-sha384-192

		Methods (total 21)
			( Aes256CtsHmacSha384192) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( Aes256CtsHmacSha384192) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( Aes256CtsHmacSha384192) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( Aes256CtsHmacSha384192) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( Aes256CtsHmacSha384192) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( Aes256CtsHmacSha384192) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( Aes256CtsHmacSha384192) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( Aes256CtsHmacSha384192) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( Aes256CtsHmacSha384192) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( Aes256CtsHmacSha384192) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( Aes256CtsHmacSha384192) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( Aes256CtsHmacSha384192) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( Aes256CtsHmacSha384192) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( Aes256CtsHmacSha384192) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( Aes256CtsHmacSha384192) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( Aes256CtsHmacSha384192) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( Aes256CtsHmacSha384192) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( Aes256CtsHmacSha384192) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( Aes256CtsHmacSha384192) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( Aes256CtsHmacSha384192) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( Aes256CtsHmacSha384192) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the ciphertext message.
				As the hash is calculated over the iv concatenated with the AES cipher output not the plaintext the pt value to this
				interface method is not use. Pass any []byte.

		Implements (at least one exported)
			 Aes256CtsHmacSha384192 : github.com/jcmturner/gokrb5/v8/crypto/etype.EType

	 type Aes256CtsHmacSha96 (struct)
		Aes256CtsHmacSha96 implements Kerberos encryption type aes256-cts-hmac-sha1-96

		Methods (total 21)
			( Aes256CtsHmacSha96) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( Aes256CtsHmacSha96) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( Aes256CtsHmacSha96) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( Aes256CtsHmacSha96) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( Aes256CtsHmacSha96) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( Aes256CtsHmacSha96) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( Aes256CtsHmacSha96) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( Aes256CtsHmacSha96) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( Aes256CtsHmacSha96) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( Aes256CtsHmacSha96) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( Aes256CtsHmacSha96) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( Aes256CtsHmacSha96) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( Aes256CtsHmacSha96) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( Aes256CtsHmacSha96) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( Aes256CtsHmacSha96) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( Aes256CtsHmacSha96) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( Aes256CtsHmacSha96) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( Aes256CtsHmacSha96) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( Aes256CtsHmacSha96) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( Aes256CtsHmacSha96) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( Aes256CtsHmacSha96) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the plaintext message.

		Implements (at least one exported)
			 Aes256CtsHmacSha96 : github.com/jcmturner/gokrb5/v8/crypto/etype.EType

	 type Des3CbcSha1Kd (struct)
		Des3CbcSha1Kd implements Kerberos encryption type des3-cbc-hmac-sha1-kd

		Methods (total 21)
			( Des3CbcSha1Kd) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( Des3CbcSha1Kd) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( Des3CbcSha1Kd) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( Des3CbcSha1Kd) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( Des3CbcSha1Kd) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( Des3CbcSha1Kd) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( Des3CbcSha1Kd) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( Des3CbcSha1Kd) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( Des3CbcSha1Kd) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( Des3CbcSha1Kd) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( Des3CbcSha1Kd) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( Des3CbcSha1Kd) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( Des3CbcSha1Kd) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( Des3CbcSha1Kd) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( Des3CbcSha1Kd) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( Des3CbcSha1Kd) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( Des3CbcSha1Kd) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( Des3CbcSha1Kd) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( Des3CbcSha1Kd) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( Des3CbcSha1Kd) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( Des3CbcSha1Kd) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the plaintext message.

		Implements (at least one exported)
			 Des3CbcSha1Kd : github.com/jcmturner/gokrb5/v8/crypto/etype.EType

	 type RC4HMAC (struct)
		RC4HMAC implements Kerberos encryption type rc4-hmac

		Methods (total 21)
			( RC4HMAC) DecryptData(key, data []byte) ([]byte, error)
				DecryptData decrypts the data provided.

			( RC4HMAC) DecryptMessage(key, ciphertext []byte, usage uint32) ([]byte, error)
				DecryptMessage decrypts the message provided and verifies the integrity of the message.

			( RC4HMAC) DeriveKey(protocolKey, usage []byte) ([]byte, error)
				DeriveKey derives a key from the protocol key based on the usage value.

			( RC4HMAC) DeriveRandom(protocolKey, usage []byte) ([]byte, error)
				DeriveRandom generates data needed for key generation.

			( RC4HMAC) EncryptData(key, data []byte) ([]byte, []byte, error)
				EncryptData encrypts the data provided.

			( RC4HMAC) EncryptMessage(key, message []byte, usage uint32) ([]byte, []byte, error)
				EncryptMessage encrypts the message provided and concatenates it with the integrity hash to create an encrypted message.

			( RC4HMAC) GetChecksumHash(protocolKey, data []byte, usage uint32) ([]byte, error)
				GetChecksumHash returns a keyed checksum hash of the bytes provided.

			( RC4HMAC) GetConfounderByteSize() int
				GetConfounderByteSize returns the byte count for confounder to be used during cryptographic operations.

			( RC4HMAC) GetCypherBlockBitLength() int
				GetCypherBlockBitLength returns the bit count size of the cypher block.

			( RC4HMAC) GetDefaultStringToKeyParams() string
				GetDefaultStringToKeyParams returns the default key derivation parameters in string form.

			( RC4HMAC) GetETypeID() int32
				GetETypeID returns the EType ID number.

			( RC4HMAC) GetHMACBitLength() int
				GetHMACBitLength returns the bit count size of the integrity hash.

			( RC4HMAC) GetHashFunc() func() hash.Hash
				GetHashFunc returns the hash function for this etype.

			( RC4HMAC) GetHashID() int32
				GetHashID returns the checksum type ID number.

			( RC4HMAC) GetKeyByteSize() int
				GetKeyByteSize returns the number of bytes for key of this etype.

			( RC4HMAC) GetKeySeedBitLength() int
				GetKeySeedBitLength returns the number of bits for the seed for key generation.

			( RC4HMAC) GetMessageBlockByteSize() int
				GetMessageBlockByteSize returns the block size for the etype's messages.

			( RC4HMAC) RandomToKey(b []byte) []byte
				RandomToKey returns a key from the bytes provided.

			( RC4HMAC) StringToKey(secret string, salt string, s2kparams string) ([]byte, error)
				StringToKey returns a key derived from the string provided.

			( RC4HMAC) VerifyChecksum(protocolKey, data, chksum []byte, usage uint32) bool
				VerifyChecksum compares the checksum of the message bytes is the same as the checksum provided.

			( RC4HMAC) VerifyIntegrity(protocolKey, ct, pt []byte, usage uint32) bool
				VerifyIntegrity checks the integrity of the plaintext message.

		Implements (at least one exported)
			 RC4HMAC : github.com/jcmturner/gokrb5/v8/crypto/etype.EType


Package-Level Functions (total 6)

	 func DecryptEncPart(ed types.EncryptedData, key types.EncryptionKey, usage uint32) ([]byte, error)
		DecryptEncPart decrypts the EncryptedData.

	 func DecryptMessage(ciphertext []byte, key types.EncryptionKey, usage uint32) ([]byte, error)
		DecryptMessage decrypts the ciphertext and verifies the integrity.

	 func GetChksumEtype(id int32) (etype.EType, error)
		GetChksumEtype returns an instances of the required etype struct for the checksum ID.

	 func GetEncryptedData(plainBytes []byte, key types.EncryptionKey, usage uint32, kvno int) (types.EncryptedData, error)
		GetEncryptedData encrypts the data provided and returns and EncryptedData type.
		Pass a usage value of zero to use the key provided directly rather than deriving one.

	 func GetEtype(id int32) (etype.EType, error)
		GetEtype returns an instances of the required etype struct for the etype ID.

	 func GetKeyFromPassword(passwd string, cname types.PrincipalName, realm string, etypeID int32, pas types.PADataSequence) (types.EncryptionKey, etype.EType, error)
		GetKeyFromPassword generates an encryption key from the principal's password.

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.