質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.05%

Cakephp3系でのAPI(提供側)の実装

解決済

回答 1

投稿

  • 評価
  • クリップ 0
  • VIEW 6,508

score 160

お世話になります。

CentOS7系
PHP7.2
MySQL5.7
Cakephp3.6.7

CakephpでAPIを作成しております。

例えば、ユーザーの登録をさせるAPIの場合、
ROOT/api/register をエンドポイントとして

ApiController.php ← 

== 省略 ==
    /**
     * User register
     *
     * @return $user
     */
    public function register()
    {
        // Input : [POST] name, birthday, email, address, gender, password
        // Output: (json) result for register

        $this->autoRender = false;

        $this->response->getType('application/json');
        $this->response->getCharset('UTF-8');

        if ($this->request->is('post')) {
            try {
                $user = $this->Users->newEntity();
                $user = $this->Users->patchEntity($user, $this->request->getData());
                if ($this->Users->save($user)) {
                    echo json_encode($user);
                    return;
                } else {
                    $this->response->body(json_encode(false));
                    return;
                }
            } catch (\PDOException $e) {
                $this->response->body(json_encode(false));
            }
        }
        $this->response->body(json_encode(false));
        return;

    }
== 省略 ==

これのAPIをPostmanをとおして実行すると、ソースは関係なしに以下のViewがかえってきます。
5000行以上あるので、該当箇所のみ記載します。

<h1 class="header-title">
Missing CSRF token cookie            
    <span class="header-type">Cake\Http\Exception\InvalidCsrfTokenException</span>
</h1>
<span class="stack-frame-file">WWW_ROOT/vendor/cakephp/cakephp/src/Http/Middleware/CsrfProtectionMiddleware.php</span>

『xsrf-token』をヘッダーなどい付与してもうまくいきませんでした。
別のバージョンのCakePHP3系では起こっていなかったのですが、どのように対応をして良いか分かりかねています。

Pご教示いただけると助かります、お願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • asahina1979

    2018/08/08 06:43

    クロスサイトの実装でCSRF設定してれば当然なきがしないでもない

    キャンセル

  • kenkbou

    2018/08/08 09:03

    ヘッダーや、ボディにトークンを埋め込んでいるのですが、、、何か良い方法があれば教えていただけると助かります、、、

    キャンセル

回答 1

checkベストアンサー

+1

CakePHP 3.5.0 から CsrfProtectionMiddleware でCSRF対策がされています。X-CSRF-Tokenヘッダーに セッションに保存されている CSRF トークンを送信すれば回避できるはずです。

なお、外部向けのAPIであれば、そもそもCSRF対策自体を無効にするでもいいのかもしれません。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/08/12 09:02

    ありがとうございます。外部から実行するものを開発しており、私も同じ記事にたどり着いたのですが、部分的にCSRF対策を無効に出来ずに全体を無効にしました。

    キャンセル

  • 2018/08/12 18:12

    そうですか... なんでしょう。自分は、Conditionally apply the middleware manuallyとなっている方の実装は、試したことがあり、うまく部分的な無効ができました。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.05%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る