diff options
author | Matt Caswell <matt@openssl.org> | 2020-09-24 10:42:23 +0100 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2020-10-01 09:25:20 +0100 |
commit | d8652be06e2778e8898453a391deb7253e1a35a2 (patch) | |
tree | fe40e22edb39642aa7ae633320c1900388f2e7ee /doc/man3/PKCS7_sign.pod | |
parent | aedac96c1172ca9a9efe72e027e935504b599e2f (diff) | |
download | openssl-new-d8652be06e2778e8898453a391deb7253e1a35a2.tar.gz |
Run the withlibctx.pl script
Automatically rename all instances of _with_libctx() to _ex() as per
our coding style.
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12970)
Diffstat (limited to 'doc/man3/PKCS7_sign.pod')
-rw-r--r-- | doc/man3/PKCS7_sign.pod | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/man3/PKCS7_sign.pod b/doc/man3/PKCS7_sign.pod index c5d6fd73c3..43a76e7e59 100644 --- a/doc/man3/PKCS7_sign.pod +++ b/doc/man3/PKCS7_sign.pod @@ -2,22 +2,22 @@ =head1 NAME -PKCS7_sign_with_libctx, PKCS7_sign +PKCS7_sign_ex, PKCS7_sign - create a PKCS#7 signedData structure =head1 SYNOPSIS #include <openssl/pkcs7.h> - PKCS7 *PKCS7_sign_with_libctx(X509 *signcert, EVP_PKEY *pkey, - STACK_OF(X509) *certs, BIO *data, int flags, - OPENSSL_CTX *libctx, const char *propq); + PKCS7 *PKCS7_sign_ex(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, + BIO *data, int flags, OPENSSL_CTX *libctx, + const char *propq); PKCS7 *PKCS7_sign(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, BIO *data, int flags); =head1 DESCRIPTION -PKCS7_sign_with_libctx() creates and returns a PKCS#7 signedData structure. +PKCS7_sign_ex() creates and returns a PKCS#7 signedData structure. I<igncert> is the certificate to sign with, Ipkey> is the corresponding private key. I<certs> is an optional additional set of certificates to include in the PKCS#7 structure (for example any intermediate CAs in the chain). The @@ -94,7 +94,7 @@ PKCS#7 structure is output. In versions of OpenSSL before 1.0.0 the B<signcert> and B<pkey> parameters must B<NOT> be NULL. -PKCS7_sign() is similar to PKCS7_sign_with_libctx() but uses default values of +PKCS7_sign() is similar to PKCS7_sign_ex() but uses default values of NULL for the library context I<libctx> and the property query I<propq>. =head1 BUGS @@ -103,7 +103,7 @@ Some advanced attributes such as counter signatures are not supported. =head1 RETURN VALUES -PKCS7_sign_with_libctx() and PKCS7_sign() return either a valid PKCS7 structure +PKCS7_sign_ex() and PKCS7_sign() return either a valid PKCS7 structure or NULL if an error occurred. The error can be obtained from ERR_get_error(3). =head1 SEE ALSO @@ -112,7 +112,7 @@ L<ERR_get_error(3)>, L<PKCS7_verify(3)> =head1 HISTORY -The function PKCS7_sign_with_libctx() was added in OpenSSL 3.0. +The function PKCS7_sign_ex() was added in OpenSSL 3.0. The B<PKCS7_PARTIAL> flag, and the ability for B<certs>, B<signcert>, and B<pkey> parameters to be B<NULL> were added in OpenSSL 1.0.0. |