diff options
| author | Matt Caswell <matt@openssl.org> | 2016-02-05 20:17:10 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-02-05 20:47:36 +0000 |
| commit | a9052bed9e485a614dd44c6ae8f8c0e84c3205df (patch) | |
| tree | 27beb2286f063520faf6836ab40f3070965aeb81 /doc | |
| parent | ce0865d8dcf4ed088a9e9ae3aa2310b7bd8c295e (diff) | |
| download | openssl-a9052bed9e485a614dd44c6ae8f8c0e84c3205df.tar.gz | |
Update DTLSv1_listen documentation
Make it clear that if we are unable to get hold of the peer address then
*peer is cleared and the family set to AF_UNSPEC.
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ssl/DTLSv1_listen.pod | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/ssl/DTLSv1_listen.pod b/doc/ssl/DTLSv1_listen.pod index 62913de56d..741669395d 100644 --- a/doc/ssl/DTLSv1_listen.pod +++ b/doc/ssl/DTLSv1_listen.pod @@ -44,9 +44,11 @@ When a ClientHello is received that contains a cookie that has been verified, then DTLSv1_listen() will return with the B<ssl> parameter updated into a state where the handshake can be continued by a call to (for example) SSL_accept(). Additionally the B<BIO_ADDR> pointed to by B<peer> will be filled in with -details of the peer that sent the ClientHello. Typically user code is expected -to "connect" the underlying socket to the peer and continue the handshake in a -connected state. +details of the peer that sent the ClientHello. If the underlying BIO is unable +to obtain the B<BIO_ADDR> of the peer (for example because the BIO does not +support this), then B<*peer> will be cleared and the family set to AF_UNSPEC. +Typically user code is expected to "connect" the underlying socket to the peer +and continue the handshake in a connected state. Prior to calling DTLSv1_listen() user code must ensure that cookie generation and verification callbacks have been set up using |