Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / openssl / doc / crypto / CMS_add0_cert.pod
blob9c13f488f61a92f622ed36c5144539f5ce87bc95
1 =pod
3 =head1 NAME
5  CMS_add0_cert, CMS_add1_cert, CMS_get1_certs, CMS_add0_crl, CMS_get1_crls, - CMS certificate and CRL utility functions
7 =head1 SYNOPSIS
9  #include <openssl/cms.h>
11  int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert);
12  int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert);
13  STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms);
15  int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl);
16  int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl);
17  STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms);
20 =head1 DESCRIPTION
22 CMS_add0_cert() and CMS_add1_cert() add certificate B<cert> to B<cms>.
23 must be of type signed data or enveloped data. 
25 CMS_get1_certs() returns all certificates in B<cms>.
27 CMS_add0_crl() and CMS_add1_crl() add CRL B<crl> to B<cms>. CMS_get1_crls()
28 returns any CRLs in B<cms>.
30 =head1 NOTES
32 The CMS_ContentInfo structure B<cms> must be of type signed data or enveloped
33 data or an error will be returned.
35 For signed data certificates and CRLs are added to the B<certificates> and
36 B<crls> fields of SignedData structure. For enveloped data they are added to
37 B<OriginatorInfo>.
39 As the B<0> implies CMS_add0_cert() adds B<cert> internally to B<cms> and it
40 must not be freed up after the call as opposed to CMS_add1_cert() where B<cert>
41 must be freed up.
43 The same certificate or CRL must not be added to the same cms structure more
44 than once.
46 =head1 RETURN VALUES
48 CMS_add0_cert(), CMS_add1_cert() and CMS_add0_crl() and CMS_add1_crl() return
49 1 for success and 0 for failure. 
51 CMS_get1_certs() and CMS_get1_crls() return the STACK of certificates or CRLs
52 or NULL if there are none or an error occurs. The only error which will occur
53 in practice is if the B<cms> type is invalid.
55 =head1 SEE ALSO
57 L<ERR_get_error(3)|ERR_get_error(3)>,
58 L<CMS_sign(3)|CMS_sign(3)>,
59 L<CMS_encrypt(3)|CMS_encrypt(3)>
61 =head1 HISTORY
63 CMS_add0_cert(), CMS_add1_cert(), CMS_get1_certs(), CMS_add0_crl()
64 and CMS_get1_crls() were all first added to OpenSSL 0.9.8
66 =cut