diff options
Diffstat (limited to 'doc/internal/man3/rand_bytes_ex.pod')
-rw-r--r-- | doc/internal/man3/rand_bytes_ex.pod | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/internal/man3/rand_bytes_ex.pod b/doc/internal/man3/rand_bytes_ex.pod new file mode 100644 index 0000000000..740607310c --- /dev/null +++ b/doc/internal/man3/rand_bytes_ex.pod @@ -0,0 +1,41 @@ +=pod + +=head1 NAME + +rand_bytes_ex, rand_priv_bytes_ex +- internal random number routines + +=head1 SYNOPSIS + + #include "internal/rand_int.h" + + int rand_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num); + int rand_priv_bytes_ex(OPENSSL_CTX *ctx, unsigned char *buf, int num); + +=head1 DESCRIPTION + +rand_bytes_ex() and rand_priv_bytes_ex() are the equivalent of RAND_bytes() and +RAND_priv_bytes() in the public API except that they both take an additional +B<ctx> parameter. +The DRBG used for the operation is the public or private DRBG associated with +the specified B<ctx>. The parameter can be NULL, in which case +the default library ctx is used. +If the default RAND_METHOD has been changed then for compatibility reasons the +RAND_METHOD will be used in preference and the DRBG of the library context +ignored. + +=head1 RETURN VALUES + +rand_bytes_ex() and rand_bytes_priv_ex() return 0 or less on error or 1 on +success. + +=head1 COPYRIGHT + +Copyright 2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |