Amazon Cognitoのカスタム認証チャレンジの実装でNotAuthorizedExceptionにハマった話
Amazon Cognitoで独自の認証フローを作ろうとしています。
認証フローを独自に組み立てるには、カスタム認証フロー(CUSTOM_AUTH)を指定してチャレンジします。今回は「非公開のQRコード(ハッシュ化した特別な文字列が記載されている)を読み取って、その文字列がDBに記録されていたら、ログイン成功とみなしてid_token/access_tokenを返す」ような認証を作ろうとしていました。
tl;dr
- Amazon Cognitoのカスタム認証フローで、InitiateAuth 時に NotAuthorizedException (Incorrect username or password) が発生する問題を解決しました。
- エラーメッセージは不正確であり、実際の原因はパスワード不一致ではなく create_auth_challenge トリガーのレスポンス不備にありました。
- 解決には、event["response"]["publicChallengeParameters"] などのパラメータに、空ではない値(ダミー値でも可)をセットする必要がありました。
どんな実装をしていたのか
初めに言っておきたいのは、Amazon Cognitoの公式ページでは、カスタム認証チャレンジの例として、SRP認証を通る例示しか無いため、SRP認証が必須のように思えてしまいます。もちろんそんなことはなく、パスワードを入力しないでもログインを通すことが可能です。今回はそれを期待していました。
さて、以下のようにカスタム認証チャレンジのdefine/create/verifyのラムダを実装し、CognitoのアプリケーションクライアントにALLOW_CUSTOM_AUTHを設定し、Cognitoの拡張機能でLambda トリガーとして認証チャレンジ3つを登録している状態まで持っていきます。
import json
import logging
import os
logger = logging.getLogger(__name__)
logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
def lambda_handler(event, context):
try:
session = event.get("request", {}).get("session", [])
if len(session) == 0:
event["response"]["challengeName"] = "CUSTOM_CHALLENGE"
event["response"]["issueTokens"] = False
event["response"]["failAuthentication"] = False
elif len(session) > 0 and session[-1].get("challengeResult") is True:
event["response"]["issueTokens"] = True
event["response"]["failAuthentication"] = False
else:
event["response"]["issueTokens"] = False
event["response"]["failAuthentication"] = True
except Exception as e:
logger.error(e, exc_info=True)
raise e
return event
import json
import logging
import os
logger = logging.getLogger(__name__)
logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
def lambda_handler(event, context):
try:
challenge_name = event.get("request", {}).get("challengeName", "")
if challenge_name != "CUSTOM_CHALLENGE":
return event
event["response"]["publicChallengeParameters"] = {}
event["response"]["privateChallengeParameters"] = {}
event["response"]["challengeMetadata"] = "HOGE_CHALLENGE"
except Exception as e:
logger.error(e, exc_info=True)
raise e
return event
import json
import logging
import os
logger = logging.getLogger(__name__)
logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
def lambda_handler(event, context):
try:
challenge_answer = event.get("request", {}).get("challengeAnswer", "")
answer_correct = verify_answer(challenge_answer)
event["response"]["answerCorrect"] = answer_correct
except Exception as e:
logger.error(e, exc_info=True)
event["response"]["answerCorrect"] = False
return event
def verify_answer(challenge_answer: str) -> bool:
return True
実行するとエラーが発生する
非常にシンプルなサンプルとして実装しましたが、別のラムダからInitiateAuthを呼び出してみると、エラーが発生します。CLIで実行しても同じ結果になります。
$ aws cognito-idp initiate-auth \
--auth-flow CUSTOM_AUTH \
--client-id xxxxxxxxxxxxxxxxxxxxxxxx \
--auth-parameters USERNAME=test_user01
An error occurred (NotAuthorizedException) when calling the InitiateAuth operation: Incorrect username or password.
調査
このエラーを見ると、「もしかして、SRP認証とかでパスワードを通さないとだめなのか?」と不安になります。ただ、結論から言えば、 ユーザー名やパスーワードは全く関係ありませんでした 。いわゆるセキュリティ上の理由で詳細なエラーを返さないがために、非常にわかりにくいエラーメッセージになっているだけで「認証が途中で失敗しました」くらいの意味だと言えそうです。
エラーの原因を探るのも大変でした。
- 実行ログをCloudWatchで見ても、define_auth_challengeとcreate_auth_challengeのログは残っていて正常終了しているのに、verify_auth_challengeのログは見当たりません。
- 別のラムダからInitiateAuthを呼び出したら例外(NotAuthorizedException)が返ってきてしまったので、後続のRespondToAuthChallengeの呼び出しに進んでおらず、verify_auth_challengeは呼ばれていません。
- CloudTrailのInitiateAuthのイベント履歴を見ても、上記のエラーメッセージと同じ情報量しか記録されていません。
- 試しにCognitoの脅威保護(旧Advanced Security Mode)を有効化してログを見てみても、エラーの原因はわかりません。
devin.aiに聞いてみても、設定不備を疑われまくったのですが、根気強く会話していると、devin.aiがstackoverflowの記事を見つけてきてくれました。
create-auth-challenge で、event.response.clientMetadata を指定する場合、private または public challengeParameters、あるいはその両方を指定する必要があります。そうしないと機能しません。
修正
初耳だわ!
ということで、publicChallengeParametersに適当なパラメータをセットすることで、意図した動作になりました。
import json
import logging
import os
logger = logging.getLogger(__name__)
logger.setLevel(os.getenv("LOG_LEVEL", "INFO"))
def lambda_handler(event, context):
try:
challenge_name = event.get("request", {}).get("challengeName", "")
if challenge_name != "CUSTOM_CHALLENGE":
return event
event["response"]["publicChallengeParameters"] = {"hoge": "fuga"}
event["response"]["privateChallengeParameters"] = {}
event["response"]["challengeMetadata"] = "HOGE_CHALLENGE"
except Exception as e:
logger.error(e, exc_info=True)
raise e
return event
これはハマるわ。
Discussion