大晦日にCognito / APIGateway / Lumenでいかがでしょうか – 時々WAF –

ACLの作成

まずはWAFでACLを作成します。

ALB-ACLの作成

AWS resource to associateには各自事前に作成したALBを選択してください。

Conditionsの作成

次にConditionsの設定画面です。

create-conditions-1

create-conditions-2

今回は「x-hogehoge-auth」というカスタムheaderに「ランダムに選定された固定文字列」が完全に一致していたらリクエストを通過させ、それ以外はForbiddenとするConditionsを作成します。

ですので、一番下にある「String and regex match conditions」の「Create Conditions」を押下します。

create-match-condition-1

create-match-condition-2

Value to matchのhogefugapiyoは適切な文字列を設定してください。

Ruleの作成

次にRuleを作成し、先ほど作成したConditionsと紐付けます。

create-rules-1

この画面に遷移しますが、まずはこの中の「Create rule」ボタンを押し、以下のように選択・記入します。

create-rule-2

「when a request」の中で「先ほど作成したConditions」が「一致したら」というRuleを作成します。
なので、「Please select」の箇所は先ほど各自が作成したConditionsを選択します。

これでACLに作成したRuleを追加できるようになりましたので、添付画像create-rule-1の「Rules」で、今作成したRuleを選択し、「Add rule to web ACL」ボタンを押下します。

create-rule-3

追加したRuleは上記のようにActionに「Allow」を設定し、それ以外はデフォルトで拒否させたい(=Forbidden)ので「Block all requests...」を選択します。

これで完成です！

tinkerがない！

というより、artisanがかなり機能が絞られてる！
make:middlewareだったり、controllerがなかったりもします。

$ php artisan
Laravel Framework Lumen (5.7.6) (Laravel Components 5.7.*)

Usage:
command [options] [arguments]

Options:
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
--env[=ENV] The environment the command should run under
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
help Displays help for a command
list Lists commands
migrate Run the database migrations
tinker Interact with your application
auth
auth:clear-resets Flush expired password reset tokens
cache
cache:clear Flush the application cache
cache:forget Remove an item from the cache
cache:table Create a migration for the cache database table
db
db:seed Seed the database with records
make
make:migration Create a new migration file
make:seeder Create a new seeder class
migrate
migrate:fresh Drop all tables and re-run all migrations
migrate:install Create the migration repository
migrate:refresh Reset and re-run all migrations
migrate:reset Rollback all database migrations
migrate:rollback Rollback the last database migration
migrate:status Show the status of each migration
queue
queue:failed List all of the failed queue jobs
queue:failed-table Create a migration for the failed queue jobs database table
queue:flush Flush all of the failed queue jobs
queue:forget Delete a failed queue job
queue:listen Listen to a given queue
queue:restart Restart queue worker daemons after their current job
queue:retry Retry a failed queue job
queue:table Create a migration for the queue jobs database table
queue:work Start processing jobs on the queue as a daemon
schedule
schedule:finish Handle the completion of a scheduled command
schedule:run Run the scheduled commands

FormRequestがない！！！

これが一番衝撃が大きかったです。
Laravelでvalidator扱う時にはFormRequestが個人的に一番重宝していたので、ショッキングでした。
Lumenerの方々はどうしているのでしょうか？？？？

AppServiceProviderがデフォで有効になってない

• 小一時間悩んだ。。bootstrap/app.phpでコメントアウトされているので外す。

tips(?)共有

Lumenを使ったサンプルリポジトリをGitにあげたので、こちらを見ながらの紹介になります。

github.com

私はFormRequestを使う時、以下のような使い方をしています。
https://github.com/yueguchi/cognito-lumen-sample/blob/master/app/Http/FormRequests/BaseFormRequest.php

こちらのBaseFormRequest.phpでextends FormRequestしてます。
認証はCognitoに任せている = APIでチェックする必要ないので、以下のようにします。

public function authorize()
{
  return true;
}

また、validatorに失敗した時は全て400パラメータエラーにして返却しています。
エラーメッセージ配列を全て「/」で文字列として繋げています。

/**
 * バリデーション試行の失敗の処理
 *
 * @param Validator|\Illuminate\Contracts\Validation\Validator $validator
 * @throws HttpResponseException
 */
protected function failedValidation(Validator $validator)
{
  abort(400, implode('/', $validator->errors()->all()));
}

また、リクエストパラメータだけでなく、ルートパラメータ(例: http://localhost:9999/users/1)もvalidation対象にしたいため、以下のように統合させています。

/**
  * URLのpathパラメータ(route parameter)もvalidationターゲットに含める
  *
  * @param array|null $keys
  * @return array
  */
public function all($keys = null)
{
  return array_replace_recursive(parent::all(), $this->route());
}

こうした上で、あとは必要に応じてBaseFormRequest.phpを継承した子クラスを以下のように作成・利用します。

https://github.com/yueguchi/cognito-lumen-sample/blob/master/app/Http/FormRequests/UserListRequest.php

class UserListRequest extends BaseFormRequest
{
    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
          'sub' => 'required|unique:users',
          'page' => 'required|integer|min:0',
          'limit' => 'required|in:20,40,50'
        ];
    }
}

あとはControllerのConstructorで以下のようにインジェクトすることでFormRequestのvalidatorがControllerの内部処理に先行して評価されます。

https://github.com/yueguchi/cognito-lumen-sample/blob/master/app/Http/Controllers/UserController.php

/**
  * [GET] Users List
  *
  * @param UserListRequest $request リクエスト
  * @return mixed Array
  */
public function index(UserListRequest $request)
{
  return $this->userService->get($request->only(['sub', 'page', 'limit']));
}

最後に、Exceptions/Handler.phpでjson形式でエラーを返却するように指定します。
ここはよしなに、やりたいようにラッピングしたら良いと思います。

public function render($request, Exception $e)
{
  $status = $e->getStatusCode();
  $message = $e->getMessage() ?: 'Error';
  switch ($status) {
    case 404:
      message = 'Not Found.';
      break;
    case 405:
      $message = 'Method Not Allowed.';
      break;
    case 500:
      $message = 'Internal Server Error.';
       break;
  }
  return response()->json([
      'code' => $status,
      'message' => $message
   ], $status);
}

こんな感じでFormRequestにvalidatorを丸っとお願いできていたので、FormRequestがないLumenでは公式でも

Form requests are not supported by Lumen. If you would like to use form requests, you should use the full Laravel framework.

はい。FormRequest使いたいならLaravel使おうねって言ってますw
結局あれもこれもと入れていくなら、もう大人しくLaravelで良いのでは？と思いましたw