diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/lib/libtls/tls_init.3 | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/src/lib/libtls/tls_init.3 b/src/lib/libtls/tls_init.3 index 61614ca239..de87119f33 100644 --- a/src/lib/libtls/tls_init.3 +++ b/src/lib/libtls/tls_init.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: tls_init.3,v 1.14 2015/02/15 13:36:06 jsing Exp $ | 1 | .\" $OpenBSD: tls_init.3,v 1.15 2015/02/21 19:54:59 tedu Exp $ |
| 2 | .\" | 2 | .\" |
| 3 | .\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org> | 3 | .\" Copyright (c) 2014 Ted Unangst <tedu@openbsd.org> |
| 4 | .\" | 4 | .\" |
| @@ -14,7 +14,7 @@ | |||
| 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
| 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| 16 | .\" | 16 | .\" |
| 17 | .Dd $Mdocdate: February 15 2015 $ | 17 | .Dd $Mdocdate: February 21 2015 $ |
| 18 | .Dt TLS 3 | 18 | .Dt TLS 3 |
| 19 | .Os | 19 | .Os |
| 20 | .Sh NAME | 20 | .Sh NAME |
| @@ -135,6 +135,7 @@ Both clients and servers are supported. | |||
| 135 | The | 135 | The |
| 136 | .Fn tls_init | 136 | .Fn tls_init |
| 137 | function should be called once before any function is used. | 137 | function should be called once before any function is used. |
| 138 | It may be called more than once, but not concurrently. | ||
| 138 | .Pp | 139 | .Pp |
| 139 | Before a connection is created, a configuration must be created. | 140 | Before a connection is created, a configuration must be created. |
| 140 | The | 141 | The |
| @@ -381,7 +382,30 @@ Functions that return | |||
| 381 | .Vt int | 382 | .Vt int |
| 382 | will return 0 on success and -1 on error. | 383 | will return 0 on success and -1 on error. |
| 383 | Functions that return a pointer will return NULL on error. | 384 | Functions that return a pointer will return NULL on error. |
| 384 | .\" .Sh ERRORS | 385 | .Pp |
| 386 | The | ||
| 387 | .Fn tls_read | ||
| 388 | and | ||
| 389 | .Fn tls_write | ||
| 390 | functions and the | ||
| 391 | .Fn tls_connect | ||
| 392 | family of functions have two special return values. | ||
| 393 | .Pp | ||
| 394 | .Bl -tag -width "TLS_WRITE_AGAIN" -offset indent -compact | ||
| 395 | .It Dv TLS_READ_AGAIN | ||
| 396 | A read operation is necessary to continue. | ||
| 397 | .It Dv TLS_WRITE_AGAIN | ||
| 398 | A write operation is necessary to continue. | ||
| 399 | .El | ||
| 400 | .Pp | ||
| 401 | The caller should call the appropriate function, or in the case of | ||
| 402 | .Fn tls_connect , | ||
| 403 | repeat the call. | ||
| 404 | .Sh ERRORS | ||
| 405 | The | ||
| 406 | .Fn tls_error | ||
| 407 | function may be used to retrieve a string containing more information | ||
| 408 | about the most recent error. | ||
| 385 | .\" .Sh SEE ALSO | 409 | .\" .Sh SEE ALSO |
| 386 | .Sh HISTORY | 410 | .Sh HISTORY |
| 387 | The | 411 | The |
