summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_CTX_set_cert_store.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_set_cert_store.3')
-rw-r--r--src/lib/libssl/doc/SSL_CTX_set_cert_store.377
1 files changed, 77 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_set_cert_store.3 b/src/lib/libssl/doc/SSL_CTX_set_cert_store.3
new file mode 100644
index 0000000000..f80670ce78
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_CTX_set_cert_store.3
@@ -0,0 +1,77 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_CTX_SET_CERT_STORE 3
3.Os
4.Sh NAME
5.Nm SSL_CTX_set_cert_store ,
6.Nm SSL_CTX_get_cert_store
7.Nd manipulate X509 certificate verification storage
8.Sh SYNOPSIS
9.In openssl/ssl.h
10.Ft void
11.Fn SSL_CTX_set_cert_store "SSL_CTX *ctx" "X509_STORE *store"
12.Ft X509_STORE *
13.Fn SSL_CTX_get_cert_store "const SSL_CTX *ctx"
14.Sh DESCRIPTION
15.Fn SSL_CTX_set_cert_store
16setsthe verification storage of
17.Fa ctx
18to or replaces it with
19.Fa store .
20If another
21.Vt X509_STORE
22object is currently set in
23.Fa ctx ,
24it will be
25.Xr X509_STORE_free 3 Ns ed.
26.Pp
27.Fn SSL_CTX_get_cert_store
28returns a pointer to the current certificate verification storage.
29.Sh NOTES
30In order to verify the certificates presented by the peer, trusted CA
31certificates must be accessed.
32These CA certificates are made available via lookup methods, handled inside the
33.Vt X509_STORE .
34From the
35.Vt X509_STORE
36the
37.Vt X509_STORE_CTX
38used when verifying certificates is created.
39.Pp
40Typically the trusted certificate store is handled indirectly via using
41.Xr SSL_CTX_load_verify_locations 3 .
42Using the
43.Fn SSL_CTX_set_cert_store
44and
45.Fn SSL_CTX_get_cert_store
46functions it is possible to manipulate the
47.Vt X509_STORE
48object beyond the
49.Xr SSL_CTX_load_verify_locations 3
50call.
51.Pp
52Currently no detailed documentation on how to use the
53.Vt X509_STORE
54object is available.
55Not all members of the
56.Vt X509_STORE
57are used when the verification takes place.
58So will, for example, the
59.Fn verify_callback
60be overridden with the
61.Fn verify_callback
62set via the
63.Xr SSL_CTX_set_verify 3
64family of functions.
65This document must therefore be updated when documentation about the
66.Vt X509_STORE
67object and its handling becomes available.
68.Sh RETURN VALUES
69.Fn SSL_CTX_set_cert_store
70does not return diagnostic output.
71.Pp
72.Fn SSL_CTX_get_cert_store
73returns the current setting.
74.Sh SEE ALSO
75.Xr ssl 3 ,
76.Xr SSL_CTX_load_verify_locations 3 ,
77.Xr SSL_CTX_set_verify 3