ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rpc: don't allow starting RPC server on a TCP port

Browse Source 
`-r` and `--rpc-socket` command line options will now require
path for a UNIX domain domain socket. The socket can be still
exposed over TCP with external programs. Hence, for (some)
compatibility reasons, the test scripts, jsonrpc-client, and
rpc.py will still be able connect directly via TCP.

Change-Id: I22a935f1596ce5f9c313b5be42cb85f772368c03
Signed-off-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/605
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Community-CI: Mellanox Build Bot
This commit is contained in:
Darek Stojaczyk 2020-02-06 10:46:12 +01:00 committed by Tomasz Zawadzki
parent 8179b09e99
commit ba23cec182
3 changed files with 57 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@ -7,6 +7,12 @@
Add `opts_size` in `spdk_nvme_ctrlr_opts` structure in order to solve the compatiblity issue
for different ABI version.
### RPC
Command line parameters `-r` and `--rpc-socket` will longer accept TCP ports. RPC server
must now be started on a Unix domain socket. Exposing RPC on the network, as well as providing
proper authentication (if needed) is now a responsibility of the user.
### accel
A new API was added `spdk_accel_get_capabilities` that allows applications to
@ -21,6 +27,7 @@ A new capability, compare, was added via `spdk_accel_submit_compare`.
The software accel engine implemenation has added support for compare.
### dpdk
Updated DPDK submodule to DPDK 19.11.2, which includes fixes for DPDK vulnerabilities:
CVE-2020-10722, CVE-2020-10723, CVE-2020-10724, CVE-2020-10725, CVE-2020-10724.

3
lib/jsonrpc/jsonrpc_server_tcp.c
View File

@ -66,9 +66,6 @@ spdk_jsonrpc_server_listen(int domain, int protocol,
val = 1;
setsockopt(server->sockfd, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
if (protocol == IPPROTO_TCP) {
setsockopt(server->sockfd, IPPROTO_TCP, TCP_NODELAY, &val, sizeof(val));
}
flag = fcntl(server->sockfd, F_GETFL);
if (fcntl(server->sockfd, F_SETFL, flag | O_NONBLOCK) < 0) {

147
lib/rpc/rpc.c
View File

@ -43,8 +43,6 @@
#include "spdk/util.h"
#include "spdk/version.h"
#define RPC_DEFAULT_PORT "5260"
static struct sockaddr_un g_rpc_listen_addr_unix = {};
static char g_rpc_lock_path[sizeof(g_rpc_listen_addr_unix.sun_path) + sizeof(".lock")];
static int g_rpc_lock_fd = -1;
@ -139,108 +137,63 @@ jsonrpc_handler(struct spdk_jsonrpc_request *request,
int
spdk_rpc_listen(const char *listen_addr)
{
struct addrinfo hints;
struct addrinfo *res;
int rc;
memset(&g_rpc_listen_addr_unix, 0, sizeof(g_rpc_listen_addr_unix));
if (listen_addr[0] == '/') {
int rc;
g_rpc_listen_addr_unix.sun_family = AF_UNIX;
rc = snprintf(g_rpc_listen_addr_unix.sun_path,
sizeof(g_rpc_listen_addr_unix.sun_path),
"%s", listen_addr);
if (rc < 0 || (size_t)rc >= sizeof(g_rpc_listen_addr_unix.sun_path)) {
SPDK_ERRLOG("RPC Listen address Unix socket path too long\n");
g_rpc_listen_addr_unix.sun_path[0] = '\0';
return -1;
}
rc = snprintf(g_rpc_lock_path, sizeof(g_rpc_lock_path), "%s.lock",
g_rpc_listen_addr_unix.sun_path);
if (rc < 0 || (size_t)rc >= sizeof(g_rpc_lock_path)) {
SPDK_ERRLOG("RPC lock path too long\n");
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
g_rpc_lock_fd = open(g_rpc_lock_path, O_RDONLY | O_CREAT, 0600);
if (g_rpc_lock_fd == -1) {
SPDK_ERRLOG("Cannot open lock file %s: %s\n",
g_rpc_lock_path, spdk_strerror(errno));
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
rc = flock(g_rpc_lock_fd, LOCK_EX | LOCK_NB);
if (rc != 0) {
SPDK_ERRLOG("RPC Unix domain socket path %s in use. Specify another.\n",
g_rpc_listen_addr_unix.sun_path);
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
/*
* Since we acquired the lock, it is safe to delete the Unix socket file
* if it still exists from a previous process.
*/
unlink(g_rpc_listen_addr_unix.sun_path);
g_jsonrpc_server = spdk_jsonrpc_server_listen(AF_UNIX, 0,
(struct sockaddr *)&g_rpc_listen_addr_unix,
sizeof(g_rpc_listen_addr_unix),
jsonrpc_handler);
if (g_jsonrpc_server == NULL) {
close(g_rpc_lock_fd);
g_rpc_lock_fd = -1;
unlink(g_rpc_lock_path);
g_rpc_lock_path[0] = '\0';
}
} else {
char *tmp;
char *host, *port;
tmp = strdup(listen_addr);
if (!tmp) {
SPDK_ERRLOG("Out of memory\n");
return -1;
}
if (spdk_parse_ip_addr(tmp, &host, &port) < 0) {
free(tmp);
SPDK_ERRLOG("Invalid listen address '%s'\n", listen_addr);
return -1;
}
if (port == NULL) {
port = RPC_DEFAULT_PORT;
}
memset(&hints, 0, sizeof(hints));
hints.ai_family = AF_UNSPEC;
hints.ai_socktype = SOCK_STREAM;
hints.ai_protocol = IPPROTO_TCP;
if (getaddrinfo(host, port, &hints, &res) != 0) {
free(tmp);
SPDK_ERRLOG("Unable to look up RPC listen address '%s'\n", listen_addr);
return -1;
}
g_jsonrpc_server = spdk_jsonrpc_server_listen(res->ai_family, res->ai_protocol,
res->ai_addr, res->ai_addrlen,
jsonrpc_handler);
freeaddrinfo(res);
free(tmp);
g_rpc_listen_addr_unix.sun_family = AF_UNIX;
rc = snprintf(g_rpc_listen_addr_unix.sun_path,
sizeof(g_rpc_listen_addr_unix.sun_path),
"%s", listen_addr);
if (rc < 0 || (size_t)rc >= sizeof(g_rpc_listen_addr_unix.sun_path)) {
SPDK_ERRLOG("RPC Listen address Unix socket path too long\n");
g_rpc_listen_addr_unix.sun_path[0] = '\0';
return -1;
}
rc = snprintf(g_rpc_lock_path, sizeof(g_rpc_lock_path), "%s.lock",
g_rpc_listen_addr_unix.sun_path);
if (rc < 0 || (size_t)rc >= sizeof(g_rpc_lock_path)) {
SPDK_ERRLOG("RPC lock path too long\n");
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
g_rpc_lock_fd = open(g_rpc_lock_path, O_RDONLY | O_CREAT, 0600);
if (g_rpc_lock_fd == -1) {
SPDK_ERRLOG("Cannot open lock file %s: %s\n",
g_rpc_lock_path, spdk_strerror(errno));
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
rc = flock(g_rpc_lock_fd, LOCK_EX | LOCK_NB);
if (rc != 0) {
SPDK_ERRLOG("RPC Unix domain socket path %s in use. Specify another.\n",
g_rpc_listen_addr_unix.sun_path);
g_rpc_listen_addr_unix.sun_path[0] = '\0';
g_rpc_lock_path[0] = '\0';
return -1;
}
/*
* Since we acquired the lock, it is safe to delete the Unix socket file
* if it still exists from a previous process.
*/
unlink(g_rpc_listen_addr_unix.sun_path);
g_jsonrpc_server = spdk_jsonrpc_server_listen(AF_UNIX, 0,
(struct sockaddr *)&g_rpc_listen_addr_unix,
sizeof(g_rpc_listen_addr_unix),
jsonrpc_handler);
if (g_jsonrpc_server == NULL) {
SPDK_ERRLOG("spdk_jsonrpc_server_listen() failed\n");
close(g_rpc_lock_fd);
g_rpc_lock_fd = -1;
unlink(g_rpc_lock_path);
g_rpc_lock_path[0] = '\0';
return -1;
}