Blame doc/man1/rand.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
openssl-rand,
Packit Service 084de1
rand - generate pseudo-random bytes
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
B<openssl rand>
Packit Service 084de1
[B<-help>]
Packit Service 084de1
[B<-out> I<file>]
Packit Service 084de1
[B<-rand file...>]
Packit Service 084de1
[B<-writerand file>]
Packit Service 084de1
[B<-base64>]
Packit Service 084de1
[B<-hex>]
Packit Service 084de1
I<num>
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
This command generates I<num> random bytes using a cryptographically
Packit Service 084de1
secure pseudo random number generator (CSPRNG).
Packit Service 084de1
Packit Service 084de1
The random bytes are generated using the L<RAND_bytes(3)> function,
Packit Service 084de1
which provides a security level of 256 bits, provided it managed to
Packit Service 084de1
seed itself successfully from a trusted operating system entropy source.
Packit Service 084de1
Otherwise, the command will fail with a nonzero error code.
Packit Service 084de1
For more details, see L<RAND_bytes(3)>, L<RAND(7)>, and L<RAND_DRBG(7)>.
Packit Service 084de1
Packit Service 084de1
=head1 OPTIONS
Packit Service 084de1
Packit Service 084de1
=over 4
Packit Service 084de1
Packit Service 084de1
=item B<-help>
Packit Service 084de1
Packit Service 084de1
Print out a usage message.
Packit Service 084de1
Packit Service 084de1
=item B<-out file>
Packit Service 084de1
Packit Service 084de1
Write to I<file> instead of standard output.
Packit Service 084de1
Packit Service 084de1
=item B<-rand file...>
Packit Service 084de1
Packit Service 084de1
A file or files containing random data used to seed the random number
Packit Service 084de1
generator.
Packit Service 084de1
Multiple files can be specified separated by an OS-dependent character.
Packit Service 084de1
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
Packit Service 084de1
all others.
Packit Service 084de1
Explicitly specifying a seed file is in general not necessary, see the
Packit Service 084de1
L</NOTES> section for more information.
Packit Service 084de1
Packit Service 084de1
=item [B<-writerand file>]
Packit Service 084de1
Packit Service 084de1
Writes random data to the specified I<file> upon exit.
Packit Service 084de1
This can be used with a subsequent B<-rand> flag.
Packit Service 084de1
Packit Service 084de1
=item B<-base64>
Packit Service 084de1
Packit Service 084de1
Perform base64 encoding on the output.
Packit Service 084de1
Packit Service 084de1
=item B<-hex>
Packit Service 084de1
Packit Service 084de1
Show the output as a hex string.
Packit Service 084de1
Packit Service 084de1
=back
Packit Service 084de1
Packit Service 084de1
=head1 NOTES
Packit Service 084de1
Packit Service 084de1
Prior to OpenSSL 1.1.1, it was common for applications to store information
Packit Service 084de1
about the state of the random-number generator in a file that was loaded
Packit Service 084de1
at startup and rewritten upon exit. On modern operating systems, this is
Packit Service 084de1
generally no longer necessary as OpenSSL will seed itself from a trusted
Packit Service 084de1
entropy source provided by the operating system. The B<-rand>  and
Packit Service 084de1
B<-writerand>  flags are still supported for special platforms or
Packit Service 084de1
circumstances that might require them.
Packit Service 084de1
Packit Service 084de1
It is generally an error to use the same seed file more than once and
Packit Service 084de1
every use of B<-rand> should be paired with B<-writerand>.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<RAND_bytes(3)>,
Packit Service 084de1
L<RAND(7)>,
Packit Service 084de1
L<RAND_DRBG(7)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut