株式会社ECナビ傘下のPeXで底辺のプログラマをやってます。高橋と言います。
底辺の実力と引き出しの少なさから何を書こうか道に迷っていたのですが
7/28にPHP5.3対応のフレームワークであるSymfony2(※1)がリリースされたという事で
Symfony2のユーザ認証まわりと簡単なカスタマイズを触れていきたいと思います。
※1 Symfony2とは何ぞやという人は下記ページをご参考にしてください。
Symfony2 公式 http://symfony.com/
日本Symfonyユーザー会 http://docs.symfony.gr.jp/
Symfony2 ドキュメント日本語版 http://docs.symfony.gr.jp/symfony2/index.html
今回の環境
今回の記事を書くにあたって下記構成で動作確認を行いました。
CentOS release 5.6 PHP 5.3.6 mysql 5.5.11 Symfony Standard Edition 2.0.0
認証と認可
最初にSymfony2に限った事ではないのですが、認証と認可について簡単に知っとく必要があります。
Symfony2では認証を「Firewalls」、 認可を「Access Controls」で設定します。
認証とは
Aさん、Bさんである本人確認。
認可とは
Aさんはシステム権限なので「/admin」にアクセスできる、Bさんはユーザ権限なので「/user」にアクセスできるといった権限の確認。
では、最初に簡単なフォーム認証を作成してみます。
今回はSymfony2のインストールと設定については省いて認証の設定だけ載せますが
フレームワークのルートディレクトリ以下の構成と修正を行なうファイルは下記となります。
app/ # 設定、キャッシュ、ログなどアプリケーションのディレクトリ |-config/ # アプリケーション全体の設定
|- routing.yml # ルーティングの設定ファイル
|- security.yml # セキュリティ機能の設定ファイル
src/ # ユーザが作成したコードを設置するディレクトリ
|- Acme/SecurityBundle/ # 今回作成するログイン機能のバンドル
|- Controller/SecurityController.php # コントローラ
|- Resources/views/Security/login.html.twig # テンプレート
|- Entity/User.php # ORMクラス
|- Repository/UserRepository.php
vendor/ # 外部のソースを置くディレクトリ
web/ # ドキュメントルート
(1)認証用バンドルを作成
Symfony2では「バンドル」を作成してその配下にコードを実装します。
バンドルの殻はコマンドを実行して作成します。
色々選択肢が出ますが今回はすべてデフォルトで問題ないです。
$ php app/console generate:bundle --namespace=Acme/SecurityBundle
$ php app/console generate:bundle --namespace=Acme/SiteBundle
(2)ルーティングの設定
ルーティングとはアクセスパスと対応するコントローラなどの設定になります。。
「login」は「Acme/SecurityBundleバンドル」の「Securityコントローラ」の「loginアクション」が動作する設定となります。
「logout」、「login_check」はルーティング設定を書くだけで、あとでSymfony2がよろしくやってくれます。
「user」は認証エリアのコンテンツという事で特に実装は行いません。
$ vi app/config/routing.yml
login:
pattern: /user/login
defaults: { _controller: AcmeSecurityBundle:Security:login }
login_check:
pattern: /user/login_check
logout:
pattern: /user/logout
user:
pattern: /user/{name}
defaults: { _controller: AcmeSiteBundle:Default:index }
(3)コントローラを修正
コントローラではログイン処理は実装せずに、テンプレートへの値の引渡し処理のみを実装します。
$ vi src/Acme/SecurityBundle/Controller/SecurityController.php
<?php
namespace Acme\SecurityBundle\Controller;
use Symfony\Component\Security\Core\SecurityContext;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
class SecurityController extends Controller
{
public function loginAction()
{
$request = $this->getRequest();
$session = $request->getSession();
// get the login error if there is one
if ($request->attributes->has(SecurityContext::AUTHENTICATION_ERROR)) {
$error = $request->attributes->get(SecurityContext::AUTHENTICATION_ERROR);
} else {
$error = $session->get(SecurityContext::AUTHENTICATION_ERROR);
}
return $this->render('AcmeSecurityBundle:Security:login.html.twig', array(
'last_username' => $session->get(SecurityContext::LAST_USERNAME),
'error' => $error,
));
}
}
(4)テンプレートの修正
Symfony2からTwig(※2)というテンプレートエンジンが採用されています。
ユーザネームとパスワードを入力するフォームを作成します。
(今までのようにphpのテンプレートで記述する事も可能です。)
$ vi src/Acme/SecurityBundle/Resources/views/Security/login.html.twig
{% if error %}
<div>{{ error.message }}</div>
{% endif %}
<form action="{{ path('login_check') }}" method="post">
<label for="username">Username:</label>
<input type="text" id="username" name="_username" value="{{ last_username }}" />
<label for="password">Password:</label>
<input type="password" id="password" name="_password" />
<input type="submit" name="login" />
</form>
※2 Twigとは速くてセキュアで柔軟性の高い(と公式で主張されている)テンプレートエンジンです。
phpのテンプレートだとモダンなテンプレートエンジンでサポートされている機能がサポートされていないため導入した
と記載がありました。
個人的には「echo 」や「()」などを記述しなくて良い事で、わりかし見た目が簡潔になるのが良いと思ってます。
Twig公式 http://www.twig-project.org/
構文/設定 http://docs.symfony.gr.jp/symfony2/book/templating.html
(5)認証設定
認証の肝となる設定を行ないます。(※3)
今回は「/user」を認証エリア、その他は非認証エリアという設定にします。
「providers」「encoders」は認証方法などの項目で平文で設定ファイルのID/PASSで認証するように設定してます。
「firewalls」は認証を適用するエリア(URL)と認証しないエリアを設定しています。
「access_control」はパスに対するアクセス権限の設定しています。他にもアクセス元IPアドレスや接続プロトコル(https or http)などの設定が可能です。
$ vi app/config/security.yml※3 セキュリティ機能の設定について: http://symfony.com/doc/current/book/security.html
security:
encoders:
Symfony\Component\Security\Core\User\User: plaintext
role_hierarchy:
ROLE_ADMIN: ROLE_USER
ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]
providers:
in_memory:
users:
user: { password: userpass, roles: [ 'ROLE_USER' ] }
admin: { password: adminpass, roles: [ 'ROLE_ADMIN' ] }
firewalls:
login:
pattern: ^/user/login$
security: false
secured_area:
pattern: ^/user
form_login:
check_path: /user/login_check
login_path: /user/login
logout:
path: /user/logout
target: /user
access_control:
- { path: ^/user, roles: ROLE_USER}
これで「/user」以下にアクセスしようとすると「/user/login」のログイン画面が表示されて認証が求められるようになり、「user/userpass」でログインできるようになります。
(やり方さえ知ってれば)簡単な気がしてきましたね!