Constify a bit X509_NAME_get_entry
[openssl.git] / doc / ssl / DTLSv1_listen.pod
index 62913de56dc70d110aab6b407918aa60ff7bd569..a839d9fec19101685a9f741b5d05ed2ce62ef4bd 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DTLSv1_listen - listen for incoming DTLS connections.
+DTLSv1_listen - listen for incoming DTLS connections
 
 =head1 SYNOPSIS
 
@@ -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
@@ -88,4 +90,13 @@ L<ssl(3)>, L<bio(3)>
 DTLSv1_listen() return codes were clarified in OpenSSL 1.1.0. The type of "peer"
 also changed in OpenSSL 1.1.0.
 
+=head1 COPYRIGHT
+
+Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
 =cut