diff options
author | schwarze <> | 2016-11-05 15:32:20 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
commit | 5af30545c000c195ca6e44f207da004e5780ddb5 (patch) | |
tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/doc/SSL_load_client_CA_file.3 | |
parent | ba7c6bac5d2c870a4d1c1ce9f08db5e57c660625 (diff) | |
download | openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.gz openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.tar.bz2 openbsd-5af30545c000c195ca6e44f207da004e5780ddb5.zip |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/doc/SSL_load_client_CA_file.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_load_client_CA_file.3 | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/src/lib/libssl/doc/SSL_load_client_CA_file.3 b/src/lib/libssl/doc/SSL_load_client_CA_file.3 deleted file mode 100644 index d1f085583f..0000000000 --- a/src/lib/libssl/doc/SSL_load_client_CA_file.3 +++ /dev/null | |||
@@ -1,53 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_load_client_CA_file.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_LOAD_CLIENT_CA_FILE 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_load_client_CA_file | ||
9 | .Nd load certificate names from file | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/ssl.h | ||
12 | .Ft STACK_OF(X509_NAME) * | ||
13 | .Fn SSL_load_client_CA_file "const char *file" | ||
14 | .Sh DESCRIPTION | ||
15 | .Fn SSL_load_client_CA_file | ||
16 | reads certificates from | ||
17 | .Fa file | ||
18 | and returns a | ||
19 | .Dv STACK_OF Ns | ||
20 | .Pq Vt X509_NAME | ||
21 | with the subject names found. | ||
22 | .Sh NOTES | ||
23 | .Fn SSL_load_client_CA_file | ||
24 | reads a file of PEM formatted certificates and extracts the | ||
25 | .Vt X509_NAME Ns s | ||
26 | of the certificates found. | ||
27 | While the name suggests the specific usage as support function for | ||
28 | .Xr SSL_CTX_set_client_CA_list 3 , | ||
29 | it is not limited to CA certificates. | ||
30 | .Sh RETURN VALUES | ||
31 | The following return values can occur: | ||
32 | .Bl -tag -width Ds | ||
33 | .It Dv NULL | ||
34 | The operation failed, check out the error stack for the reason. | ||
35 | .It Pointer to Dv STACK_OF Ns Po Vt X509_NAME Pc | ||
36 | Pointer to the subject names of the successfully read certificates. | ||
37 | .El | ||
38 | .Sh EXAMPLES | ||
39 | Load names of CAs from file and use it as a client CA list: | ||
40 | .Bd -literal | ||
41 | SSL_CTX *ctx; | ||
42 | STACK_OF(X509_NAME) *cert_names; | ||
43 | \&... | ||
44 | cert_names = SSL_load_client_CA_file("/path/to/CAfile.pem"); | ||
45 | if (cert_names != NULL) | ||
46 | SSL_CTX_set_client_CA_list(ctx, cert_names); | ||
47 | else | ||
48 | error_handling(); | ||
49 | \&... | ||
50 | .Ed | ||
51 | .Sh SEE ALSO | ||
52 | .Xr ssl 3 , | ||
53 | .Xr SSL_CTX_set_client_CA_list 3 | ||