Commit 1d786fae authored by Isaac Boukris's avatar Isaac Boukris Committed by Peter Wu
Browse files

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: default avatarIsaac Boukris <iboukris@gmail.com>
Reported-by: Chungtsun Li (typeless)
Reviewed-by: Daniel Stenberg
Reviewed-by: Peter Wu
Closes #1197
Fixes #1061
parent a7c73ae3

docs/cmdline-opts/Makefile.am

+2 −1
Original line number Diff line number Diff line
@@ -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	\

docs/cmdline-opts/abstract-unix-socket.d

0 → 100644
+9 −0
Original line number Diff line number Diff line 
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.

docs/curl.1

+4 −0
Original line number Diff line number Diff line
@@ -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

docs/libcurl/curl_easy_setopt.3

+2 −0
Original line number Diff line number Diff line
@@ -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

docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3

0 → 100644
+58 −0
Original line number Diff line number Diff line 
.\" **************************************************************************

.\" *                                  _   _ ____  _

.\" *  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), "