VOYAGE GROUP　エンジニアブログ

こんにちは、底辺プログラマの高橋です。

(6)認証設定(doctrine利用の認証の場合)
「Symfony2のススメ1」(5)の記述から「encoders」と「providers」の項目を変更します。
「chain_provider」を指定する事で前回の設定を行った「user」アカウントでの設定を有効にしつつ追加設定を行っています。
このように複数のエンコーダー、プロバイダーを定義できる点 もこの認証機能のすぐれた点となります。

$ vi app/config/security.yml
security:
    encoders:
        main1:
            class:     Symfony\Component\Security\Core\User\User
            algorithm: plaintext
        main2:
            class:     Acme\SecurityBundle\Entity\User
            algorithm: sha1
    providers:
        chain_provider:
            providers: [in_memory, main]
        in_memory:
            users:
                user:  { password: userpass, roles: [ 'ROLE_USER' ] }
                admin: { password: adminpass, roles: [ 'ROLE_ADMIN' ] }
        main:
            entity:
                class: Acme\SecurityBundle\Entity\User
                property: username

(7)エンティティクラスの作成
symfony1系だと「lib/model」の下にモデルクラスが作成されていましたが、
Symfony2系はバンドルディレクトリの「Entity」下に作成する事になると思います。(※1)
設定ファイルからのクラスの自動生成も可能ですが、今回は手動で以下のファイルを作成します。

$ vi src/Acme/SecurityBundle/Entity/User.php
<?php
namespace Acme\SecurityBundle\Entity;
use Symfony\Component\Security\Core\User\UserInterface;
use Doctrine\ORM\Mapping as ORM;
/**
  * @orm\Entity(repositoryClass="Acme\SecurityBundle\Repository\UserRepository")
  * @orm\Table(name="user")
  */
class User implements UserInterface {
    /**
     * @orm\Id
     * @orm\Column(type="integer")
     * @orm\GeneratedValue(strategy="AUTO")
     */
    protected $id;
    /**
     * @orm\Column(name="username",unique="true", nullable="true")
     */
    protected $username;
    /**
     * @orm\Column(name="password",length="128")
     */
    protected $password;
     /**
      * @orm\Column(name="salt", length="16")
      */
    protected $salt;
    public function getRoles(){
        return array("ROLE_USER");
    }
    public function getPassword(){
        return $this->password;
    }
    public function getSalt(){
        return $this->salt;
    }
    public function getUsername(){
        return $this->username;
    }
    public function eraseCredentials(){
    }
    public function equals(UserInterface $user){
        return $this->getUsername() == $user->getUsername();
    }
}

コマンドを実行するとコメントの定義を元にセッター/ゲッターメソッドを「User.php」に自動生成してくれます。
コメントの「@orm～」の部分がデータベースの定義の記述となります。 

php app/console doctrine:generate:entities AcmeSecurityBundle:User

php app/console doctrine:schema:update --force

ユーザ管理に利用するテーブルのエンティティクラスは「UserInterface」をimplementsする必要があります。
そのため、Interfaceに定義されている下記メソッドを実装しています。

getRoles():      # ユーザの権限を返す
getPassword():   # ユーザのパスワードを返す
getSalt():       # ユーザのサルトを返す
getUsername():   # ユーザを識別するIDを返す
eraseCredentials(): # 重要なデータが含まれている場合の削除処理
equals():        # 同じユーザであるとの判定処理

(8)レポジトリクラスの作成
Symfony1系では「lib/model」の下に自動生成されていた「XXXXTable.class.php」(doctrineの場合)
「XXXXXPeer.php」(Propelの場合)と同じような用途のクラスとなります。(※1)
このクラスも自分で作成する必要があります。

$ vi src/Acme/SecurityBundle/Repository/UserRepository.php
<?php
namespace Acme\SecurityBundle\Repository;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Core\User\UserInterface;
use Doctrine\ORM\EntityRepository;
use Acme\SecurityBundle\Entity\User;

class UserRepository extends EntityRepository implements UserProviderInterface {
    public function loadUserByUsername($username) {
        return $this->findOneBy(array('username' => $username));
    }
    public function supportsClass($class)
    {
        return true;
    }
    public function refreshUser(UserInterface $user)
    {
        if (!$user->getUsername()) {
            throw new Exception(sprintf('Instances of "%s" are not supported.', get_class($user)));
        }
        return $this->loadUserByUsername($user->getUsername());
    }
}

loadUserByUsername($username)     # usernameが与えられた時のユーザのロード処理
supportsClass($class)             # classの型の妥当性
refreshUser(UserInterface $user)  # ユーザのリフレッシュ処理

以上でユーザ認証する処理の実装は完了となります。
ユーザを作成する処理の実装については割愛します。Userテーブルに以下SQLでデータを入れると「hoge/hoge」でログインできるようになります
(今回の設定だと「sha1→base64」のストレッチングをデフォルトで5000回行なうのでこの値となります)

insert into user(id, username, password, salt) values(1, 'hoge', 'E5GwPYtO3mEBCJ3mTVn2VTu8p40=', '');

※1 エンティティとリポジトリについて
エンティティ/リポジトリという用語が登場しますが、このフレーズそのものはPofEAAやDDDで
使用されているパターン名になります。
自分の理解だと(怪しいですがｗ）下のような意味を持つようです。
エンティティは同一性をもったオブジェクトで、同一性とは5歳の自分と20歳の自分は属性情報が異なるが
同一性を持っておりエンティティとなる。逆に同じ属性情報をもっていても同一性がないと値オブジェクトとなる。
リポジトリはオブジェクトにアクセスするため手段で、データへのアクセス手段をカプセル化してドメイン-モデルレイヤ間の明確な分離を行う。
DDDのエッセンス：http://www.ogis-ri.co.jp/otc/hiroba/technical/DDDEssence/chap2.html
Repository(PofEAA)：http://capsctrl.que.jp/kdmsnr/wiki/PofEAA/?Repository

今回実装した認証処理は自分が確認した時点では、リリースされたばかりのせいか
本家のドキュメントを眺めても纏まっておらずグーグル先生に尋ねたり、ソースを見るなど少しがんばる必要がありました。
ただユーザ会の方々がドキュメントを翻訳されてますし、今後も利用ケースが増えてくれば情報は充実していくと思います。
php5.3を利用する要件の場合、選択肢の一つになってくると思いますので機会があったら一度試してみてはいかがでしょうか？
また最後になりますが、下書き段階の文章にご感想いただいた@brtriverさんありがとうございました！