package ecdsa

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

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	    cast.go
	    ecdsa.go
	    ecdsa_noasm.go
	    hmacdrbg.go
Package-Level Type Names (total 5)

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

		Type Parameters:
			P: Point[P]

		Fields (only one)
			N *bigmod.Modulus
		As Outputs Of (at least 4)
			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 6)
			func GenerateKey[P](c *Curve[P], rand io.Reader) (*PrivateKey, error)
			func NewPrivateKey[P](c *Curve[P], D, Q []byte) (*PrivateKey, error)
			func NewPublicKey[P](c *Curve[P], Q []byte) (*PublicKey, error)
			func Sign[P, H](c *Curve[P], h func() H, priv *PrivateKey, rand io.Reader, hash []byte) (*Signature, error)
			func SignDeterministic[P, H](c *Curve[P], h func() H, priv *PrivateKey, hash []byte) (*Signature, error)
			func Verify[P](c *Curve[P], pub *PublicKey, hash []byte, sig *Signature) error

	 type Point[P] (interface)

		Type Parameters:
			P: any

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

		Methods (total 6)
			( Point[P]) Add(p1, p2 P) P
			( 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)

		Methods (total 2)
			(*PrivateKey) Bytes() []byte
			(*PrivateKey) PublicKey() *PublicKey
		As Outputs Of (at least 2)
			func GenerateKey[P](c *Curve[P], rand io.Reader) (*PrivateKey, error)
			func NewPrivateKey[P](c *Curve[P], D, Q []byte) (*PrivateKey, error)
		As Inputs Of (at least 2)
			func Sign[P, H](c *Curve[P], h func() H, priv *PrivateKey, rand io.Reader, hash []byte) (*Signature, error)
			func SignDeterministic[P, H](c *Curve[P], h func() H, priv *PrivateKey, hash []byte) (*Signature, error)

	 type PublicKey (struct)

		Methods (only one)
			(*PublicKey) Bytes() []byte
		As Outputs Of (at least 2)
			func NewPublicKey[P](c *Curve[P], Q []byte) (*PublicKey, error)
			func (*PrivateKey).PublicKey() *PublicKey
		As Inputs Of (at least one exported)
			func Verify[P](c *Curve[P], pub *PublicKey, hash []byte, sig *Signature) error

	 type Signature (struct)
		Signature is an ECDSA signature, where r and s are represented as big-endian
		byte slices of the same length as the curve order.

		Fields (total 2)
			R []byte
			S []byte
		As Outputs Of (at least 2)
			func Sign[P, H](c *Curve[P], h func() H, priv *PrivateKey, rand io.Reader, hash []byte) (*Signature, error)
			func SignDeterministic[P, H](c *Curve[P], h func() H, priv *PrivateKey, hash []byte) (*Signature, error)
		As Inputs Of (at least one exported)
			func Verify[P](c *Curve[P], pub *PublicKey, hash []byte, sig *Signature) error


Package-Level Functions (total 11)

	 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], D, Q []byte) (*PrivateKey, error)

		Type Parameters:
			P: Point[P]

	 func NewPublicKey[P](c *Curve[P], Q []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]
	 func Sign[P, H](c *Curve[P], h func() H, priv *PrivateKey, rand io.Reader, hash []byte) (*Signature, error)

		Type Parameters:
			P: Point[P]
			H: fips140.Hash

		Sign signs a hash (which shall be the result of hashing a larger message with
		the hash function H) using the private key, priv. If the hash is longer than
		the bit-length of the private key's curve order, the hash will be truncated
		to that length.

	 func SignDeterministic[P, H](c *Curve[P], h func() H, priv *PrivateKey, hash []byte) (*Signature, error)

		Type Parameters:
			P: Point[P]
			H: fips140.Hash

		SignDeterministic signs a hash (which shall be the result of hashing a
		larger message with the hash function H) using the private key, priv. If the
		hash is longer than the bit-length of the private key's curve order, the hash
		will be truncated to that length. This applies Deterministic ECDSA as
		specified in FIPS 186-5 and RFC 6979.

	 func TestingOnlyNewDRBG(hash func() fips140.Hash, entropy, nonce []byte, s []byte) *hmacDRBG
		TestingOnlyNewDRBG creates an SP 800-90A Rev. 1 HMAC_DRBG with a plain
		personalization string.
		
		This should only be used for ACVP testing. hmacDRBG is not intended to be
		used directly.

	 func Verify[P](c *Curve[P], pub *PublicKey, hash []byte, sig *Signature) error

		Type Parameters:
			P: Point[P]

		Verify verifies the signature, sig, of hash (which should be the result of
		hashing a larger message) using the public key, pub. If the hash is longer
		than the bit-length of the private key's curve order, the hash will be
		truncated to that length.
		
		The inputs are not considered confidential, and may leak through timing side
		channels, or if an attacker has control of part of the inputs.

The pages are generated with Golds v0.7.6-preview. (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.