diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_load_client_CA_file.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
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 | 50 |
1 files changed, 50 insertions, 0 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 new file mode 100644 index 0000000000..52d21e8e31 --- /dev/null +++ b/src/lib/libssl/doc/SSL_load_client_CA_file.3 | |||
@@ -0,0 +1,50 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_LOAD_CLIENT_CA_FILE 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_load_client_CA_file | ||
6 | .Nd load certificate names from file | ||
7 | .Sh SYNOPSIS | ||
8 | .In openssl/ssl.h | ||
9 | .Ft STACK_OF(X509_NAME) * | ||
10 | .Fn SSL_load_client_CA_file "const char *file" | ||
11 | .Sh DESCRIPTION | ||
12 | .Fn SSL_load_client_CA_file | ||
13 | reads certificates from | ||
14 | .Fa file | ||
15 | and returns a | ||
16 | .Dv STACK_OF Ns | ||
17 | .Pq Vt X509_NAME | ||
18 | with the subject names found. | ||
19 | .Sh NOTES | ||
20 | .Fn SSL_load_client_CA_file | ||
21 | reads a file of PEM formatted certificates and extracts the | ||
22 | .Vt X509_NAME Ns s | ||
23 | of the certificates found. | ||
24 | While the name suggests the specific usage as support function for | ||
25 | .Xr SSL_CTX_set_client_CA_list 3 , | ||
26 | it is not limited to CA certificates. | ||
27 | .Sh RETURN VALUES | ||
28 | The following return values can occur: | ||
29 | .Bl -tag -width Ds | ||
30 | .It Dv NULL | ||
31 | The operation failed, check out the error stack for the reason. | ||
32 | .It Pointer to Dv STACK_OF Ns Po Vt X509_NAME Pc | ||
33 | Pointer to the subject names of the successfully read certificates. | ||
34 | .El | ||
35 | .Sh EXAMPLES | ||
36 | Load names of CAs from file and use it as a client CA list: | ||
37 | .Bd -literal | ||
38 | SSL_CTX *ctx; | ||
39 | STACK_OF(X509_NAME) *cert_names; | ||
40 | \&... | ||
41 | cert_names = SSL_load_client_CA_file("/path/to/CAfile.pem"); | ||
42 | if (cert_names != NULL) | ||
43 | SSL_CTX_set_client_CA_list(ctx, cert_names); | ||
44 | else | ||
45 | error_handling(); | ||
46 | \&... | ||
47 | .Ed | ||
48 | .Sh SEE ALSO | ||
49 | .Xr ssl 3 , | ||
50 | .Xr SSL_CTX_set_client_CA_list 3 | ||