Alternc_Api_Auth_Sharedsecret Class Reference

Authentication API used by server to authenticate a user using a SHARED SECRET (ApiKey) More...

Inheritance diagram for Alternc_Api_Auth_Sharedsecret:

Public Member Functions
	__construct ($service)
	Constructor of the Shared Secret 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 = 1111801
const	ERR_INVALID_SECRET = 1111802
const	ERR_INVALID_LOGIN = 1111803
const	ERR_DISABLED_ACCOUNT = 1111804
const	ERR_INVALID_AUTH = 1111805

Private Attributes
	$db

Detailed Description

Authentication API used by server to authenticate a user using a SHARED SECRET (ApiKey)

Definition at line 7 of file Sharedsecret.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Auth_Sharedsecret::__construct

(

$service

)

Constructor of the Shared Secret Api Auth.

Parameters

$service

an Alternc_Api_Service object

Returns

create the object

Implements Alternc_Api_Auth_Interface.

Definition at line 23 of file Sharedsecret.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_Sharedsecret::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 secret is a valid shared secret for this user.

Returns

an Alternc_Api_Token

Implements Alternc_Api_Auth_Interface.

Definition at line 38 of file Sharedsecret.php.

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

References Alternc_Api_Token\tokenGenerate().

instructions()

Alternc_Api_Auth_Sharedsecret::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 71 of file Sharedsecret.php.

                            {
        return array("fields" => array("login" => "AlternC user account", "secret" => "API Key, Shared secrets, valid for this account, stored in sharedsecret table."),
            "description" => "Authenticate against an Api Key, also called SharedSecret. distinct from the account's password, can be plenty and revoked independently"
        );
    }

Member Data Documentation

$db

Alternc_Api_Auth_Sharedsecret::$db

private

Definition at line 9 of file Sharedsecret.php.

ERR_DISABLED_ACCOUNT

const Alternc_Api_Auth_Sharedsecret::ERR_DISABLED_ACCOUNT = 1111804

Definition at line 14 of file Sharedsecret.php.

ERR_INVALID_ARGUMENT

const Alternc_Api_Auth_Sharedsecret::ERR_INVALID_ARGUMENT = 1111801

Definition at line 11 of file Sharedsecret.php.

Referenced by __construct().

ERR_INVALID_AUTH

const Alternc_Api_Auth_Sharedsecret::ERR_INVALID_AUTH = 1111805

Definition at line 15 of file Sharedsecret.php.

ERR_INVALID_LOGIN

const Alternc_Api_Auth_Sharedsecret::ERR_INVALID_LOGIN = 1111803

Definition at line 13 of file Sharedsecret.php.

ERR_INVALID_SECRET

const Alternc_Api_Auth_Sharedsecret::ERR_INVALID_SECRET = 1111802

Definition at line 12 of file Sharedsecret.php.

---

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

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