-*- mode: troff; coding: utf-8 -*- Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) Standard preamble: ========================================================================..
..
..
\*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
======================================================================== Title "SSL_LOAD_CLIENT_CA_FILE 3ossl" SSL_LOAD_CLIENT_CA_FILE 3ossl 2025-09-30 3.5.4 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents. NAME
SSL_load_client_CA_file_ex, SSL_load_client_CA_file,
SSL_add_file_cert_subjects_to_stack,
SSL_add_dir_cert_subjects_to_stack,
SSL_add_store_cert_subjects_to_stack
\- load certificate names
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <
openssl/
ssl.h>
\&
STACK_OF(X509_NAME) *SSL_load_client_CA_file_ex(const char *file,
OSSL_LIB_CTX *libctx,
const char *propq);
STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
\&
int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
const char *file);
int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
const char *dir);
int SSL_add_store_cert_subjects_to_stack(STACK_OF(X509_NAME) *stack,
const char *store);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBSSL_load_client_CA_file_ex() reads certificates from
file and returns
a STACK_OF(X509_NAME) with the subject names found. The library context
libctx
and property query
propq are used when fetching algorithms from providers.
\fBSSL_load_client_CA_file() is similar to SSL_load_client_CA_file_ex()
but uses NULL for the library context libctx and property query propq.
\fBSSL_add_file_cert_subjects_to_stack() reads certificates from file,
and adds their subject name to the already existing stack.
\fBSSL_add_dir_cert_subjects_to_stack() reads certificates from every
file in the directory dir, and adds their subject name to the
already existing stack.
\fBSSL_add_store_cert_subjects_to_stack() loads certificates from the
\fIstore URI, and adds their subject name to the already existing
\fIstack.
NOTES
Header "NOTES" \fBSSL_load_client_CA_file() reads a file of PEM formatted certificates and
extracts the X509_NAMES of the certificates found. While the name suggests
the specific usage as support function for
\fBSSL_CTX_set_client_CA_list\|(3),
it is not limited to CA certificates.
"RETURN VALUES"
Header "RETURN VALUES" The following return values can occur for
SSL_load_client_CA_file_ex(), and
\fBSSL_load_client_CA_file():
NULL 4
Item "NULL" The operation failed, check out the error stack for the reason.
"Pointer to STACK_OF(X509_NAME)" 4
Item "Pointer to STACK_OF(X509_NAME)" Pointer to the subject names of the successfully read certificates.
The following return values can occur for SSL_add_file_cert_subjects_to_stack(),
\fBSSL_add_dir_cert_subjects_to_stack(), and SSL_add_store_cert_subjects_to_stack():
"0 (Failure)" 4
Item "0 (Failure)" The operation failed.
"1 (Success)" 4
Item "1 (Success)" The operation succeeded.
EXAMPLES
Header "EXAMPLES" Load names of CAs from file and use it as a client CA list:
.Vb 2
SSL_CTX *ctx;
STACK_OF(X509_NAME) *cert_names;
\&
...
cert_names = SSL_load_client_CA_file("/path/to/CAfile.pem");
if (cert_names != NULL)
SSL_CTX_set_client_CA_list(ctx, cert_names);
else
/* error */
...
.Ve
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7),
\fBossl_store\|(7),
\fBSSL_CTX_set_client_CA_list\|(3)
HISTORY
Header "HISTORY" \fBSSL_load_client_CA_file_ex() and
SSL_add_store_cert_subjects_to_stack()
were added in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.