Adding a custom authentication module - Revision history

Bahati at 09:56, 11 March 2011

2011-03-11T09:56:22Z

← Older revision		Revision as of 09:56, 11 March 2011
Line 1:		Line 1:
	{{howto\|Advanced\|[[Lorna Mitchell]] ~~<lorna@ibuildings.com>~~}}		{{howto\|Advanced\|[[Lorna Mitchell]]}}

	There are a number of different security modules available in atk - you can find them atk/security. We can easily add another, for example I added one to authenticate against a REST service. They all extend the class auth_interface, so this is a good place to start.		There are a number of different security modules available in atk - you can find them atk/security. We can easily add another, for example I added one to authenticate against a REST service. They all extend the class auth_interface, so this is a good place to start.

bahtiar at 18:02, 4 September 2008

2008-09-04T18:02:44Z

← Older revision		Revision as of 18:02, 4 September 2008
Line 10:		Line 10:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	atkimport ('atk.security.auth_interface');		atkimport ('atk.security.auth_interface');

	class auth_rest extends auth_interface		class auth_rest extends auth_interface
	{		{
	var $m_rightscache = array();		var $m_rightscache = array();

	function validateUser($user, $passwd)		function validateUser($user, $passwd)
	{		{
	if ($user=="") return AUTH_UNVERIFIED; // can't verify if we have no userid		if ($user=="") return AUTH_UNVERIFIED; // can't verify if we have no userid

	$attr = < the attributes of the result of the call to the REST service >		$attr = < the attributes of the result of the call to the REST service >
	if($attr['status'] == 'ok') {		if($attr['status'] == 'ok') {
	return AUTH_SUCCESS;		return AUTH_SUCCESS;
	} elseif ($attr['status'] == 'error') {		} elseif ($attr['status'] == 'error') {
	$error_attr = $xml->error->attributes();		$error_attr = $xml->error->attributes();
	if($error_attr['code'] == 'LoginError') {		if($error_attr['code'] == 'LoginError') {
	return AUTH_UNVERIFIED;		return AUTH_UNVERIFIED;
	} elseif($error_attr['code'] == 'BlockedUserError') {		} elseif($error_attr['code'] == 'BlockedUserError') {
	return AUTH_LOCKED;		return AUTH_LOCKED;
	}		}

	}		}

	}		}

	function canMd5()		function canMd5()
	{		{
	return false;		return false;
	}		}

	}		}
	</syntaxhighlight>		</syntaxhighlight>

bahtiar at 18:01, 4 September 2008

2008-09-04T18:01:40Z

← Older revision		Revision as of 18:01, 4 September 2008
Line 1:		Line 1:
	{{howto\|Advanced\|[[Lorna Mitchell]] <lorna@ibuildings.com>}}		{{howto\|Advanced\|[[Lorna Mitchell]] <lorna@ibuildings.com>}}

	There are a number of different security modules available in atk - you can find them atk/security. We can easily add another, for example I added one to authenticate against a REST service. They all extend the class auth_interface, so this is a good place to start. My REST ~~class~~ looked a bit like this:		There are a number of different security modules available in atk - you can find them atk/security. We can easily add another, for example I added one to authenticate against a REST service. They all extend the class auth_interface, so this is a good place to start.

			To avoid having to upload your custom class in atk/security and potentially lose it when you upgrade ATK, you can place the authentication class in your own module. For example if we have a helloworld module that provides an additional authentication method, it would be in the file:

			modules/helloworld/security/class.auth_rest.inc

			I implemented a custom authentication module using REST, and it looked a bit like this:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
			atkimport ('atk.security.auth_interface');

	class auth_rest extends auth_interface		class auth_rest extends auth_interface
	{		{
Line 36:		Line 44:

	To use this class, the $config_authentication variable needs to be set to match the new class you made. To use the example above we can do:		To use this class, the $config_authentication variable needs to be set to match the new class you made. To use the example above we can do:
			<syntaxhighlight lang="php">
			$config_authentication = "module.helloworld.security.auth_rest";
			</syntaxhighlight>

			(Note, for authentication methods in the atk/security directory, it would suffice to say:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$config_authentication = "rest";		$config_authentication = "rest";
	</syntaxhighlight>		</syntaxhighlight>

Lorna: Creating the page

2008-09-03T15:10:16Z

Creating the page

New page

{{howto|Advanced|[[Lorna Mitchell]] <lorna@ibuildings.com>}}

There are a number of different security modules available in atk - you can find them atk/security. We can easily add another, for example I added one to authenticate against a REST service. They all extend the class auth_interface, so this is a good place to start. My REST class looked a bit like this:

<syntaxhighlight lang="php">
class auth_rest extends auth_interface
{
var $m_rightscache = array();

function validateUser($user, $passwd)
{
if ($user=="") return AUTH_UNVERIFIED; // can't verify if we have no userid

$attr = < the attributes of the result of the call to the REST service >
if($attr['status'] == 'ok') {
return AUTH_SUCCESS;
} elseif ($attr['status'] == 'error') {
$error_attr = $xml->error->attributes();
if($error_attr['code'] == 'LoginError') {
return AUTH_UNVERIFIED;
} elseif($error_attr['code'] == 'BlockedUserError') {
return AUTH_LOCKED;
}

}

}

function canMd5()
{
return false;
}

}
</syntaxhighlight>

To use this class, the $config_authentication variable needs to be set to match the new class you made. To use the example above we can do:
<syntaxhighlight lang="php">
$config_authentication = "rest";
</syntaxhighlight>