diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_SESSION_get_time.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_SESSION_get_time.3 | 94 |
1 files changed, 0 insertions, 94 deletions
diff --git a/src/lib/libssl/doc/SSL_SESSION_get_time.3 b/src/lib/libssl/doc/SSL_SESSION_get_time.3 deleted file mode 100644 index 5eb7e5a162..0000000000 --- a/src/lib/libssl/doc/SSL_SESSION_get_time.3 +++ /dev/null | |||
| @@ -1,94 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_SESSION_get_time.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_SESSION_GET_TIME 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_SESSION_get_time , | ||
| 9 | .Nm SSL_SESSION_set_time , | ||
| 10 | .Nm SSL_SESSION_get_timeout , | ||
| 11 | .Nm SSL_SESSION_set_timeout | ||
| 12 | .Nd retrieve and manipulate session time and timeout settings | ||
| 13 | .Sh SYNOPSIS | ||
| 14 | .In openssl/ssl.h | ||
| 15 | .Ft long | ||
| 16 | .Fn SSL_SESSION_get_time "const SSL_SESSION *s" | ||
| 17 | .Ft long | ||
| 18 | .Fn SSL_SESSION_set_time "SSL_SESSION *s" "long tm" | ||
| 19 | .Ft long | ||
| 20 | .Fn SSL_SESSION_get_timeout "const SSL_SESSION *s" | ||
| 21 | .Ft long | ||
| 22 | .Fn SSL_SESSION_set_timeout "SSL_SESSION *s" "long tm" | ||
| 23 | .Ft long | ||
| 24 | .Fn SSL_get_time "const SSL_SESSION *s" | ||
| 25 | .Ft long | ||
| 26 | .Fn SSL_set_time "SSL_SESSION *s" "long tm" | ||
| 27 | .Ft long | ||
| 28 | .Fn SSL_get_timeout "const SSL_SESSION *s" | ||
| 29 | .Ft long | ||
| 30 | .Fn SSL_set_timeout "SSL_SESSION *s" "long tm" | ||
| 31 | .Sh DESCRIPTION | ||
| 32 | .Fn SSL_SESSION_get_time | ||
| 33 | returns the time at which the session | ||
| 34 | .Fa s | ||
| 35 | was established. | ||
| 36 | The time is given in seconds since the Epoch and therefore compatible to the | ||
| 37 | time delivered by the | ||
| 38 | .Xr time 3 | ||
| 39 | call. | ||
| 40 | .Pp | ||
| 41 | .Fn SSL_SESSION_set_time | ||
| 42 | replaces the creation time of the session | ||
| 43 | .Fa s | ||
| 44 | with | ||
| 45 | the chosen value | ||
| 46 | .Fa tm . | ||
| 47 | .Pp | ||
| 48 | .Fn SSL_SESSION_get_timeout | ||
| 49 | returns the timeout value set for session | ||
| 50 | .Fa s | ||
| 51 | in seconds. | ||
| 52 | .Pp | ||
| 53 | .Fn SSL_SESSION_set_timeout | ||
| 54 | sets the timeout value for session | ||
| 55 | .Fa s | ||
| 56 | in seconds to | ||
| 57 | .Fa tm . | ||
| 58 | .Pp | ||
| 59 | The | ||
| 60 | .Fn SSL_get_time , | ||
| 61 | .Fn SSL_set_time , | ||
| 62 | .Fn SSL_get_timeout , | ||
| 63 | and | ||
| 64 | .Fn SSL_set_timeout | ||
| 65 | functions are synonyms for the | ||
| 66 | .Fn SSL_SESSION_* | ||
| 67 | counterparts. | ||
| 68 | .Sh NOTES | ||
| 69 | Sessions are expired by examining the creation time and the timeout value. | ||
| 70 | Both are set at creation time of the session to the actual time and the default | ||
| 71 | timeout value at creation, respectively, as set by | ||
| 72 | .Xr SSL_CTX_set_timeout 3 . | ||
| 73 | Using these functions it is possible to extend or shorten the lifetime of the | ||
| 74 | session. | ||
| 75 | .Sh RETURN VALUES | ||
| 76 | .Fn SSL_SESSION_get_time | ||
| 77 | and | ||
| 78 | .Fn SSL_SESSION_get_timeout | ||
| 79 | return the currently valid values. | ||
| 80 | .Pp | ||
| 81 | .Fn SSL_SESSION_set_time | ||
| 82 | and | ||
| 83 | .Fn SSL_SESSION_set_timeout | ||
| 84 | return 1 on success. | ||
| 85 | .Pp | ||
| 86 | If any of the function is passed the | ||
| 87 | .Dv NULL | ||
| 88 | pointer for the session | ||
| 89 | .Fa s , | ||
| 90 | 0 is returned. | ||
| 91 | .Sh SEE ALSO | ||
| 92 | .Xr ssl 3 , | ||
| 93 | .Xr SSL_CTX_set_timeout 3 , | ||
| 94 | .Xr SSL_get_default_timeout 3 | ||
