Skip to content

Commit

Permalink
Merge pull request yiisoft#6606 from softark/docs-guide-ja-security-a…
Browse files Browse the repository at this point in the history
…uthentication

Docs guide ja security authentication
  • Loading branch information
samdark committed Dec 21, 2014
2 parents e520f55 + 40419bb commit 8ec2336
Show file tree
Hide file tree
Showing 10 changed files with 144 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/guide-ja/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ All Rights Reserved.
セキュリティ
------------

* **翻訳未着手** [認証](security-authentication.md)
* **翻訳未着手** [権限](security-authorization.md)
* **翻訳未着手** [パスワードを扱う](security-passwords.md)
* [認証](security-authentication.md)
* **翻訳中** [権限付与](security-authorization.md)
* **翻訳中** [パスワードを扱う](security-passwords.md)
* **TBD** [Auth クライアント](security-auth-clients.md)
* **翻訳未着手** [ベストプラクティス](security-best-practices.md)
* **翻訳中** [ベストプラクティス](security-best-practices.md)


キャッシュ
Expand Down
6 changes: 6 additions & 0 deletions docs/guide-ja/db-elasticsearch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Elasticsearch
=============

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/db-mongodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Mongo DB
========

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/db-redis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Redis
=====

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/db-sphinx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Sphinx Search
=============

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/input-multiple-models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
複数のモデルを扱う複雑なフォーム
================================

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/output-pagination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ページネーション
================

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/output-sorting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
並べ替え
========

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
6 changes: 6 additions & 0 deletions docs/guide-ja/security-auth-clients.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Auth クライアント
=================

> Note|注意: この節はまだ執筆中です。
>
> まだ内容がありません。
92 changes: 92 additions & 0 deletions docs/guide-ja/security-authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
認証
====

> Note|注意: この節はまだ執筆中です。
認証はユーザが誰であるかを確認する行為であり、ログインプロセスの基礎となるものです。
典型的には、認証は、識別子 (ユーザ名またはメールアドレス) とパスワードの組み合わせを使用します。
ユーザはこれらの値をフォームを通じて送信し、アプリケーションは送信された情報を以前に (例えば、ユーザ登録時に) 保存された情報と比較します。

Yii では、このプロセス全体が半自動的に実行されます。
開発者に残されているのは、認証システムにおいて最も重要なクラスである [[yii\web\IdentityInterface]] を実装することだけです。
典型的には、`IdentityInterface` の実装は `User` モデルを使って達成されます。

十分な機能を有する認証の実例を [アドバンストアプリケーションテンプレート](tutorial-advanced-app.md) の中に見出すことが出来ます。
下記にインターフェイスのメソッドだけをリストします。

```php
class User extends ActiveRecord implements IdentityInterface
{
// ...

/**
* 与えられた ID によって識別子を探す
*
* @param string|integer $id 探すための ID
* @return IdentityInterface|null 与えられた ID に合致する識別子オブジェクト
*/
public static function findIdentity($id)
{
return static::findOne($id);
}

/**
* 与えられたトークンによって識別子を探す
*
* @param string $token 探すためのトークン
* @return IdentityInterface|null 与えられたトークンに合致する識別子オブジェクト
*/
public static function findIdentityByAccessToken($token, $type = null)
{
return static::findOne(['access_token' => $token]);
}

/**
* @return int|string 現在のユーザの ID
*/
public function getId()
{
return $this->id;
}

/**
* @return string 現在のユーザの認証キー
*/
public function getAuthKey()
{
return $this->auth_key;
}

/**
* @param string $authKey
* @return boolean 認証キーが現在のユーザに対して有効か否か
*/
public function validateAuthKey($authKey)
{
return $this->getAuthKey() === $authKey;
}
}
```

概要を述べたメソッドのうち、二つは単純なものです。
`findIdentity` は ID の値を受け取って、その ID と関連付けられたモデルのインスタンスを返します。
`getId` メソッドは ID そのものを返します。
その他のメソッドのうち、二つのもの - `getAuthKey``validateAuthKey` - は、「次回から自動ログイン ("remember me")」のクッキーに対して追加のセキュリティを提供するために使われます。
`getAuthKey` メソッドは全てのユーザに対してユニークな文字列を返さなければなりません。
`Yii::$app->getSecurity()->generateRandomString()` を使うと、信頼性の高い方法でユニークな文字列を生成することが出来ます。
これをユーザのレコードの一部として保存しておくのが良いアイデアです。

```php
public function beforeSave($insert)
{
if (parent::beforeSave($insert)) {
if ($this->isNewRecord) {
$this->auth_key = Yii::$app->getSecurity()->generateRandomString();
}
return true;
}
return false;
}
```

`validateAuthKey` メソッドでは、パラメータとして渡された `$authKey` 変数 (これ自体はクッキーから読み出されます) をデータベースから読み出された値と比較する必要があるだけです。

0 comments on commit 8ec2336

Please sign in to comment.