ac7f813e84df7e16a1c30c40eb2134d1f3a6f39f
[openssl.git] / doc / internal / man3 / cms_add1_signing_cert.pod
1 =pod
2
3 =head1 NAME
4
5 cms_add1_signing_cert, cms_add1_signing_cert_v2
6 - add ESS signing-certificate signed attribute to a
7 CMS_SignerInfo data structure
8
9 =head1 SYNOPSIS
10
11  #include <openssl/cms.h>
12
13  int cms_add1_signing_cert(CMS_SignerInfo *si, ESS_SIGNING_CERT *sc);
14
15  int cms_add1_signing_cert_v2(CMS_SignerInfo *si, ESS_SIGNING_CERT_V2 *sc2);
16
17 =head1 DESCRIPTION
18
19 cms_add1_signing_cert() adds an ESS Signing Certificate I<sc> (version 1) signed
20 attribute to the CMS_SignerInfo I<si>.
21 cms_add1_signing_cert_v2() adds an ESS Signing Certificate I<sc2> (version 2) signed
22 attribute to the CMS_SignerInfo I<si>.
23 The ESS Signing Certificate attributes version 1 and 2 are defined in RFC 5035
24 which updates Section 5.4 of RFC 2634.
25
26 =head1 NOTES
27
28 This attribute is mandatory to make a CMS compliant with CAdES-BES
29 (European Standard ETSI EN 319 122-1 V1.1.1).
30 For a fuller description see L<cms(1)>).
31
32 =head1 RETURN VALUES
33
34 cms_add1_signing_cert() and cms_add1_signing_cert_v2() return 1 if attribute 
35 is added or 0 if an error occurred.
36
37 =head1 COPYRIGHT
38
39 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
40
41 Licensed under the Apache License 2.0 (the "License").  You may not use
42 this file except in compliance with the License.  You can obtain a copy
43 in the file LICENSE in the source distribution or at
44 L<https://www.openssl.org/source/license.html>.
45
46 =cut