fix(cognito): quote or mime-encode fromName to comply RFC 5322

[Tietew]

Closes #18903

When fromName of UserPoolEmail.withSES() does not comply RFC 5322 atom or quoted-string, it will be quoted or mime-encoded.

For example:

fromName	Template	Description
'simple atom'	"simple atom <address@example.com>"	as is
'"quoted string"'	"\"quoted string\" <address@example.com>"	as is
'あいう'	"=?UTF-8?B?44GC44GE44GG?= <address@example.com>"	mime encode (RFC 2047)
'name@company'	"\"name@company\" <address@example.com>"	make quoted-string

For details, see RFC 5322 Section 3.4 and RFC 2047

---

All Submissions:

• Have you followed the guidelines in our Contributing guide?

Adding new Construct Runtime Dependencies:

• This PR adds new construct runtime dependencies following the process described here

New Features

• Have you added the new feature to an integration test?
  • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[gitpod-io]

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

[Tietew]

I tried to update integration test but it failed with following error:

Stack Deployments Failed: Error: The stack named integ-user-pool-signup-code failed to deploy: UPDATE_FAILED (The following resource(s) failed to update: [myuserpool01998219]. ): Cognito received the following error from Amazon SES when attempting to send email: Email address is not verified. The following identities failed the check in region US-EAST-1: arn:aws:ses:us-east-1:********:identity/example.com (Service: AWSCognitoIdentityProviderService; Status Code: 400; Error Code: InvalidParameterException; Request ID: ef20db4e-9e68-49df-ae9c-7c174fe9cd37; Proxy: null)

I cannot verify example.com domain. How do I fix this?

[Tietew]

Is it acceptable to try following steps?

1. replace existing test's domain from example.com to my private domain which is SES verified in us-east-1
2. remove the old snapshot not to create a stack with example.com domain
3. run yarn integ --update-on-failed
4. confirm successful
5. replace the test's domain back to example.com
6. run yarn integ --update-on-failed --dry-run to recreate the snapshot including example.com domain

[TheRealAmazonKendra]

Is it acceptable to try following steps?

1. replace existing test's domain from example.com to my private domain which is SES verified in us-east-1
2. remove the old snapshot not to create a stack with example.com domain
3. run yarn integ --update-on-failed
4. confirm successful
5. replace the test's domain back to example.com
6. run yarn integ --update-on-failed --dry-run to recreate the snapshot including example.com domain

This is an excellent solution.

✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.

[Tietew]

yarn integ --update-on-failed succeeded with my private domain.

Pull request has been modified.

[Tietew]

@corymhall Thank you for review! I refactored them to separate functions and more explanations.

[corymhall]

Thanks this is much easier to follow! The only question I have is how this
handles different types of quotes? Will it still work if you use " or ```

fromName: "'foo.bar'"
fromName: `'${someVar}'`

[Tietew]

Per RFC 5322, both the single quote ' and the backquote ` are "atext". They are same as alphabet/digit letters. But surprising, the dot . is a "specials".

   atext           =   ALPHA / DIGIT /    ; Printable US-ASCII
                       "!" / "#" /        ;  characters not including
                       "$" / "%" /        ;  specials.  Used for atoms.
                       "&" / "'" /
                       "*" / "+" /
                       "-" / "/" /
                       "=" / "?" /
                       "^" / "_" /
                       "`" / "{" /
                       "|" / "}" /
                       "~"

Note: White space is not defined as "atext", but also allowed.

Examples:

source	template	cause
"'foo.bar'"	quoted-string "From": "\"'foo.bar'\" <addr@example.com>"	the dot . is "specials"
"'foo bar'"	bare "From": "'foo bar' <addr@example.com>"	all chars are "atext"
"Foo's Bar"	bare "From": "Foo's Bar <addr@example.com>"	all chars are "atext"
'${price}'	bare "From": "${price} <addr@example.com>"	all chars are "atext"
"`foo bar`"	bare "From": "`foo bar` <addr@example.com>"	all chars are "atext"
'Café'	mime encode "From": "=?UTF-8?B?Q2Fmw6k=?= <addr@example.com>"	é is not US-ASCII
'"Café"'	entire "Café" including double quote " is mime encoded "From": "=?UTF-8?B?IkNhZsOpIg==?= <addr@example.com>"	é is not US-ASCII
`'${someVar}'`	mime encode if someVar is not US-ASCII quoted-string if someVar includes "specials" otherwise, as-is	`~` is evaluated at runtime single quote ' is atext
`"${someVar}"`	mime encode if someVar is not US-ASCII quoted-string again if someVar includes malformed escape otherwise, as-is	already quoted-string form

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: f6ec3f3
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).