2947af32a0
Adjust brace placement, whitespace after keywords, indentation and empty lines after variable declarations according to https://www.openssl.org/policies/codingstyle.html. Indent literal sections by exactly one space. Reviewed-by: Rich Salz <rsalz@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1956)
71 lines
1.5 KiB
Text
71 lines
1.5 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
SSL_load_client_CA_file - load certificate names from file
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
SSL_load_client_CA_file() reads certificates from B<file> and returns
|
|
a STACK_OF(X509_NAME) with the subject names found.
|
|
|
|
=head1 NOTES
|
|
|
|
SSL_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
|
|
L<SSL_CTX_set_client_CA_list(3)>,
|
|
it is not limited to CA certificates.
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Load names of CAs from file and use it as a client CA list:
|
|
|
|
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 */
|
|
...
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
The following return values can occur:
|
|
|
|
=over 4
|
|
|
|
=item NULL
|
|
|
|
The operation failed, check out the error stack for the reason.
|
|
|
|
=item Pointer to STACK_OF(X509_NAME)
|
|
|
|
Pointer to the subject names of the successfully read certificates.
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ssl(7)>,
|
|
L<SSL_CTX_set_client_CA_list(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|