CVS gsasl/doc

[gsasl-commit]

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

Modified Files:
        gsasl.texi 
Log Message:
Add.


--- /home/cvs/gsasl/doc/gsasl.texi      2004/09/30 21:03:38     1.77
+++ /home/cvs/gsasl/doc/gsasl.texi      2004/10/03 22:20:00     1.78
@@ -59,6 +59,7 @@
 * Introduction::                How to use this manual.
 * Preparation::                 What you should do before using the library.
 * Using the Library::           High level overview of how to use the library.
+* Properties::                  How to specify username, password, etc.
 * Mechanisms::                  Mechanism specific information.
 * Global Functions::            Functions that can be used at all times.
 * Callback Functions::          Set and use callbacks.
@@ -1030,6 +1031,63 @@
 response.
 
 @c **********************************************************
address@hidden *******************  Properties  *************************
address@hidden **********************************************************
address@hidden Properties
address@hidden Properties
+
+Shared client and server properties:
+
address@hidden
+
address@hidden GSASL_AUTHID
+The authentication identity.
+
address@hidden GSASL_AUTHZID
+The authorization identity.
+
address@hidden GSASL_PASSWORD
+The password of the authentication identity.
+
address@hidden GSASL_ANONYMOUS_TOKEN
+The anonymous token.  This is typically the email address of the user.
+
address@hidden GSASL_PASSCODE
+The SecurID passcode.
+
address@hidden GSASL_PIN
+The SecurID personal identification number (PIN).
+
address@hidden GSASL_SUGGESTED_PIN
+A SecurID personal identification number (PIN) suggested by the server.
+
address@hidden itemize
+
+Server specific properties, used to validate client:
+
address@hidden
+
address@hidden 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
+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
+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
+ask the client to supply another passcode, and
+GSASL_SECURID_SERVER_NEED_NEW_PIN to require the client to supply a
+new PIN code.
+
address@hidden itemize
+
+
address@hidden **********************************************************
 @c *******************  Mechanisms  *************************
 @c **********************************************************
 @node Mechanisms