CVS gsasl/doc

[gsasl-commit]

Update of /home/cvs/gsasl/doc
In directory dopio:/tmp/cvs-serv13973

Modified Files:
        gsasl.texi 
Log Message:
Fix properties.


--- /home/cvs/gsasl/doc/gsasl.texi      2004/10/31 20:23:35     1.85
+++ /home/cvs/gsasl/doc/gsasl.texi      2004/10/31 20:36:51     1.86
@@ -1210,25 +1210,48 @@
 
 @itemize
 
address@hidden GSASL_AUTHID
address@hidden @code{GSASL_AUTHID}
+
 The authentication identity.
 
address@hidden GSASL_AUTHZID
address@hidden @code{GSASL_AUTHZID}
+
 The authorization identity.
 
address@hidden GSASL_PASSWORD
address@hidden @code{GSASL_PASSWORD}
+
 The password of the authentication identity.
 
address@hidden GSASL_ANONYMOUS_TOKEN
address@hidden @code{GSASL_ANONYMOUS_TOKEN}
+
 The anonymous token.  This is typically the email address of the user.
 
address@hidden GSASL_PASSCODE
address@hidden @code{GSASL_SERVICE}
+
+The registered GSSAPI service name of the application service,
+e.g. ``imap''.  While the names are registered for GSSAPI, other
+mechanisms such as DIGEST-MD5 may also use this.
+
address@hidden @code{GSASL_HOSTNAME}
+
+Should be the local host name of the machine.
+
address@hidden @code{GSASL_GSSAPI_DISPLAY_NAME}
+
+Contain the GSSAPI ``display name'', set by the server GSSAPI
+mechanism.  Typically you retrieve this property in your callback,
+when invoked for @code{GSASL_VALIDATE_GSSAPI}.
+
address@hidden @code{GSASL_PASSCODE}
+
 The SecurID passcode.
 
address@hidden GSASL_PIN
address@hidden @code{GSASL_PIN}
+
 The SecurID personal identification number (PIN).
 
address@hidden GSASL_SUGGESTED_PIN
address@hidden @code{GSASL_SUGGESTED_PIN}
+
 A SecurID personal identification number (PIN) suggested by the server.
 
 @end itemize
@@ -1237,16 +1260,31 @@
 
 @itemize
 
address@hidden GSASL_VALIDATE_EXTERNAL
address@hidden @code{GSASL_VALIDATE_SIMPLE}
+
+You may retrieve GSASL_AUTHID, GSASL_AUTHZID and GSASL_PASSWORD and
+use them to make an authentication and authorization decision.
+
address@hidden @code{GSASL_VALIDATE_EXTERNAL}
+
 Used by EXTERNAL mechanism on the server side to validate the client.
 The GSASL_AUTHID will contain the authorization identity of the
 client.
 
address@hidden GSASL_VALIDATE_ANONYMOUS
address@hidden @code{GSASL_VALIDATE_ANONYMOUS}
+
 Used by ANONYMOUS mechanism on the server side to validate the client.
 The GSASL_ANONYMOUS_TOKEN will contain token that identity the client.
 
address@hidden GSASL_VALIDATE_SECURID
address@hidden @code{GSASL_VALIDATE_GSSAPI}
+
+Used by the GSSAPI mechanism on the server side, to validate the
+client.  You may retrieve the authorization identity from
+GSASL_AUTHZID and the GSS-API display name from
+GSASL_GSSAPI_DISPLAY_NAME.
+
address@hidden @code{GSASL_VALIDATE_SECURID}
+
 Used by SECURID mechanism on the server side to validate client.  The
 GSASL_AUTHID, GSASL_AUTHZID, GSASL_PASSCODE, and GSASL_PIN will be
 set.  It can return GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE to
@@ -1692,7 +1730,7 @@
 as it improves readability.  Possible values are:
 
 @table @code
address@hidden GSASL_OK
address@hidden @code{GSASL_OK}
 This value indicates success.  The value of this error is guaranteed
 to always be @code{0} so you may use it in boolean constructs.