package ecdsa

Import Path
	crypto/ecdsa (on golang.org and go.dev)

Dependency Relation
	imports 11 packages, and imported by 2 packages

Involved Source Files
	d-> ecdsa.go
	    ecdsa_noasm.go

Exported Type Names

	type PrivateKey (struct)
		PrivateKey represents an ECDSA private key.

		Exported Fields (5)
			D *big.Int
			PublicKey PublicKey
			PublicKey.Curve elliptic.Curve
			PublicKey.X *big.Int
			PublicKey.Y *big.Int
		Exported Methods (9)
			( T) Add(x1, y1, x2, y2 *big.Int) (x, y *big.Int)
				Add returns the sum of (x1,y1) and (x2,y2)

			( T) Double(x1, y1 *big.Int) (x, y *big.Int)
				Double returns 2*(x,y)

			(*T) Equal(x crypto.PrivateKey) bool
				Equal reports whether priv and x have the same value.

				See PublicKey.Equal for details on how Curve is compared.

			( T) IsOnCurve(x, y *big.Int) bool
				IsOnCurve reports whether the given (x,y) lies on the curve.

			( T) Params() *elliptic.CurveParams
				Params returns the parameters for the curve.

			(*T) Public() crypto.PublicKey
				Public returns the public key corresponding to priv.

			( T) ScalarBaseMult(k []byte) (x, y *big.Int)
				ScalarBaseMult returns k*G, where G is the base point of the group
				and k is an integer in big-endian form.

			( T) ScalarMult(x1, y1 *big.Int, k []byte) (x, y *big.Int)
				ScalarMult returns k*(Bx,By) where k is a number in big-endian form.

			(*T) Sign(rand io.Reader, digest []byte, opts crypto.SignerOpts) ([]byte, error)
				Sign signs digest with priv, reading randomness from rand. The opts argument
				is not currently used but, in keeping with the crypto.Signer interface,
				should be the hash function used to digest the message.

				This method implements crypto.Signer, which is an interface to support keys
				where the private part is kept in, for example, a hardware module. Common
				uses should use the Sign function in this package directly.

		Implements (2+)
			*T : crypto.Signer
			 T : crypto/elliptic.Curve
		As Outputs Of (2+)
			func GenerateKey(c elliptic.Curve, rand io.Reader) (*PrivateKey, error)
			func crypto/x509.ParseECPrivateKey(der []byte) (*PrivateKey, error)
		As Inputs Of (3+)
			func Sign(rand io.Reader, priv *PrivateKey, hash []byte) (r, s *big.Int, err error)
			func SignASN1(rand io.Reader, priv *PrivateKey, hash []byte) ([]byte, error)
			func crypto/x509.MarshalECPrivateKey(key *PrivateKey) ([]byte, error)
	type PublicKey (struct)
		PublicKey represents an ECDSA public key.

		Exported Fields (3)
			Curve elliptic.Curve
			X *big.Int
			Y *big.Int
		Exported Methods (7)
			( T) Add(x1, y1, x2, y2 *big.Int) (x, y *big.Int)
				Add returns the sum of (x1,y1) and (x2,y2)

			( T) Double(x1, y1 *big.Int) (x, y *big.Int)
				Double returns 2*(x,y)

			(*T) Equal(x crypto.PublicKey) bool
				Equal reports whether pub and x have the same value.

				Two keys are only considered to have the same value if they have the same Curve value.
				Note that for example elliptic.P256() and elliptic.P256().Params() are different
				values, as the latter is a generic not constant time implementation.

			( T) IsOnCurve(x, y *big.Int) bool
				IsOnCurve reports whether the given (x,y) lies on the curve.

			( T) Params() *elliptic.CurveParams
				Params returns the parameters for the curve.

			( T) ScalarBaseMult(k []byte) (x, y *big.Int)
				ScalarBaseMult returns k*G, where G is the base point of the group
				and k is an integer in big-endian form.

			( T) ScalarMult(x1, y1 *big.Int, k []byte) (x, y *big.Int)
				ScalarMult returns k*(Bx,By) where k is a number in big-endian form.

		Implements (1+)
			 T : crypto/elliptic.Curve
		As Inputs Of (2+)
			func Verify(pub *PublicKey, hash []byte, r, s *big.Int) bool
			func VerifyASN1(pub *PublicKey, hash, sig []byte) bool
Exported Values

	 func GenerateKey(c elliptic.Curve, rand io.Reader) (*PrivateKey, error)
		GenerateKey generates a public and private key pair.
	 func Sign(rand io.Reader, priv *PrivateKey, hash []byte) (r, s *big.Int, err error)
		Sign signs a hash (which should be the result of hashing a larger message)
		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. It
		returns the signature as a pair of integers. The security of the private key
		depends on the entropy of rand.
	 func SignASN1(rand io.Reader, priv *PrivateKey, hash []byte) ([]byte, error)
		SignASN1 signs a hash (which should be the result of hashing a larger message)
		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. It
		returns the ASN.1 encoded signature. The security of the private key
		depends on the entropy of rand.
	 func Verify(pub *PublicKey, hash []byte, r, s *big.Int) bool
		Verify verifies the signature in r, s of hash using the public key, pub. Its
		return value records whether the signature is valid.
	 func VerifyASN1(pub *PublicKey, hash, sig []byte) bool
		VerifyASN1 verifies the ASN.1 encoded signature, sig, of hash using the
		public key, pub. Its return value records whether the signature is valid.

The pages are generated with Golds v0.1.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project and 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.