package rand

Import Path
	crypto/rand (on go.dev)

Dependency Relation
	imports 10 packages, and imported by 7 packages

Involved Source Files

	  d rand.go
		Package rand implements a cryptographically secure
		random number generator.

	    text.go
	    util.go
Code Examples

	Read
		package main
		
		import (
			"crypto/rand"
		)
		
		func main() {
			// Note that no error handling is necessary, as Read always succeeds.
			key := make([]byte, 32)
			rand.Read(key)
		}


Package-Level Functions (total 4)

	 func Int(rand io.Reader, max *big.Int) (n *big.Int, err error)
		Int returns a uniform random value in [0, max). It panics if max <= 0, and
		returns an error if rand.Read returns one.

	 func Prime(rand io.Reader, bits int) (*big.Int, error)
		Prime returns a number of the given bit length that is prime with high probability.
		Prime will return error for any error returned by rand.Read or if bits < 2.

	 func Read(b []byte) (n int, err error)
		Read fills b with cryptographically secure random bytes. It never returns an
		error, and always fills b entirely.
		
		Read calls [io.ReadFull] on [Reader] and crashes the program irrecoverably if
		an error is returned. The default Reader uses operating system APIs that are
		documented to never return an error on all but legacy Linux systems.

	 func Text() string
		Text returns a cryptographically random string using the standard RFC 4648 base32 alphabet
		for use when a secret string, token, password, or other text is needed.
		The result contains at least 128 bits of randomness, enough to prevent brute force
		guessing attacks and to make the likelihood of collisions vanishingly small.
		A future version may return longer texts as needed to maintain those properties.


Package-Level Variables (only one)

	  var Reader io.Reader
		Reader is a global, shared instance of a cryptographically
		secure random number generator. It is safe for concurrent use.
		
		  - On Linux, FreeBSD, Dragonfly, and Solaris, Reader uses getrandom(2).
		  - On legacy Linux (< 3.17), Reader opens /dev/urandom on first use.
		  - On macOS, iOS, and OpenBSD Reader, uses arc4random_buf(3).
		  - On NetBSD, Reader uses the kern.arandom sysctl.
		  - On Windows, Reader uses the ProcessPrng API.
		  - On js/wasm, Reader uses the Web Crypto API.
		  - On wasip1/wasm, Reader uses random_get.
		
		In FIPS 140-3 mode, the output passes through an SP 800-90A Rev. 1
		Deterministric Random Bit Generator (DRBG).

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