Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cognito): user pools - non-ascii email domains #11099

Merged
merged 7 commits into from
Nov 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@
"**/jszip/**",
"@aws-cdk/aws-codepipeline-actions/case",
"@aws-cdk/aws-codepipeline-actions/case/**",
"@aws-cdk/aws-cognito/punycode",
"@aws-cdk/aws-cognito/punycode/**",
"@aws-cdk/aws-ecr-assets/minimatch",
"@aws-cdk/aws-ecr-assets/minimatch/**",
"@aws-cdk/aws-eks/yaml",
Expand All @@ -79,6 +81,8 @@
"aws-cdk-lib/jsonschema/**",
"aws-cdk-lib/minimatch",
"aws-cdk-lib/minimatch/**",
"aws-cdk-lib/punycode",
"aws-cdk-lib/punycode/**",
"aws-cdk-lib/semver",
"aws-cdk-lib/semver/**",
"aws-cdk-lib/yaml",
Expand All @@ -91,6 +95,8 @@
"monocdk/jsonschema/**",
"monocdk/minimatch",
"monocdk/minimatch/**",
"monocdk/punycode",
"monocdk/punycode/**",
"monocdk/semver",
"monocdk/semver/**",
"monocdk/yaml",
Expand Down
28 changes: 28 additions & 0 deletions packages/@aws-cdk/aws-cognito/NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
AWS Cloud Development Kit (AWS CDK)
Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

-------------------------------------------------------------------------------

The AWS CDK includes the following third-party software/licensing:

** punycode - https://www.npmjs.com/package/punycode
Copyright Mathias Bynens <https://mathiasbynens.be/>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

----------------
3 changes: 3 additions & 0 deletions packages/@aws-cdk/aws-cognito/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,9 @@ Amazon SES, however, support for Amazon SES is not available in the CDK yet. If
give [this issue](https://github.com/aws/aws-cdk/issues/6768) a +1. Until then, you can use the [cfn
layer](https://docs.aws.amazon.com/cdk/latest/guide/cfn_layer.html) to configure this.

If an email address contains non-ASCII characters, it will be encoded using the [punycode
wtho marked this conversation as resolved.
Show resolved Hide resolved
encoding](https://en.wikipedia.org/wiki/Punycode) when generating the template for Cloudformation.

### Lambda Triggers

User pools can be configured such that AWS Lambda functions can be triggered when certain user operations or actions
Expand Down
10 changes: 7 additions & 3 deletions packages/@aws-cdk/aws-cognito/lib/user-pool.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { IRole, PolicyDocument, PolicyStatement, Role, ServicePrincipal } from '
import * as lambda from '@aws-cdk/aws-lambda';
import { Duration, IResource, Lazy, Names, Resource, Stack, Token } from '@aws-cdk/core';
import { Construct } from 'constructs';
import { toASCII as punycodeEncode } from 'punycode/';
nija-at marked this conversation as resolved.
Show resolved Hide resolved
import { CfnUserPool } from './cognito.generated';
import { StandardAttributeNames } from './private/attr-names';
import { ICustomAttribute, StandardAttribute, StandardAttributes } from './user-pool-attr';
Expand Down Expand Up @@ -733,8 +734,8 @@ export class UserPool extends UserPoolBase {
enabledMfas: this.mfaConfiguration(props),
policies: passwordPolicy !== undefined ? { passwordPolicy } : undefined,
emailConfiguration: undefinedIfNoKeys({
from: props.emailSettings?.from,
replyToEmailAddress: props.emailSettings?.replyTo,
from: encodePuny(props.emailSettings?.from),
replyToEmailAddress: encodePuny(props.emailSettings?.replyTo),
}),
usernameConfiguration: undefinedIfNoKeys({
caseSensitive: props.signInCaseSensitive,
Expand Down Expand Up @@ -1019,6 +1020,9 @@ export class UserPool extends UserPoolBase {
}

function undefinedIfNoKeys(struct: object): object | undefined {
const allUndefined = Object.values(struct).reduce((acc, v) => acc && (v === undefined), true);
const allUndefined = Object.values(struct).every(val => val === undefined);
return allUndefined ? undefined : struct;
}
function encodePuny(input: string | undefined): string | undefined {
return input !== undefined ? punycodeEncode(input) : input;
}
8 changes: 7 additions & 1 deletion packages/@aws-cdk/aws-cognito/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
"license": "Apache-2.0",
"devDependencies": {
"@aws-cdk/assert": "0.0.0",
"@types/punycode": "^2.1.0",
"cdk-build-tools": "0.0.0",
"cdk-integ-tools": "0.0.0",
"cfn2ts": "0.0.0",
Expand All @@ -85,7 +86,9 @@
"@aws-cdk/aws-lambda": "0.0.0",
"@aws-cdk/core": "0.0.0",
"@aws-cdk/custom-resources": "0.0.0",
"constructs": "^3.2.0"
"constructs": "^3.2.0",
"punycode": "^2.1.1"

},
"homepage": "https://github.com/aws/aws-cdk",
"peerDependencies": {
Expand All @@ -96,6 +99,9 @@
"@aws-cdk/custom-resources": "0.0.0",
"constructs": "^3.2.0"
},
"bundledDependencies": [
"punycode"
],
"engines": {
"node": ">= 10.13.0 <13 || >=13.7.0"
},
Expand Down
21 changes: 21 additions & 0 deletions packages/@aws-cdk/aws-cognito/test/user-pool.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1271,6 +1271,27 @@ describe('User Pool', () => {
})).toThrow(/enableSmsRole cannot be disabled/);
});
});

test('email transmission with cyrillic characters are encoded', () => {
// GIVEN
const stack = new Stack();

// WHEN
new UserPool(stack, 'Pool', {
emailSettings: {
from: 'от@домен.рф',
replyTo: 'ответить@домен.рф',
},
});

// THEN
expect(stack).toHaveResourceLike('AWS::Cognito::UserPool', {
EmailConfiguration: {
From: 'от@xn--d1acufc.xn--p1ai',
ReplyToEmailAddress: 'ответить@xn--d1acufc.xn--p1ai',
},
});
});
});


Expand Down
2 changes: 2 additions & 0 deletions packages/aws-cdk-lib/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@
"fs-extra",
"jsonschema",
"minimatch",
"punycode",
"semver",
"yaml"
],
Expand All @@ -90,6 +91,7 @@
"fs-extra": "^9.0.1",
"jsonschema": "^1.4.0",
"minimatch": "^3.0.4",
"punycode": "^2.1.1",
"semver": "^7.3.2",
"yaml": "1.10.0"
},
Expand Down
26 changes: 25 additions & 1 deletion packages/monocdk/NOTICE
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,28 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

----------------
----------------

** punycode - https://www.npmjs.com/package/punycode
Copyright Mathias Bynens <https://mathiasbynens.be/>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

----------------
2 changes: 2 additions & 0 deletions packages/monocdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
"fs-extra",
"jsonschema",
"minimatch",
"punycode",
"semver",
"yaml"
],
Expand All @@ -89,6 +90,7 @@
"fs-extra": "^9.0.1",
"jsonschema": "^1.4.0",
"minimatch": "^3.0.4",
"punycode": "^2.1.1",
"semver": "^7.3.2",
"yaml": "1.10.0"
},
Expand Down
13 changes: 13 additions & 0 deletions tools/cdk-build-tools/config/eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,19 @@ module.exports = {
alphabetize: { order: 'asc', caseInsensitive: true },
}],

// disallow import of deprecated punycode package
'no-restricted-imports': [
'error', {
paths: [
{
name: 'punycode',
message: `Package 'punycode' has to be imported with trailing slash, see warning in https://github.com/bestiejs/punycode.js#installation`,
},
],
patterns: ['!punycode/'],
},
],

// Cannot import from the same module twice
'no-duplicate-imports': ['error'],

Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3191,6 +3191,11 @@
resolved "https://registry.yarnpkg.com/@types/proxyquire/-/proxyquire-1.3.28.tgz#05a647bb0d8fe48fc8edcc193e43cc79310faa7d"
integrity sha512-SQaNzWQ2YZSr7FqAyPPiA3FYpux2Lqh3HWMZQk47x3xbMCqgC/w0dY3dw9rGqlweDDkrySQBcaScXWeR+Yb11Q==

"@types/punycode@^2.1.0":
version "2.1.0"
resolved "https://registry.yarnpkg.com/@types/punycode/-/punycode-2.1.0.tgz#89e4f3d09b3f92e87a80505af19be7e0c31d4e83"
integrity sha512-PG5aLpW6PJOeV2fHRslP4IOMWn+G+Uq8CfnyJ+PDS8ndCbU+soO+fB3NKCKo0p/Jh2Y4aPaiQZsrOXFdzpcA6g==

"@types/q@^1.5.1":
version "1.5.4"
resolved "https://registry.yarnpkg.com/@types/q/-/q-1.5.4.tgz#15925414e0ad2cd765bfef58842f7e26a7accb24"
Expand Down