Introduce X509_add_cert[s] simplifying various additions to cert lists
[openssl.git] / doc / internal / man3 / ossl_cmp_X509_STORE_add1_certs.pod
1 =pod
2
3 =head1 NAME
4
5 ossl_cmp_X509_STORE_add1_certs,
6 ossl_cmp_X509_STORE_get1_certs
7 - functions manipulating stores of certificates
8
9 =head1 SYNOPSIS
10
11   #include <openssl/cmp_util.h>
12
13   int ossl_cmp_X509_STORE_add1_certs(X509_STORE *store, STACK_OF(X509) *certs,
14                                      int only_self_signed);
15   STACK_OF(X509) *ossl_cmp_X509_STORE_get1_certs(X509_STORE *store);
16
17 =head1 DESCRIPTION
18
19 ossl_cmp_X509_STORE_add1_certs() adds all or only self-signed certificates from
20 the given stack to given store. The I<certs> parameter may be NULL.
21
22 ossl_cmp_X509_STORE_get1_certs() retrieves a copy of all certificates in the
23 given store.
24
25 =head1 RETURN VALUES
26
27 ossl_cmp_X509_STORE_add1_certs() returns 1 on success, 0 on error.
28
29 ossl_cmp_X509_STORE_get1_certs() returns a list of certificates, NULL on error.
30
31 =head1 HISTORY
32
33 The OpenSSL CMP support was added in OpenSSL 3.0.
34
35 =head1 COPYRIGHT
36
37 Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
38
39 Licensed under the Apache License 2.0 (the "License").  You may not use
40 this file except in compliance with the License.  You can obtain a copy
41 in the file LICENSE in the source distribution or at
42 L<https://www.openssl.org/source/license.html>.
43
44 =cut