package hpke

Import Path
	github.com/refraction-networking/utls/internal/hpke (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	    hpke.go
Package-Level Type Names (total 9, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AEADID uint16 (basic type)
	 type KDFID uint16 (basic type)
	 type KemID uint16 (basic type)
	 type Receipient (struct)

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			context *context
			context.aead cipher.AEAD
			context.baseNonce []byte
			context.exporterSecret []byte
			context.key []byte
			context.seqNum uint128
			context.sharedSecret []byte
			context.suiteID []byte
		Methods (total 3, in which 1 is exported)
			(*Receipient) Open(aad, ciphertext []byte) ([]byte, error)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			( Receipient) incrementNonce()
			( Receipient) nextNonce() []byte
		As Outputs Of (at least one exported)
			func SetupReceipient(kemID, kdfID, aeadID uint16, priv *ecdh.PrivateKey, info, encPubEph []byte) (*Receipient, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/refraction-networking/utls.decryptECHPayload(context *Receipient, hello, payload []byte) ([]byte, error)

	 type Sender (struct)

		Fields (total 8, none are exported)
			/* 8 unexporteds ... *//* 8 unexporteds: */
			context *context
			context.aead cipher.AEAD
			context.baseNonce []byte
			context.exporterSecret []byte
			context.key []byte
			context.seqNum uint128
			context.sharedSecret []byte
			context.suiteID []byte
		Methods (total 3, in which 1 is exported)
			(*Sender) Seal(aad, plaintext []byte) ([]byte, error)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			( Sender) incrementNonce()
			( Sender) nextNonce() []byte
		As Outputs Of (at least one exported)
			func SetupSender(kemID, kdfID, aeadID uint16, pub *ecdh.PublicKey, info []byte) ([]byte, *Sender, error)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type context (struct)

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			aead cipher.AEAD
			baseNonce []byte
			exporterSecret []byte
			key []byte
			seqNum uint128
			sharedSecret []byte
			suiteID []byte
		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*context) incrementNonce()
			(*context) nextNonce() []byte
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newContext(sharedSecret []byte, kemID, kdfID, aeadID uint16, info []byte) (*context, error)

	 type dhKEM (struct)
		dhKEM implements the KEM specified in RFC 9180, Section 4.1.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			dh ecdh.Curve
			kdf hkdfKDF
			nSecret uint16
			suiteID []byte
		Methods (total 3, all are exported)
			(*dhKEM) Decap(encPubEph []byte, secRecipient *ecdh.PrivateKey) ([]byte, error)
			(*dhKEM) Encap(pubRecipient *ecdh.PublicKey) (sharedSecret []byte, encapPub []byte, err error)
			(*dhKEM) ExtractAndExpand(dhKey, kemContext []byte) []byte
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newDHKem(kemID uint16) (*dhKEM, error)

	 type hkdfKDF (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			hash crypto.Hash
		Methods (total 2, both are exported)
			(*hkdfKDF) LabeledExpand(suiteID []byte, randomKey []byte, label string, info []byte, length uint16) []byte
			(*hkdfKDF) LabeledExtract(sid []byte, salt []byte, label string, inputKey []byte) []byte

	 type uint128 (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			hi uint64
			lo uint64
		Methods (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			( uint128) addOne() uint128
			( uint128) bitLen() int
			( uint128) bytes() []byte


Package-Level Functions (total 7, in which 4 are exported)

	 func ParseHPKEPrivateKey(kemID uint16, bytes []byte) (*ecdh.PrivateKey, error)
	 func ParseHPKEPublicKey(kemID uint16, bytes []byte) (*ecdh.PublicKey, error)
	 func SetupReceipient(kemID, kdfID, aeadID uint16, priv *ecdh.PrivateKey, info, encPubEph []byte) (*Receipient, error)
	 func SetupSender(kemID, kdfID, aeadID uint16, pub *ecdh.PublicKey, info []byte) ([]byte, *Sender, error)
	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func newContext(sharedSecret []byte, kemID, kdfID, aeadID uint16, info []byte) (*context, error)
	 func newDHKem(kemID uint16) (*dhKEM, error)
	 func suiteID(kemID, kdfID, aeadID uint16) []byte
Package-Level Variables (total 5, in which 3 are exported)

	  var SupportedAEADs map[uint16]struct{keySize int; nonceSize int; aead func([]byte) (cipher.AEAD, error)}
	  var SupportedKDFs map[uint16]func() *hkdfKDF
	  var SupportedKEMs map[uint16]struct{curve ecdh.Curve; hash crypto.Hash; nSecret uint16}
	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var aesGCMNew func(key []byte) (cipher.AEAD, error)
	  var testingOnlyGenerateKey () (*ecdh.PrivateKey, error)
		testingOnlyGenerateKey is only used during testing, to provide
		a fixed test key to use when checking the RFC 9180 vectors.


Package-Level Constants (total 5, all are exported)

	const AEAD_AES_128_GCM = 1
	const AEAD_AES_256_GCM = 2
	const AEAD_ChaCha20Poly1305 = 3
	const DHKEM_X25519_HKDF_SHA256 = 32
	const KDF_HKDF_SHA256 = 1

The pages are generated with Golds v0.8.4. (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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.