iauth: Send an empty "u" message on ident lookup failure.
[ircu2.10.12-pk.git] / doc / readme.iauth
index 133e4e228927d43444e60d6c48d58071de69bb83..1962d9cd5a9ddc2b8273818d11879167fd883c1b 100644 (file)
@@ -114,8 +114,8 @@ Comments: This is an example message description.  Each message is a
   message may be sent during those states (restrictions only make
   sense when Next State is -).  The Next State field indicates which
   new state is implied by the message; a hyphen indicates no state
-  change is implied.  The X (Example) message is not a real message
-  type.
+  change is implied.  This is an example, not a description of the
+  actual X message.
 Compatibility: If we believe ircu behavior is different than ircd's,
   this describes ircd's behavior or expectations.
 
@@ -174,12 +174,14 @@ Compatibility: ircd only sends the <username> parameter.
 
 u - Client Username
 Syntax: <id> u <username>
+Syntax: <id> u
 Example: 5 u notbuddha
 States: REGISTER(1)
 Next State: -
 Comments: Indicates a more reliable username for the client.
 Compatibility: This is an Undernet extension and ircd does not send
   it.  It is enabled by the iauth instance requesting the U policy.
+  If the identd lookup fails for a user, no username is passed.
 
 n - Client Nickname
 Syntax: <id> n <nickname>
@@ -235,6 +237,33 @@ Comments: Indicates the server's name and upper bound on client
 Compatibility: ircd does not include the <capacity> information.
   The <id> should be ignored: ircd sends 0 and ircu sends -1.
 
+X - Extension Query Reply
+Syntax: <id> X <servername> <routing> :<reply>
+Example: -1 X channels.undernet.org 5/127.0.0.1/6667 :OK kev Logged in
+States: N/A
+Next State: -
+Comments: Used to deliver the reply to an extension query to the iauth
+  instance.  The <servername> parameter indicates the origin of the
+  reply.  The <routing> parameter is the same as was used in the X
+  message from the iauth instance, and can be used to pair the reply
+  with the original request.  The <reply> parameter contains the text
+  of the reply.
+Compatibility: This is an Undernet extension and ircd does not send
+  it.
+
+x - Extension Query Server Not Linked
+Syntax: <id> x <servername> <routing> :Server not online
+Example: -1 x channels.undernet.org 5/127.0.0.1/6667 :Server not online
+States: N/A
+Next State: -
+Comments: Used to indicate to the iauth instance that the server
+  specified in the X message is not presently linked to the network.
+  This will not detect the extension query being lost due to a network
+  break, so iauth instances should further implement a timeout
+  mechanism for extension queries.
+Compatibility: This is an Undernet extension and ircd does not send
+  it.
+
 IAUTH MESSAGES
 ==============
 
@@ -251,6 +280,7 @@ Comments: This is an example message description.  Each message is a
   accept this message.  Clients in other states should ignore the
   message or treat it as an error.  The Next State field, where
   present, indicates what the next state should be for the client.
+  This is an example, not a description of the actual X message.
 Compatibility: If we believe ircu behavior is different than ircd's,
   this describes ircd's behavior or expectations.
 
@@ -366,8 +396,8 @@ Compatibility: This is an Undernet extension and ircd does not support
   this message.
 
 I - Client IP Address
-Syntax: N <id> <currentip> <remoteport> <newip>
-Example: N 5 192.168.1.10 23367 127.128.129.130
+Syntax: I <id> <currentip> <remoteport> <newip>
+Example: I 5 192.168.1.10 23367 127.128.129.130
 States: REGISTER, HURRY
 Next State: -
 Comments: Indicates that the iauth instance wants the server to
@@ -377,6 +407,16 @@ Comments: Indicates that the iauth instance wants the server to
 Compatibility: This is an Undernet extension and ircd does not support
   this message.
 
+M - Adjust User Mode
+Syntax: M <id> <remoteip> <remoteport> +<mode changes>
+Example: M 5 192.168.1.10 23367 +iwg
+States: REGISTER, HURRY
+Next State: -
+Comments: Indicates a set of user mode changes to be applied to the
+  client.
+Compatibility: This is an Undernet extension and ircd does not support
+  this message.
+
 C - Challenge User
 Syntax: C <id> <remoteip> <remoteport> :<challenge string>
 Example: C 5 192.168.1.10 23367 :In which year did Columbus sail the ocean blue?
@@ -408,6 +448,18 @@ Next State: GONE
 Comments: Indicates that the specified client should be disconnected
   for the reason given.  Operators should be notified.
 
+d - "Soft" Done Checking
+Syntax: d <id> <remoteip> <remoteport>
+Example: d 5 192.168.1.10 23367
+States: REGISTER, HURRY
+Next State: -
+Comments: Indicates that the iauth instance has no objection to letting
+  the specified client onto the network, but that some further work is
+  in process.  In particular, an account stamp and/or connection class
+  might be available later.
+Compatibility: This is an Undernet extension and ircd does not support
+  this message.
+
 D - Done Checking
 Syntax: D <id> <remoteip> <remoteport> [class]
 Example: D 5 192.168.1.10 23367
@@ -430,3 +482,15 @@ Comments: Indicates that the iauth instance believes the specified
   should be assigned to that class.
 Compatibility: This is an Undernet extension and ircd does not support
   this message.
+
+X - Extension Query
+Syntax: X <servername> <routing> :<query>
+Example: X channels.undernet.org 5/127.0.0.1/6667 :login kev pass
+Comments: Used by the iauth instance to send an extension query to
+  the server specified by <servername>.  The <routing> parameter is
+  not interpreted by the servers; it will be returned unchanged in
+  the extension query reply message (the X server message) and may be
+  used to pair the query with its reply.  The <query> parameter is
+  sent to <servername>.
+Compatibility: This is an Undernet extension and ircd does not support
+  this message.