Merge branch 'experimental_ocsp'

[exim.git] / src / src / auths / README

diff --git a/src/src/auths/README b/src/src/auths/README
index a25aaf0b011a395575c2dd777c2f16fb70d4e85a..21b0cda92c31603daf9c6fd317ab613e3f784227 100644 (file)
--- a/src/src/auths/README
+++ b/src/src/auths/README
@@ -1,5 +1,3 @@
-$Cambridge: exim/src/src/auths/README,v 1.2 2004/12/20 14:57:05 ph10 Exp $
-

 AUTHS
 
 The modules in this directory are in support of various authentication
 AUTHS
 
 The modules in this directory are in support of various authentication


@@ -44,9 +42,10 @@ The second function performs authentication as a server. It receives a pointer
 to the instance block, and its second argument is the remainder of the data
 from the AUTH command. The numeric variable maximum setting (expand_nmax) is
 set to zero, with $0 initialized as unset. The authenticator may set up numeric
 to the instance block, and its second argument is the remainder of the data
 from the AUTH command. The numeric variable maximum setting (expand_nmax) is
 set to zero, with $0 initialized as unset. The authenticator may set up numeric

-variables according to its specification; it should leave expand_nmax set at
-the end so that they can be used for the expansion of the generic server_set_id
-option, which happens centrally.
+variables according to its (old) specification and $auth<n> variables the
+preferred ones nowadays; it should leave them set at the end so that they can
+be used for the expansion of the generic server_set_id option, which happens
+centrally.

 
 This function has access to the SMTP input and output so that it can write
 intermediate responses and read more data if necessary. There is a packaged
 
 This function has access to the SMTP input and output so that it can write
 intermediate responses and read more data if necessary. There is a packaged


@@ -58,7 +57,7 @@ The yield of a server authentication check must be one of:
   DEFER       couldn't complete the check
   FAIL        authentication failed
   CANCELLED   authentication forced to fail by "*" response to challenge,
   DEFER       couldn't complete the check
   FAIL        authentication failed
   CANCELLED   authentication forced to fail by "*" response to challenge,

-                or by a forced string expansion failure 
+                or by certain forced string expansion failures

   BAD64       bad base64 data received
   UNEXPECTED  unexpected data received
 
   BAD64       bad base64 data received
   UNEXPECTED  unexpected data received
 


@@ -86,7 +85,8 @@ The yield of a client authentication check must be one of:
   FAIL        failed after reading a response;
               either errno is set (for timeouts, I/O failures) or
               the buffer contains the SMTP response line
   FAIL        failed after reading a response;
               either errno is set (for timeouts, I/O failures) or
               the buffer contains the SMTP response line

-  FORCEFAIL   failed without reading a response (often "fail" in expansion)
+  CANCELLED   the client cancelled authentication (often "fail" in expansion)
+              the buffer may contain a message; if not, *buffer = 0

   ERROR       local problem (typically expansion error); message in buffer
 
 To communicate with the remote host the client should call
   ERROR       local problem (typically expansion error); message in buffer
 
 To communicate with the remote host the client should call