User.auth - Revision history

Moritz Orbach: grammar

2014-03-13T21:15:43Z

grammar

Dana at 10:54, 21 January 2013

2013-01-21T10:54:37Z

Dana at 10:53, 21 January 2013

2013-01-21T10:53:12Z

Dana at 10:50, 21 January 2013

2013-01-21T10:50:56Z

Dana: Created page with " The '''user.auth''' is a message that requires from an authentication module a password for a certain user. If none of the authentication modules (regfile) know about thi..."

2012-10-08T10:51:24Z

Created page with " The '''user.auth''' is a message that requires from an authentication module a password for a certain user. If none of the authentication modules (regfile) know about thi..."

New page

The '''user.auth''' is a message that requires from an authentication module a password for a certain user. If none of the authentication modules ([[regfile]]) know about this user then the module who started authentication will deny user registration in the system.

Channels like SIP, H.323, IAX and voicemail are sending a '''user.auth''' to the engine.

The main parameter for this message is '''username'''. Other parameters may be present depending on the protocol used.

Currently only SIP sends the parameters for digest authentication as follows:

* protocol=sip
* nonce=''server supplied nonce''
* realm=''server supplied realm''
* method=''SIP method that is authenticated''
* uri=''SIP URI used in request''
* response=''Digest (MD5) response computed by client''

There are also some parameters that may not be always available:

* ip_host=''IP address from which the request was received''
* ip_port=''UDP or TCP port of the request''
* address=''ip_address:port of the request''

Additional parameters may be set to filter which module handles this message.
The default is to have all modules attempt to perform authentication:

* auth_register=false - Disables handling by the [[register]] database module
* auth_regfile=false - Disables handling by the [[regfile]] module

The returned value from the authentication module depends on the protocol:

* the plaintext password is returned and the sender must check it further;
* an empty string is returned if the user was authenticated by using supplied parameters;
* the message must be left unhandled to deny authentication

← Older revision		Revision as of 21:15, 13 March 2014
Line 1:		Line 1:

−	The '''user.auth''' is a message that requires ~~from an authentication module~~ a password for a certain user. If none of the authentication modules ([[regfile]]) know about this user then the module who started authentication will deny user registration in the system.	+	The '''user.auth''' is a message that requires a password for a certain user from an authentication module. If none of the authentication modules ([[regfile]]) know about this user then the module who started authentication will deny user registration in the system.

	Channels like SIP, H.323, IAX and voicemail are sending a '''user.auth''' to the engine.		Channels like SIP, H.323, IAX and voicemail are sending a '''user.auth''' to the engine.

@@ Line 10: / Line 10: @@
 Currently only SIP sends the parameters for digest authentication as follows:
-* protocol=sip
+* '''protocol'''=sip
-* nonce=''server supplied nonce''
+* '''nonce'''=''server supplied nonce''
-* realm=''server supplied realm''
+* '''realm'''=''server supplied realm''
-* method=''SIP method that is authenticated''
+* '''method'''=''SIP method that is authenticated''
-* uri=''SIP URI used in request''
+* '''uri'''=''SIP URI used in request''
-* response=''Digest (MD5) response computed by client''
+* '''response'''=''Digest (MD5) response computed by client''
 There are also some parameters that may not be always available:
-* ip_host=''IP address from which the request was received''
+* '''ip_host'''=''IP address from which the request was received''
-* ip_port=''UDP or TCP port of the request''
+* '''ip_port'''=''UDP or TCP port of the request''
-* address=''ip_address:port of the request''
+* '''address'''=''ip_address:port of the request''
 ===Additional parameters===
@@ Line 28: / Line 28: @@
 The default is to have all modules attempt to perform authentication:
-* auth_register=false - Disables handling by the [[register]] database module
+* '''auth_register'''=false - Disables handling by the [[register]] database module
-* auth_regfile=false - Disables handling by the [[regfile]] module
+* '''auth_regfile'''=false - Disables handling by the [[regfile]] module
 ===Return===

← Older revision		Revision as of 10:50, 21 January 2013
Line 32:		Line 32:
	* an empty string is returned if the user was authenticated by using supplied parameters;		* an empty string is returned if the user was authenticated by using supplied parameters;
	* the message must be left unhandled to deny authentication		* the message must be left unhandled to deny authentication
		+
		+
		+	'''See also'''
		+
		+	* [[user.account]]

@@ Line 3: / Line 3: @@
 Channels like SIP, H.323, IAX and voicemail are sending a '''user.auth''' to the engine.
 The main parameter for this message is '''username'''. Other parameters may be present depending on the protocol used.
@@ Line 20: / Line 22: @@
 * ip_port=''UDP or TCP port of the request''
 * address=''ip_address:port of the request''
 Additional parameters may be set to filter which module handles this message.
@@ Line 26: / Line 30: @@
 * auth_register=false - Disables handling by the [[register]] database module
 * auth_regfile=false - Disables handling by the [[regfile]] module
 The returned value from the authentication module depends on the protocol: