projects
/
openssl.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
update docs with descriptions and deprecation
[openssl.git]
/
doc
/
crypto
/
BIO_f_cipher.pod
diff --git
a/doc/crypto/BIO_f_cipher.pod
b/doc/crypto/BIO_f_cipher.pod
index 02439cea94a0d6e550fd17be879b3be4717daf64..8b8e2001d19aa70681edd9ca81749118fc543b5c 100644
(file)
--- a/
doc/crypto/BIO_f_cipher.pod
+++ b/
doc/crypto/BIO_f_cipher.pod
@@
-9,9
+9,9
@@
BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher
#include <openssl/bio.h>
#include <openssl/evp.h>
#include <openssl/bio.h>
#include <openssl/evp.h>
-
BIO_METHOD *
BIO_f_cipher(void);
+
const BIO_METHOD *
BIO_f_cipher(void);
void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher,
void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher,
- unsigned char *key, unsigned char *iv, int enc);
+
unsigned char *key, unsigned char *iv, int enc);
int BIO_get_cipher_status(BIO *b)
int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx)
int BIO_get_cipher_status(BIO *b)
int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx)
@@
-22,7
+22,7
@@
BIO that encrypts any data written through it, and decrypts any data
read from it. It is a BIO wrapper for the cipher routines
EVP_CipherInit(), EVP_CipherUpdate() and EVP_CipherFinal().
read from it. It is a BIO wrapper for the cipher routines
EVP_CipherInit(), EVP_CipherUpdate() and EVP_CipherFinal().
-Cipher BIOs do not support BIO_gets() or BIO_puts().
+Cipher BIOs do not support BIO_gets() or BIO_puts().
BIO_flush() on an encryption BIO that is being written through is
used to signal that no more data is to be encrypted: this is used
BIO_flush() on an encryption BIO that is being written through is
used to signal that no more data is to be encrypted: this is used
@@
-48,7
+48,7
@@
When encrypting BIO_flush() B<must> be called to flush the final block
through the BIO. If it is not then the final block will fail a subsequent
decrypt.
through the BIO. If it is not then the final block will fail a subsequent
decrypt.
-When decrypting an error on the final block is signal
l
ed by a zero
+When decrypting an error on the final block is signaled by a zero
return value from the read operation. A successful decrypt followed
by EOF will also return zero for the final read. BIO_get_cipher_status()
should be called to determine if the decrypt was successful.
return value from the read operation. A successful decrypt followed
by EOF will also return zero for the final read. BIO_get_cipher_status()
should be called to determine if the decrypt was successful.
@@
-67,10
+67,13
@@
for failure.
BIO_get_cipher_ctx() currently always returns 1.
BIO_get_cipher_ctx() currently always returns 1.
-=head1
EXAMPLES
+=head1
COPYRIGHT
-TBA
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
-=head1 SEE ALSO
+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>.
-TBA
+=cut