package dsa

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

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files
	d-> dsa.go

Exported Type Names

	 type Parameters (struct)
		Parameters represents the domain parameters for a key. These parameters can
		be shared across many keys. The bit length of Q must be a multiple of 8.

		Exported Fields (3)
			G *big.Int
			P *big.Int
			Q *big.Int
		As Inputs Of (1+)
			func GenerateParameters(params *Parameters, rand io.Reader, sizes ParameterSizes) error
	 type ParameterSizes int
		ParameterSizes is an enumeration of the acceptable bit lengths of the primes
		in a set of DSA parameters. See FIPS 186-3, section 4.2.

		As Inputs Of (1+)
			func GenerateParameters(params *Parameters, rand io.Reader, sizes ParameterSizes) error
		As Types Of (4+)
			const L1024N160
			const L2048N224
			const L2048N256
			const L3072N256
	 type PrivateKey (struct)
		PrivateKey represents a DSA private key.

		Exported Fields (7)
			PublicKey PublicKey
			PublicKey.Parameters Parameters
			PublicKey.Parameters.G *big.Int
			PublicKey.Parameters.P *big.Int
			PublicKey.Parameters.Q *big.Int
			PublicKey.Y *big.Int
			X *big.Int
		As Inputs Of (2+)
			func GenerateKey(priv *PrivateKey, rand io.Reader) error
			func Sign(rand io.Reader, priv *PrivateKey, hash []byte) (r, s *big.Int, err error)
	 type PublicKey (struct)
		PublicKey represents a DSA public key.

		Exported Fields (5)
			Parameters Parameters
			Parameters.G *big.Int
			Parameters.P *big.Int
			Parameters.Q *big.Int
			Y *big.Int
		As Inputs Of (1+)
			func Verify(pub *PublicKey, hash []byte, r, s *big.Int) bool
Exported Values

	  var ErrInvalidPublicKey error
		ErrInvalidPublicKey results when a public key is not usable by this code.
		FIPS is quite strict about the format of DSA keys, but other code may be
		less so. Thus, when using keys which may have been generated by other code,
		this error must be handled.
	 func GenerateKey(priv *PrivateKey, rand io.Reader) error
		GenerateKey generates a public&private key pair. The Parameters of the
		PrivateKey must already be valid (see GenerateParameters).
	 func GenerateParameters(params *Parameters, rand io.Reader, sizes ParameterSizes) error
		GenerateParameters puts a random, valid set of DSA parameters into params.
		This function can take many seconds, even on fast machines.
	const L1024N160 ParameterSizes = 0
	const L2048N224 ParameterSizes = 1
	const L2048N256 ParameterSizes = 2
	const L3072N256 ParameterSizes = 3
	 func Sign(rand io.Reader, priv *PrivateKey, hash []byte) (r, s *big.Int, err error)
		Sign signs an arbitrary length hash (which should be the result of hashing a
		larger message) using the private key, priv. It returns the signature as a
		pair of integers. The security of the private key depends on the entropy of
		rand.

		Note that FIPS 186-3 section 4.6 specifies that the hash should be truncated
		to the byte-length of the subgroup. This function does not perform that
		truncation itself.

		Be aware that calling Sign with an attacker-controlled PrivateKey may
		require an arbitrary amount of CPU.
	 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. It
		reports whether the signature is valid.

		Note that FIPS 186-3 section 4.6 specifies that the hash should be truncated
		to the byte-length of the subgroup. This function does not perform that
		truncation itself.

The pages are generated with Golds v0.1.6. (GOOS=darwin 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.