diff options
Diffstat (limited to 'doc/man3/PKCS7_sign.pod')
| -rw-r--r-- | doc/man3/PKCS7_sign.pod | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/doc/man3/PKCS7_sign.pod b/doc/man3/PKCS7_sign.pod index 11b626191038..5c55aa191def 100644 --- a/doc/man3/PKCS7_sign.pod +++ b/doc/man3/PKCS7_sign.pod @@ -2,27 +2,34 @@ =head1 NAME -PKCS7_sign - create a PKCS#7 signedData structure +PKCS7_sign_ex, PKCS7_sign +- create a PKCS#7 signedData structure =head1 SYNOPSIS #include <openssl/pkcs7.h> + PKCS7 *PKCS7_sign_ex(X509 *signcert, EVP_PKEY *pkey, STACK_OF(X509) *certs, + BIO *data, int flags, OSSL_LIB_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() creates and returns a PKCS#7 signedData structure. +PKCS7_sign_ex() creates and returns a PKCS#7 signedData structure. I<signcert> is the certificate to sign with, I<pkey> is the corresponding private key. I<certs> is an optional set of extra certificates to include in the PKCS#7 structure (for example any intermediate CAs in the chain). +The library context I<libctx> and property query I<propq> are used when +retrieving algorithms from providers. The data to be signed is read from BIO I<data>. I<flags> is an optional set of flags. Any of the following flags (ored together) can be passed in the I<flags> +parameter. Many S/MIME clients expect the signed content to include valid MIME headers. If the B<PKCS7_TEXT> flag is set MIME headers for type C<text/plain> are prepended @@ -63,8 +70,6 @@ way data can be signed in a single pass. If the B<PKCS7_PARTIAL> flag is set a partial B<PKCS7> structure is output to which additional signers and capabilities can be added before finalization. -=head1 NOTES - If the flag B<PKCS7_STREAM> is set the returned B<PKCS7> structure is B<not> complete and outputting its contents via a function that does not properly finalize the B<PKCS7> structure will give unpredictable results. @@ -75,7 +80,7 @@ can be performed by obtaining the streaming ASN1 B<BIO> directly using BIO_new_PKCS7(). If a signer is specified it will use the default digest for the signing -algorithm. This is B<SHA1> for both RSA and DSA keys. +algorithm. This is B<SHA256> for both RSA and DSA keys. The I<certs>, I<signcert> and I<pkey> parameters can all be NULL if the B<PKCS7_PARTIAL> flag is set. One or more signers can be added @@ -89,14 +94,18 @@ PKCS#7 structure is output. In versions of OpenSSL before 1.0.0 the I<signcert> and I<pkey> parameters must not be NULL. +PKCS7_sign() is like PKCS7_sign_ex() except that it uses default values of +NULL for the library context I<libctx> and the property query I<propq>. +This is retained for API backward compatibility. + =head1 BUGS Some advanced attributes such as counter signatures are not supported. =head1 RETURN VALUES -PKCS7_sign() returns either a valid PKCS7 structure or NULL if an error -occurred. The error can be obtained from ERR_get_error(3). +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 @@ -104,6 +113,8 @@ L<ERR_get_error(3)>, L<PKCS7_verify(3)> =head1 HISTORY +The function PKCS7_sign_ex() was added in OpenSSL 3.0. + The B<PKCS7_PARTIAL> flag, and the ability for I<certs>, I<signcert>, and I<pkey> parameters to be NULL were added in OpenSSL 1.0.0. @@ -111,9 +122,9 @@ The B<PKCS7_STREAM> flag was added in OpenSSL 1.0.0. =head1 COPYRIGHT -Copyright 2002-2022 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2002-2025 The OpenSSL Project Authors. All Rights Reserved. -Licensed under the OpenSSL license (the "License"). You may not use +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>. |