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