Alternc_Api_Auth_Login Class Reference

Authentication API used by server to authenticate a user using his alternc login and password. More...

Inheritance diagram for Alternc_Api_Auth_Login:

Public Member Functions
	__construct ($service)
	Constructor of the Login Api Auth. More...
	auth ($options)
	Authenticate a user. More...
	instructions ()
	instructions on how to use this Auth class More...

Public Attributes
const	ERR_INVALID_ARGUMENT = 1111201

Private Attributes
	$db

Detailed Description

Authentication API used by server to authenticate a user using his alternc login and password.

Definition at line 7 of file Login.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Auth_Login::__construct

(

$service

)

Constructor of the Login Api Auth.

Parameters

$service

an Alternc_Api_Service object

Returns

create the object

Implements Alternc_Api_Auth_Interface.

Definition at line 19 of file Login.php.

                                   {
 
        if (!($service instanceof Alternc_Api_Service))
            throw new \Exception("Invalid argument (service)", ERR_INVALID_ARGUMENT);
 
        $this->db = $service->getDb();
    }

References ERR_INVALID_ARGUMENT.

Member Function Documentation

auth()

Alternc_Api_Auth_Login::auth

(

$options

)

Authenticate a user.

Parameters

$options

options, depending on the auth scheme, including uid for setuid users here, login is the AlternC username, and password is the password for this username.

Returns

an Alternc_Api_Token

Implements Alternc_Api_Auth_Interface.

Definition at line 34 of file Login.php.

                            {
 
        if (!isset($options["login"]) || !is_string($options["login"])) {
            throw new \Exception("Missing required parameter login", self::ERR_INVALID_ARGUMENT);
        }
        if (!isset($options["password"]) || !is_string($options["password"])) {
            throw new \Exception("Missing required parameter password", self::ERR_INVALID_ARGUMENT);
        }
 
        if (!preg_match("#^[0-9a-zA-Z-]{1,32}$#", $options["login"])) { // FIXME : normalize this on AlternC !!!
            throw new \Exception("Invalid login", self::ERR_INVALID_LOGIN);
        }
 
        $stmt = $db->query("SELECT m.enabled,m.uid,m.login,m.su FROM membres m WHERE m.login=? AND m.password=?;", array($options["login"], $options["password"]), PDO::FETCH_CLASS);
        $me = $stmt->fetch();
        if (!$me)
            return new Alternc_Api_Response(array("code" => ERR_INVALID_AUTH, "message" => "Invalid login or password"));
        if (!$me->enabled)
            return new Alternc_Api_Response(array("code" => ERR_DISABLED_ACCOUNT, "message" => "Account is disabled"));
 
        return Alternc_Api_Token::tokenGenerate(
                        array("uid" => $me->uid, "isAdmin" => ($me->su != 0)), $this->db
        );
    }

References $db, and Alternc_Api_Token\tokenGenerate().

instructions()

Alternc_Api_Auth_Login::instructions

(

)

instructions on how to use this Auth class

Returns

array("fields" => array("fields to send, required or not"), "description" => "description of this auth")

Implements Alternc_Api_Auth_Interface.

Definition at line 63 of file Login.php.

                            {
        return array("fields" => array("login" => "AlternC user account", "password" => "AlternC's user password stored in membres table."),
            "description" => "Authenticate against an AlternC user and password, the same as for the control panel"
        );
    }

Member Data Documentation

$db

Alternc_Api_Auth_Login::$db

private

Definition at line 9 of file Login.php.

Referenced by auth().

ERR_INVALID_ARGUMENT

const Alternc_Api_Auth_Login::ERR_INVALID_ARGUMENT = 1111201

Definition at line 11 of file Login.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• lib/Alternc/Api/Auth/Login.php