aboutsummaryrefslogtreecommitdiffstats
path: root/crypto/openssl/doc/man3/EVP_OpenInit.pod
diff options
context:
space:
mode:
authorJung-uk Kim <jkim@FreeBSD.org>2018-09-13 20:40:51 +0000
committerJung-uk Kim <jkim@FreeBSD.org>2018-09-13 20:40:51 +0000
commite71b70530d95c4f34d8bdbd78d1242df1ba4a945 (patch)
treead6275bcad7894dc16f27ef882a2934a3d80bc14 /crypto/openssl/doc/man3/EVP_OpenInit.pod
parent73511c241bab29b078c84d992082cc44513c608d (diff)
parenta43ce912fc025d11e1395506111f75fc194d7ba5 (diff)
downloadsrc-e71b70530d95c4f34d8bdbd78d1242df1ba4a945.tar.gz
src-e71b70530d95c4f34d8bdbd78d1242df1ba4a945.zip
Update OpenSSL to 1.1.1.
Note it does not update build infrastructure.
Notes
Notes: svn path=/projects/openssl111/; revision=338663
Diffstat (limited to 'crypto/openssl/doc/man3/EVP_OpenInit.pod')
-rw-r--r--crypto/openssl/doc/man3/EVP_OpenInit.pod69
1 files changed, 69 insertions, 0 deletions
diff --git a/crypto/openssl/doc/man3/EVP_OpenInit.pod b/crypto/openssl/doc/man3/EVP_OpenInit.pod
new file mode 100644
index 000000000000..61b4307bca31
--- /dev/null
+++ b/crypto/openssl/doc/man3/EVP_OpenInit.pod
@@ -0,0 +1,69 @@
+=pod
+
+=head1 NAME
+
+EVP_OpenInit, EVP_OpenUpdate, EVP_OpenFinal - EVP envelope decryption
+
+=head1 SYNOPSIS
+
+ #include <openssl/evp.h>
+
+ int EVP_OpenInit(EVP_CIPHER_CTX *ctx, EVP_CIPHER *type, unsigned char *ek,
+ int ekl, unsigned char *iv, EVP_PKEY *priv);
+ int EVP_OpenUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
+ int *outl, unsigned char *in, int inl);
+ int EVP_OpenFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl);
+
+=head1 DESCRIPTION
+
+The EVP envelope routines are a high level interface to envelope
+decryption. They decrypt a public key encrypted symmetric key and
+then decrypt data using it.
+
+EVP_OpenInit() initializes a cipher context B<ctx> for decryption
+with cipher B<type>. It decrypts the encrypted symmetric key of length
+B<ekl> bytes passed in the B<ek> parameter using the private key B<priv>.
+The IV is supplied in the B<iv> parameter.
+
+EVP_OpenUpdate() and EVP_OpenFinal() have exactly the same properties
+as the EVP_DecryptUpdate() and EVP_DecryptFinal() routines, as
+documented on the L<EVP_EncryptInit(3)> manual
+page.
+
+=head1 NOTES
+
+It is possible to call EVP_OpenInit() twice in the same way as
+EVP_DecryptInit(). The first call should have B<priv> set to NULL
+and (after setting any cipher parameters) it should be called again
+with B<type> set to NULL.
+
+If the cipher passed in the B<type> parameter is a variable length
+cipher then the key length will be set to the value of the recovered
+key length. If the cipher is a fixed length cipher then the recovered
+key length must match the fixed cipher length.
+
+=head1 RETURN VALUES
+
+EVP_OpenInit() returns 0 on error or a non zero integer (actually the
+recovered secret key size) if successful.
+
+EVP_OpenUpdate() returns 1 for success or 0 for failure.
+
+EVP_OpenFinal() returns 0 if the decrypt failed or 1 for success.
+
+=head1 SEE ALSO
+
+L<evp(7)>, L<RAND_bytes(3)>,
+L<EVP_EncryptInit(3)>,
+L<EVP_SealInit(3)>
+
+=head1 COPYRIGHT
+
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (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