Debian Codegraph @

upstream/debian-unstable/man3/X509_add_cert.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_ADD_CERT 3SSL"
58 .TH X509_ADD_CERT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_add_cert,
65 X509_add_certs \-
66 X509 certificate list addition functions
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509.h>
71 \&
72 \& int X509_add_cert(STACK_OF(X509) *sk, X509 *cert, int flags);
73 \& int X509_add_certs(STACK_OF(X509) *sk, STACK_OF(X509) *certs, int flags);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBX509_add_cert()\fR adds a certificate \fIcert\fR to the given list \fIsk\fR.
78 It is an error for the \fIcert\fR argument to be NULL.
79 .PP
80 \&\fBX509_add_certs()\fR adds a list of certificate \fIcerts\fR to the given list \fIsk\fR.
81 The \fIcerts\fR argument may be NULL, which implies no effect.
82 It does not modify the list \fIcerts\fR but
83 in case the \fBX509_ADD_FLAG_UP_REF\fR flag (described below) is set
84 the reference counters of those of its members added to \fIsk\fR are increased.
85 .PP
86 Both these functions have a \fIflags\fR parameter,
87 which is used to control details of the operation.
88 .PP
89 The value \fBX509_ADD_FLAG_DEFAULT\fR, which equals 0, means no special semantics.
90 .PP
91 If \fBX509_ADD_FLAG_UP_REF\fR is set then
92 the reference counts of those certificates added successfully are increased.
93 .PP
94 If \fBX509_ADD_FLAG_PREPEND\fR is set then the certificates are prepended to \fIsk\fR.
95 By default they are appended to \fIsk\fR.
96 In both cases the original order of the added certificates is preserved.
97 .PP
98 If \fBX509_ADD_FLAG_NO_DUP\fR is set then certificates already contained in \fIsk\fR,
99 which is determined using \fBX509_cmp\fR\|(3), are ignored.
100 .PP
101 If \fBX509_ADD_FLAG_NO_SS\fR is set then certificates that are marked self-signed,
102 which is determined using \fBX509_self_signed\fR\|(3), are ignored.
103 .SH "RETURN VALUES"
104 .IX Header "RETURN VALUES"
105 Both functions return 1 for success and 0 for failure.
106 .SH NOTES
107 .IX Header "NOTES"
108 If \fBX509_add_certs()\fR is used with the flags \fBX509_ADD_FLAG_NO_DUP\fR or
109 \&\fBX509_ADD_FLAG_NO_SS\fR it is advisable to use also \fBX509_ADD_FLAG_UP_REF\fR
110 because otherwise likely not for all members of the \fIcerts\fR list
111 the ownership is transferred to the list of certificates \fIsk\fR.
112 .PP
113 Care should also be taken in case the \fIcerts\fR argument equals \fIsk\fR.
114 .SH "SEE ALSO"
115 .IX Header "SEE ALSO"
116 \&\fBX509_cmp\fR\|(3)
117 \&\fBX509_self_signed\fR\|(3)
118 .SH HISTORY
119 .IX Header "HISTORY"
120 The functions \fBX509_add_cert()\fR and \fBX509_add_certs()\fR
121 were added in OpenSSL 3.0.
122 .SH COPYRIGHT
123 .IX Header "COPYRIGHT"
124 Copyright 2019\-2025 The OpenSSL Project Authors. All Rights Reserved.
125 .PP
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 <https://www.openssl.org/source/license.html>.