@aws-amplify/auth 6.10.2-unstable.e888e7c.0 → 6.10.2

package/package.json

@@ -1,108 +1,108 @@
 {
-  "name": "@aws-amplify/auth",
-  "version": "6.10.2-unstable.e888e7c.0+e888e7c",
-  "description": "Auth category of aws-amplify",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.mjs",
-  "typings": "./dist/esm/index.d.ts",
-  "react-native": "./src/index.ts",
-  "sideEffects": [
-    "./dist/cjs/providers/cognito/apis/signInWithRedirect.js",
-    "./dist/esm/providers/cognito/apis/signInWithRedirect.mjs",
-    "./dist/cjs/providers/cognito/utils/oauth/enableOAuthListener.js",
-    "./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.mjs"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "yarn lint --fix && jest -w 1 --coverage --logHeapUsage",
-    "build-with-test": "npm test && npm run build",
-    "build:umd": "webpack && webpack --config ./webpack.config.dev.js",
-    "build:esm-cjs": "rollup --forceExit -c rollup.config.mjs",
-    "build:watch": "npm run build:esm-cjs -- --watch",
-    "build": "npm run clean && npm run build:esm-cjs && npm run build:umd",
-    "clean": "npm run clean:size && rimraf lib-esm lib dist",
-    "clean:size": "rimraf dual-publish-tmp tmp*",
-    "format": "echo \"Not implemented\"",
-    "lint": "eslint '**/*.{ts,tsx}' && npm run ts-coverage",
-    "lint:fix": "eslint '**/*.{ts,tsx}' --fix",
-    "ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 91.18"
-  },
-  "typesVersions": {
-    ">=4.2": {
-      "cognito": [
-        "./dist/esm/providers/cognito/index.d.ts"
-      ],
-      "cognito/server": [
-        "./dist/esm/providers/cognito/apis/server/index.d.ts"
-      ],
-      "server": [
-        "./dist/esm/server.d.ts"
-      ]
-    }
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/esm/index.d.ts",
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js",
-      "react-native": "./src/index.ts"
-    },
-    "./cognito": {
-      "types": "./dist/esm/providers/cognito/index.d.ts",
-      "import": "./dist/esm/providers/cognito/index.mjs",
-      "require": "./dist/cjs/providers/cognito/index.js",
-      "react-native": "./src/providers/cognito/index.ts"
-    },
-    "./cognito/server": {
-      "types": "./dist/esm/providers/cognito/apis/server/index.d.ts",
-      "import": "./dist/esm/providers/cognito/apis/server/index.mjs",
-      "require": "./dist/cjs/providers/cognito/apis/server/index.js"
-    },
-    "./server": {
-      "types": "./dist/esm/server.d.ts",
-      "import": "./dist/esm/server.mjs",
-      "require": "./dist/cjs/server.js"
-    },
-    "./enable-oauth-listener": {
-      "types": "./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.d.ts",
-      "import": "./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.mjs",
-      "require": "./dist/cjs/providers/cognito/utils/oauth/enableOAuthListener.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/aws-amplify/amplify-js.git"
-  },
-  "author": "Amazon Web Services",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/aws/aws-amplify/issues"
-  },
-  "homepage": "https://aws-amplify.github.io/",
-  "files": [
-    "dist/cjs",
-    "dist/esm",
-    "src",
-    "cognito",
-    "server",
-    "enable-oauth-listener"
-  ],
-  "dependencies": {
-    "@aws-crypto/sha256-js": "5.2.0",
-    "@smithy/types": "^3.3.0",
-    "tslib": "^2.5.0"
-  },
-  "peerDependencies": {
-    "@aws-amplify/core": "6.9.3-unstable.e888e7c.0+e888e7c"
-  },
-  "devDependencies": {
-    "@aws-amplify/core": "6.9.3-unstable.e888e7c.0+e888e7c",
-    "@aws-amplify/react-native": "1.1.7-unstable.e888e7c.0+e888e7c",
-    "@jest/test-sequencer": "^29.7.0",
-    "typescript": "5.0.2"
-  },
-  "gitHead": "e888e7c0ce264871def577a01fd804919f7b79d5"
+	"name": "@aws-amplify/auth",
+	"version": "6.10.2",
+	"description": "Auth category of aws-amplify",
+	"main": "./dist/cjs/index.js",
+	"module": "./dist/esm/index.mjs",
+	"typings": "./dist/esm/index.d.ts",
+	"react-native": "./src/index.ts",
+	"sideEffects": [
+		"./dist/cjs/providers/cognito/apis/signInWithRedirect.js",
+		"./dist/esm/providers/cognito/apis/signInWithRedirect.mjs",
+		"./dist/cjs/providers/cognito/utils/oauth/enableOAuthListener.js",
+		"./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.mjs"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "yarn lint --fix && jest -w 1 --coverage --logHeapUsage",
+		"build-with-test": "npm test && npm run build",
+		"build:umd": "webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm-cjs": "rollup --forceExit -c rollup.config.mjs",
+		"build:watch": "npm run build:esm-cjs -- --watch",
+		"build": "npm run clean && npm run build:esm-cjs && npm run build:umd",
+		"clean": "npm run clean:size && rimraf lib-esm lib dist",
+		"clean:size": "rimraf dual-publish-tmp tmp*",
+		"format": "echo \"Not implemented\"",
+		"lint": "eslint '**/*.{ts,tsx}' && npm run ts-coverage",
+		"lint:fix": "eslint '**/*.{ts,tsx}' --fix",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 91.18"
+	},
+	"typesVersions": {
+		">=4.2": {
+			"cognito": [
+				"./dist/esm/providers/cognito/index.d.ts"
+			],
+			"cognito/server": [
+				"./dist/esm/providers/cognito/apis/server/index.d.ts"
+			],
+			"server": [
+				"./dist/esm/server.d.ts"
+			]
+		}
+	},
+	"exports": {
+		".": {
+			"types": "./dist/esm/index.d.ts",
+			"import": "./dist/esm/index.mjs",
+			"require": "./dist/cjs/index.js",
+			"react-native": "./src/index.ts"
+		},
+		"./cognito": {
+			"types": "./dist/esm/providers/cognito/index.d.ts",
+			"import": "./dist/esm/providers/cognito/index.mjs",
+			"require": "./dist/cjs/providers/cognito/index.js",
+			"react-native": "./src/providers/cognito/index.ts"
+		},
+		"./cognito/server": {
+			"types": "./dist/esm/providers/cognito/apis/server/index.d.ts",
+			"import": "./dist/esm/providers/cognito/apis/server/index.mjs",
+			"require": "./dist/cjs/providers/cognito/apis/server/index.js"
+		},
+		"./server": {
+			"types": "./dist/esm/server.d.ts",
+			"import": "./dist/esm/server.mjs",
+			"require": "./dist/cjs/server.js"
+		},
+		"./enable-oauth-listener": {
+			"types": "./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.d.ts",
+			"import": "./dist/esm/providers/cognito/utils/oauth/enableOAuthListener.mjs",
+			"require": "./dist/cjs/providers/cognito/utils/oauth/enableOAuthListener.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/aws-amplify/amplify-js.git"
+	},
+	"author": "Amazon Web Services",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/aws/aws-amplify/issues"
+	},
+	"homepage": "https://aws-amplify.github.io/",
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"src",
+		"cognito",
+		"server",
+		"enable-oauth-listener"
+	],
+	"dependencies": {
+		"@aws-crypto/sha256-js": "5.2.0",
+		"@smithy/types": "^3.3.0",
+		"tslib": "^2.5.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.1.0"
+	},
+	"devDependencies": {
+		"@aws-amplify/core": "6.9.3",
+		"@aws-amplify/react-native": "1.1.7",
+		"@jest/test-sequencer": "^29.7.0",
+		"typescript": "5.0.2"
+	},
+	"gitHead": "de14a78391a3ca7ef7c804f42d728cfab5cf0755"
 }

package/src/client/flows/shared/handlePasswordSRP.ts

@@ -13,16 +13,14 @@ import {
 	RespondToAuthChallengeCommandOutput,
 } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
 import { getAuthenticationHelper } from '../../../providers/cognito/utils/srp';
-import {
-	handlePasswordVerifierChallenge,
-	retryOnResourceNotFoundException,
-	setActiveSignInUsername,
-} from '../../../providers/cognito/utils/signInHelpers';
 import { createInitiateAuthClient } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider';
 import { createCognitoUserPoolEndpointResolver } from '../../../providers/cognito/factories';
 import { getRegionFromUserPoolId } from '../../../foundation/parsers';
 import { getAuthUserAgentValue } from '../../../utils';
 import { AuthFactorType } from '../../../providers/cognito/types/models';
+import { handlePasswordVerifierChallenge } from '../../../providers/cognito/utils/handlePasswordVerifierChallenge';
+import { retryOnResourceNotFoundException } from '../../../providers/cognito/utils/retryOnResourceNotFoundException';
+import { setActiveSignInUsername } from '../../../providers/cognito/utils/setActiveSignInUsername';
 
 interface HandlePasswordSRPInput {
 	username: string;

package/src/client/flows/userAuth/handleSelectChallengeWithPassword.ts

@@ -11,7 +11,7 @@ import { getRegionFromUserPoolId } from '../../../foundation/parsers';
 import { getAuthUserAgentValue } from '../../../utils';
 import { getUserContextData } from '../../../providers/cognito/utils/userContextData';
 import { RespondToAuthChallengeCommandOutput } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
-import { setActiveSignInUsername } from '../../../providers/cognito/utils/signInHelpers';
+import { setActiveSignInUsername } from '../../../providers/cognito/utils/setActiveSignInUsername';
 
 /**
  * Handles the SELECT_CHALLENGE response specifically for Password authentication.

package/src/client/flows/userAuth/handleSelectChallengeWithPasswordSRP.ts

@@ -16,11 +16,9 @@ import { getRegionFromUserPoolId } from '../../../foundation/parsers';
 import { getAuthUserAgentValue } from '../../../utils';
 import { getAuthenticationHelper } from '../../../providers/cognito/utils/srp';
 import { getUserContextData } from '../../../providers/cognito/utils/userContextData';
-import {
-	handlePasswordVerifierChallenge,
-	retryOnResourceNotFoundException,
-	setActiveSignInUsername,
-} from '../../../providers/cognito/utils/signInHelpers';
+import { setActiveSignInUsername } from '../../../providers/cognito/utils/setActiveSignInUsername';
+import { retryOnResourceNotFoundException } from '../../../providers/cognito/utils/retryOnResourceNotFoundException';
+import { handlePasswordVerifierChallenge } from '../../../providers/cognito/utils/handlePasswordVerifierChallenge';
 
 /**
  * Handles the SELECT_CHALLENGE response specifically for Password SRP authentication.

package/src/client/flows/userAuth/handleUserAuthFlow.ts

@@ -18,7 +18,7 @@ import { getAuthUserAgentValue } from '../../../utils';
 import { handlePasswordSRP } from '../shared/handlePasswordSRP';
 import { assertValidationError } from '../../../errors/utils/assertValidationError';
 import { AuthValidationErrorCode } from '../../../errors/types/validation';
-import { setActiveSignInUsername } from '../../../providers/cognito/utils/signInHelpers';
+import { setActiveSignInUsername } from '../../../providers/cognito/utils/setActiveSignInUsername';
 
 export interface HandleUserAuthFlowInput {
 	username: string;

package/src/client/flows/userAuth/handleWebAuthnSignInResult.ts

@@ -17,12 +17,7 @@ import { getRegionFromUserPoolId } from '../../../foundation/parsers';
 import { createCognitoUserPoolEndpointResolver } from '../../../providers/cognito/factories';
 import { cacheCognitoTokens } from '../../../providers/cognito/tokenProvider/cacheTokens';
 import { dispatchSignedInHubEvent } from '../../../providers/cognito/utils/dispatchSignedInHubEvent';
-import {
-	getNewDeviceMetadata,
-	getSignInResult,
-} from '../../../providers/cognito/utils/signInHelpers';
 import { setActiveSignInState, signInStore } from '../../../client/utils/store';
-import { AuthSignInOutput } from '../../../types';
 import { getAuthUserAgentValue } from '../../../utils';
 import { getPasskey } from '../../utils/passkey';
 import {
@@ -30,10 +25,13 @@ import {
 	assertPasskeyError,
 } from '../../utils/passkey/errors';
 import { AuthError } from '../../../errors/AuthError';
+import { getNewDeviceMetadata } from '../../../providers/cognito/utils/getNewDeviceMetadata';
+
+import { WebAuthnSignInResult } from './types';
 
 export async function handleWebAuthnSignInResult(
 	challengeParameters: ChallengeParameters,
-): Promise<AuthSignInOutput> {
+): Promise<WebAuthnSignInResult> {
 	const authConfig = Amplify.getConfig().Auth?.Cognito;
 	assertTokenProviderConfig(authConfig);
 	const { username, signInSession, signInDetails, challengeName } =
@@ -119,8 +117,8 @@ export async function handleWebAuthnSignInResult(
 		});
 	}
 
-	return getSignInResult({
+	return {
 		challengeName: nextChallengeName as ChallengeName,
 		challengeParameters: nextChallengeParameters as ChallengeParameters,
-	});
+	};
 }

package/src/client/flows/userAuth/types.ts

@@ -0,0 +1,15 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	ChallengeName,
+	ChallengeParameters,
+} from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
+import { AuthSignInOutput } from '../../../types';
+
+export type WebAuthnSignInResult =
+	| AuthSignInOutput
+	| {
+			challengeName: ChallengeName;
+			challengeParameters: ChallengeParameters;
+	  };

package/src/providers/cognito/apis/confirmSignIn.ts

@@ -17,7 +17,6 @@ import {
 } from '../../../client/utils/store';
 import { AuthError } from '../../../errors/AuthError';
 import {
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 	handleChallengeName,
@@ -33,6 +32,7 @@ import {
 	ChallengeName,
 	ChallengeParameters,
 } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 /**
  * Continues or completes the sign in process when required by the initial call to `signIn`.

package/src/providers/cognito/apis/signInWithCustomAuth.ts

@@ -9,11 +9,9 @@ import { assertValidationError } from '../../../errors/utils/assertValidationErr
 import { assertServiceError } from '../../../errors/utils/assertServiceError';
 import {
 	getActiveSignInUsername,
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 	handleCustomAuthFlowWithoutSRP,
-	retryOnResourceNotFoundException,
 } from '../utils/signInHelpers';
 import { InitiateAuthException } from '../types/errors';
 import {
@@ -32,6 +30,8 @@ import {
 } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
+import { retryOnResourceNotFoundException } from '../utils/retryOnResourceNotFoundException';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 /**
  * Signs a user in using a custom authentication flow without password

package/src/providers/cognito/apis/signInWithCustomSRPAuth.ts

@@ -9,7 +9,6 @@ import { assertValidationError } from '../../../errors/utils/assertValidationErr
 import { assertServiceError } from '../../../errors/utils/assertServiceError';
 import {
 	getActiveSignInUsername,
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 	handleCustomSRPAuthFlow,
@@ -34,6 +33,7 @@ import {
 } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 /**
  * Signs a user in using a custom authentication flow with SRP

package/src/providers/cognito/apis/signInWithSRP.ts

@@ -17,7 +17,6 @@ import {
 } from '../types/errors';
 import {
 	getActiveSignInUsername,
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 	handleUserSRPAuthFlow,
@@ -34,6 +33,7 @@ import {
 import { cacheCognitoTokens } from '../tokenProvider/cacheTokens';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 import { resetAutoSignIn } from './autoSignIn';
 

package/src/providers/cognito/apis/signInWithUserAuth.ts

@@ -17,7 +17,6 @@ import {
 } from '../types/errors';
 import {
 	getActiveSignInUsername,
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 } from '../utils/signInHelpers';
@@ -38,6 +37,7 @@ import {
 	HandleUserAuthFlowInput,
 	handleUserAuthFlow,
 } from '../../../client/flows/userAuth/handleUserAuthFlow';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 import { resetAutoSignIn } from './autoSignIn';
 

package/src/providers/cognito/apis/signInWithUserPassword.ts

@@ -13,11 +13,9 @@ import {
 } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
 import {
 	getActiveSignInUsername,
-	getNewDeviceMetadata,
 	getSignInResult,
 	getSignInResultFromError,
 	handleUserPasswordAuthFlow,
-	retryOnResourceNotFoundException,
 } from '../utils/signInHelpers';
 import { InitiateAuthException } from '../types/errors';
 import {
@@ -32,6 +30,8 @@ import {
 import { cacheCognitoTokens } from '../tokenProvider/cacheTokens';
 import { tokenOrchestrator } from '../tokenProvider';
 import { dispatchSignedInHubEvent } from '../utils/dispatchSignedInHubEvent';
+import { retryOnResourceNotFoundException } from '../utils/retryOnResourceNotFoundException';
+import { getNewDeviceMetadata } from '../utils/getNewDeviceMetadata';
 
 import { resetAutoSignIn } from './autoSignIn';
 

package/src/providers/cognito/utils/getNewDeviceMetadata.ts

@@ -0,0 +1,88 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	base64Encoder,
+	getDeviceName,
+} from '@aws-amplify/core/internals/utils';
+
+import { DeviceMetadata } from '../tokenProvider/types';
+import { createConfirmDeviceClient } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider';
+import { createCognitoUserPoolEndpointResolver } from '../factories';
+import { NewDeviceMetadataType } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider/types';
+import { getRegionFromUserPoolId } from '../../../foundation/parsers';
+
+import { getAuthenticationHelper, getBytesFromHex } from './srp';
+
+/**
+ * This function is used to kick off the device management flow.
+ *
+ * If an error is thrown while generating a hash device or calling the `ConfirmDevice`
+ * client, then this API will ignore the error and return undefined. Otherwise the authentication
+ * flow will not complete and the user won't be able to be signed in.
+ *
+ * @returns DeviceMetadata | undefined
+ */
+export async function getNewDeviceMetadata({
+	userPoolId,
+	userPoolEndpoint,
+	newDeviceMetadata,
+	accessToken,
+}: {
+	userPoolId: string;
+	userPoolEndpoint: string | undefined;
+	newDeviceMetadata?: NewDeviceMetadataType;
+	accessToken?: string;
+}): Promise<DeviceMetadata | undefined> {
+	if (!newDeviceMetadata) return undefined;
+	const userPoolName = userPoolId.split('_')[1] || '';
+	const authenticationHelper = await getAuthenticationHelper(userPoolName);
+	const deviceKey = newDeviceMetadata?.DeviceKey;
+	const deviceGroupKey = newDeviceMetadata?.DeviceGroupKey;
+
+	try {
+		await authenticationHelper.generateHashDevice(
+			deviceGroupKey ?? '',
+			deviceKey ?? '',
+		);
+	} catch (errGenHash) {
+		// TODO: log error here
+		return undefined;
+	}
+
+	const deviceSecretVerifierConfig = {
+		Salt: base64Encoder.convert(
+			getBytesFromHex(authenticationHelper.getSaltToHashDevices()),
+		),
+		PasswordVerifier: base64Encoder.convert(
+			getBytesFromHex(authenticationHelper.getVerifierDevices()),
+		),
+	};
+	const randomPassword = authenticationHelper.getRandomPassword();
+
+	try {
+		const confirmDevice = createConfirmDeviceClient({
+			endpointResolver: createCognitoUserPoolEndpointResolver({
+				endpointOverride: userPoolEndpoint,
+			}),
+		});
+		await confirmDevice(
+			{ region: getRegionFromUserPoolId(userPoolId) },
+			{
+				AccessToken: accessToken,
+				DeviceName: await getDeviceName(),
+				DeviceKey: newDeviceMetadata?.DeviceKey,
+				DeviceSecretVerifierConfig: deviceSecretVerifierConfig,
+			},
+		);
+
+		return {
+			deviceKey,
+			deviceGroupKey,
+			randomPassword,
+		};
+	} catch (error) {
+		// TODO: log error here
+		return undefined;
+	}
+}