zmq_gssapi.txt 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. zmq_gssapi(7)
  2. ============
  3. NAME
  4. ----
  5. zmq_gssapi - secure authentication and confidentiality
  6. SYNOPSIS
  7. --------
  8. The GSSAPI mechanism defines a mechanism for secure authentication and
  9. confidentiality for communications between a client and a server using the
  10. Generic Security Service Application Program Interface (GSSAPI). The GSSAPI
  11. mechanism can be used on both public and private networks. GSSAPI itself is
  12. defined in IETF RFC-2743: <http://tools.ietf.org/html/rfc2743>. The ZeroMQ
  13. GSSAPI mechanism is defined by this document: <http://rfc.zeromq.org/spec:38>.
  14. CLIENT AND SERVER ROLES
  15. -----------------------
  16. A socket using GSSAPI can be either client or server, but not both.
  17. To become a GSSAPI server, the application sets the ZMQ_GSSAPI_SERVER
  18. option on the socket.
  19. To become a GSSAPI client, the application sets the ZMQ_GSSAPI_SERVICE_PRINCIPAL
  20. option to the name of the principal on the server to which it intends to
  21. connect.
  22. On client or server, the application may additionally set the
  23. ZMQ_GSSAPI_PRINCIPAL option to provide the socket with the name of the
  24. principal for whom GSSAPI credentials should be acquired. If this option
  25. is not set, default credentials are used.
  26. OPTIONAL ENCRYPTION
  27. -------------------
  28. By default, the GSSAPI mechanism will encrypt all communications between client
  29. and server. If encryption is not desired (e.g. on private networks), the
  30. client and server applications can disable it by setting the
  31. ZMQ_GSSAPI_PLAINTEXT option. Both the client and server must set this option
  32. to the same value.
  33. PRINCIPAL NAMES
  34. ---------------
  35. Principal names specified with the ZMQ_GSSAPI_SERVICE_PRINCIPAL or
  36. ZMQ_GSSAPI_PRINCIPAL options are interpreted as "host based" name types
  37. by default. The ZMQ_GSSAPI_PRINCIPAL_NAMETYPE and
  38. ZMQ_GSSAPI_SERVICE_PRINCIPAL_NAMETYPE options may be used to change the
  39. name type to one of:
  40. *ZMQ_GSSAPI_NT_HOSTBASED*::
  41. The name should be of the form "service" or "service@hostname",
  42. which will parse into a principal of "service/hostname"
  43. in the local realm. This is the default name type.
  44. *ZMQ_GSSAPI_NT_USER_NAME*::
  45. The name should be a local username, which will parse into a single-component
  46. principal in the local realm.
  47. *ZMQ_GSSAPI_NT_KRB5_PRINCIPAL*::
  48. The name is a principal name string. This name type only works with
  49. the krb5 GSSAPI mechanism.
  50. SEE ALSO
  51. --------
  52. linkzmq:zmq_setsockopt[3]
  53. linkzmq:zmq_null[7]
  54. linkzmq:zmq_curve[7]
  55. linkzmq:zmq[7]
  56. AUTHORS
  57. -------
  58. This page was written by the 0MQ community. To make a change please
  59. read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.