package ecdh

Import Path
	crypto/internal/fips140/ecdh (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	    cast.go
	    ecdh.go
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Curve[P] (struct)

		Type Parameters:
			P: Point[P]

		Fields (total 3, in which 1 is exported)
			N []byte
			/* 2 unexporteds ... *//* 2 unexporteds: */
			curve curveID
			newPoint func() P
		As Outputs Of (at least 4, all are exported)
			func P224() *Curve[*nistec.P224Point]
			func P256() *Curve[*nistec.P256Point]
			func P384() *Curve[*nistec.P384Point]
			func P521() *Curve[*nistec.P521Point]
		As Inputs Of (at least 5, in which 4 are exported)
			func ECDH[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)
			func GenerateKey[P](c *Curve[P], rand io.Reader) (*PrivateKey, error)
			func NewPrivateKey[P](c *Curve[P], key []byte) (*PrivateKey, error)
			func NewPublicKey[P](c *Curve[P], key []byte) (*PublicKey, error)
			/* at least one unexported ... *//* at least one unexported: */
			func ecdh[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)

	 type Point[P] (interface)

		Type Parameters:
			P: any

		Point is a generic constraint for the [nistec] Point types.

		Methods (total 5, all are exported)
			( Point[P]) Bytes() []byte
			( Point[P]) BytesX() ([]byte, error)
			( Point[P]) ScalarBaseMult([]byte) (P, error)
			( Point[P]) ScalarMult(P, []byte) (P, error)
			( Point[P]) SetBytes([]byte) (P, error)

	 type PrivateKey (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			d []byte
				// bigmod.(*Nat).Bytes output (fixed length)

			pub PublicKey
		Methods (total 2, both are exported)
			(*PrivateKey) Bytes() []byte
			(*PrivateKey) PublicKey() *PublicKey
		As Outputs Of (at least 2, both are exported)
			func GenerateKey[P](c *Curve[P], rand io.Reader) (*PrivateKey, error)
			func NewPrivateKey[P](c *Curve[P], key []byte) (*PrivateKey, error)
		As Inputs Of (at least 2, in which 1 is exported)
			func ECDH[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)
			/* at least one unexported ... *//* at least one unexported: */
			func ecdh[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)

	 type PublicKey (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			curve curveID
			q []byte
				// uncompressed nistec Point.Bytes output

		Methods (only one, which is exported)
			(*PublicKey) Bytes() []byte
		As Outputs Of (at least 2, both are exported)
			func NewPublicKey[P](c *Curve[P], key []byte) (*PublicKey, error)
			func (*PrivateKey).PublicKey() *PublicKey
		As Inputs Of (at least 2, in which 1 is exported)
			func ECDH[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)
			/* at least one unexported ... *//* at least one unexported: */
			func ecdh[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)

	/* one unexported ... *//* one unexported: */
	 type curveID string (basic type)

		As Types Of (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			const p224
			const p256
			const p384
			const p521


Package-Level Functions (total 11, in which 8 are exported)

	 func ECDH[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)

		Type Parameters:
			P: Point[P]

	 func GenerateKey[P](c *Curve[P], rand io.Reader) (*PrivateKey, error)

		Type Parameters:
			P: Point[P]

		GenerateKey generates a new ECDSA private key pair for the specified curve.

	 func NewPrivateKey[P](c *Curve[P], key []byte) (*PrivateKey, error)

		Type Parameters:
			P: Point[P]

	 func NewPublicKey[P](c *Curve[P], key []byte) (*PublicKey, error)

		Type Parameters:
			P: Point[P]

	 func P224() *Curve[*nistec.P224Point]
	 func P256() *Curve[*nistec.P256Point]
	 func P384() *Curve[*nistec.P384Point]
	 func P521() *Curve[*nistec.P521Point]
	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func ecdh[P](c *Curve[P], k *PrivateKey, peer *PublicKey) ([]byte, error)

		Type Parameters:
			P: Point[P]

	 func isLess(a, b []byte) bool
		isLess reports whether a < b, where a and b are big-endian buffers of the
		same length and shorter than 72 bytes.

	 func isZero(x []byte) bool
		isZero reports whether x is all zeroes in constant time.


Package-Level Variables (total 5, none are exported)

	/* 5 unexporteds ... *//* 5 unexporteds: */
	  var fipsSelfTest func()
	  var p224Order []byte
	  var p256Order []byte
	  var p384Order []byte
	  var p521Order []byte
Package-Level Constants (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	const p224 curveID = "P-224"
	const p256 curveID = "P-256"
	const p384 curveID = "P-384"
	const p521 curveID = "P-521"

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.