options.cpp 32.5 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
5

6 7 8
    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
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    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.
25

26
    You should have received a copy of the GNU Lesser General Public License
27 28 29
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30
#include "precompiled.hpp"
31 32
#include <string.h>

33
#include "options.hpp"
34
#include "err.hpp"
35
#include "macros.hpp"
36

37 38 39 40 41 42 43 44 45 46
#ifndef ZMQ_HAVE_WINDOWS
#include <net/if.h>
#endif

#if defined IFNAMSIZ
#define BINDDEVSIZ IFNAMSIZ
#else
#define BINDDEVSIZ 16
#endif

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
static int sockopt_invalid ()
{
#if defined(ZMQ_ACT_MILITANT)
    zmq_assert (false);
#endif
    errno = EINVAL;
    return -1;
}

int zmq::do_getsockopt (void *const optval_,
                        size_t *const optvallen_,
                        const std::string &value_)
{
    return do_getsockopt (optval_, optvallen_, value_.c_str (),
                          value_.size () + 1);
}

int zmq::do_getsockopt (void *const optval_,
                        size_t *const optvallen_,
                        const void *value_,
                        const size_t value_len_)
{
    // TODO behaviour is inconsistent with options_t::getsockopt; there, an
    // *exact* length match is required except for string-like (but not the
    // CURVE keys!) (and therefore null-ing remaining memory is a no-op, see
    // comment below)
    if (*optvallen_ < value_len_) {
        return sockopt_invalid ();
    }
    memcpy (optval_, value_, value_len_);
    // TODO why is the remaining memory null-ed?
    memset ((char *) optval_ + value_len_, 0, *optvallen_ - value_len_);
    *optvallen_ = value_len_;
    return 0;
}

#ifdef ZMQ_HAVE_CURVE
static int do_getsockopt_curve_key (void *const optval_,
                                    size_t *const optvallen_,
                                    const uint8_t (&curve_key_)[CURVE_KEYSIZE])
{
    if (*optvallen_ == CURVE_KEYSIZE) {
        memcpy (optval_, curve_key_, CURVE_KEYSIZE);
        return 0;
    } else if (*optvallen_ == CURVE_KEYSIZE_Z85 + 1) {
        zmq_z85_encode ((char *) optval_, curve_key_, CURVE_KEYSIZE);
        return 0;
    }
    return sockopt_invalid ();
}
#endif

template <typename T>
int do_setsockopt (const void *const optval_,
                   const size_t optvallen_,
                   T *const out_value_)
{
    if (optvallen_ == sizeof (T)) {
        memcpy (out_value_, optval_, sizeof (T));
        return 0;
    }
    return sockopt_invalid ();
}

int zmq::do_setsockopt_int_as_bool_strict (const void *const optval_,
                                           const size_t optvallen_,
                                           bool *const out_value_)
{
    // TODO handling of values other than 0 or 1 is not consistent,
    // here it is disallowed, but for other options such as
    // ZMQ_ROUTER_RAW any positive value is accepted
118
    int value = -1;
119 120 121 122 123 124 125 126 127 128 129 130 131
    if (do_setsockopt (optval_, optvallen_, &value) == -1)
        return -1;
    if (value == 0 || value == 1) {
        *out_value_ = (value != 0);
        return 0;
    }
    return sockopt_invalid ();
}

int zmq::do_setsockopt_int_as_bool_relaxed (const void *const optval_,
                                            const size_t optvallen_,
                                            bool *const out_value_)
{
132
    int value = -1;
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    if (do_setsockopt (optval_, optvallen_, &value) == -1)
        return -1;
    *out_value_ = (value != 0);
    return 0;
}

static int
do_setsockopt_string_allow_empty_strict (const void *const optval_,
                                         const size_t optvallen_,
                                         std::string *const out_value_,
                                         const size_t max_len_)
{
    // TODO why is optval_ != NULL not allowed in case of optvallen_== 0?
    // TODO why are empty strings allowed for some socket options, but not for others?
    if (optval_ == NULL && optvallen_ == 0) {
        out_value_->clear ();
        return 0;
    } else if (optval_ != NULL && optvallen_ > 0 && optvallen_ <= max_len_) {
        out_value_->assign ((const char *) optval_, optvallen_);
        return 0;
    }
    return sockopt_invalid ();
}

static int
do_setsockopt_string_allow_empty_relaxed (const void *const optval_,
                                          const size_t optvallen_,
                                          std::string *const out_value_,
                                          const size_t max_len_)
{
    // TODO use either do_setsockopt_string_allow_empty_relaxed or
    // do_setsockopt_string_allow_empty_strict everywhere
    if (optvallen_ > 0 && optvallen_ <= max_len_) {
        out_value_->assign ((const char *) optval_, optvallen_);
        return 0;
    }
    return sockopt_invalid ();
}

template <typename T>
int do_setsockopt_set (const void *const optval_,
                       const size_t optvallen_,
                       std::set<T> *const set_)
{
    if (optvallen_ == 0 && optval_ == NULL) {
        set_->clear ();
        return 0;
    } else if (optvallen_ == sizeof (T) && optval_ != NULL) {
        set_->insert (*((const T *) optval_));
        return 0;
    }
    return sockopt_invalid ();
}

187
zmq::options_t::options_t () :
188 189
    sndhwm (1000),
    rcvhwm (1000),
malosek's avatar
malosek committed
190
    affinity (0),
191
    routing_id_size (0),
192
    rate (100),
193
    recovery_ivl (10000),
194
    multicast_hops (1),
195
    multicast_maxtpdu (1500),
196 197
    sndbuf (-1),
    rcvbuf (-1),
198
    tos (0),
199
    type (-1),
200
    linger (-1),
201
    connect_timeout (0),
202
    tcp_maxrt (0),
203
    reconnect_ivl (100),
204
    reconnect_ivl_max (0),
205
    backlog (100),
206
    maxmsgsize (-1),
207 208
    rcvtimeo (-1),
    sndtimeo (-1),
Pieter Hintjens's avatar
Pieter Hintjens committed
209
    ipv6 (0),
210
    immediate (0),
211
    filter (false),
212
    invert_matching (false),
213
    recv_routing_id (false),
214
    raw_socket (false),
215
    raw_notify (true),
216 217 218 219
    tcp_keepalive (-1),
    tcp_keepalive_cnt (-1),
    tcp_keepalive_idle (-1),
    tcp_keepalive_intvl (-1),
220
    mechanism (ZMQ_NULL),
221
    as_server (0),
222 223
    gss_principal_nt (ZMQ_GSSAPI_NT_HOSTBASED),
    gss_service_principal_nt (ZMQ_GSSAPI_NT_HOSTBASED),
224
    gss_plaintext (false),
danielkr's avatar
danielkr committed
225
    socket_id (0),
226
    conflate (false),
227
    handshake_ivl (30000),
Jonathan Reams's avatar
Jonathan Reams committed
228 229 230
    connected (false),
    heartbeat_ttl (0),
    heartbeat_interval (0),
231
    heartbeat_timeout (-1),
232
    use_fd (-1),
233
    zap_enforce_domain (false),
234 235
    loopback_fastpath (false),
    zero_copy (true)
236
{
237 238 239
    memset (curve_public_key, 0, CURVE_KEYSIZE);
    memset (curve_secret_key, 0, CURVE_KEYSIZE);
    memset (curve_server_key, 0, CURVE_KEYSIZE);
Ilya Kulakov's avatar
Ilya Kulakov committed
240 241 242 243 244 245
#if defined ZMQ_HAVE_VMCI
    vmci_buffer_size = 0;
    vmci_buffer_min_size = 0;
    vmci_buffer_max_size = 0;
    vmci_connect_timeout = -1;
#endif
246
}
247

248 249 250
int zmq::options_t::set_curve_key (uint8_t *destination,
                                   const void *optval_,
                                   size_t optvallen_)
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
{
    switch (optvallen_) {
        case CURVE_KEYSIZE:
            memcpy (destination, optval_, optvallen_);
            mechanism = ZMQ_CURVE;
            return 0;

        case CURVE_KEYSIZE_Z85 + 1:
            if (zmq_z85_decode (destination, (char *) optval_)) {
                mechanism = ZMQ_CURVE;
                return 0;
            }
            break;

        case CURVE_KEYSIZE_Z85:
266
            char z85_key[CURVE_KEYSIZE_Z85 + 1];
267
            memcpy (z85_key, (char *) optval_, optvallen_);
268
            z85_key[CURVE_KEYSIZE_Z85] = 0;
269 270 271 272 273 274 275 276 277 278 279 280
            if (zmq_z85_decode (destination, z85_key)) {
                mechanism = ZMQ_CURVE;
                return 0;
            }
            break;

        default:
            break;
    }
    return -1;
}

281 282 283
int zmq::options_t::setsockopt (int option_,
                                const void *optval_,
                                size_t optvallen_)
284
{
285
    bool is_int = (optvallen_ == sizeof (int));
286
    int value = 0;
287 288 289 290
    if (is_int)
        memcpy (&value, optval_, sizeof (int));
#if defined(ZMQ_ACT_MILITANT)
    bool malformed = true; //  Did caller pass a bad option value?
291
#endif
292

293
    switch (option_) {
294
        case ZMQ_SNDHWM:
295
            if (is_int && value >= 0) {
296
                sndhwm = value;
297 298
                return 0;
            }
299
            break;
300

301
        case ZMQ_RCVHWM:
302
            if (is_int && value >= 0) {
303
                rcvhwm = value;
304 305
                return 0;
            }
306
            break;
307

308
        case ZMQ_AFFINITY:
309
            return do_setsockopt (optval_, optvallen_, &affinity);
310

311 312
        case ZMQ_ROUTING_ID:
            //  Routing id is any binary string from 1 to 255 octets
313
            if (optvallen_ > 0 && optvallen_ < 256) {
314 315
                routing_id_size = (unsigned char) optvallen_;
                memcpy (routing_id, optval_, routing_id_size);
316
                return 0;
317 318
            }
            break;
319

320
        case ZMQ_RATE:
321
            if (is_int && value > 0) {
322
                rate = value;
323 324
                return 0;
            }
325
            break;
326

327
        case ZMQ_RECOVERY_IVL:
328
            if (is_int && value >= 0) {
329
                recovery_ivl = value;
330 331 332
                return 0;
            }
            break;
333

334
        case ZMQ_SNDBUF:
335
            if (is_int && value >= -1) {
336
                sndbuf = value;
337 338
                return 0;
            }
339
            break;
340

341
        case ZMQ_RCVBUF:
342
            if (is_int && value >= -1) {
343
                rcvbuf = value;
344 345
                return 0;
            }
346
            break;
347

348 349 350 351 352 353 354
        case ZMQ_TOS:
            if (is_int && value >= 0) {
                tos = value;
                return 0;
            }
            break;

355
        case ZMQ_LINGER:
356
            if (is_int && value >= -1) {
357
                linger.store (value);
358 359
                return 0;
            }
360
            break;
361

362 363 364 365 366 367 368
        case ZMQ_CONNECT_TIMEOUT:
            if (is_int && value >= 0) {
                connect_timeout = value;
                return 0;
            }
            break;

369
        case ZMQ_TCP_MAXRT:
370
            if (is_int && value >= 0) {
371
                tcp_maxrt = value;
372 373 374 375
                return 0;
            }
            break;

376
        case ZMQ_RECONNECT_IVL:
377
            if (is_int && value >= -1) {
378
                reconnect_ivl = value;
379 380
                return 0;
            }
381
            break;
382

383
        case ZMQ_RECONNECT_IVL_MAX:
384
            if (is_int && value >= 0) {
385
                reconnect_ivl_max = value;
386 387
                return 0;
            }
388
            break;
389

390
        case ZMQ_BACKLOG:
391
            if (is_int && value >= 0) {
392
                backlog = value;
393 394
                return 0;
            }
395
            break;
396

397
        case ZMQ_MAXMSGSIZE:
398
            return do_setsockopt (optval_, optvallen_, &maxmsgsize);
399

400
        case ZMQ_MULTICAST_HOPS:
401
            if (is_int && value > 0) {
402
                multicast_hops = value;
403 404
                return 0;
            }
405
            break;
406

407 408 409 410 411 412 413
        case ZMQ_MULTICAST_MAXTPDU:
            if (is_int && value > 0) {
                multicast_maxtpdu = value;
                return 0;
            }
            break;

414
        case ZMQ_RCVTIMEO:
415
            if (is_int && value >= -1) {
416
                rcvtimeo = value;
417 418
                return 0;
            }
419
            break;
420

421
        case ZMQ_SNDTIMEO:
422
            if (is_int && value >= -1) {
423
                sndtimeo = value;
424 425
                return 0;
            }
426
            break;
427

Pieter Hintjens's avatar
Pieter Hintjens committed
428
        /*  Deprecated in favor of ZMQ_IPV6  */
429 430 431 432 433 434 435 436
        case ZMQ_IPV4ONLY: {
            bool value;
            int rc =
              do_setsockopt_int_as_bool_strict (optval_, optvallen_, &value);
            if (rc == 0)
                ipv6 = !value;
            return rc;
        }
437

438 439
        /*  To replace the somewhat surprising IPV4ONLY */
        case ZMQ_IPV6:
440 441
            return do_setsockopt_int_as_bool_strict (optval_, optvallen_,
                                                     &ipv6);
442

443
        case ZMQ_SOCKS_PROXY:
444 445
            return do_setsockopt_string_allow_empty_strict (
              optval_, optvallen_, &socks_proxy_address, SIZE_MAX);
446

447
        case ZMQ_TCP_KEEPALIVE:
448
            if (is_int && (value == -1 || value == 0 || value == 1)) {
449
                tcp_keepalive = value;
450 451
                return 0;
            }
452
            break;
453

454
        case ZMQ_TCP_KEEPALIVE_CNT:
455
            if (is_int && (value == -1 || value >= 0)) {
456
                tcp_keepalive_cnt = value;
457 458
                return 0;
            }
459
            break;
460

461
        case ZMQ_TCP_KEEPALIVE_IDLE:
462
            if (is_int && (value == -1 || value >= 0)) {
463
                tcp_keepalive_idle = value;
464 465
                return 0;
            }
466
            break;
467

468
        case ZMQ_TCP_KEEPALIVE_INTVL:
469
            if (is_int && (value == -1 || value >= 0)) {
470
                tcp_keepalive_intvl = value;
471 472
                return 0;
            }
473
            break;
474

475
        case ZMQ_IMMEDIATE:
476
            // TODO why is immediate not bool (and called non_immediate, as its meaning appears to be reversed)
477
            if (is_int && (value == 0 || value == 1)) {
478
                immediate = value;
479 480
                return 0;
            }
481
            break;
482

483 484 485 486 487 488 489 490 491 492 493 494 495
        case ZMQ_TCP_ACCEPT_FILTER: {
            std::string filter_str;
            int rc = do_setsockopt_string_allow_empty_strict (
              optval_, optvallen_, &filter_str, 255);
            if (rc == 0) {
                if (filter_str.empty ()) {
                    tcp_accept_filters.clear ();
                } else {
                    tcp_address_mask_t mask;
                    rc = mask.resolve (filter_str.c_str (), ipv6);
                    if (rc == 0) {
                        tcp_accept_filters.push_back (mask);
                    }
496 497
                }
            }
498 499
            return rc;
        }
500

501
#if defined ZMQ_HAVE_SO_PEERCRED || defined ZMQ_HAVE_LOCAL_PEERCRED
502
        case ZMQ_IPC_FILTER_UID:
503 504 505
            return do_setsockopt_set (optval_, optvallen_,
                                      &ipc_uid_accept_filters);

506

507
        case ZMQ_IPC_FILTER_GID:
508 509
            return do_setsockopt_set (optval_, optvallen_,
                                      &ipc_gid_accept_filters);
510
#endif
511

512
#if defined ZMQ_HAVE_SO_PEERCRED
513
        case ZMQ_IPC_FILTER_PID:
514 515
            return do_setsockopt_set (optval_, optvallen_,
                                      &ipc_pid_accept_filters);
516
#endif
517

518 519
        case ZMQ_PLAIN_SERVER:
            if (is_int && (value == 0 || value == 1)) {
520
                as_server = value;
521
                mechanism = value ? ZMQ_PLAIN : ZMQ_NULL;
522 523 524
                return 0;
            }
            break;
525

526 527 528 529
        case ZMQ_PLAIN_USERNAME:
            if (optvallen_ == 0 && optval_ == NULL) {
                mechanism = ZMQ_NULL;
                return 0;
530
            } else if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
531
                plain_username.assign ((const char *) optval_, optvallen_);
532
                as_server = 0;
533 534 535 536
                mechanism = ZMQ_PLAIN;
                return 0;
            }
            break;
537

538 539 540 541
        case ZMQ_PLAIN_PASSWORD:
            if (optvallen_ == 0 && optval_ == NULL) {
                mechanism = ZMQ_NULL;
                return 0;
542
            } else if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
543
                plain_password.assign ((const char *) optval_, optvallen_);
544
                as_server = 0;
545 546
                mechanism = ZMQ_PLAIN;
                return 0;
547
            }
548
            break;
549 550

        case ZMQ_ZAP_DOMAIN:
551 552
            return do_setsockopt_string_allow_empty_relaxed (
              optval_, optvallen_, &zap_domain, 255);
553 554
            break;

555
            //  If curve encryption isn't built, these options provoke EINVAL
556
#ifdef ZMQ_HAVE_CURVE
557
        case ZMQ_CURVE_SERVER:
558
            if (is_int && (value == 0 || value == 1)) {
559
                as_server = value;
560
                mechanism = value ? ZMQ_CURVE : ZMQ_NULL;
561 562 563
                return 0;
            }
            break;
564

565
        case ZMQ_CURVE_PUBLICKEY:
566
            if (0 == set_curve_key (curve_public_key, optval_, optvallen_)) {
567
                return 0;
568
            }
569
            break;
570

571
        case ZMQ_CURVE_SECRETKEY:
572
            if (0 == set_curve_key (curve_secret_key, optval_, optvallen_)) {
573
                return 0;
574
            }
575 576
            break;

577
        case ZMQ_CURVE_SERVERKEY:
578
            if (0 == set_curve_key (curve_server_key, optval_, optvallen_)) {
579
                as_server = 0;
580
                return 0;
581
            }
582
            break;
583
#endif
Martin Hurton's avatar
Martin Hurton committed
584

danielkr's avatar
danielkr committed
585
        case ZMQ_CONFLATE:
586 587
            return do_setsockopt_int_as_bool_strict (optval_, optvallen_,
                                                     &conflate);
588

589
            //  If libgssapi isn't installed, these options provoke EINVAL
590
#ifdef HAVE_LIBGSSAPI_KRB5
591 592 593 594 595 596 597
        case ZMQ_GSSAPI_SERVER:
            if (is_int && (value == 0 || value == 1)) {
                as_server = value;
                mechanism = ZMQ_GSSAPI;
                return 0;
            }
            break;
598

Chris Busbey's avatar
Chris Busbey committed
599
        case ZMQ_GSSAPI_PRINCIPAL:
600
            if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
Chris Busbey's avatar
Chris Busbey committed
601
                gss_principal.assign ((const char *) optval_, optvallen_);
602 603 604 605 606
                mechanism = ZMQ_GSSAPI;
                return 0;
            }
            break;

Chris Busbey's avatar
Chris Busbey committed
607
        case ZMQ_GSSAPI_SERVICE_PRINCIPAL:
608
            if (optvallen_ > 0 && optvallen_ < 256 && optval_ != NULL) {
609 610
                gss_service_principal.assign ((const char *) optval_,
                                              optvallen_);
611
                mechanism = ZMQ_GSSAPI;
Chris Busbey's avatar
Chris Busbey committed
612
                as_server = 0;
613 614 615
                return 0;
            }
            break;
danielkr's avatar
danielkr committed
616

617
        case ZMQ_GSSAPI_PLAINTEXT:
618 619
            return do_setsockopt_int_as_bool_strict (optval_, optvallen_,
                                                     &gss_plaintext);
620

621
        case ZMQ_GSSAPI_PRINCIPAL_NAMETYPE:
622 623 624 625
            if (is_int
                && (value == ZMQ_GSSAPI_NT_HOSTBASED
                    || value == ZMQ_GSSAPI_NT_USER_NAME
                    || value == ZMQ_GSSAPI_NT_KRB5_PRINCIPAL)) {
626 627 628 629
                gss_principal_nt = value;
                return 0;
            }
            break;
630

631
        case ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE:
632 633 634 635
            if (is_int
                && (value == ZMQ_GSSAPI_NT_HOSTBASED
                    || value == ZMQ_GSSAPI_NT_USER_NAME
                    || value == ZMQ_GSSAPI_NT_KRB5_PRINCIPAL)) {
636 637 638 639
                gss_service_principal_nt = value;
                return 0;
            }
            break;
640
#endif
641

642 643 644 645 646 647 648
        case ZMQ_HANDSHAKE_IVL:
            if (is_int && value >= 0) {
                handshake_ivl = value;
                return 0;
            }
            break;

649
        case ZMQ_INVERT_MATCHING:
650 651
            return do_setsockopt_int_as_bool_relaxed (optval_, optvallen_,
                                                      &invert_matching);
652

Jonathan Reams's avatar
Jonathan Reams committed
653 654 655 656 657 658 659 660
        case ZMQ_HEARTBEAT_IVL:
            if (is_int && value >= 0) {
                heartbeat_interval = value;
                return 0;
            }
            break;

        case ZMQ_HEARTBEAT_TTL:
661 662 663
            // Convert this to deciseconds from milliseconds
            value = value / 100;
            if (is_int && value >= 0 && value <= 6553) {
664
                heartbeat_ttl = (uint16_t) value;
Jonathan Reams's avatar
Jonathan Reams committed
665 666 667 668 669 670 671 672 673 674 675
                return 0;
            }
            break;

        case ZMQ_HEARTBEAT_TIMEOUT:
            if (is_int && value >= 0) {
                heartbeat_timeout = value;
                return 0;
            }
            break;

676
#ifdef ZMQ_HAVE_VMCI
Ilya Kulakov's avatar
Ilya Kulakov committed
677
        case ZMQ_VMCI_BUFFER_SIZE:
678
            return do_setsockopt (optval_, optvallen_, &vmci_buffer_size);
Ilya Kulakov's avatar
Ilya Kulakov committed
679 680

        case ZMQ_VMCI_BUFFER_MIN_SIZE:
681
            return do_setsockopt (optval_, optvallen_, &vmci_buffer_min_size);
Ilya Kulakov's avatar
Ilya Kulakov committed
682 683

        case ZMQ_VMCI_BUFFER_MAX_SIZE:
684
            return do_setsockopt (optval_, optvallen_, &vmci_buffer_max_size);
Ilya Kulakov's avatar
Ilya Kulakov committed
685 686

        case ZMQ_VMCI_CONNECT_TIMEOUT:
687
            return do_setsockopt (optval_, optvallen_, &vmci_connect_timeout);
688
#endif
Ilya Kulakov's avatar
Ilya Kulakov committed
689

690
        case ZMQ_USE_FD:
691
            if (is_int && value >= -1) {
692
                use_fd = value;
693 694 695 696
                return 0;
            }
            break;

697
        case ZMQ_BINDTODEVICE:
698 699
            return do_setsockopt_string_allow_empty_strict (
              optval_, optvallen_, &bound_device, BINDDEVSIZ);
700

701
        case ZMQ_ZAP_ENFORCE_DOMAIN:
702 703
            return do_setsockopt_int_as_bool_relaxed (optval_, optvallen_,
                                                      &zap_enforce_domain);
704

705
        case ZMQ_LOOPBACK_FASTPATH:
706 707
            return do_setsockopt_int_as_bool_relaxed (optval_, optvallen_,
                                                      &loopback_fastpath);
708

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728
        case ZMQ_METADATA:
            if (optvallen_ > 0 && !is_int) {
                std::string s ((char *) optval_);
                size_t pos = 0;
                std::string key, val, delimiter = ":";
                pos = s.find (delimiter);
                if (pos != std::string::npos && pos != 0
                    && pos != s.length () - 1) {
                    key = s.substr (0, pos);
                    if (key.compare (0, 2, "X-") == 0 && key.length () < 256) {
                        val = s.substr (pos + 1, s.length ());
                        app_metadata.insert (
                          std::pair<std::string, std::string> (key, val));
                        return 0;
                    }
                }
            }
            errno = EINVAL;
            return -1;
            break;
danielkr's avatar
danielkr committed
729
        default:
730
#if defined(ZMQ_ACT_MILITANT)
731 732 733 734 735
            //  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;
736
#endif
danielkr's avatar
danielkr committed
737
            break;
738
    }
739

740 741 742 743
            // TODO mechanism should either be set explicitly, or determined when
            // connecting. currently, it depends on the order of setsockopt calls
            // if there is some inconsistency, which is confusing. in addition,
            // the assumed or set mechanism should be queryable (as a socket option)
744

745
#if defined(ZMQ_ACT_MILITANT)
746 747 748 749 750 751
    //  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
752 753
    errno = EINVAL;
    return -1;
754
}
755

756 757 758
int zmq::options_t::getsockopt (int option_,
                                void *optval_,
                                size_t *optvallen_) const
759
{
760 761
    bool is_int = (*optvallen_ == sizeof (int));
    int *value = (int *) optval_;
762 763
#if defined(ZMQ_ACT_MILITANT)
    bool malformed = true; //  Did caller pass a bad option value?
764
#endif
765

766
    switch (option_) {
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
        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;

788
        case ZMQ_ROUTING_ID:
789 790
            return do_getsockopt (optval_, optvallen_, routing_id,
                                  routing_id_size);
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
            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;

821 822 823 824 825 826
        case ZMQ_TOS:
            if (is_int) {
                *value = tos;
                return 0;
            }
            break;
Martin Hurton's avatar
Martin Hurton committed
827

828 829 830 831 832 833 834 835 836
        case ZMQ_TYPE:
            if (is_int) {
                *value = type;
                return 0;
            }
            break;

        case ZMQ_LINGER:
            if (is_int) {
837
                *value = linger.load ();
838 839 840
                return 0;
            }
            break;
841

842 843 844 845 846 847 848
        case ZMQ_CONNECT_TIMEOUT:
            if (is_int) {
                *value = connect_timeout;
                return 0;
            }
            break;

849
        case ZMQ_TCP_MAXRT:
850
            if (is_int) {
851
                *value = tcp_maxrt;
852 853 854 855
                return 0;
            }
            break;

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
        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;

892 893 894 895 896 897 898
        case ZMQ_MULTICAST_MAXTPDU:
            if (is_int) {
                *value = multicast_maxtpdu;
                return 0;
            }
            break;

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
        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;
919

920 921 922 923 924 925 926 927 928 929 930 931 932 933
        case ZMQ_IPV6:
            if (is_int) {
                *value = ipv6;
                return 0;
            }
            break;

        case ZMQ_IMMEDIATE:
            if (is_int) {
                *value = immediate;
                return 0;
            }
            break;

934
        case ZMQ_SOCKS_PROXY:
935
            return do_getsockopt (optval_, optvallen_, socks_proxy_address);
936 937
            break;

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
        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;

        case ZMQ_MECHANISM:
            if (is_int) {
                *value = mechanism;
                return 0;
            }
            break;
972

973
        case ZMQ_PLAIN_SERVER:
974
            if (is_int) {
975
                *value = as_server && mechanism == ZMQ_PLAIN;
976 977 978
                return 0;
            }
            break;
979

980
        case ZMQ_PLAIN_USERNAME:
981
            return do_getsockopt (optval_, optvallen_, plain_username);
982
            break;
983

984
        case ZMQ_PLAIN_PASSWORD:
985
            return do_getsockopt (optval_, optvallen_, plain_password);
986
            break;
987 988

        case ZMQ_ZAP_DOMAIN:
989
            return do_getsockopt (optval_, optvallen_, zap_domain);
990 991
            break;

992
            //  If curve encryption isn't built, these options provoke EINVAL
993
#ifdef ZMQ_HAVE_CURVE
994
        case ZMQ_CURVE_SERVER:
995
            if (is_int) {
996
                *value = as_server && mechanism == ZMQ_CURVE;
997 998 999
                return 0;
            }
            break;
1000

1001
        case ZMQ_CURVE_PUBLICKEY:
1002 1003
            return do_getsockopt_curve_key (optval_, optvallen_,
                                            curve_public_key);
1004
            break;
1005

1006
        case ZMQ_CURVE_SECRETKEY:
1007 1008
            return do_getsockopt_curve_key (optval_, optvallen_,
                                            curve_secret_key);
1009 1010
            break;

1011
        case ZMQ_CURVE_SERVERKEY:
1012 1013
            return do_getsockopt_curve_key (optval_, optvallen_,
                                            curve_server_key);
1014
            break;
1015
#endif
danielkr's avatar
danielkr committed
1016 1017 1018 1019 1020 1021 1022

        case ZMQ_CONFLATE:
            if (is_int) {
                *value = conflate;
                return 0;
            }
            break;
Martin Hurton's avatar
Martin Hurton committed
1023

1024
            //  If libgssapi isn't installed, these options provoke EINVAL
1025
#ifdef HAVE_LIBGSSAPI_KRB5
1026 1027 1028 1029 1030 1031
        case ZMQ_GSSAPI_SERVER:
            if (is_int) {
                *value = as_server && mechanism == ZMQ_GSSAPI;
                return 0;
            }
            break;
1032

Chris Busbey's avatar
Chris Busbey committed
1033
        case ZMQ_GSSAPI_PRINCIPAL:
1034
            return do_getsockopt (optval_, optvallen_, gss_principal);
1035
            break;
danielkr's avatar
danielkr committed
1036

Chris Busbey's avatar
Chris Busbey committed
1037
        case ZMQ_GSSAPI_SERVICE_PRINCIPAL:
1038
            return do_getsockopt (optval_, optvallen_, gss_service_principal);
1039
            break;
1040

1041 1042 1043 1044 1045 1046
        case ZMQ_GSSAPI_PLAINTEXT:
            if (is_int) {
                *value = gss_plaintext;
                return 0;
            }
            break;
1047

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
        case ZMQ_GSSAPI_PRINCIPAL_NAMETYPE:
            if (is_int) {
                *value = gss_principal_nt;
                return 0;
            }
            break;
        case ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE:
            if (is_int) {
                *value = gss_service_principal_nt;
                return 0;
            }
            break;
1060 1061
#endif

1062 1063 1064 1065 1066 1067
        case ZMQ_HANDSHAKE_IVL:
            if (is_int) {
                *value = handshake_ivl;
                return 0;
            }
            break;
1068

1069 1070 1071 1072 1073 1074 1075
        case ZMQ_INVERT_MATCHING:
            if (is_int) {
                *value = invert_matching;
                return 0;
            }
            break;

Jonathan Reams's avatar
Jonathan Reams committed
1076 1077 1078 1079 1080 1081 1082 1083 1084
        case ZMQ_HEARTBEAT_IVL:
            if (is_int) {
                *value = heartbeat_interval;
                return 0;
            }
            break;

        case ZMQ_HEARTBEAT_TTL:
            if (is_int) {
1085 1086
                // Convert the internal deciseconds value to milliseconds
                *value = heartbeat_ttl * 100;
Jonathan Reams's avatar
Jonathan Reams committed
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
                return 0;
            }
            break;

        case ZMQ_HEARTBEAT_TIMEOUT:
            if (is_int) {
                *value = heartbeat_timeout;
                return 0;
            }
            break;

1098
        case ZMQ_USE_FD:
1099
            if (is_int) {
1100
                *value = use_fd;
1101 1102 1103 1104
                return 0;
            }
            break;

1105
        case ZMQ_BINDTODEVICE:
1106
            return do_getsockopt (optval_, optvallen_, bound_device);
1107 1108
            break;

1109 1110 1111 1112 1113 1114 1115
        case ZMQ_ZAP_ENFORCE_DOMAIN:
            if (is_int) {
                *value = zap_enforce_domain;
                return 0;
            }
            break;

1116 1117 1118 1119 1120 1121 1122
        case ZMQ_LOOPBACK_FASTPATH:
            if (is_int) {
                *value = loopback_fastpath;
                return 0;
            }
            break;

1123
        default:
1124
#if defined(ZMQ_ACT_MILITANT)
1125 1126 1127
            malformed = false;
#endif
            break;
1128
    }
1129
#if defined(ZMQ_ACT_MILITANT)
1130 1131 1132
    if (malformed)
        zmq_assert (false);
#endif
1133 1134 1135
    errno = EINVAL;
    return -1;
}
1136 1137 1138

bool zmq::options_t::is_valid (int option_) const
{
1139
    LIBZMQ_UNUSED (option_);
1140
    return true;
1141
}