summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPatrick Steuer <patrick.steuer@de.ibm.com>2017-12-05 00:36:43 +0100
committerAndy Polyakov <appro@openssl.org>2017-12-09 21:38:41 +0100
commit5c5eb286afc046094cf48ecc49b10d04a1a3146c (patch)
tree3b573136077c4c05746c7d05cf1668c471a74fee /doc
parent27ab91951c96364351f1ea0652dbf14622440345 (diff)
doc/man3/EVP_EncryptInit.pod: add EVP_CIPHER_CTX_rand_key
Signed-off-by: Patrick Steuer <patrick.steuer@de.ibm.com> Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Andy Polyakov <appro@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4843)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/EVP_EncryptInit.pod8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man3/EVP_EncryptInit.pod b/doc/man3/EVP_EncryptInit.pod
index d82468c562..29ebf74765 100644
--- a/doc/man3/EVP_EncryptInit.pod
+++ b/doc/man3/EVP_EncryptInit.pod
@@ -91,6 +91,7 @@ EVP_enc_null
int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *x, int padding);
int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen);
int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr);
+ int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key);
const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
const EVP_CIPHER *EVP_get_cipherbynid(int nid);
@@ -274,6 +275,11 @@ is not supported.
EVP_CIPHER_CTX_ctrl() allows various cipher specific parameters to be determined
and set.
+EVP_CIPHER_CTX_rand_key() generates a random key of the appropriate length
+based on the cipher context. The EVP_CIPHER can provide its own random key
+generation routine to support keys of a specific form. B<Key> must point to a
+buffer at least as big as the value returned by EVP_CIPHER_CTX_key_length().
+
=head1 RETURN VALUES
EVP_CIPHER_CTX_new() returns a pointer to a newly created
@@ -314,6 +320,8 @@ EVP_CIPHER_CTX_cipher() returns an B<EVP_CIPHER> structure.
EVP_CIPHER_param_to_asn1() and EVP_CIPHER_asn1_to_param() return greater
than zero for success and zero or a negative number.
+EVP_CIPHER_CTX_rand_key() returns 1 for success.
+
=head1 CIPHER LISTING
All algorithms have a fixed key length unless otherwise stated.