summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjsing <>2017-05-06 21:06:19 +0000
committerjsing <>2017-05-06 21:06:19 +0000
commit7b5928f0dae9f2bd8bff7efc646ac8be2ba312da (patch)
tree68bc0916e640346fba37ed6e67aacb89ebc76804
parent7d324d6b4a253e59f811b823131fa480dca49d94 (diff)
downloadopenbsd-7b5928f0dae9f2bd8bff7efc646ac8be2ba312da.tar.gz
openbsd-7b5928f0dae9f2bd8bff7efc646ac8be2ba312da.tar.bz2
openbsd-7b5928f0dae9f2bd8bff7efc646ac8be2ba312da.zip
Document tls_unload_file().
-rw-r--r--src/lib/libtls/man/tls_load_file.317
1 files changed, 14 insertions, 3 deletions
diff --git a/src/lib/libtls/man/tls_load_file.3 b/src/lib/libtls/man/tls_load_file.3
index c67be9159b..ea3a3feed5 100644
--- a/src/lib/libtls/man/tls_load_file.3
+++ b/src/lib/libtls/man/tls_load_file.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: tls_load_file.3,v 1.5 2017/01/31 20:53:50 jmc Exp $ 1.\" $OpenBSD: tls_load_file.3,v 1.6 2017/05/06 21:06:19 jsing Exp $
2.\" 2.\"
3.\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org> 3.\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org>
4.\" Copyright (c) 2015 Reyk Floeter <reyk@openbsd.org> 4.\" Copyright (c) 2015 Reyk Floeter <reyk@openbsd.org>
@@ -17,11 +17,12 @@
17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19.\" 19.\"
20.Dd $Mdocdate: January 31 2017 $ 20.Dd $Mdocdate: May 6 2017 $
21.Dt TLS_LOAD_FILE 3 21.Dt TLS_LOAD_FILE 3
22.Os 22.Os
23.Sh NAME 23.Sh NAME
24.Nm tls_load_file , 24.Nm tls_load_file ,
25.Nm tls_unload_file ,
25.Nm tls_config_set_ca_file , 26.Nm tls_config_set_ca_file ,
26.Nm tls_config_set_ca_path , 27.Nm tls_config_set_ca_path ,
27.Nm tls_config_set_ca_mem , 28.Nm tls_config_set_ca_mem ,
@@ -52,6 +53,11 @@
52.Fa "size_t *len" 53.Fa "size_t *len"
53.Fa "char *password" 54.Fa "char *password"
54.Fc 55.Fc
56.Ft void
57.Fo tls_unload_file
58.Fa "uint8_t *buf"
59.Fa "size_t len"
60.Fc
55.Ft int 61.Ft int
56.Fo tls_config_set_ca_file 62.Fo tls_config_set_ca_file
57.Fa "struct tls_config *config" 63.Fa "struct tls_config *config"
@@ -176,7 +182,7 @@
176.Fn tls_config_verify_client_optional "struct tls_config *config" 182.Fn tls_config_verify_client_optional "struct tls_config *config"
177.Sh DESCRIPTION 183.Sh DESCRIPTION
178.Fn tls_load_file 184.Fn tls_load_file
179loads a certificate or key from disk into memory to be loaded with 185loads a certificate or key from disk into memory to be used with
180.Fn tls_config_set_ca_mem , 186.Fn tls_config_set_ca_mem ,
181.Fn tls_config_set_cert_mem 187.Fn tls_config_set_cert_mem
182or 188or
@@ -185,6 +191,11 @@ A private key will be decrypted if the optional
185.Ar password 191.Ar password
186argument is specified. 192argument is specified.
187.Pp 193.Pp
194.Fn tls_unload_file
195unloads the memory that was returned from an earlier
196.Fn tls_load_file
197call, ensuring that the memory contents is discarded.
198.Pp
188.Fn tls_config_set_ca_file 199.Fn tls_config_set_ca_file
189sets the filename used to load a file 200sets the filename used to load a file
190containing the root certificates. 201containing the root certificates.