Skip to content

Commit 1163301

Browse files
fix(parser): accept real Cognito trigger events (#8762)
The Cognito trigger models rejected events that Cognito sends in common flows: CUSTOM_CHALLENGE in the auth challenge session, the other documented trigger sources for pre sign-up, post confirmation and the custom email and SMS senders, and a null answerCorrect or clientId. This is the same fix as powertools-lambda-typescript#5777. Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent 84f690a commit 1163301

2 files changed

Lines changed: 128 additions & 6 deletions

File tree

‎aws_lambda_powertools/utilities/parser/models/cognito.py‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# Common context model for Cognito triggers
77
class CognitoCallerContextModel(BaseModel):
88
awsSdkVersion: str
9-
clientId: str
9+
clientId: str | None = None
1010

1111

1212
# Base model for all Cognito triggers
@@ -33,7 +33,7 @@ class CognitoPreSignupResponseModel(BaseModel):
3333

3434

3535
class CognitoPreSignupTriggerModel(CognitoTriggerBaseSchema):
36-
triggerSource: Literal["PreSignUp_SignUp"]
36+
triggerSource: Literal["PreSignUp_SignUp", "PreSignUp_AdminCreateUser", "PreSignUp_ExternalProvider"]
3737
request: CognitoPreSignupRequestModel
3838
response: CognitoPreSignupResponseModel
3939

@@ -45,7 +45,7 @@ class CognitoPostConfirmationRequestModel(BaseModel):
4545

4646

4747
class CognitoPostConfirmationTriggerModel(CognitoTriggerBaseSchema):
48-
triggerSource: Literal["PostConfirmation_ConfirmSignUp"]
48+
triggerSource: Literal["PostConfirmation_ConfirmSignUp", "PostConfirmation_ConfirmForgotPassword"]
4949
request: CognitoPostConfirmationRequestModel
5050
response: dict[str, Any] = {}
5151

@@ -157,18 +157,36 @@ class CognitoCustomEmailSMSSenderRequestModel(BaseModel):
157157

158158

159159
class CognitoCustomEmailSenderTriggerModel(CognitoTriggerBaseSchema):
160-
triggerSource: Literal["CustomEmailSender_SignUp"]
160+
triggerSource: Literal[
161+
"CustomEmailSender_SignUp",
162+
"CustomEmailSender_ResendCode",
163+
"CustomEmailSender_ForgotPassword",
164+
"CustomEmailSender_UpdateUserAttribute",
165+
"CustomEmailSender_VerifyUserAttribute",
166+
"CustomEmailSender_AdminCreateUser",
167+
"CustomEmailSender_Authentication",
168+
"CustomEmailSender_AccountTakeOverNotification",
169+
]
161170
request: CognitoCustomEmailSMSSenderRequestModel
162171

163172

164173
class CognitoCustomSMSSenderTriggerModel(CognitoTriggerBaseSchema):
165-
triggerSource: Literal["CustomSMSSender_SignUp"]
174+
triggerSource: Literal[
175+
"CustomSMSSender_SignUp",
176+
"CustomSMSSender_ResendCode",
177+
"CustomSMSSender_ForgotPassword",
178+
"CustomSMSSender_UpdateUserAttribute",
179+
"CustomSMSSender_VerifyUserAttribute",
180+
"CustomSMSSender_AdminCreateUser",
181+
"CustomSMSSender_Authentication",
182+
]
166183
request: CognitoCustomEmailSMSSenderRequestModel
167184

168185

169186
# Models for Challenge Authentication flows
170187
class CognitoChallengeResultModel(BaseModel):
171188
challengeName: Literal[
189+
"CUSTOM_CHALLENGE",
172190
"SRP_A",
173191
"PASSWORD_VERIFIER",
174192
"SMS_MFA",
@@ -222,7 +240,7 @@ class CognitoVerifyAuthChallengeRequestModel(BaseModel):
222240

223241

224242
class CognitoVerifyAuthChallengeResponseModel(BaseModel):
225-
answerCorrect: bool
243+
answerCorrect: bool | None = None
226244

227245

228246
class CognitoVerifyAuthChallengeTriggerModel(CognitoTriggerBaseSchema):

‎tests/unit/parser/_pydantic/test_cognito_triggers.py‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,107 @@ def test_cognito_trigger_models_parse_success(filename, model):
4646
def test_cognito_trigger_models_invalid_raises():
4747
with pytest.raises(ValidationError):
4848
parse(event={"foo": "bar"}, model=CognitoPreSignupTriggerModel)
49+
50+
51+
@pytest.mark.parametrize(
52+
"filename,model,trigger_source",
53+
[
54+
("cognitoPreSignUpEvent.json", CognitoPreSignupTriggerModel, "PreSignUp_AdminCreateUser"),
55+
("cognitoPreSignUpEvent.json", CognitoPreSignupTriggerModel, "PreSignUp_ExternalProvider"),
56+
(
57+
"cognitoPostConfirmationEvent.json",
58+
CognitoPostConfirmationTriggerModel,
59+
"PostConfirmation_ConfirmForgotPassword",
60+
),
61+
("cognitoCustomEmailSenderEvent.json", CognitoCustomEmailSenderTriggerModel, "CustomEmailSender_ResendCode"),
62+
(
63+
"cognitoCustomEmailSenderEvent.json",
64+
CognitoCustomEmailSenderTriggerModel,
65+
"CustomEmailSender_ForgotPassword",
66+
),
67+
(
68+
"cognitoCustomEmailSenderEvent.json",
69+
CognitoCustomEmailSenderTriggerModel,
70+
"CustomEmailSender_UpdateUserAttribute",
71+
),
72+
(
73+
"cognitoCustomEmailSenderEvent.json",
74+
CognitoCustomEmailSenderTriggerModel,
75+
"CustomEmailSender_VerifyUserAttribute",
76+
),
77+
(
78+
"cognitoCustomEmailSenderEvent.json",
79+
CognitoCustomEmailSenderTriggerModel,
80+
"CustomEmailSender_AdminCreateUser",
81+
),
82+
(
83+
"cognitoCustomEmailSenderEvent.json",
84+
CognitoCustomEmailSenderTriggerModel,
85+
"CustomEmailSender_Authentication",
86+
),
87+
(
88+
"cognitoCustomEmailSenderEvent.json",
89+
CognitoCustomEmailSenderTriggerModel,
90+
"CustomEmailSender_AccountTakeOverNotification",
91+
),
92+
("cognitoCustomSMSSenderEvent.json", CognitoCustomSMSSenderTriggerModel, "CustomSMSSender_ResendCode"),
93+
("cognitoCustomSMSSenderEvent.json", CognitoCustomSMSSenderTriggerModel, "CustomSMSSender_ForgotPassword"),
94+
(
95+
"cognitoCustomSMSSenderEvent.json",
96+
CognitoCustomSMSSenderTriggerModel,
97+
"CustomSMSSender_UpdateUserAttribute",
98+
),
99+
(
100+
"cognitoCustomSMSSenderEvent.json",
101+
CognitoCustomSMSSenderTriggerModel,
102+
"CustomSMSSender_VerifyUserAttribute",
103+
),
104+
("cognitoCustomSMSSenderEvent.json", CognitoCustomSMSSenderTriggerModel, "CustomSMSSender_AdminCreateUser"),
105+
("cognitoCustomSMSSenderEvent.json", CognitoCustomSMSSenderTriggerModel, "CustomSMSSender_Authentication"),
106+
],
107+
)
108+
def test_cognito_trigger_models_accept_documented_trigger_sources(filename, model, trigger_source):
109+
event = load_event(filename)
110+
event["triggerSource"] = trigger_source
111+
112+
parsed = parse(event=event, model=model)
113+
114+
assert parsed.triggerSource == trigger_source
115+
116+
117+
@pytest.mark.parametrize(
118+
"filename,model",
119+
[
120+
("cognitoDefineAuthChallengeEvent.json", CognitoDefineAuthChallengeTriggerModel),
121+
("cognitoCreateAuthChallengeEvent.json", CognitoCreateAuthChallengeTriggerModel),
122+
],
123+
)
124+
def test_cognito_auth_challenge_models_accept_custom_challenge_in_session(filename, model):
125+
event = load_event(filename)
126+
event["request"]["session"].append(
127+
{"challengeName": "CUSTOM_CHALLENGE", "challengeResult": True, "challengeMetadata": "CAPTCHA_CHALLENGE"},
128+
)
129+
130+
parsed = parse(event=event, model=model)
131+
132+
assert parsed.request.session[-1].challengeName == "CUSTOM_CHALLENGE"
133+
134+
135+
def test_cognito_verify_auth_challenge_model_accepts_null_answer_correct():
136+
# Cognito sends answerCorrect as null, and the function sets it
137+
event = load_event("cognitoVerifyAuthChallengeResponseEvent.json")
138+
event["response"]["answerCorrect"] = None
139+
140+
parsed = parse(event=event, model=CognitoVerifyAuthChallengeTriggerModel)
141+
142+
assert parsed.response.answerCorrect is None
143+
144+
145+
def test_cognito_trigger_models_accept_null_client_id():
146+
# Admin API operations such as AdminConfirmSignUp send clientId as null
147+
event = load_event("cognitoPostConfirmationEvent.json")
148+
event["callerContext"]["clientId"] = None
149+
150+
parsed = parse(event=event, model=CognitoPostConfirmationTriggerModel)
151+
152+
assert parsed.callerContext.clientId is None

0 commit comments

Comments
 (0)