xref: /freebsd/crypto/openssl/doc/man3/CMS_add0_cert.pod (revision a7623790fb345e6dc986dfd31df0ace115e6f2e4)
1=pod
2
3=head1 NAME
4
5CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_add1_crl, CMS_get1_crls
6- CMS certificate and CRL utility functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/cms.h>
11
12 int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert);
13 int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert);
14 STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms);
15
16 int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl);
17 int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl);
18 STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms);
19
20=head1 DESCRIPTION
21
22CMS_add0_cert() and CMS_add1_cert() add certificate B<cert> to B<cms>.
23must be of type signed data or enveloped data.
24
25CMS_get1_certs() returns all certificates in B<cms>.
26
27CMS_add0_crl() and CMS_add1_crl() add CRL B<crl> to B<cms>. CMS_get1_crls()
28returns any CRLs in B<cms>.
29
30=head1 NOTES
31
32The CMS_ContentInfo structure B<cms> must be of type signed data or enveloped
33data or an error will be returned.
34
35For signed data certificates and CRLs are added to the B<certificates> and
36B<crls> fields of SignedData structure. For enveloped data they are added to
37B<OriginatorInfo>.
38
39As the B<0> implies CMS_add0_cert() adds B<cert> internally to B<cms> and it
40must not be freed up after the call as opposed to CMS_add1_cert() where B<cert>
41must be freed up.
42
43The same certificate or CRL must not be added to the same cms structure more
44than once.
45
46=head1 RETURN VALUES
47
48CMS_add0_cert(), CMS_add1_cert() and CMS_add0_crl() and CMS_add1_crl() return
491 for success and 0 for failure.
50
51CMS_get1_certs() and CMS_get1_crls() return the STACK of certificates or CRLs
52or NULL if there are none or an error occurs. The only error which will occur
53in practice is if the B<cms> type is invalid.
54
55=head1 SEE ALSO
56
57L<ERR_get_error(3)>,
58L<CMS_sign(3)>,
59L<CMS_encrypt(3)>
60
61=head1 COPYRIGHT
62
63Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved.
64
65Licensed under the OpenSSL license (the "License").  You may not use
66this file except in compliance with the License.  You can obtain a copy
67in the file LICENSE in the source distribution or at
68L<https://www.openssl.org/source/license.html>.
69
70=cut
71