From 568feb1c7f4b7a2ca712f854e6688d801ef29ffd Mon Sep 17 00:00:00 2001 From: Jim Garlick Date: Mon, 24 Apr 2017 16:11:02 -0700 Subject: [PATCH] gssapi: document NAMETYPE options in get/setsockopt(3) Problem: GSSAPI NAMETYPE options were not documented in man pages for zmq_getsockopt() and zmq_setsockopt(). Solution: add new options to these manual pages. --- doc/zmq_getsockopt.txt | 35 +++++++++++++++++++++++++++++++++++ doc/zmq_setsockopt.txt | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 4cbbd86b..07b1e84a 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -232,6 +232,41 @@ Option value unit:: N/A Default value:: null string Applicable socket types:: all, when using TCP or IPC transports +ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE: Retrieve nametype for service principal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Returns the 'ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE' option, if any, previously +set on the socket. A value of 'ZMQ_GSSAPI_NT_HOSTBASED' (0) means the name +specified with 'ZMQ_GSSAPI_SERVICE_PRINCIPAL' is interpreted as a host based +name. A value of 'ZMQ_GSSAPI_NT_USER_NAME' (1) means it is interpreted as +a local user name. A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it +is interpreted as an unparsed principal name string (valid only with the +krb5 GSSAPI mechanism). + +NOTE: in DRAFT state, not yet available in stable releases. + +[horizontal] +Option value type:: int +Option value unit:: 0, 1, 2 +Default value:: 0 (ZMQ_GSSAPI_NT_HOSTBASED) +Applicable socket types:: all, when using TCP or IPC transports + +ZMQ_GSSAPI_PRINCIPAL_NAMETYPE: Retrieve nametype for service principal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Returns the 'ZMQ_GSSAPI_PRINCIPAL_NAMETYPE' option, if any, previously +set on the socket. A value of 'ZMQ_GSSAPI_NT_HOSTBASED' (0) means the name +specified with 'ZMQ_GSSAPI_PRINCIPAL' is interpreted as a host based +name. A value of 'ZMQ_GSSAPI_NT_USER_NAME' (1) means it is interpreted as +a local user name. A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it +is interpreted as an unparsed principal name string (valid only with the +krb5 GSSAPI mechanism). + +NOTE: in DRAFT state, not yet available in stable releases. + +[horizontal] +Option value type:: int +Option value unit:: 0, 1, 2 +Default value:: 0 (ZMQ_GSSAPI_NT_HOSTBASED) +Applicable socket types:: all, when using TCP or IPC transports ZMQ_HANDSHAKE_IVL: Retrieve maximum handshake interval ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index c79f7cb2..4877ee7e 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -249,6 +249,39 @@ Option value unit:: N/A Default value:: not set Applicable socket types:: all, when using TCP transport +ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE: Set name type of service principal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Sets the name type of the GSSAPI service principal. A value of +'ZMQ_GSSAPI_NT_HOSTBASED' (0) means the name specified with +'ZMQ_GSSAPI_SERVICE_PRINCIPAL' is interpreted as a host based name. A value +of 'ZMQ_GSSAPI_NT_USER_NAME' (1) means it is interpreted as a local user name. +A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an +unparsed principal name string (valid only with the krb5 GSSAPI mechanism). + +NOTE: in DRAFT state, not yet available in stable releases. + +[horizontal] +Option value type:: int +Option value unit:: 0, 1, 2 +Default value:: 0 (ZMQ_GSSAPI_NT_HOSTBASED) +Applicable socket types:: all, when using TCP or IPC transport + +ZMQ_GSSAPI_PRINCIPAL_NAMETYPE: Set name type of principal +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Sets the name type of the GSSAPI principal. A value of +'ZMQ_GSSAPI_NT_HOSTBASED' (0) means the name specified with +'ZMQ_GSSAPI_PRINCIPAL' is interpreted as a host based name. A value of +'ZMQ_GSSAPI_NT_USER_NAME' (1) means it is interpreted as a local user name. +A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an +unparsed principal name string (valid only with the krb5 GSSAPI mechanism). + +NOTE: in DRAFT state, not yet available in stable releases. + +[horizontal] +Option value type:: int +Option value unit:: 0, 1, 2 +Default value:: 0 (ZMQ_GSSAPI_NT_HOSTBASED) +Applicable socket types:: all, when using TCP or IPC transport ZMQ_HANDSHAKE_IVL: Set maximum handshake interval ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~