package drbg

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

Dependency Relation
	imports 13 packages, and imported by 11 packages

Involved Source Files

	    cast.go
	    ctrdrbg.go
	  d rand.go
		Package drbg provides cryptographically secure random bytes
		usable by FIPS code. In FIPS mode it uses an SP 800-90A Rev. 1
		Deterministic Random Bit Generator (DRBG). Otherwise,
		it uses the operating system's random number generator.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Counter (struct)
		Counter is an SP 800-90A Rev. 1 CTR_DRBG instantiated with AES-256.
		
		Per Table 3, it has a security strength of 256 bits, a seed size of 384 bits,
		a counter length of 128 bits, a reseed interval of 2^48 requests, and a
		maximum request size of 2^19 bits (2^16 bytes, 64 KiB).
		
		We support a narrow range of parameters that fit the needs of our RNG:
		AES-256, no derivation function, no personalization string, no prediction
		resistance, and 384-bit additional input.
		
		WARNING: this type provides tightly scoped support for the DRBG
		functionality we need for FIPS 140-3 _only_. This type _should not_ be used
		outside of the FIPS 140-3 module for any other use.
		
		In particular, as documented, Counter does not support the derivation
		function, or personalization strings which are necessary for safely using
		this DRBG for generic purposes without leaking sensitive values.

		Methods (total 2)
			(*Counter) Generate(out []byte, additionalInput *[48]byte) (reseedRequired bool)
				Generate produces at most maxRequestSize bytes of random data in out.

			(*Counter) Reseed(entropy, additionalInput *[48]byte)
		As Outputs Of (at least one exported)
			func NewCounter(entropy *[48]byte) *Counter

	 type DefaultReader (interface)
		DefaultReader is a sentinel type, embedded in the default
		[crypto/rand.Reader], used to recognize it when passed to
		APIs that accept a rand io.Reader.
		
		Any Reader that implements this interface is assumed to
		call [Read] as its Read method.


Package-Level Functions (total 4)

	 func NewCounter(entropy *[48]byte) *Counter
	 func Read(b []byte)
		Read fills b with cryptographically secure random bytes. In FIPS mode, it
		uses an SP 800-90A Rev. 1 Deterministic Random Bit Generator (DRBG).
		Otherwise, it uses the operating system's random number generator.

	 func ReadWithReader(r io.Reader, b []byte) error
		ReadWithReader uses Reader to fill b with cryptographically secure random
		bytes. It is intended for use in APIs that expose a rand io.Reader.

	 func SetTestingReader(r io.Reader)
		SetTestingReader sets a global, deterministic cryptographic randomness source
		for testing purposes. Its Read method must never return an error, it must
		never return short, and it must be safe for concurrent use.
		
		This is only intended to be used by the testing/cryptotest package.


Package-Level Constants (only one)

	const SeedSize = 48

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