2009-08-12 09:40:16 +02:00
|
|
|
/*
|
2015-01-22 10:32:06 +01:00
|
|
|
Copyright (c) 2007-2015 Contributors as noted in the AUTHORS file
|
2009-08-12 09:40:16 +02:00
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
This file is part of libzmq, the ZeroMQ core engine in C++.
|
2009-08-12 09:40:16 +02:00
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
libzmq is free software; you can redistribute it and/or modify it under
|
|
|
|
the terms of the GNU Lesser General Public License (LGPL) as published
|
|
|
|
by the Free Software Foundation; either version 3 of the License, or
|
2009-08-12 09:40:16 +02:00
|
|
|
(at your option) any later version.
|
|
|
|
|
2015-06-02 22:33:55 +02:00
|
|
|
As a special exception, the Contributors give you permission to link
|
|
|
|
this library with independent modules to produce an executable,
|
|
|
|
regardless of the license terms of these independent modules, and to
|
|
|
|
copy and distribute the resulting executable under terms of your choice,
|
|
|
|
provided that you also meet, for each linked independent module, the
|
|
|
|
terms and conditions of the license of that module. An independent
|
|
|
|
module is a module which is not derived from or based on this library.
|
|
|
|
If you modify this library, you must extend this exception to your
|
|
|
|
version of the library.
|
|
|
|
|
|
|
|
libzmq is distributed in the hope that it will be useful, but WITHOUT
|
|
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
|
|
|
|
License for more details.
|
2009-08-12 09:40:16 +02:00
|
|
|
|
2010-10-30 15:08:28 +02:00
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
2009-08-12 09:40:16 +02:00
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2010-04-09 13:04:15 +02:00
|
|
|
#include <string.h>
|
|
|
|
|
2009-08-12 09:40:16 +02:00
|
|
|
#include "options.hpp"
|
2009-09-21 14:39:59 +02:00
|
|
|
#include "err.hpp"
|
2013-09-15 20:07:33 +02:00
|
|
|
#include "../include/zmq_utils.h"
|
2009-08-12 09:40:16 +02:00
|
|
|
|
|
|
|
zmq::options_t::options_t () :
|
2011-10-06 13:12:49 +02:00
|
|
|
sndhwm (1000),
|
|
|
|
rcvhwm (1000),
|
2009-09-11 17:58:37 +02:00
|
|
|
affinity (0),
|
2011-11-02 14:33:58 +01:00
|
|
|
identity_size (0),
|
2009-09-14 11:25:57 +02:00
|
|
|
rate (100),
|
2011-03-24 14:36:40 +01:00
|
|
|
recovery_ivl (10000),
|
2011-05-15 18:25:43 +02:00
|
|
|
multicast_hops (1),
|
2015-11-23 20:35:02 +01:00
|
|
|
multicast_maxtpdu (1500),
|
2015-07-06 17:05:31 +02:00
|
|
|
sndbuf (-1),
|
|
|
|
rcvbuf (-1),
|
2013-11-25 04:01:21 +01:00
|
|
|
tos (0),
|
2010-09-28 15:27:45 +02:00
|
|
|
type (-1),
|
2014-11-17 11:56:59 +01:00
|
|
|
linger (-1),
|
2015-08-04 14:47:07 +02:00
|
|
|
connect_timeout (0),
|
2015-08-06 17:36:27 +02:00
|
|
|
tcp_retransmit_timeout (0),
|
2010-10-17 09:54:12 +02:00
|
|
|
reconnect_ivl (100),
|
2011-01-26 07:01:06 +01:00
|
|
|
reconnect_ivl_max (0),
|
2010-10-17 10:23:58 +02:00
|
|
|
backlog (100),
|
2011-03-02 09:00:36 +01:00
|
|
|
maxmsgsize (-1),
|
2011-06-17 12:22:02 +02:00
|
|
|
rcvtimeo (-1),
|
|
|
|
sndtimeo (-1),
|
2013-01-31 20:47:45 +01:00
|
|
|
ipv6 (0),
|
2013-03-12 16:11:19 +01:00
|
|
|
immediate (0),
|
2011-11-04 08:00:47 +01:00
|
|
|
filter (false),
|
2015-01-26 15:59:19 +01:00
|
|
|
invert_matching(false),
|
2012-03-20 01:41:20 +01:00
|
|
|
recv_identity (false),
|
2015-01-23 15:25:40 +01:00
|
|
|
raw_socket (false),
|
2015-07-23 23:20:31 +02:00
|
|
|
raw_notify (true),
|
2012-04-05 17:39:53 +02:00
|
|
|
tcp_keepalive (-1),
|
|
|
|
tcp_keepalive_cnt (-1),
|
|
|
|
tcp_keepalive_idle (-1),
|
|
|
|
tcp_keepalive_intvl (-1),
|
2015-11-13 10:44:53 +01:00
|
|
|
tcp_recv_buffer_size (8192),
|
|
|
|
tcp_send_buffer_size (8192),
|
2013-05-15 17:54:03 +02:00
|
|
|
mechanism (ZMQ_NULL),
|
2013-05-17 17:46:30 +02:00
|
|
|
as_server (0),
|
2014-04-23 21:45:13 +02:00
|
|
|
gss_plaintext (false),
|
2013-08-17 21:59:07 +02:00
|
|
|
socket_id (0),
|
2014-05-09 15:54:24 +02:00
|
|
|
conflate (false),
|
2015-06-05 11:43:40 +02:00
|
|
|
handshake_ivl (30000),
|
2015-03-17 02:39:16 +01:00
|
|
|
connected (false),
|
|
|
|
heartbeat_ttl (0),
|
|
|
|
heartbeat_interval (0),
|
2015-06-26 20:08:08 +02:00
|
|
|
heartbeat_timeout (-1)
|
2009-08-12 09:40:16 +02:00
|
|
|
{
|
|
|
|
}
|
2009-09-21 14:39:59 +02:00
|
|
|
|
|
|
|
int zmq::options_t::setsockopt (int option_, const void *optval_,
|
|
|
|
size_t optvallen_)
|
|
|
|
{
|
2013-01-30 23:53:09 +01:00
|
|
|
bool is_int = (optvallen_ == sizeof (int));
|
|
|
|
int value = is_int? *((int *) optval_): 0;
|
2014-06-17 16:14:19 +02:00
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
Problem: API violations are treated as recoverable errors
The example is applications passing invalid arguments to a socket option
and then failing to check the return code. The results can be very hard
to diagnose. Here are some threads that show the pain this causes:
* https://github.com/zeromq/zyre/issues/179
* http://lists.zeromq.org/pipermail/zeromq-dev/2014-June/026388.html
One common argument is that a library should never assert, and should
pass errors back to the calling application. The counter argument is
that when an application is broken enough to pass garbage to libzmq,
it cannot be trusted to handle the resulting errors properly. Empirical
evidence from CZMQ, where we systematically assert on bad arguments, is
that this militant approach makes applications more, not less, robust.
I don't see any valid use cases for returning errors on bad arguments,
with one exception: zmq_setsockopt can be used to probe whether libzmq
was e.g. built with CURVE security. I'd argue that it's nasty to use a
side effect like this. If apps need to probe how libzmq was built, this
should be done explicitly, and for ALL build options, not just CURVE.
There are/were no libzmq test cases that check the return code for an
invalid option.
For now I've enabled militant assertions using --with-militant at
configure time. However I'd like to make this the default setting.
2014-06-17 15:49:52 +02:00
|
|
|
bool malformed = true; // Did caller pass a bad option value?
|
2014-06-17 16:14:19 +02:00
|
|
|
#endif
|
2014-06-17 16:24:56 +02:00
|
|
|
|
2009-09-21 14:39:59 +02:00
|
|
|
switch (option_) {
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_SNDHWM:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
sndhwm = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RCVHWM:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
rcvhwm = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2009-09-21 14:39:59 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_AFFINITY:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (optvallen_ == sizeof (uint64_t)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
affinity = *((uint64_t*) optval_);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_IDENTITY:
|
2014-05-15 16:31:32 +02:00
|
|
|
// Identity is any binary string from 1 to 255 octets
|
|
|
|
if (optvallen_ > 0 && optvallen_ < 256) {
|
2015-04-22 07:26:32 +02:00
|
|
|
identity_size = (unsigned char) optvallen_;
|
2013-01-30 23:53:09 +01:00
|
|
|
memcpy (identity, optval_, identity_size);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
2013-01-30 23:53:09 +01:00
|
|
|
}
|
|
|
|
break;
|
2009-09-21 14:39:59 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RATE:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value > 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
rate = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2009-09-21 14:39:59 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RECOVERY_IVL:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
recovery_ivl = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2011-11-02 14:33:58 +01:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_SNDBUF:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
sndbuf = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-11-02 14:33:58 +01:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RCVBUF:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
rcvbuf = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2012-04-13 11:26:57 +02:00
|
|
|
|
2013-11-25 04:01:21 +01:00
|
|
|
case ZMQ_TOS:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
tos = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_LINGER:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= -1) {
|
2013-01-30 23:53:09 +01:00
|
|
|
linger = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2009-09-21 14:39:59 +02:00
|
|
|
|
2015-08-04 14:47:07 +02:00
|
|
|
case ZMQ_CONNECT_TIMEOUT:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
connect_timeout = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-08-06 17:36:27 +02:00
|
|
|
case ZMQ_TCP_RETRANSMIT_TIMEOUT:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
tcp_retransmit_timeout = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RECONNECT_IVL:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= -1) {
|
2013-01-30 23:53:09 +01:00
|
|
|
reconnect_ivl = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2009-12-10 09:47:24 +01:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RECONNECT_IVL_MAX:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
reconnect_ivl_max = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2010-10-16 10:53:29 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_BACKLOG:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
backlog = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2010-10-17 09:54:12 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_MAXMSGSIZE:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (optvallen_ == sizeof (int64_t)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
maxmsgsize = *((int64_t *) optval_);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-02-20 14:05:55 +01:00
|
|
|
break;
|
2010-10-17 10:23:58 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_MULTICAST_HOPS:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value > 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
multicast_hops = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-01-26 07:01:06 +01:00
|
|
|
|
2015-11-23 20:35:02 +01:00
|
|
|
case ZMQ_MULTICAST_MAXTPDU:
|
|
|
|
if (is_int && value > 0) {
|
|
|
|
multicast_maxtpdu = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_RCVTIMEO:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= -1) {
|
2013-01-30 23:53:09 +01:00
|
|
|
rcvtimeo = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2010-10-17 10:23:58 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_SNDTIMEO:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && value >= -1) {
|
2013-01-30 23:53:09 +01:00
|
|
|
sndtimeo = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-03-02 09:00:36 +01:00
|
|
|
|
2013-01-31 20:47:45 +01:00
|
|
|
/* Deprecated in favor of ZMQ_IPV6 */
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_IPV4ONLY:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
2013-02-19 14:18:50 +01:00
|
|
|
ipv6 = (value == 0);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-05-15 18:25:43 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
/* To replace the somewhat surprising IPV4ONLY */
|
|
|
|
case ZMQ_IPV6:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
2013-02-19 14:18:50 +01:00
|
|
|
ipv6 = (value != 0);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-06-17 12:22:02 +02:00
|
|
|
|
2014-06-22 10:32:22 +02:00
|
|
|
case ZMQ_SOCKS_PROXY:
|
|
|
|
if (optval_ == NULL && optvallen_ == 0) {
|
|
|
|
socks_proxy_address.clear ();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (optval_ != NULL && optvallen_ > 0 ) {
|
|
|
|
socks_proxy_address =
|
|
|
|
std::string ((const char *) optval_, optvallen_);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_TCP_KEEPALIVE:
|
2014-01-31 12:02:42 +01:00
|
|
|
if (is_int && (value == -1 || value == 0 || value == 1)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
tcp_keepalive = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2011-06-17 12:22:02 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_TCP_KEEPALIVE_CNT:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == -1 || value >= 0)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
tcp_keepalive_cnt = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2009-09-21 14:39:59 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_TCP_KEEPALIVE_IDLE:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == -1 || value >= 0)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
tcp_keepalive_idle = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2012-04-05 17:39:53 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_TCP_KEEPALIVE_INTVL:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == -1 || value >= 0)) {
|
2013-01-30 23:53:09 +01:00
|
|
|
tcp_keepalive_intvl = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2015-10-08 22:06:33 +02:00
|
|
|
case ZMQ_TCP_RECV_BUFFER:
|
2015-11-13 10:44:53 +01:00
|
|
|
if (is_int && (value > 0) ) {
|
|
|
|
tcp_recv_buffer_size = static_cast<unsigned int>(value);
|
|
|
|
return 0;
|
2015-10-08 22:06:33 +02:00
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_TCP_SEND_BUFFER:
|
2015-11-13 10:44:53 +01:00
|
|
|
if (is_int && (value > 0) ) {
|
|
|
|
tcp_send_buffer_size = static_cast<unsigned int>(value);
|
|
|
|
return 0;
|
2015-10-08 22:06:33 +02:00
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-03-12 16:11:19 +01:00
|
|
|
case ZMQ_IMMEDIATE:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
2013-03-12 16:11:19 +01:00
|
|
|
immediate = value;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2012-04-12 16:37:14 +02:00
|
|
|
|
2013-01-30 23:53:09 +01:00
|
|
|
case ZMQ_TCP_ACCEPT_FILTER:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
2012-04-12 16:37:14 +02:00
|
|
|
tcp_accept_filters.clear ();
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2012-04-12 16:37:14 +02:00
|
|
|
else
|
2013-05-15 17:54:03 +02:00
|
|
|
if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL && *((const char*) optval_) != 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
std::string filter_str ((const char *) optval_, optvallen_);
|
2013-01-01 10:24:51 +01:00
|
|
|
tcp_address_mask_t mask;
|
2013-01-31 20:47:45 +01:00
|
|
|
int rc = mask.resolve (filter_str.c_str (), ipv6);
|
2013-05-15 17:54:03 +02:00
|
|
|
if (rc == 0) {
|
2013-01-30 23:53:09 +01:00
|
|
|
tcp_accept_filters.push_back (mask);
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-12-04 23:17:39 +01:00
|
|
|
# if defined ZMQ_HAVE_SO_PEERCRED || defined ZMQ_HAVE_LOCAL_PEERCRED
|
2013-12-06 18:58:10 +01:00
|
|
|
case ZMQ_IPC_FILTER_UID:
|
2013-12-04 23:17:39 +01:00
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
|
|
|
ipc_uid_accept_filters.clear ();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (optvallen_ == sizeof (uid_t) && optval_ != NULL) {
|
|
|
|
ipc_uid_accept_filters.insert (*((uid_t *) optval_));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-12-06 18:58:10 +01:00
|
|
|
case ZMQ_IPC_FILTER_GID:
|
2013-12-04 23:17:39 +01:00
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
|
|
|
ipc_gid_accept_filters.clear ();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (optvallen_ == sizeof (gid_t) && optval_ != NULL) {
|
|
|
|
ipc_gid_accept_filters.insert (*((gid_t *) optval_));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
# endif
|
|
|
|
|
|
|
|
# if defined ZMQ_HAVE_SO_PEERCRED
|
2013-12-06 18:58:10 +01:00
|
|
|
case ZMQ_IPC_FILTER_PID:
|
2013-12-04 23:17:39 +01:00
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
|
|
|
ipc_pid_accept_filters.clear ();
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (optvallen_ == sizeof (pid_t) && optval_ != NULL) {
|
|
|
|
ipc_pid_accept_filters.insert (*((pid_t *) optval_));
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
# endif
|
|
|
|
|
2013-09-17 14:05:41 +02:00
|
|
|
case ZMQ_PLAIN_SERVER:
|
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
2013-05-17 17:46:30 +02:00
|
|
|
as_server = value;
|
2013-09-17 14:05:41 +02:00
|
|
|
mechanism = value? ZMQ_PLAIN: ZMQ_NULL;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_PLAIN_USERNAME:
|
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
|
|
|
mechanism = ZMQ_NULL;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
2013-07-03 22:30:48 +02:00
|
|
|
if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
|
2013-05-15 17:54:03 +02:00
|
|
|
plain_username.assign ((const char *) optval_, optvallen_);
|
2013-09-17 14:05:41 +02:00
|
|
|
as_server = 0;
|
2013-05-15 17:54:03 +02:00
|
|
|
mechanism = ZMQ_PLAIN;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_PLAIN_PASSWORD:
|
|
|
|
if (optvallen_ == 0 && optval_ == NULL) {
|
|
|
|
mechanism = ZMQ_NULL;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
2013-07-03 22:30:48 +02:00
|
|
|
if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
|
2013-05-15 17:54:03 +02:00
|
|
|
plain_password.assign ((const char *) optval_, optvallen_);
|
2013-09-17 14:05:41 +02:00
|
|
|
as_server = 0;
|
2013-05-15 17:54:03 +02:00
|
|
|
mechanism = ZMQ_PLAIN;
|
|
|
|
return 0;
|
2012-04-12 16:37:14 +02:00
|
|
|
}
|
2013-01-30 23:53:09 +01:00
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
|
|
|
case ZMQ_ZAP_DOMAIN:
|
2013-09-26 11:33:44 +02:00
|
|
|
if (optvallen_ < 256) {
|
2013-09-09 20:40:34 +02:00
|
|
|
zap_domain.assign ((const char *) optval_, optvallen_);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
Added Z85 support
The use of binary for CURVE keys is painful; you cannot easily copy
these in e.g. email, or use them directly in source code. There are
various encoding possibilities. Base16 and Base64 are not optimal.
Ascii85 is not safe for source (it generates quotes and escapes).
So, I've designed a new Base85 encoding, Z85, which is safe to use
in code and elsewhere, and I've modified libzmq to use this where
it also uses binary keys (in get/setsockopt).
Very simply, if you use a 32-byte value, it's Base256 (binary),
and if you use a 40-byte value, it's Base85 (Z85).
I've put the Z85 codec into z85_codec.hpp, it's not elegant C++
but it is minimal and it works. Feel free to rewrap as a real class
if this annoys you.
2013-06-28 22:10:22 +02:00
|
|
|
// If libsodium isn't installed, these options provoke EINVAL
|
2013-06-28 12:04:01 +02:00
|
|
|
# ifdef HAVE_LIBSODIUM
|
2013-09-17 14:05:41 +02:00
|
|
|
case ZMQ_CURVE_SERVER:
|
2013-09-17 14:05:55 +02:00
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
2013-06-20 18:09:12 +02:00
|
|
|
as_server = value;
|
2013-09-17 14:05:55 +02:00
|
|
|
mechanism = value? ZMQ_CURVE: ZMQ_NULL;
|
2013-06-20 18:09:12 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_PUBLICKEY:
|
2014-08-09 10:24:26 +02:00
|
|
|
// TODO: refactor repeated code for these three options
|
|
|
|
// into set_curve_key (destination, optval, optlen) method
|
|
|
|
// ==> set_curve_key (curve_public_key, optval_, optvallen_);
|
2013-09-17 14:05:55 +02:00
|
|
|
if (optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (curve_public_key, optval_, CURVE_KEYSIZE);
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
2014-08-09 10:24:26 +02:00
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_public_key, (char *) optval_)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
2013-09-17 14:05:55 +02:00
|
|
|
}
|
2014-08-09 10:24:26 +02:00
|
|
|
else
|
|
|
|
// Deprecated, not symmetrical with zmq_getsockopt
|
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85) {
|
2014-11-07 16:56:49 +01:00
|
|
|
char z85_key [CURVE_KEYSIZE_Z85 + 1];
|
2014-08-09 10:24:26 +02:00
|
|
|
memcpy (z85_key, (char *) optval_, CURVE_KEYSIZE_Z85);
|
|
|
|
z85_key [CURVE_KEYSIZE_Z85] = 0;
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_public_key, z85_key)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
2014-08-09 10:24:26 +02:00
|
|
|
}
|
2013-06-20 18:09:12 +02:00
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_SECRETKEY:
|
|
|
|
if (optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (curve_secret_key, optval_, CURVE_KEYSIZE);
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
2014-08-09 10:24:26 +02:00
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_secret_key, (char *) optval_)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
2013-09-17 14:05:55 +02:00
|
|
|
}
|
2014-08-09 10:24:26 +02:00
|
|
|
else
|
|
|
|
// Deprecated, not symmetrical with zmq_getsockopt
|
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85) {
|
2014-11-07 16:56:49 +01:00
|
|
|
char z85_key [CURVE_KEYSIZE_Z85 + 1];
|
2014-08-09 10:24:26 +02:00
|
|
|
memcpy (z85_key, (char *) optval_, CURVE_KEYSIZE_Z85);
|
|
|
|
z85_key [CURVE_KEYSIZE_Z85] = 0;
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_secret_key, z85_key)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
return 0;
|
|
|
|
}
|
2014-08-09 10:24:26 +02:00
|
|
|
}
|
2013-09-17 12:44:14 +02:00
|
|
|
break;
|
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_SERVERKEY:
|
|
|
|
if (optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (curve_server_key, optval_, CURVE_KEYSIZE);
|
|
|
|
mechanism = ZMQ_CURVE;
|
2014-08-09 10:24:26 +02:00
|
|
|
as_server = 0;
|
2013-09-17 14:05:55 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
2014-08-09 10:24:26 +02:00
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_server_key, (char *) optval_)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
as_server = 0;
|
|
|
|
return 0;
|
|
|
|
}
|
2014-08-09 10:24:26 +02:00
|
|
|
}
|
|
|
|
else
|
|
|
|
// Deprecated, not symmetrical with zmq_getsockopt
|
|
|
|
if (optvallen_ == CURVE_KEYSIZE_Z85) {
|
2014-11-07 16:56:49 +01:00
|
|
|
char z85_key [CURVE_KEYSIZE_Z85 + 1];
|
2014-08-09 10:24:26 +02:00
|
|
|
memcpy (z85_key, (char *) optval_, CURVE_KEYSIZE_Z85);
|
|
|
|
z85_key [CURVE_KEYSIZE_Z85] = 0;
|
2014-11-07 16:56:49 +01:00
|
|
|
if (zmq_z85_decode (curve_server_key, z85_key)) {
|
|
|
|
mechanism = ZMQ_CURVE;
|
|
|
|
as_server = 0;
|
|
|
|
return 0;
|
|
|
|
}
|
2013-09-17 14:05:55 +02:00
|
|
|
}
|
2013-06-20 18:09:12 +02:00
|
|
|
break;
|
2013-06-28 12:04:01 +02:00
|
|
|
# endif
|
2014-08-12 09:31:19 +02:00
|
|
|
|
2013-08-17 21:59:07 +02:00
|
|
|
case ZMQ_CONFLATE:
|
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
|
|
|
conflate = (value != 0);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-06-17 16:32:47 +02:00
|
|
|
|
|
|
|
// If libgssapi isn't installed, these options provoke EINVAL
|
|
|
|
# ifdef HAVE_LIBGSSAPI_KRB5
|
2013-09-25 05:20:01 +02:00
|
|
|
case ZMQ_GSSAPI_SERVER:
|
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
|
|
|
as_server = value;
|
|
|
|
mechanism = ZMQ_GSSAPI;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-06-17 16:32:47 +02:00
|
|
|
|
2014-04-23 19:20:22 +02:00
|
|
|
case ZMQ_GSSAPI_PRINCIPAL:
|
2013-11-20 23:01:16 +01:00
|
|
|
if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
|
2014-04-23 19:20:22 +02:00
|
|
|
gss_principal.assign ((const char *) optval_, optvallen_);
|
2013-11-20 23:01:16 +01:00
|
|
|
mechanism = ZMQ_GSSAPI;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2014-04-23 19:20:22 +02:00
|
|
|
case ZMQ_GSSAPI_SERVICE_PRINCIPAL:
|
2013-11-20 23:01:16 +01:00
|
|
|
if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
|
2014-04-23 19:20:22 +02:00
|
|
|
gss_service_principal.assign ((const char *) optval_, optvallen_);
|
2013-09-25 05:20:01 +02:00
|
|
|
mechanism = ZMQ_GSSAPI;
|
2013-11-21 19:46:23 +01:00
|
|
|
as_server = 0;
|
2013-09-25 05:20:01 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-08-17 21:59:07 +02:00
|
|
|
|
2014-04-23 20:01:54 +02:00
|
|
|
case ZMQ_GSSAPI_PLAINTEXT:
|
|
|
|
if (is_int && (value == 0 || value == 1)) {
|
|
|
|
gss_plaintext = (value != 0);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-06-17 16:32:47 +02:00
|
|
|
# endif
|
|
|
|
|
2014-05-09 15:54:24 +02:00
|
|
|
case ZMQ_HANDSHAKE_IVL:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
handshake_ivl = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-01-26 15:59:19 +01:00
|
|
|
case ZMQ_INVERT_MATCHING:
|
|
|
|
if (is_int) {
|
|
|
|
invert_matching = (value != 0);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-03-17 02:39:16 +01:00
|
|
|
case ZMQ_HEARTBEAT_IVL:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
heartbeat_interval = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_HEARTBEAT_TTL:
|
2015-06-26 20:08:08 +02:00
|
|
|
// Convert this to deciseconds from milliseconds
|
|
|
|
value = value / 100;
|
|
|
|
if (is_int && value >= 0 && value <= 6553) {
|
2015-03-17 02:39:16 +01:00
|
|
|
heartbeat_ttl = (uint16_t)value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_HEARTBEAT_TIMEOUT:
|
|
|
|
if (is_int && value >= 0) {
|
|
|
|
heartbeat_timeout = value;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-08-17 21:59:07 +02:00
|
|
|
default:
|
2014-06-17 16:14:19 +02:00
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
Problem: API violations are treated as recoverable errors
The example is applications passing invalid arguments to a socket option
and then failing to check the return code. The results can be very hard
to diagnose. Here are some threads that show the pain this causes:
* https://github.com/zeromq/zyre/issues/179
* http://lists.zeromq.org/pipermail/zeromq-dev/2014-June/026388.html
One common argument is that a library should never assert, and should
pass errors back to the calling application. The counter argument is
that when an application is broken enough to pass garbage to libzmq,
it cannot be trusted to handle the resulting errors properly. Empirical
evidence from CZMQ, where we systematically assert on bad arguments, is
that this militant approach makes applications more, not less, robust.
I don't see any valid use cases for returning errors on bad arguments,
with one exception: zmq_setsockopt can be used to probe whether libzmq
was e.g. built with CURVE security. I'd argue that it's nasty to use a
side effect like this. If apps need to probe how libzmq was built, this
should be done explicitly, and for ALL build options, not just CURVE.
There are/were no libzmq test cases that check the return code for an
invalid option.
For now I've enabled militant assertions using --with-militant at
configure time. However I'd like to make this the default setting.
2014-06-17 15:49:52 +02:00
|
|
|
// There are valid scenarios for probing with unknown socket option
|
|
|
|
// values, e.g. to check if security is enabled or not. This will not
|
|
|
|
// provoke a militant assert. However, passing bad values to a valid
|
|
|
|
// socket option will, if ZMQ_ACT_MILITANT is defined.
|
|
|
|
malformed = false;
|
2014-06-17 16:14:19 +02:00
|
|
|
#endif
|
2013-08-17 21:59:07 +02:00
|
|
|
break;
|
2013-01-30 23:53:09 +01:00
|
|
|
}
|
Problem: API violations are treated as recoverable errors
The example is applications passing invalid arguments to a socket option
and then failing to check the return code. The results can be very hard
to diagnose. Here are some threads that show the pain this causes:
* https://github.com/zeromq/zyre/issues/179
* http://lists.zeromq.org/pipermail/zeromq-dev/2014-June/026388.html
One common argument is that a library should never assert, and should
pass errors back to the calling application. The counter argument is
that when an application is broken enough to pass garbage to libzmq,
it cannot be trusted to handle the resulting errors properly. Empirical
evidence from CZMQ, where we systematically assert on bad arguments, is
that this militant approach makes applications more, not less, robust.
I don't see any valid use cases for returning errors on bad arguments,
with one exception: zmq_setsockopt can be used to probe whether libzmq
was e.g. built with CURVE security. I'd argue that it's nasty to use a
side effect like this. If apps need to probe how libzmq was built, this
should be done explicitly, and for ALL build options, not just CURVE.
There are/were no libzmq test cases that check the return code for an
invalid option.
For now I've enabled militant assertions using --with-militant at
configure time. However I'd like to make this the default setting.
2014-06-17 15:49:52 +02:00
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
|
|
|
// There is no valid use case for passing an error back to the application
|
|
|
|
// when it sent malformed arguments to a socket option. Use ./configure
|
|
|
|
// --with-militant to enable this checking.
|
|
|
|
if (malformed)
|
|
|
|
zmq_assert (false);
|
|
|
|
#endif
|
2013-05-15 17:54:03 +02:00
|
|
|
errno = EINVAL;
|
|
|
|
return -1;
|
2009-09-21 14:39:59 +02:00
|
|
|
}
|
2010-04-09 13:04:15 +02:00
|
|
|
|
2015-06-05 11:43:40 +02:00
|
|
|
int zmq::options_t::getsockopt (int option_, void *optval_, size_t *optvallen_) const
|
2010-04-09 13:04:15 +02:00
|
|
|
{
|
2013-05-15 17:54:03 +02:00
|
|
|
bool is_int = (*optvallen_ == sizeof (int));
|
|
|
|
int *value = (int *) optval_;
|
2014-06-17 16:24:56 +02:00
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
|
|
|
bool malformed = true; // Did caller pass a bad option value?
|
|
|
|
#endif
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2010-04-09 13:04:15 +02:00
|
|
|
switch (option_) {
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_SNDHWM:
|
|
|
|
if (is_int) {
|
|
|
|
*value = sndhwm;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_RCVHWM:
|
|
|
|
if (is_int) {
|
|
|
|
*value = rcvhwm;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_AFFINITY:
|
|
|
|
if (*optvallen_ == sizeof (uint64_t)) {
|
|
|
|
*((uint64_t *) optval_) = affinity;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_IDENTITY:
|
|
|
|
if (*optvallen_ >= identity_size) {
|
|
|
|
memcpy (optval_, identity, identity_size);
|
|
|
|
*optvallen_ = identity_size;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_RATE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = rate;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_RECOVERY_IVL:
|
|
|
|
if (is_int) {
|
|
|
|
*value = recovery_ivl;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_SNDBUF:
|
|
|
|
if (is_int) {
|
|
|
|
*value = sndbuf;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_RCVBUF:
|
|
|
|
if (is_int) {
|
|
|
|
*value = rcvbuf;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-11-25 04:01:21 +01:00
|
|
|
case ZMQ_TOS:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tos;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-08-12 09:31:19 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_TYPE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = type;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_LINGER:
|
|
|
|
if (is_int) {
|
|
|
|
*value = linger;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2010-04-09 13:04:15 +02:00
|
|
|
|
2015-08-04 14:47:07 +02:00
|
|
|
case ZMQ_CONNECT_TIMEOUT:
|
|
|
|
if (is_int) {
|
|
|
|
*value = connect_timeout;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-08-06 17:36:27 +02:00
|
|
|
case ZMQ_TCP_RETRANSMIT_TIMEOUT:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_retransmit_timeout;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_RECONNECT_IVL:
|
|
|
|
if (is_int) {
|
|
|
|
*value = reconnect_ivl;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_RECONNECT_IVL_MAX:
|
|
|
|
if (is_int) {
|
|
|
|
*value = reconnect_ivl_max;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_BACKLOG:
|
|
|
|
if (is_int) {
|
|
|
|
*value = backlog;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_MAXMSGSIZE:
|
|
|
|
if (*optvallen_ == sizeof (int64_t)) {
|
|
|
|
*((int64_t *) optval_) = maxmsgsize;
|
|
|
|
*optvallen_ = sizeof (int64_t);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_MULTICAST_HOPS:
|
|
|
|
if (is_int) {
|
|
|
|
*value = multicast_hops;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-11-23 20:35:02 +01:00
|
|
|
case ZMQ_MULTICAST_MAXTPDU:
|
|
|
|
if (is_int) {
|
|
|
|
*value = multicast_maxtpdu;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_RCVTIMEO:
|
|
|
|
if (is_int) {
|
|
|
|
*value = rcvtimeo;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_SNDTIMEO:
|
|
|
|
if (is_int) {
|
|
|
|
*value = sndtimeo;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_IPV4ONLY:
|
|
|
|
if (is_int) {
|
|
|
|
*value = 1 - ipv6;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_IPV6:
|
|
|
|
if (is_int) {
|
|
|
|
*value = ipv6;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_IMMEDIATE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = immediate;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2014-06-22 10:32:22 +02:00
|
|
|
case ZMQ_SOCKS_PROXY:
|
|
|
|
if (*optvallen_ >= socks_proxy_address.size () + 1) {
|
|
|
|
memcpy (optval_, socks_proxy_address.c_str (), socks_proxy_address.size () + 1);
|
|
|
|
*optvallen_ = socks_proxy_address.size () + 1;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_TCP_KEEPALIVE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_keepalive;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_TCP_KEEPALIVE_CNT:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_keepalive_cnt;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_TCP_KEEPALIVE_IDLE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_keepalive_idle;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_TCP_KEEPALIVE_INTVL:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_keepalive_intvl;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-10-08 22:06:33 +02:00
|
|
|
case ZMQ_TCP_SEND_BUFFER:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_send_buffer_size;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_TCP_RECV_BUFFER:
|
|
|
|
if (is_int) {
|
|
|
|
*value = tcp_recv_buffer_size;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_MECHANISM:
|
|
|
|
if (is_int) {
|
|
|
|
*value = mechanism;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-09-17 14:05:41 +02:00
|
|
|
case ZMQ_PLAIN_SERVER:
|
2013-05-15 17:54:03 +02:00
|
|
|
if (is_int) {
|
2013-09-17 14:05:41 +02:00
|
|
|
*value = as_server && mechanism == ZMQ_PLAIN;
|
2013-05-15 17:54:03 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_PLAIN_USERNAME:
|
|
|
|
if (*optvallen_ >= plain_username.size () + 1) {
|
|
|
|
memcpy (optval_, plain_username.c_str (), plain_username.size () + 1);
|
|
|
|
*optvallen_ = plain_username.size () + 1;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-05-15 17:54:03 +02:00
|
|
|
case ZMQ_PLAIN_PASSWORD:
|
|
|
|
if (*optvallen_ >= plain_password.size () + 1) {
|
|
|
|
memcpy (optval_, plain_password.c_str (), plain_password.size () + 1);
|
|
|
|
*optvallen_ = plain_password.size () + 1;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
|
|
|
case ZMQ_ZAP_DOMAIN:
|
|
|
|
if (*optvallen_ >= zap_domain.size () + 1) {
|
|
|
|
memcpy (optval_, zap_domain.c_str (), zap_domain.size () + 1);
|
|
|
|
*optvallen_ = zap_domain.size () + 1;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
Added Z85 support
The use of binary for CURVE keys is painful; you cannot easily copy
these in e.g. email, or use them directly in source code. There are
various encoding possibilities. Base16 and Base64 are not optimal.
Ascii85 is not safe for source (it generates quotes and escapes).
So, I've designed a new Base85 encoding, Z85, which is safe to use
in code and elsewhere, and I've modified libzmq to use this where
it also uses binary keys (in get/setsockopt).
Very simply, if you use a 32-byte value, it's Base256 (binary),
and if you use a 40-byte value, it's Base85 (Z85).
I've put the Z85 codec into z85_codec.hpp, it's not elegant C++
but it is minimal and it works. Feel free to rewrap as a real class
if this annoys you.
2013-06-28 22:10:22 +02:00
|
|
|
// If libsodium isn't installed, these options provoke EINVAL
|
2013-06-28 12:04:01 +02:00
|
|
|
# ifdef HAVE_LIBSODIUM
|
2013-09-17 14:05:41 +02:00
|
|
|
case ZMQ_CURVE_SERVER:
|
2013-06-20 18:09:12 +02:00
|
|
|
if (is_int) {
|
2013-09-17 14:05:55 +02:00
|
|
|
*value = as_server && mechanism == ZMQ_CURVE;
|
2013-06-20 18:09:12 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_PUBLICKEY:
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (optval_, curve_public_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
|
|
|
zmq_z85_encode ((char *) optval_, curve_public_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
2013-06-20 18:09:12 +02:00
|
|
|
break;
|
2013-09-09 20:40:34 +02:00
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_SECRETKEY:
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (optval_, curve_secret_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
|
|
|
zmq_z85_encode ((char *) optval_, curve_secret_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
2013-09-17 12:44:14 +02:00
|
|
|
break;
|
|
|
|
|
2013-09-17 14:05:55 +02:00
|
|
|
case ZMQ_CURVE_SERVERKEY:
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE) {
|
|
|
|
memcpy (optval_, curve_server_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
if (*optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
|
|
|
|
zmq_z85_encode ((char *) optval_, curve_server_key, CURVE_KEYSIZE);
|
|
|
|
return 0;
|
|
|
|
}
|
2013-06-20 18:09:12 +02:00
|
|
|
break;
|
2013-06-28 12:04:01 +02:00
|
|
|
# endif
|
2013-08-17 21:59:07 +02:00
|
|
|
|
|
|
|
case ZMQ_CONFLATE:
|
|
|
|
if (is_int) {
|
|
|
|
*value = conflate;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-08-12 09:31:19 +02:00
|
|
|
|
2014-06-17 16:32:47 +02:00
|
|
|
// If libgssapi isn't installed, these options provoke EINVAL
|
|
|
|
# ifdef HAVE_LIBGSSAPI_KRB5
|
2013-09-25 05:20:01 +02:00
|
|
|
case ZMQ_GSSAPI_SERVER:
|
|
|
|
if (is_int) {
|
|
|
|
*value = as_server && mechanism == ZMQ_GSSAPI;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-11-20 23:01:16 +01:00
|
|
|
|
2014-04-23 19:20:22 +02:00
|
|
|
case ZMQ_GSSAPI_PRINCIPAL:
|
|
|
|
if (*optvallen_ >= gss_principal.size () + 1) {
|
|
|
|
memcpy (optval_, gss_principal.c_str (), gss_principal.size () + 1);
|
|
|
|
*optvallen_ = gss_principal.size () + 1;
|
2013-09-25 05:20:01 +02:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-08-17 21:59:07 +02:00
|
|
|
|
2014-04-23 19:20:22 +02:00
|
|
|
case ZMQ_GSSAPI_SERVICE_PRINCIPAL:
|
|
|
|
if (*optvallen_ >= gss_service_principal.size () + 1) {
|
|
|
|
memcpy (optval_, gss_service_principal.c_str (), gss_service_principal.size () + 1);
|
|
|
|
*optvallen_ = gss_service_principal.size () + 1;
|
2013-11-20 23:01:16 +01:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2013-09-25 05:20:01 +02:00
|
|
|
|
2014-04-23 20:01:54 +02:00
|
|
|
case ZMQ_GSSAPI_PLAINTEXT:
|
|
|
|
if (is_int) {
|
|
|
|
*value = gss_plaintext;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-06-17 16:32:47 +02:00
|
|
|
#endif
|
|
|
|
|
2014-05-09 15:54:24 +02:00
|
|
|
case ZMQ_HANDSHAKE_IVL:
|
|
|
|
if (is_int) {
|
|
|
|
*value = handshake_ivl;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
2014-08-08 19:36:00 +02:00
|
|
|
|
2015-01-26 15:59:19 +01:00
|
|
|
case ZMQ_INVERT_MATCHING:
|
|
|
|
if (is_int) {
|
|
|
|
*value = invert_matching;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2015-03-17 02:39:16 +01:00
|
|
|
case ZMQ_HEARTBEAT_IVL:
|
|
|
|
if (is_int) {
|
|
|
|
*value = heartbeat_interval;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_HEARTBEAT_TTL:
|
|
|
|
if (is_int) {
|
2015-06-26 20:08:08 +02:00
|
|
|
// Convert the internal deciseconds value to milliseconds
|
|
|
|
*value = heartbeat_ttl * 100;
|
2015-03-17 02:39:16 +01:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case ZMQ_HEARTBEAT_TIMEOUT:
|
|
|
|
if (is_int) {
|
|
|
|
*value = heartbeat_timeout;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
2014-06-17 16:24:56 +02:00
|
|
|
default:
|
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
|
|
|
malformed = false;
|
|
|
|
#endif
|
|
|
|
break;
|
Problem: API violations are treated as recoverable errors
The example is applications passing invalid arguments to a socket option
and then failing to check the return code. The results can be very hard
to diagnose. Here are some threads that show the pain this causes:
* https://github.com/zeromq/zyre/issues/179
* http://lists.zeromq.org/pipermail/zeromq-dev/2014-June/026388.html
One common argument is that a library should never assert, and should
pass errors back to the calling application. The counter argument is
that when an application is broken enough to pass garbage to libzmq,
it cannot be trusted to handle the resulting errors properly. Empirical
evidence from CZMQ, where we systematically assert on bad arguments, is
that this militant approach makes applications more, not less, robust.
I don't see any valid use cases for returning errors on bad arguments,
with one exception: zmq_setsockopt can be used to probe whether libzmq
was e.g. built with CURVE security. I'd argue that it's nasty to use a
side effect like this. If apps need to probe how libzmq was built, this
should be done explicitly, and for ALL build options, not just CURVE.
There are/were no libzmq test cases that check the return code for an
invalid option.
For now I've enabled militant assertions using --with-militant at
configure time. However I'd like to make this the default setting.
2014-06-17 15:49:52 +02:00
|
|
|
}
|
2014-06-17 16:24:56 +02:00
|
|
|
#if defined (ZMQ_ACT_MILITANT)
|
|
|
|
if (malformed)
|
|
|
|
zmq_assert (false);
|
|
|
|
#endif
|
2010-04-09 13:04:15 +02:00
|
|
|
errno = EINVAL;
|
|
|
|
return -1;
|
|
|
|
}
|
2015-06-05 11:43:40 +02:00
|
|
|
|
|
|
|
bool zmq::options_t::is_valid (int option_) const
|
|
|
|
{
|
2015-06-05 18:14:55 +02:00
|
|
|
return true;
|
2015-06-05 11:43:40 +02:00
|
|
|
}
|