Commit c371824b authored by Jim Garlick's avatar Jim Garlick

gssapi: document ZMQ_GSSAPI_PRINCIPAL as optional

Problem: the ZMQ_GSSAPI_PRINCIPAL socket option is described
as mandatory in the zmq_gssapi(7) manual page.  In fact it
is optional.

Solution: Describe ZMQ_GSSAPI_PRINCIPAL as optional.
If unspecified, default credentials are used.
parent 43f4c286
...@@ -22,16 +22,17 @@ CLIENT AND SERVER ROLES ...@@ -22,16 +22,17 @@ CLIENT AND SERVER ROLES
----------------------- -----------------------
A socket using GSSAPI can be either client or server, but not both. A socket using GSSAPI can be either client or server, but not both.
To become either a GSSAPI client or server, the application sets the To become a GSSAPI server, the application sets the ZMQ_GSSAPI_SERVER
ZMQ_GSSAPI_PRINCIPAL option to provide the socket with the name of the principal option on the socket.
for whom GSSAPI credentials should be acquired.
To become a GSSAPI server, the application additionally sets the To become a GSSAPI client, the application sets the ZMQ_GSSAPI_SERVICE_PRINCIPAL
ZMQ_GSSAPI_SERVER option on the socket. option to the name of the principal on the server to which it intends to
connect.
To become a GSSAPI client, the application additionally sets the On client or server, the application may additionally set the
ZMQ_GSSAPI_SERVICE_PRINCIPAL option to the name of the principal of the server ZMQ_GSSAPI_PRINCIPAL option to provide the socket with the name of the
to which it intends to connect. principal for whom GSSAPI credentials should be acquired. If this option
is not set, default credentials are used.
OPTIONAL ENCRYPTION OPTIONAL ENCRYPTION
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment