diff options
author | schwarze <> | 2016-12-06 18:40:31 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-06 18:40:31 +0000 |
commit | 41a4ac71e6600629e8b16cf1de1d21e268d72079 (patch) | |
tree | 439bdb479a86170bff56d19fcbcda027ed93c940 | |
parent | 8f392eca07790ee2bdb358c8616d0d9a0ccb47cd (diff) | |
download | openbsd-41a4ac71e6600629e8b16cf1de1d21e268d72079.tar.gz openbsd-41a4ac71e6600629e8b16cf1de1d21e268d72079.tar.bz2 openbsd-41a4ac71e6600629e8b16cf1de1d21e268d72079.zip |
New manual page SSL_SESSION_new(3) written from scratch.
The function prototype is listed in ssl(3) and <openssl/ssl.h>, so
it's clearly a public interface, but OpenSSL has no documentation
about it whatsoever.
-rw-r--r-- | src/lib/libssl/man/Makefile | 3 | ||||
-rw-r--r-- | src/lib/libssl/man/SSL_SESSION_new.3 | 62 |
2 files changed, 64 insertions, 1 deletions
diff --git a/src/lib/libssl/man/Makefile b/src/lib/libssl/man/Makefile index c2176f1022..a07231f19f 100644 --- a/src/lib/libssl/man/Makefile +++ b/src/lib/libssl/man/Makefile | |||
@@ -1,4 +1,4 @@ | |||
1 | # $OpenBSD: Makefile,v 1.44 2016/12/01 21:12:49 schwarze Exp $ | 1 | # $OpenBSD: Makefile,v 1.45 2016/12/06 18:40:31 schwarze Exp $ |
2 | 2 | ||
3 | .include <bsd.own.mk> | 3 | .include <bsd.own.mk> |
4 | 4 | ||
@@ -48,6 +48,7 @@ MAN = BIO_f_ssl.3 \ | |||
48 | SSL_SESSION_free.3 \ | 48 | SSL_SESSION_free.3 \ |
49 | SSL_SESSION_get_ex_new_index.3 \ | 49 | SSL_SESSION_get_ex_new_index.3 \ |
50 | SSL_SESSION_get_time.3 \ | 50 | SSL_SESSION_get_time.3 \ |
51 | SSL_SESSION_new.3 \ | ||
51 | SSL_accept.3 \ | 52 | SSL_accept.3 \ |
52 | SSL_alert_type_string.3 \ | 53 | SSL_alert_type_string.3 \ |
53 | SSL_clear.3 \ | 54 | SSL_clear.3 \ |
diff --git a/src/lib/libssl/man/SSL_SESSION_new.3 b/src/lib/libssl/man/SSL_SESSION_new.3 new file mode 100644 index 0000000000..77e77e9105 --- /dev/null +++ b/src/lib/libssl/man/SSL_SESSION_new.3 | |||
@@ -0,0 +1,62 @@ | |||
1 | .\" $OpenBSD: SSL_SESSION_new.3,v 1.1 2016/12/06 18:40:31 schwarze Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org> | ||
4 | .\" | ||
5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
7 | .\" copyright notice and this permission notice appear in all copies. | ||
8 | .\" | ||
9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
16 | .\" | ||
17 | .Dd $Mdocdate: December 6 2016 $ | ||
18 | .Dt SSL_SESSION_NEW 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm SSL_SESSION_new | ||
22 | .Nd construct a new SSL_SESSION object | ||
23 | .Sh SYNOPSIS | ||
24 | .In openssl/ssl.h | ||
25 | .Ft SSL_SESSION * | ||
26 | .Fn SSL_SESSION_new void | ||
27 | .Sh DESCRIPTION | ||
28 | .Fn SSL_SESSION_new | ||
29 | allocates and initializes an new | ||
30 | .Vt SSL_SESSION | ||
31 | object. | ||
32 | The reference count is set to 1, the time to the current time, and | ||
33 | the timeout to five minutes. | ||
34 | .Pp | ||
35 | When the object is no longer needed, it can be destructed with | ||
36 | .Xr SSL_SESSION_free 3 . | ||
37 | .Pp | ||
38 | .Fn SSL_SESSION_new | ||
39 | is used internally, for example by | ||
40 | .Xr SSL_connect 3 . | ||
41 | .Sh RETURN VALUES | ||
42 | .Fn SSL_SESSION_new | ||
43 | returns the new | ||
44 | .Vt SSL_SESSION | ||
45 | object or | ||
46 | .Dv NULL | ||
47 | if insufficient memory is available. | ||
48 | .Pp | ||
49 | After failure, | ||
50 | .Xr ERR_get_error 3 | ||
51 | returns | ||
52 | .Dv ERR_R_MALLOC_FAILURE . | ||
53 | .Sh SEE ALSO | ||
54 | .Xr d2i_SSL_SESSION 3 , | ||
55 | .Xr PEM_read_SSL_SESSION 3 , | ||
56 | .Xr SSL_connect 3 , | ||
57 | .Xr SSL_CTX_add_session 3 , | ||
58 | .Xr SSL_get_session 3 , | ||
59 | .Xr SSL_SESSION_free 3 , | ||
60 | .Xr SSL_SESSION_get_ex_new_index 3 , | ||
61 | .Xr SSL_SESSION_get_time 3 , | ||
62 | .Xr SSL_set_session 3 | ||