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