diff options
| author | bentley <> | 2014-10-12 09:33:04 +0000 |
|---|---|---|
| committer | bentley <> | 2014-10-12 09:33:04 +0000 |
| commit | 78332233d01faa45e0bb0b1583d47cb5ad1ddc19 (patch) | |
| tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_CTX_set_timeout.3 | |
| parent | 4e737c824fafe5f105e5f4849a9db2569b5d53d8 (diff) | |
| download | openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.gz openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.bz2 openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.zip | |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_set_timeout.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_CTX_set_timeout.3 | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_set_timeout.3 b/src/lib/libssl/doc/SSL_CTX_set_timeout.3 new file mode 100644 index 0000000000..c8aaee24e2 --- /dev/null +++ b/src/lib/libssl/doc/SSL_CTX_set_timeout.3 | |||
| @@ -0,0 +1,62 @@ | |||
| 1 | .Dd $Mdocdate: October 12 2014 $ | ||
| 2 | .Dt SSL_CTX_SET_TIMEOUT 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm SSL_CTX_set_timeout , | ||
| 6 | .Nm SSL_CTX_get_timeout | ||
| 7 | .Nd manipulate timeout values for session caching | ||
| 8 | .Sh SYNOPSIS | ||
| 9 | .In openssl/ssl.h | ||
| 10 | .Ft long | ||
| 11 | .Fn SSL_CTX_set_timeout "SSL_CTX *ctx" "long t" | ||
| 12 | .Ft long | ||
| 13 | .Fn SSL_CTX_get_timeout "SSL_CTX *ctx" | ||
| 14 | .Sh DESCRIPTION | ||
| 15 | .Fn SSL_CTX_set_timeout | ||
| 16 | sets the timeout for newly created sessions for | ||
| 17 | .Fa ctx | ||
| 18 | to | ||
| 19 | .Fa t . | ||
| 20 | The timeout value | ||
| 21 | .Fa t | ||
| 22 | must be given in seconds. | ||
| 23 | .Pp | ||
| 24 | .Fn SSL_CTX_get_timeout | ||
| 25 | returns the currently set timeout value for | ||
| 26 | .Fa ctx . | ||
| 27 | .Sh NOTES | ||
| 28 | Whenever a new session is created, it is assigned a maximum lifetime. | ||
| 29 | This lifetime is specified by storing the creation time of the session and the | ||
| 30 | timeout value valid at this time. | ||
| 31 | If the actual time is later than creation time plus timeout, | ||
| 32 | the session is not reused. | ||
| 33 | .Pp | ||
| 34 | Due to this realization, all sessions behave according to the timeout value | ||
| 35 | valid at the time of the session negotiation. | ||
| 36 | Changes of the timeout value do not affect already established sessions. | ||
| 37 | .Pp | ||
| 38 | The expiration time of a single session can be modified using the | ||
| 39 | .Xr SSL_SESSION_get_time 3 | ||
| 40 | family of functions. | ||
| 41 | .Pp | ||
| 42 | Expired sessions are removed from the internal session cache, whenever | ||
| 43 | .Xr SSL_CTX_flush_sessions 3 | ||
| 44 | is called, either directly by the application or automatically (see | ||
| 45 | .Xr SSL_CTX_set_session_cache_mode 3 ) . | ||
| 46 | .Pp | ||
| 47 | The default value for session timeout is decided on a per-protocol basis; see | ||
| 48 | .Xr SSL_get_default_timeout 3 . | ||
| 49 | All currently supported protocols have the same default timeout value of 300 | ||
| 50 | seconds. | ||
| 51 | .Sh RETURN VALUES | ||
| 52 | .Fn SSL_CTX_set_timeout | ||
| 53 | returns the previously set timeout value. | ||
| 54 | .Pp | ||
| 55 | .Fn SSL_CTX_get_timeout | ||
| 56 | returns the currently set timeout value. | ||
| 57 | .Sh SEE ALSO | ||
| 58 | .Xr ssl 3 , | ||
| 59 | .Xr SSL_CTX_flush_sessions 3 , | ||
| 60 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
| 61 | .Xr SSL_get_default_timeout 3 , | ||
| 62 | .Xr SSL_SESSION_get_time 3 | ||