xref: /freebsd/crypto/openssl/doc/man3/X509_add_cert.pod (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1=pod
2
3=head1 NAME
4
5X509_add_cert,
6X509_add_certs -
7X509 certificate list addition functions
8
9=head1 SYNOPSIS
10
11 #include <openssl/x509.h>
12
13 int X509_add_cert(STACK_OF(X509) *sk, X509 *cert, int flags);
14 int X509_add_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs, int flags);
15
16=head1 DESCRIPTION
17
18X509_add_cert() adds a certificate I<cert> to the given list I<sk>.
19
20X509_add_certs() adds a list of certificate I<certs> to the given list I<sk>.
21The I<certs> argument may be NULL, which implies no effect.
22It does not modify the list I<certs> but
23in case the B<X509_ADD_FLAG_UP_REF> flag (described below) is set
24the reference counters of those of its members added to I<sk> are increased.
25
26Both these functions have a I<flags> parameter,
27which is used to control details of the operation.
28
29The value B<X509_ADD_FLAG_DEFAULT>, which equals 0, means no special semantics.
30
31If B<X509_ADD_FLAG_UP_REF> is set then
32the reference counts of those certificates added successfully are increased.
33
34If B<X509_ADD_FLAG_PREPEND> is set then the certificates are prepended to I<sk>.
35By default they are appended to I<sk>.
36In both cases the original order of the added certificates is preserved.
37
38If B<X509_ADD_FLAG_NO_DUP> is set then certificates already contained in I<sk>,
39which is determined using L<X509_cmp(3)>, are ignored.
40
41If B<X509_ADD_FLAG_NO_SS> is set then certificates that are marked self-signed,
42which is determined using L<X509_self_signed(3)>, are ignored.
43
44=head1 RETURN VALUES
45
46Both functions return 1 for success and 0 for failure.
47
48=head1 NOTES
49
50If X509_add_certs() is used with the flags B<X509_ADD_FLAG_NO_DUP> or
51B<X509_ADD_FLAG_NO_SS> it is advisable to use also B<X509_ADD_FLAG_UP_REF>
52because otherwise likely not for all members of the I<certs> list
53the ownership is transferred to the list of certificates I<sk>.
54
55Care should also be taken in case the I<certs> argument equals I<sk>.
56
57=head1 SEE ALSO
58
59L<X509_cmp(3)>
60L<X509_self_signed(3)>
61
62=head1 HISTORY
63
64The functions X509_add_cert() and X509_add_certs()
65were added in OpenSSL 3.0.
66
67=head1 COPYRIGHT
68
69Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
70
71Licensed under the Apache License 2.0 (the "License").  You may not use
72this file except in compliance with the License.  You can obtain a copy
73in the file LICENSE in the source distribution or at
74L<https://www.openssl.org/source/license.html>.
75
76=cut
77