diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/CMS_add0_cert.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/CMS_add0_cert.3 | 53 |
1 files changed, 31 insertions, 22 deletions
diff --git a/secure/lib/libcrypto/man/man3/CMS_add0_cert.3 b/secure/lib/libcrypto/man/man3/CMS_add0_cert.3 index 5928a9919a67..f7a137c4cc82 100644 --- a/secure/lib/libcrypto/man/man3/CMS_add0_cert.3 +++ b/secure/lib/libcrypto/man/man3/CMS_add0_cert.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -68,8 +68,6 @@ . \} .\} .rr rF -.\" -.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ @@ -132,14 +130,15 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "CMS_ADD0_CERT 3" -.TH CMS_ADD0_CERT 3 "2022-07-05" "1.1.1q" "OpenSSL" +.IX Title "CMS_ADD0_CERT 3ossl" +.TH CMS_ADD0_CERT 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. .if n .ad l .nh .SH "NAME" -CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_get1_crls \&\- CMS certificate and CRL utility functions +CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_get1_crls +\&\- CMS certificate and CRL utility functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 @@ -155,28 +154,38 @@ CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_ge .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fBCMS_add0_cert()\fR and \fBCMS_add1_cert()\fR add certificate \fBcert\fR to \fBcms\fR. -must be of type signed data or enveloped data. +\&\fBCMS_add0_cert()\fR and \fBCMS_add1_cert()\fR add certificate \fIcert\fR to \fIcms\fR. +This is used by \fBCMS_sign_ex\fR\|(3) and \fBCMS_sign\fR\|(3) and may be used before +calling \fBCMS_verify\fR\|(3) to help chain building in certificate validation. +\&\fIcms\fR must be of type signed data or (authenticated) enveloped data. +For signed data, such a certificate can be used when signing or verifying +to fill in the signer certificate or to provide an extra \s-1CA\s0 certificate +that may be needed for chain building in certificate validation. +.PP +\&\fBCMS_get1_certs()\fR returns all certificates in \fIcms\fR. .PP -\&\fBCMS_get1_certs()\fR returns all certificates in \fBcms\fR. +\&\fBCMS_add0_crl()\fR and \fBCMS_add1_crl()\fR add \s-1CRL\s0 \fIcrl\fR to \fIcms\fR. +\&\fIcms\fR must be of type signed data or (authenticated) enveloped data. +For signed data, such a \s-1CRL\s0 may be used in certificate validation +with \fBCMS_verify\fR\|(3). +It may be given both for inclusion when signing a \s-1CMS\s0 message +and when verifying a signed \s-1CMS\s0 message. .PP -\&\fBCMS_add0_crl()\fR and \fBCMS_add1_crl()\fR add \s-1CRL\s0 \fBcrl\fR to \fBcms\fR. \fBCMS_get1_crls()\fR -returns any CRLs in \fBcms\fR. +\&\fBCMS_get1_crls()\fR returns all CRLs in \fIcms\fR. .SH "NOTES" .IX Header "NOTES" -The CMS_ContentInfo structure \fBcms\fR must be of type signed data or enveloped +The CMS_ContentInfo structure \fIcms\fR must be of type signed data or enveloped data or an error will be returned. .PP -For signed data certificates and CRLs are added to the \fBcertificates\fR and -\&\fBcrls\fR fields of SignedData structure. For enveloped data they are added to +For signed data certificates and CRLs are added to the \fIcertificates\fR and +\&\fIcrls\fR fields of SignedData structure. For enveloped data they are added to \&\fBOriginatorInfo\fR. .PP -As the \fB0\fR implies \fBCMS_add0_cert()\fR adds \fBcert\fR internally to \fBcms\fR and it -must not be freed up after the call as opposed to \fBCMS_add1_cert()\fR where \fBcert\fR +As the \fI0\fR implies \fBCMS_add0_cert()\fR adds \fIcert\fR internally to \fIcms\fR and it +must not be freed up after the call as opposed to \fBCMS_add1_cert()\fR where \fIcert\fR must be freed up. .PP -The same certificate or \s-1CRL\s0 must not be added to the same cms structure more -than once. +The same certificate must not be added to the same cms structure more than once. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBCMS_add0_cert()\fR, \fBCMS_add1_cert()\fR and \fBCMS_add0_crl()\fR and \fBCMS_add1_crl()\fR return @@ -184,17 +193,17 @@ than once. .PP \&\fBCMS_get1_certs()\fR and \fBCMS_get1_crls()\fR return the \s-1STACK\s0 of certificates or CRLs or \s-1NULL\s0 if there are none or an error occurs. The only error which will occur -in practice is if the \fBcms\fR type is invalid. +in practice is if the \fIcms\fR type is invalid. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBERR_get_error\fR\|(3), -\&\fBCMS_sign\fR\|(3), +\&\fBCMS_sign\fR\|(3), \fBCMS_sign_ex\fR\|(3), \fBCMS_verify\fR\|(3), \&\fBCMS_encrypt\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" -Copyright 2008\-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2008\-2023 The OpenSSL Project Authors. All Rights Reserved. .PP -Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use +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>. |