xref: /freebsd/secure/lib/libcrypto/man/man3/PKCS7_sign_add_signer.3 (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "PKCS7_SIGN_ADD_SIGNER 3ossl"
PKCS7_SIGN_ADD_SIGNER 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
PKCS7_sign_add_signer, PKCS7_add_certificate, PKCS7_add_crl - add information to PKCS7 structure
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/pkcs7.h> \& PKCS7_SIGNER_INFO *PKCS7_sign_add_signer(PKCS7 *p7, X509 *signcert, EVP_PKEY *pkey, const EVP_MD *md, int flags); int PKCS7_add_certificate(PKCS7 *p7, X509 *cert); int PKCS7_add_crl(PKCS7 *p7, X509_CRL *crl); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBPKCS7_sign_add_signer() adds a signer with certificate signcert and private key pkey using message digest md to a \s-1PKCS7\s0 signed data structure p7.

The \s-1PKCS7\s0 structure should be obtained from an initial call to PKCS7_sign() with the flag \s-1PKCS7_PARTIAL\s0 set or in the case or re-signing a valid PKCS#7 signed data structure.

If the md parameter is \s-1NULL\s0 then the default digest for the public key algorithm will be used.

Unless the \s-1PKCS7_REUSE_DIGEST\s0 flag is set the returned \s-1PKCS7\s0 structure is not complete and must be finalized either by streaming (if applicable) or a call to PKCS7_final().

"NOTES"
Header "NOTES" The main purpose of this function is to provide finer control over a PKCS#7 signed data structure where the simpler PKCS7_sign() function defaults are not appropriate. For example if multiple signers or non default digest algorithms are needed.

Any of the following flags (ored together) can be passed in the flags parameter.

If \s-1PKCS7_REUSE_DIGEST\s0 is set then an attempt is made to copy the content digest value from the \s-1PKCS7\s0 structure: to add a signer to an existing structure. An error occurs if a matching digest value cannot be found to copy. The returned \s-1PKCS7\s0 structure will be valid and finalized when this flag is set.

If \s-1PKCS7_PARTIAL\s0 is set in addition to \s-1PKCS7_REUSE_DIGEST\s0 then the \fB\s-1PKCS7_SIGNER_INO\s0 structure will not be finalized so additional attributes can be added. In this case an explicit call to PKCS7_SIGNER_INFO_sign() is needed to finalize it.

If \s-1PKCS7_NOCERTS\s0 is set the signer's certificate will not be included in the \fB\s-1PKCS7\s0 structure, the signer's certificate must still be supplied in the \fIsigncert parameter though. This can reduce the size of the signature if the signers certificate can be obtained by other means: for example a previously signed message.

The signedData structure includes several PKCS#7 authenticatedAttributes including the signing time, the PKCS#7 content type and the supported list of ciphers in an SMIMECapabilities attribute. If \s-1PKCS7_NOATTR\s0 is set then no authenticatedAttributes will be used. If \s-1PKCS7_NOSMIMECAP\s0 is set then just the SMIMECapabilities are omitted.

If present the SMIMECapabilities attribute indicates support for the following algorithms: triple \s-1DES, 128\s0 bit \s-1RC2, 64\s0 bit \s-1RC2, DES\s0 and 40 bit \s-1RC2.\s0 If any of these algorithms is disabled then it will not be included.

\fBPKCS7_sign_add_signers() returns an internal pointer to the \s-1PKCS7_SIGNER_INFO\s0 structure just added, which can be used to set additional attributes before it is finalized.

\fBPKCS7_add_certificate() adds to the \s-1PKCS7\s0 structure p7 the certificate \fIcert, which may be an end-entity (signer) certificate or a \s-1CA\s0 certificate useful for chain building. This is done internally by PKCS7_sign_ex\|(3) and similar signing functions. It may have to be used before calling PKCS7_verify\|(3) in order to provide any missing certificate(s) needed for verification.

\fBPKCS7_add_crl() adds the \s-1CRL\s0 crl to the \s-1PKCS7\s0 structure p7. This may be called to provide certificate status information to be included when signing or to use when verifying the \s-1PKCS7\s0 structure.

"RETURN VALUES"
Header "RETURN VALUES" \fBPKCS7_sign_add_signers() returns an internal pointer to the \s-1PKCS7_SIGNER_INFO\s0 structure just added or \s-1NULL\s0 if an error occurs.

\fBPKCS7_add_certificate() and PKCS7_add_crl() return 1 on success, 0 on error.

"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), PKCS7_sign_ex\|(3), \fBPKCS7_final\|(3), PKCS7_verify\|(3)
"HISTORY"
Header "HISTORY" The PPKCS7_sign_add_signer() function was added in OpenSSL 1.0.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2007-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.