diff options
Diffstat (limited to 'src/lib/libssl/man/SSL_renegotiate.3')
| -rw-r--r-- | src/lib/libssl/man/SSL_renegotiate.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/src/lib/libssl/man/SSL_renegotiate.3 b/src/lib/libssl/man/SSL_renegotiate.3 new file mode 100644 index 0000000000..c07a1e2c2a --- /dev/null +++ b/src/lib/libssl/man/SSL_renegotiate.3 | |||
| @@ -0,0 +1,56 @@ | |||
| 1 | .\" $OpenBSD: SSL_renegotiate.3,v 1.1 2016/12/07 20:11:55 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 7 2016 $ | ||
| 18 | .Dt SSL_RENEGOTIATE 3 | ||
| 19 | .Os | ||
| 20 | .Sh NAME | ||
| 21 | .Nm SSL_renegotiate | ||
| 22 | .Nd request a new session | ||
| 23 | .Sh SYNOPSIS | ||
| 24 | .In openssl/ssl.h | ||
| 25 | .Ft int | ||
| 26 | .Fo SSL_renegotiate | ||
| 27 | .Fa "SSL *ssl" | ||
| 28 | .Fc | ||
| 29 | .Sh DESCRIPTION | ||
| 30 | .Fn SSL_renegotiate | ||
| 31 | manually instructs | ||
| 32 | .Fa ssl | ||
| 33 | to renegotiate and generate a new session. | ||
| 34 | .Pp | ||
| 35 | This function is automatically called by | ||
| 36 | .Xr SSL_read 3 | ||
| 37 | and | ||
| 38 | .Xr SSL_write 3 | ||
| 39 | whenever the renegotiation byte count set by | ||
| 40 | .Xr BIO_set_ssl_renegotiate_bytes 3 | ||
| 41 | or the timeout set by | ||
| 42 | .Xr BIO_set_ssl_renegotiate_timeout 3 | ||
| 43 | are exceeded. | ||
| 44 | .Sh RETURN VALUES | ||
| 45 | .Fn SSL_renegotiate | ||
| 46 | always returns 1 unless the protocol-specific flag | ||
| 47 | .Dv SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS | ||
| 48 | is set, in which case it may return 0. | ||
| 49 | The API provides no function to set that flag; | ||
| 50 | it can only be set by manipulating internal data structures. | ||
| 51 | .Sh SEE ALSO | ||
| 52 | .Xr SSL_read 3 , | ||
| 53 | .Xr SSL_write 3 | ||
| 54 | .Sh HISTORY | ||
| 55 | .Fn SSL_renegotiate | ||
| 56 | is available in all versions of OpenSSL. | ||