Merge pull request #178 from aws/gcbeatty/v3merge

Sync up V3 and V4 branches

Author: GarrettBeatty

CHANGELOG.md

@@ -1,3 +1,8 @@
+## Release 2025-04-17
+
+### Amazon.Extensions.CognitoAuthentication (2.5.6)
+* Add support for UserContextData
+
 ## Release 2025-03-31
 
 ### Amazon.Extensions.CognitoAuthentication (3.0.0-preview.3)
@@ -100,4 +105,4 @@ Thanks [DmitryProskurin](https://github.com/DmitryProskurin) for the above chang
 
 ### Amazon.Extensions.CognitoAuthentication (2.1.0)
 * Added support for TOTP challenges, supports the existing way by defaulting to SMS, but also has an additional override method to allow setting the challenge type.
-* Make the methods of CognitoUser virtual so that mock test cases could be written for CognitoUser class.
+* Make the methods of CognitoUser virtual so that mock test cases could be written for CognitoUser class.

src/Amazon.Extensions.CognitoAuthentication/CognitoAuthenticationClasses.cs

@@ -73,10 +73,15 @@ public AuthFlowResponse(string sessionId, AuthenticationResultType authenticatio
         /// The analytics metadata for collecting Amazon Pinpoint metrics.
         /// </summary>
         public AnalyticsMetadataType AnalyticsMetadata { get; set; }
+
+        /// <summary>
+        /// Additional UserContextDataType 
+        /// </summary>
+        public UserContextDataType UserContextData { get; set; }
     }
 
     /// <summary>
-    /// Class containing the necessary properities to initiate SRP authentication flow
+    /// Class containing the necessary properties to initiate SRP authentication flow
     /// </summary>
     public class InitiateSrpAuthRequest
     {
@@ -104,6 +109,12 @@ public class InitiateSrpAuthRequest
         /// The analytics metadata for collecting Amazon Pinpoint metrics.
         /// </summary>
         public AnalyticsMetadataType AnalyticsMetadata { get; set; }
+  
+        /// <summary>
+        /// Additional UserContextDataType 
+        /// </summary>
+        public UserContextDataType UserContextData { get; set; }
+        
         /// <summary>
         /// Enable custom auth flow
         /// https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#Using-SRP-password-verification-in-custom-authentication-flow
@@ -112,7 +123,7 @@ public class InitiateSrpAuthRequest
     }
 
     /// <summary>
-    /// Class containing the necessary properities to initiate custom authentication flow
+    /// Class containing the necessary properties to initiate custom authentication flow
     /// </summary>
     public class InitiateCustomAuthRequest
     {
@@ -130,10 +141,15 @@ public class InitiateCustomAuthRequest
         /// The analytics metadata for collecting Amazon Pinpoint metrics.
         /// </summary>
         public AnalyticsMetadataType AnalyticsMetadata { get; set; }
+
+        /// <summary>
+        /// Additional UserContextDataType 
+        /// </summary>
+        public UserContextDataType UserContextData { get; set; }
     }
 
     /// <summary>
-    /// Class containing the necessary properities to initiate either REFRESH_TOKEN or
+    /// Class containing the necessary properties to initiate either REFRESH_TOKEN or
     /// REFRESH_TOKEN_AUTH authentication
     /// </summary>
     public class InitiateRefreshTokenAuthRequest
@@ -146,7 +162,7 @@ public class InitiateRefreshTokenAuthRequest
     }
 
     /// <summary>
-    /// Class containing the necessary properities to respond to an MFA authentication challenge
+    /// Class containing the necessary properties to respond to an MFA authentication challenge
     /// </summary>
     public class RespondToMfaRequest
     {
@@ -167,7 +183,7 @@ public class RespondToMfaRequest
     }
 
     /// <summary>
-    /// Class containing the necessary properities to respond to an MFA authentication challenge
+    /// Class containing the necessary properties to respond to an MFA authentication challenge
     /// </summary>
     public class RespondToSmsMfaRequest : RespondToMfaRequest
     {
@@ -178,7 +194,7 @@ public class RespondToSmsMfaRequest : RespondToMfaRequest
     }
 
     /// <summary>
-    /// Class containing the necessary properities to respond to a new password required authentication challenge
+    /// Class containing the necessary properties to respond to a new password required authentication challenge
     /// </summary>
     public class RespondToNewPasswordRequiredRequest
     {
@@ -194,7 +210,7 @@ public class RespondToNewPasswordRequiredRequest
     }
 
     /// <summary>
-    /// Class containing the necessary properities to respond to a custom authentication challenge
+    /// Class containing the necessary properties to respond to a custom authentication challenge
     /// </summary>
     public class RespondToCustomChallengeRequest
     {
@@ -217,6 +233,11 @@ public class RespondToCustomChallengeRequest
         /// The sessionID for the current authentication flow.
         /// </summary>
         public string SessionID { get; set; }
+
+        /// <summary>
+        /// Additional UserContextDataType 
+        /// </summary>
+        public UserContextDataType UserContextData { get; set; }
     }
 
     /// <summary>
@@ -237,6 +258,6 @@ public class InitiateAdminNoSrpAuthRequest
         /// <summary>
         /// Optional analytics metadata for collecting Amazon Pinpoint metrics.
         /// </summary>
-        public AnalyticsMetadataType AnalyticsMetadata { get; set; }
+        public AnalyticsMetadataType AnalyticsMetadata { get; set; }       
     }
 }

src/Amazon.Extensions.CognitoAuthentication/CognitoUser.cs

@@ -105,6 +105,8 @@ public partial class CognitoUser
         /// <param name="provider">IAmazonCognitoIdentityProvider for the specified user pool</param>
         /// <param name="clientSecret">Client secret for the specified client, if exists</param>
         /// <param name="username">Username for user, if different from userID</param>
+        /// <param name="status">Status for user.</param>
+        /// <param name="attributes">User attributes.</param>
         public CognitoUser(string userID, string clientID,
                            CognitoUserPool pool,
                            IAmazonCognitoIdentityProvider provider,
@@ -833,4 +835,4 @@ private void EnsureUserAuthenticated()
             }
         }
     }
-}
+}

src/Amazon.Extensions.CognitoAuthentication/CognitoUserAuthentication.cs

@@ -68,6 +68,8 @@ public virtual async Task<AuthFlowResponse> StartWithSrpAuthAsync(InitiateSrpAut
                 initiateRequest.ClientMetadata = new Dictionary<string, string>(srpRequest.ClientMetadata);
             }
 
+            initiateRequest.UserContextData = srpRequest.UserContextData;
+
             initiateRequest.AnalyticsMetadata = srpRequest.AnalyticsMetadata;
 
             if (srpRequest.IsCustomAuthFlow)
@@ -86,6 +88,8 @@ public virtual async Task<AuthFlowResponse> StartWithSrpAuthAsync(InitiateSrpAut
                 challengeRequest.ClientMetadata = new Dictionary<string, string>(srpRequest.ClientMetadata);
             }
 
+            challengeRequest.UserContextData = srpRequest.UserContextData;
+
             challengeRequest.AnalyticsMetadata = srpRequest.AnalyticsMetadata;
 
             bool challengeResponsesValid = challengeRequest != null && challengeRequest.ChallengeResponses != null;
@@ -247,7 +251,8 @@ public virtual async Task<AuthFlowResponse> StartWithCustomAuthAsync(InitiateCus
                 AuthParameters = new Dictionary<string, string>(customRequest.AuthParameters),
                 ClientId = ClientID,
                 ClientMetadata = new Dictionary<string, string>(customRequest.ClientMetadata),
-                AnalyticsMetadata = customRequest.AnalyticsMetadata
+                AnalyticsMetadata = customRequest.AnalyticsMetadata,
+                UserContextData = customRequest.UserContextData
             };
 
             InitiateAuthResponse initiateResponse = await Provider.InitiateAuthAsync(authRequest, cancellationToken).ConfigureAwait(false);
@@ -293,7 +298,8 @@ public virtual async Task<AuthFlowResponse> RespondToCustomAuthAsync(RespondToCu
                 ChallengeResponses = new Dictionary<string, string>(customRequest.ChallengeParameters ?? new Dictionary<string, string>()),
                 ClientMetadata = new Dictionary<string, string>(customRequest.ClientMetadata ?? new Dictionary<string, string>()),
                 AnalyticsMetadata = customRequest.AnalyticsMetadata,
-                Session = customRequest.SessionID
+                Session = customRequest.SessionID,
+                UserContextData = customRequest.UserContextData
             };
 
             RespondToAuthChallengeResponse authResponse =
@@ -550,7 +556,6 @@ public virtual async Task<AuthFlowResponse> RespondToNewPasswordRequiredAsync(Re
                 { CognitoConstants.ChlgParamNewPassword, newPasswordRequest.NewPassword},
                 { CognitoConstants.ChlgParamUsername, Username }
             };
-
             if (requiredAttributes != null)
             {
                 foreach (KeyValuePair<string, string> attribute in requiredAttributes)
@@ -758,7 +763,7 @@ private AdminInitiateAuthRequest CreateAdminAuthRequest(InitiateAdminNoSrpAuthRe
             {
                 returnRequest.ClientMetadata = new Dictionary<string, string>(adminRequest.ClientMetadata);
             }
-
+           
             returnRequest.AnalyticsMetadata = adminRequest.AnalyticsMetadata;
 
             return returnRequest;

test/Amazon.Extensions.CognitoAuthentication.IntegrationTests/CognitoAWSCredentialsTests.cs

@@ -21,6 +21,7 @@
 
 using Amazon;
 using Amazon.CognitoIdentity;
+using Amazon.CognitoIdentityProvider.Model;
 using Amazon.CognitoIdentity.Model;
 using Amazon.Extensions.CognitoAuthentication;
 using Amazon.IdentityManagement;
@@ -55,7 +56,11 @@ public async Task TestGetCognitoAWSCredentials()
             AuthFlowResponse context =
                 await user.StartWithSrpAuthAsync(new InitiateSrpAuthRequest()
                 {
-                    Password = password
+                    Password = password,
+                    UserContextData = new UserContextDataType {
+                        EncodedData = "AmazonCognitoAdvancedSecurityData_object",
+                        IpAddress = "192.0.2.1"
+                    }
                 });
 
             //Create identity pool