diff options
author | Isaac Boukris <iboukris@gmail.com> | 2017-01-09 00:51:08 +0200 |
---|---|---|
committer | Peter Wu <peter@lekensteyn.nl> | 2017-01-13 16:25:20 +0100 |
commit | 1d786faee1046ff90e71252aeef4a997c3bf0d8d (patch) | |
tree | 325ebddb13f12be61a28062c2f06980e2a34754a /docs | |
parent | a7c73ae309c03bd84b28659421ac613e503565ce (diff) |
unix_socket: add support for abstract unix domain socket
In addition to unix domain sockets, Linux also supports an
abstract namespace which is independent of the filesystem.
In order to support it, add new CURLOPT_ABSTRACT_UNIX_SOCKET
option which uses the same storage as CURLOPT_UNIX_SOCKET_PATH
internally, along with a flag to specify abstract socket.
On non-supporting platforms, the abstract address will be
interpreted as an empty string and fail gracefully.
Also add new --abstract-unix-socket tool parameter.
Signed-off-by: Isaac Boukris <iboukris@gmail.com>
Reported-by: Chungtsun Li (typeless)
Reviewed-by: Daniel Stenberg
Reviewed-by: Peter Wu
Closes #1197
Fixes #1061
Diffstat (limited to 'docs')
-rw-r--r-- | docs/cmdline-opts/Makefile.am | 3 | ||||
-rw-r--r-- | docs/cmdline-opts/abstract-unix-socket.d | 9 | ||||
-rw-r--r-- | docs/curl.1 | 4 | ||||
-rw-r--r-- | docs/libcurl/curl_easy_setopt.3 | 2 | ||||
-rw-r--r-- | docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 | 58 | ||||
-rw-r--r-- | docs/libcurl/opts/Makefile.am | 3 | ||||
-rw-r--r-- | docs/libcurl/symbols-in-versions | 1 |
7 files changed, 79 insertions, 1 deletions
diff --git a/docs/cmdline-opts/Makefile.am b/docs/cmdline-opts/Makefile.am index 925f07fc1..4a10b9e5c 100644 --- a/docs/cmdline-opts/Makefile.am +++ b/docs/cmdline-opts/Makefile.am @@ -22,7 +22,8 @@ AUTOMAKE_OPTIONS = foreign no-dependencies -DPAGES = anyauth.d append.d basic.d cacert.d capath.d cert.d \ +DPAGES = abstract-unix-socket.d anyauth.d \ + append.d basic.d cacert.d capath.d cert.d \ cert-status.d cert-type.d ciphers.d compressed.d config.d \ connect-timeout.d connect-to.d continue-at.d cookie.d cookie-jar.d \ create-dirs.d crlf.d crlfile.d data-ascii.d data-binary.d data.d \ diff --git a/docs/cmdline-opts/abstract-unix-socket.d b/docs/cmdline-opts/abstract-unix-socket.d new file mode 100644 index 000000000..bb4467b67 --- /dev/null +++ b/docs/cmdline-opts/abstract-unix-socket.d @@ -0,0 +1,9 @@ +Long: abstract-unix-socket +Arg: <path> +Help: Connect through an abstract Unix domain socket +Added: 7.53.0 +Protocols: HTTP +--- +Connect through an abstract Unix domain socket, instead of using the network. +Note: netstat shows the path of an abstract socket prefixed with '@', however +the <path> argument should not have this leading character. diff --git a/docs/curl.1 b/docs/curl.1 index ce54fb2f1..b930b246f 100644 --- a/docs/curl.1 +++ b/docs/curl.1 @@ -139,6 +139,10 @@ but prefix it with "no-". However, in this list we mostly only list and show the --option version of them. (This concept with --no options was added in 7.19.0. Previously most options were toggled on/off on repeated use of the same command line option.) +.IP "--abstract-unix-socket <path>" +(HTTP) Connect through an abstract Unix domain socket, instead of using the network. + +Added in 7.53.0. .IP "--anyauth" (HTTP) Tells curl to figure out authentication method by itself, and use the most secure one the remote site claims to support. This is done by first doing a diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index a130a8a08..66f573464 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -207,6 +207,8 @@ Idle time before sending keep-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP Interval between keep-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP .IP CURLOPT_UNIX_SOCKET_PATH Path to a Unix domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP +.IP CURLOPT_ABSTRACT_UNIX_SOCKET +Path to an abstract Unix domain socket. See \fICURLOPT_ABSTRACT_UNIX_SOCKET(3)\fP .SH NAMES and PASSWORDS OPTIONS (Authentication) .IP CURLOPT_NETRC Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP diff --git a/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 b/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 new file mode 100644 index 000000000..8b61854c0 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 @@ -0,0 +1,58 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH CURLOPT_ABSTRACT_UNIX_SOCKET 3 "08 Jan 2017" "libcurl 7.53.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_ABSTRACT_UNIX_SOCKET \- set an abstract Unix domain socket +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ABSTRACT_UNIX_SOCKET, char *path); +.SH DESCRIPTION +Enables the use of an abstract Unix domain socket instead of establishing a TCP +connection to a host. The parameter should be a char * to a zero terminated string +holding the path of the socket. The path will be set to \fIpath\fP prefixed by a +NULL byte (this is the convention for abstract sockets, however it should be stressed +that the path passed to this function should not contain a leading NULL). + +On non-supporting platforms, the abstract address will be interpreted as an empty +string and fail gracefully, generating a run-time error. + +This option shares the same semantics as +.BR CURLOPT_UNIX_SOCKET_PATH "(3) +in which documentation more details can be found. Internally, these two options share +the same storage and therefore only one of them can be set per handle. + +.SH DEFAULT +Default is NULL. +.SH EXAMPLE +.nf + curl_easy_setopt(curl_handle, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock"); + curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/"); +.fi + +.SH AVAILABILITY +Since 7.53.0. +.SH RETURN VALUE +Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_UNIX_SOCKET_PATH "(3), " unix "(7), " diff --git a/docs/libcurl/opts/Makefile.am b/docs/libcurl/opts/Makefile.am index eb7ca1bb5..80f28ca9b 100644 --- a/docs/libcurl/opts/Makefile.am +++ b/docs/libcurl/opts/Makefile.am @@ -87,6 +87,7 @@ man_MANS = \ CURLMOPT_SOCKETFUNCTION.3 \ CURLMOPT_TIMERDATA.3 \ CURLMOPT_TIMERFUNCTION.3 \ + CURLOPT_ABSTRACT_UNIX_SOCKET.3 \ CURLOPT_ACCEPTTIMEOUT_MS.3 \ CURLOPT_ACCEPT_ENCODING.3 \ CURLOPT_ADDRESS_SCOPE.3 \ @@ -397,6 +398,7 @@ HTMLPAGES = \ CURLMOPT_SOCKETFUNCTION.html \ CURLMOPT_TIMERDATA.html \ CURLMOPT_TIMERFUNCTION.html \ + CURLOPT_ABSTRACT_UNIX_SOCKET.html \ CURLOPT_ACCEPTTIMEOUT_MS.html \ CURLOPT_ACCEPT_ENCODING.html \ CURLOPT_ADDRESS_SCOPE.html \ @@ -707,6 +709,7 @@ PDFPAGES = \ CURLMOPT_SOCKETFUNCTION.pdf \ CURLMOPT_TIMERDATA.pdf \ CURLMOPT_TIMERFUNCTION.pdf \ + CURLOPT_ABSTRACT_UNIX_SOCKET.pdf \ CURLOPT_ACCEPTTIMEOUT_MS.pdf \ CURLOPT_ACCEPT_ENCODING.pdf \ CURLOPT_ADDRESS_SCOPE.pdf \ diff --git a/docs/libcurl/symbols-in-versions b/docs/libcurl/symbols-in-versions index bd5960c2f..89672c5e9 100644 --- a/docs/libcurl/symbols-in-versions +++ b/docs/libcurl/symbols-in-versions @@ -317,6 +317,7 @@ CURLOPTTYPE_LONG 7.1 CURLOPTTYPE_OBJECTPOINT 7.1 CURLOPTTYPE_OFF_T 7.11.0 CURLOPTTYPE_STRINGPOINT 7.46.0 +CURLOPT_ABSTRACT_UNIX_SOCKET 7.53.0 CURLOPT_ACCEPTTIMEOUT_MS 7.24.0 CURLOPT_ACCEPT_ENCODING 7.21.6 CURLOPT_ADDRESS_SCOPE 7.19.0 |