Follow @mycb750

前回の続き

ドライバの実装が終わったので、呼び出し側のコード

<?php

class Controller_Base extends Controller_Template {

	public $template = 'common/template';

	public function before()
	{
		parent::before();
		$this->current_user = Auth::check() ? Model_User::find_by_username(Auth::get_screen_name()) : null;
		View::set_global('current_user', $this->current_user);
	}

}

これはoil generate admin コマンドで自動生成されるベースファイルをそのまま流用
テンプレートパスは’common/template’にしている

ログインを管理するsign.phpを作成

<?php
class Controller_Sign extends Controller_Base {

	public function before()
	{
		parent::before();
	}

	public function action_login()
	{
		if(Auth::check()) Response::redirect($this->get_groups_redirect_path());

		$val = Validation::forge();

		if (Input::method() == 'POST')
		{
			$val->add('email', 'Email or Username')
			->add_rule('required');
			$val->add('password', 'Password')
			->add_rule('required');

			if ($val->run())
			{
				if (Auth::instance()->login(Input::post('email'), Input::post('password')))
				{
					$current_user = Model_User::find_by_username(Auth::get_screen_name());
					Session::set_flash('success', e('Welcome, '.$current_user->username));

					Response::redirect($this->get_groups_redirect_path());
				}

				// login failure
				Session::set_flash('error', e('login error. please try agein'));
					
			}
		}

		$this->template->title = 'Login';
		$this->template->content = View::forge('admin/login')->set('val', $val, false);
	}

	public function action_logout()
	{
		if(!Auth::logout())
		{
			Session::set_flash('info', e('logout success'));
			Response::redirect('sign/login');
		}	
	}

	public function get_groups_redirect_path()
	{
		$groups = Auth::instance()->get_groups();
		$group = $groups[0][1];

		$group == Util_Const::GROUP_ADMINISTRATOR_KEY and $redirect_path = 'admin/index';
		$group == Util_Const::GROUP_USER_KEY and $redirect_path = 'user/index';

		return empty($redirect_path) ? '':$redirect_path;
	}
}

ログイン認証を通った場合のリダイレクト先についてはこちらの都合上、groupの権限でswitchしている。
groupのkey値をconstに指定。

<?php
class Util_Const
{
	/* ======= db ======= */
	
	const DB_DLT_OFF = 0;
	const DB_DLT_ON = 1;
	
	
	/* ======= group ======= */
	
	const GROUP_USER_KEY = 1;
	const GROUP_ADMINISTRATOR_KEY = 100;
	
}

ここまでで呼び出し完了のはず。今回はログインのみのためtb_usersテーブルにアカウントを作成しないと動かない。アカウント作成用のメソッドをauth/login/baseauth.phpに作成。

	public function create_user($username, $password, $email, $group = 1,$auth_type = 1,$dlt_flg = 0)
	{
		$password = trim($password);
		$email = filter_var(trim($email), FILTER_VALIDATE_EMAIL);

		if (empty($username) or empty($password) or empty($email))
			throw new Exception('Username, password or email address is not given, or email address is invalid');

		$user = new Model_User();
		$user->username = $username;
		$user->password = $this->hash_password((string) $password);
		$user->email = $email;
		$user->group = $group;
		$user->auth_type = $auth_type;
		$user->last_login = '';
		$user->salt = '';
		$user->dlt_flg = $dlt_flg;

		try{
			$user->save();
		}catch(Exception $e){
			throw new Exception('create user registry error');
		}
		return 1;
	}

それでは呼び出してadminアカウントを作成。ここではsignup画面は省略してoil consoleから作成。

$ oil console
>>> Auth::create_user('admin', 'password', 'test@test.co.jp', 100);
1
>>> exit

正直戻り値が成功で「１」っていうのは意味が分からないが、simpleauthに便乗している。trueにしたいところ。phpだからしかたないのかな。これでログインできれば成功かな。

今回はviewなどのコードをアップしていないので、分かりにくいところがあるので、一応githubにsignup画面込みでアップする予定。

Follow @mycb750

前回の続き

抽象メソッド全て実装。simpleauthパクってる所も多い。
本来はDB操作はモデルでメソッド作成するべきだろう。
あとUtil_Const::DB_DLT_OFFをバインドパラメータに直でbind(‘dlt_flg’ , Util_Const::DB_DLT_OFF)とパラメータ参照エラーになる。fuelphpとかではなくDB上の話。
dlt_flgでデフォルトの物理削除ではなく論理削除に回避しているので、取得時も条件式にいれている。

<?php
class Auth_Login_BaseAuth extends Auth\Auth_Login_Driver {

protected $config = array('drivers' =&gt; array('group' =&gt; array('BaseAuth')));

protected $user;

protected function perform_check() {
$current_user = Session::get('current_user');

if (!is_null($current_user) &amp;&amp; is_array($current_user)) {
if (isset($current_user['id']) &amp;&amp; isset($current_user['salt'])) {

$dlt_flg = Util_Const::DB_DLT_OFF;

$users = DB::query(
'SELECT * FROM tb_users WHERE id = :id AND salt = :salt AND dlt_flg = :dlt_flg'
)
-&gt;bind('id', $current_user['id'])
-&gt;bind('salt' , $current_user['salt'])
-&gt;bind('dlt_flg' , $dlt_flg)
-&gt;as_object('Model_User')
-&gt;execute()
-&gt;as_array();

if (!is_null($users) &amp;&amp; count($users) === 1) {
$this-&gt;user = reset($users);
return true;
}

}

}
return false;
}

public function validate_user($username_or_email = '', $password = '') {

if(empty($username_or_email) || empty($password)) return false;

$username_or_email = trim($username_or_email);
$password = trim($password);

$password = $this-&gt;hash_password($password);
$dlt_flg = Util_Const::DB_DLT_OFF;

$users = DB::query(
'SELECT * FROM tb_users WHERE (username = :username_or_email or email = :username_or_email) AND password = :password AND dlt_flg = :dlt_flg'
)
-&gt;bind('username_or_email', $username_or_email)
-&gt;bind('password' , $password)
-&gt;bind('dlt_flg' , $dlt_flg)
-&gt;as_object('Model_User')
-&gt;execute()
-&gt;as_array();

if (!is_null($users) &amp;&amp; count($users) === 1){

$this-&gt;user = reset($users);
$this-&gt;user-&gt;last_login = Date::forge()-&gt;get_timestamp();
$this-&gt;user-&gt;salt = $this-&gt;create_salt();
$this-&gt;user-&gt;save();

Session::set('current_user', array('id' =&gt; $this-&gt;user-&gt;id,'salt' =&gt; $this-&gt;user-&gt;salt));

return true;
}

return false;
}

public function login($username_or_email = '', $password = '') {
return $this-&gt;validate_user($username_or_email, $password);
}

public function logout() {
Session::delete('current_user');
return true;
}

public function get_user_id() {
if (!empty($this-&gt;user) &amp;&amp; isset($this-&gt;user['id'])) {
return array($this-&gt;id, (int)$this-&gt;user['id']);
}

return null;
}

public function get_groups() {
if (!empty($this-&gt;user) &amp;&amp; isset($this-&gt;user['group'])) {
return array(array('BaseAuth', $this-&gt;user['group']));
}
return null;
}

public function get_email() {
if (!empty($this-&gt;user) &amp;&amp; isset($this-&gt;user['email'])) {
return $this-&gt;user['email'];
}
return null;
}

public function get_screen_name() {
if (!empty($this-&gt;user) &amp;&amp; isset($this-&gt;user['username'])) {
return $this-&gt;user['username'];
}
return null;
}

public function has_access($condition, $driver = null, $entity = null) {
if (is_null($entity) &amp;&amp; !empty($this-&gt;user)) {
$groups = $this-&gt;get_groups();
$entity = reset($groups);
}
return parent::has_access($condition, $driver, $entity);
}

public function create_salt()
{
if (empty($this-&gt;user)) throw new Exception();
return sha1(Config::get('baseauth.login_hash_salt').$this-&gt;user-&gt;username.$this-&gt;user-&gt;last_login);
}
}

<?php 
class Auth_Group_BaseAuth extends Auth\Auth_Group_Driver {

protected $config = array('drivers' =&gt; array('acl' =&gt; array('BaseAuth')));

public function get_name($group = null) {
// noop
}

public function member($group, $user = null) {
$auth = empty($user) ? Auth::instance() : Auth::instance($user[0]);
$groups = $auth-&gt;get_groups();
return in_array(array($this-&gt;id, $group), $groups);
}
}

<?php 
class Auth_Acl_BaseAuth extends Auth\Auth_Acl_Driver {
public function has_access($condition, Array $entity) {
if (count($entity) &gt; 0) {
$group = Auth::group($entity[0]);
if (!is_null($group) || !empty($group)) return $group-&gt;member($condition);
}
return false;
}
}

ここまでで実装完了。コード中にutilで定義している定数を使っているのでこちらのソースも公開

<?php
class Util_Const
{
/* ======= db ======= */

const DB_DLT_OFF = 0;
const DB_DLT_ON = 1;
}

パスワードの暗号化はsimpleauthと同様driversのメソッドを呼び出し。

今回はここまで
ここまででドライバは一応実装済み。
simpleauthドライバよりもシンプルで特に勝るところもなく仕上がったかな。
あとは呼び出しのみ。

Follow @mycb750

認証ドライバの作成方法についてメモ

FuelPHPで認証用に用意されているAuthパッケージがある。Authパッケージを既に実装しているsimpleauthドライバを使用すると簡単に認証機能を実装できる。しかし、simpleauthの仕様にあわせてテーブルカラムを用意しなければならなそう？なので、中で何をやっているか解析しつつ独自にドライバを作成。

※simpleauth仕様：
http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/simpleauth/intro.html#/database

■参考
•公式サイト
http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/drivers.html
※情報が少なく全然役に立たない

•公式ドキュメント
http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/simpleauth/login.html
http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/simpleauth/groups.html
http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/simpleauth/acl.html
※英語だがAPIマニュアルとして多少役立つ

•simpleauth[packages/auth/classes/auth/配下]の実装
•親クラスdriver.php[packages/auth/classes/auth/配下]の実装

※取り込み元のコードなのでほとんどこれらを参考

実装要件

今回はドライバ名は「baseauth」にします
そしてuserテーブル構成は以下のようにします

CREATE TABLE `tb_users` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`username` varchar(50) NOT NULL,
`password` varchar(255) NOT NULL,
`group` int(11) NOT NULL DEFAULT '1',
`email` varchar(255) NOT NULL,
`last_login` int(11) NOT NULL,
`auth_type` int(11) NOT NULL DEFAULT '1',
`salt` varchar(255) NOT NULL,
`dlt_flg` tinyint(1) NOT NULL,
`created_at` int(11) NOT NULL,
`updated_at` int(11) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `username_email` (`username`,`email`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 AUTO_INCREMENT=4 ;

auth_typeはログイン画面のbasic認証か各SNS(Twitter,Facebook etc)認証かのタイプを格納するつもり(とりあえず)。ここではbasic認証のみのため、常に1で良い。dlt_flgは削除されたときに物理削除をさけるため、論理削除とするため。groupは今回は管理者adminと一般ユーザのuserのみとする。

ドライバの準備

まずは下記３点を準備する。

•Login (Auth_Login_Driver).
•Group (Auth_Group_Driver).
•Acl (Auth_Acl_Driver).

公式サイト：http://press.nekoget.com/fuelphp_doc_1.2/packages/auth/drivers.html

つまり
fuel/app/classes/authフォルダへ以下３つのフォルダを用意し、それぞれにドライバ名をつけたphpファイル「baseauth.php」を用意する。
fuel/app/classes/auth/login
fuel/app/classes/auth/group
fuel/app/classes/auth/acl

親クラスdriver.php内で抽象メソッドとして宣言しているものをとりあえずbaseauth.phpへすべて実装しておきます。

abstract protected function perform_check();
abstract public function validate_user();
abstract public function login();
abstract public function logout();
abstract public function get_user_id();
abstract public function get_groups();
abstract public function get_email();
abstract public function get_screen_name();

abstract public function member($group, $user = null);
abstract public function get_name($group);

abstract public function has_access($condition, Array $entity);

これら各メソッドの処理を実装したらドライバができるはずです。それぞれメソッドでなにをやるかはsimpleauthの実装を見ながらゆっくり考えていこうと思います。

configファイル準備

simpleauthのconfigファイルもそのまま流用。
「fuel/packages/auth/config」フォルダにあるsimpleauth.phpを「fuel/app/config」フォルダにbaseauth.phpとしてコピー。
設定情報を下記のように変更。ついでに不要なものは削除。
login_hash_saltはログイン認証後にSessionの認証をするために使用する文字列。ある程度の文字列にするとセキュリティ的に有効。simpleauthの仕様と同様に固定指定とする。

return array(
'login_hash_salt' => 'ZegakljelktPm16AA$Y/dlgadkjjelijmaaZe',
'groups' => array(
1 => array('name' => 'Users', 'roles' => array('user')),
100 => array('name' => 'Administrators', 'roles' => array('admin')),
),
'auth_type' => array(
1 => array('type' => 'Basic'),
2 => array('type' => 'Twitter'),
3 => array('type' => 'Facebook'),
),
);

authファイル準備

「fuel/packages/auth/config」フォルダにあるauth.phpを「fuel/app/config」フォルダにコピー。
そしてBaseAuthをドライバとして登録。
saltは親クラスdrivers.phpでパスワードに付与して暗号化する文字列。ある程度複雑な文字列の方がセキュリティ上よい。ただ固定していのため、ブルートフォースに負ける可能性が高い。別メモ参照

return array(
'driver' => 'BaseAuth',
'verify_multiple_logins' => false,
'salt' => 'b70Ga(Z0s4zu&1!cR#DoXrAgaa7&6aTsM$C/)ZmkZ00bkaz',
);

今回はここまで