summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2015-11-27 11:54:52 +0100
committerWerner Koch <wk@gnupg.org>2015-11-27 11:58:30 +0100
commit05ac2dc5c77fa4b87e98508c1b15fd254806b1ce (patch)
treee78eedd74ed733ad1eb207f4268f1a0c4a556de0 /doc
parent18ca1593c62d62bb72b4e7e14347cd221c187138 (diff)
downloadlibassuan-05ac2dc5c77fa4b87e98508c1b15fd254806b1ce.tar.gz
New feature to test for SOCKS5 proxy availability.
* src/assuan-socket.c (socks5_connect): Add special treatment for empty hostnames. (_assuan_sock_connect_byname): Add feature to test for proxy availibility. * tests/socks5.c (main): Add option --have-proxy. Signed-off-by: Werner Koch <wk@gnupg.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/assuan.texi7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/assuan.texi b/doc/assuan.texi
index 131ffc1..aae3de7 100644
--- a/doc/assuan.texi
+++ b/doc/assuan.texi
@@ -1995,7 +1995,12 @@ current implementation requires that @var{flags} has either
new TCP STREAM socket is returned; on error @code{ASSUAN_INVALID_FD}
and ERRNO set. If @var{credentials} is not @code{NULL}, it is a
string used for password based SOCKS authentication. Username and
-password are separated by a colon. @var{reserved} should be 0.
+password are separated by a colon. @var{reserved} should be 0. To
+test whether the proxy is available @var{host} and @var{port} may be
+given as NULL/0: If the proxy is available the function returns a
+valid socket which is in the state after credentials sub-negotiation.
+The caller now knows that the SOCKS proxy is available and has been
+authenticated; normally the caller closes the socket then.
@end deftypefun