RocketChatからOutgoing Webhookで呼び出されたAPI Gatewayでtokenをリクエスト検証する

2023/03/23

本来はWAFでやったほうがよさそうですが、追加料金を発生させたくない場合にAPI Gatewayだけで検証してみました。

RocketChatの設定

RocketChatのOutgoing Webhookでトークンを設定しました。
このトークンはリクエスト本文に含まれてPOSTされます。

API Gatewayの設定

APIのモデルを作成しました。

RocketChatToken

{
  "type" : "string",
  "enum" : [ "**********" ]
}

{

"type" : "string",

"enum" : [ "**********" ]

}

トークンの値です。

RocketChatTokenCheck

{
  "type" : "object",
  "properties" : {
    "token" : {
      "$ref":"https://apigateway.amazonaws.com/restapis/1j23j4k5j/models/RocketChatToken"
    }
  },
  "required":["token"]
}

{

"type" : "object",

"properties" : {

"token" : {

"$ref":"https://apigateway.amazonaws.com/restapis/1j23j4k5j/models/RocketChatToken"

}

"required":["token"]

}

本文に含まれるキーから値を参照しています。

APIリソースのメソッドリクエストの設定で、リクエストの検証を本文にして、作成したモデルを指定しました。

検証のテスト

RocketChatから投稿してAPIにPOSTしてみます。
API GatewayではCloudWatch Logsへの出力を設定しています。

Method request body before transformations:
の次に
Request validation succeeded for content type application/json
のログが出力されていました。
成功しました。

検証に失敗するテストのために、POSTMANから適当なトークンの値でPOSTしてみました。

Request body does not match model schema for content type application/json: [instance value (“abcdefghi”) not found in enum (possible values: [“***********”])]
このログが出力されていました。
値が違ったので400 Bad Requestエラーになりました。
requiredを指定しているのでtokenキーが本文にない場合もエラーになります。

最後までお読みいただきましてありがとうございました！

【PR】「AWS認定試験対策 AWS クラウドプラクティショナー」という本を書きました。

【PR】「AWSではじめるLinux入門ガイド」という本を書きました。

【PR】「ポケットスタディ AWS認定デベロッパーアソシエイト」という本を書きました。

【PR】「AWS認定資格試験テキスト＆問題集　AWS認定ソリューションアーキテクト - プロフェッショナル」という本を書きました。