Add C++ Cognito MVP (Issue #4098) (PR #4278)

Author: meyertst-aws

.doc_gen/metadata/cognito-identity-provider_metadata.yaml

@@ -67,6 +67,16 @@ cognito-identity-provider_SignUp:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.SignUp
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.signup
   services:
     cognito-identity-provider: {SignUp}
 cognito-identity-provider_AdminGetUser:
@@ -121,6 +131,16 @@ cognito-identity-provider_AdminGetUser:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.AdminGetUser
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.admin_get_user
   services:
     cognito-identity-provider: {AdminGetUser}
 cognito-identity-provider_ResendConfirmationCode:
@@ -175,6 +195,16 @@ cognito-identity-provider_ResendConfirmationCode:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.ResendConfirmationCode
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.resend_confirmation
   services:
     cognito-identity-provider: {ResendConfirmationCode}
 cognito-identity-provider_ConfirmSignUp:
@@ -229,6 +259,16 @@ cognito-identity-provider_ConfirmSignUp:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.ConfirmSignUp
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.confirm_signup
   services:
     cognito-identity-provider: {ConfirmSignUp}
 cognito-identity-provider_ListUsers:
@@ -319,6 +359,16 @@ cognito-identity-provider_AdminInitiateAuth:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.AdminInitiateAuth
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.admin_initiate_auth
   services:
     cognito-identity-provider: {AdminInitiateAuth}
 cognito-identity-provider_AssociateSoftwareToken:
@@ -373,6 +423,16 @@ cognito-identity-provider_AssociateSoftwareToken:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.AssociateSoftwareToken
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.associate_software_token
   services:
     cognito-identity-provider: {AssociateSoftwareToken}
 cognito-identity-provider_VerifySoftwareToken:
@@ -427,6 +487,16 @@ cognito-identity-provider_VerifySoftwareToken:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.VerifySoftwareToken
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.verify_software_token
   services:
     cognito-identity-provider: {VerifySoftwareToken}
 cognito-identity-provider_AdminRespondToAuthChallenge:
@@ -482,6 +552,16 @@ cognito-identity-provider_AdminRespondToAuthChallenge:
             - description:
               snippet_tags:
                 - javascript.v3.cognito-idp.actions.AdminRespondToAuthChallenge
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.admin_respond_to_auth_challenge
   services:
     cognito-identity-provider: {AdminRespondToAuthChallenge}
 cognito-identity-provider_ConfirmDevice:
@@ -587,6 +667,24 @@ cognito-identity-provider_RespondToAuthChallenge:
                 - javascript.v3.cognito-idp.actions.RespondToAuthChallenge
   services:
     cognito-identity-provider: {RespondToAuthChallenge}
+cognito-identity-provider_DeleteUser:
+  title: Delete an &COG; user using an &AWS; SDK
+  title_abbrev: Delete a user
+  synopsis: delete an &COG; user.
+  category:
+  languages:
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.cognito.cognito_client
+                - cpp.example_code.cognito.delete_user
+  services:
+    cognito-identity-provider: {DeleteUser}
 cognito-identity-provider_Scenario_SignUpUserWithMfa:
   title: Sign up a user with an &COG; user pool that requires MFA using an &AWS; SDK
   title_abbrev: Sign up a user with a user pool that requires MFA
@@ -656,6 +754,15 @@ cognito-identity-provider_Scenario_SignUpUserWithMfa:
                 - javascript.v3.cognito-idp.actions.RespondToAuthChallenge
                 - javascript.v3.cognito-idp.scenarios.basic.VerifySoftwareTokenHandler
                 - javascript.v3.cognito-idp.actions.VerifySoftwareToken
+    C++:
+      versions:
+        - sdk_version: 1
+          github: cpp/example_code/cognito
+          excerpts:
+            - description:
+              snippet_tags:
+                - cpp.example_code.cognito.client_configuration
+                - cpp.example_code.getting_started_with_user_pools
   services:
     cognito-identity-provider: {ConfirmSignUp, ConfirmDevice, AssociateSoftwareToken,
                                 AdminGetUser, ListUsers, ResendConfirmationCode,

cpp/example_code/cognito/CMakeLists.txt

@@ -0,0 +1,98 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# Set the minimum required version of CMake for this project.
+cmake_minimum_required(VERSION 3.8)
+
+set(SERVICE_NAME cognito)
+set(SERVICE_COMPONENTS cognito-idp)
+
+# Set this project's name.
+project("${SERVICE_NAME}-examples")
+
+set(USING_CONAN FALSE)  # Setting to true enables generation of a QR code.
+
+
+if (USING_CONAN)
+    set(ADDED_CONAN_DEFINE USING_QR=1)
+    include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)
+    conan_basic_setup()
+else ()
+
+endif ()
+
+#Set the location of where Windows can find the installed libraries of the SDK.
+if (MSVC)
+    string(REPLACE ";" "/aws-cpp-sdk-all;" SYSTEM_MODULE_PATH "${CMAKE_SYSTEM_PREFIX_PATH}/aws-cpp-sdk-all")
+    list(APPEND CMAKE_PREFIX_PATH ${SYSTEM_MODULE_PATH})
+endif ()
+
+# Set the C++ standard to use to build this target.
+set(CMAKE_CXX_STANDARD 11)
+
+# Enable CTest for testing these code examples.
+if (BUILD_TESTS)
+    include(CTest)
+endif ()
+
+# Build shared libraries by default.
+if (NOT DEFINED BUILD_SHARED_LIBS)
+    set(BUILD_SHARED_LIBS ON)
+endif ()
+
+# Find the AWS SDK for C++ package.
+find_package(AWSSDK REQUIRED COMPONENTS ${SERVICE_COMPONENTS})
+
+# If the compiler is some version of Microsoft Visual C++, or another compiler simulating C++,
+# and building as shared libraries, then dynamically link to those shared libraries.
+if (MSVC AND BUILD_SHARED_LIBS)
+    add_definitions(-DUSE_IMPORT_EXPORT)
+    # Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
+
+    set(CMAKE_BUILD_TYPE Debug) # Explicitly setting CMAKE_BUILD_TYPE is necessary in Windows to copy DLLs.
+
+    list(APPEND SERVICE_LIST ${SERVICE_COMPONENTS})
+
+    AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+endif ()
+
+# AWSDOC_SOURCE can be defined in the command line to limit the files in a build. For example,
+# you can limit files to one action.
+if (NOT DEFINED AWSDOC_SOURCE)
+    file(GLOB AWSDOC_SOURCE
+            "*.cpp"
+            )
+endif ()
+
+# Check whether the target system is Windows, including Win64.
+if (WIN32)
+    # Check whether the compiler is some version of Microsoft Visual C++, or another compiler simulating C++.
+    if (MSVC)
+        source_group("Source Files" FILES ${AWSDOC_SOURCE})
+    endif (MSVC)
+endif ()
+
+foreach (file ${AWSDOC_SOURCE})
+    get_filename_component(EXAMPLE ${file} NAME_WE)
+
+    # Build the code example executables.
+    set(EXAMPLE_EXE run_${EXAMPLE})
+
+    add_executable(${EXAMPLE_EXE} ${file})
+
+    target_link_libraries(${EXAMPLE_EXE} ${AWSSDK_LINK_LIBRARIES}
+            ${AWSSDK_PLATFORM_DEPS}
+            ${CONAN_LIBS})
+
+    target_compile_definitions(${EXAMPLE_EXE}
+            PRIVATE
+            ${ADDED_CONAN_DEFINE}
+            SOURCE_DIR="${CMAKE_CURRENT_SOURCE_DIR}"
+            )
+endforeach ()
+
+# Conan and googletest are not getting along in this instance.
+if (BUILD_TESTS AND NOT USING_CONAN)
+    add_subdirectory(tests)
+endif ()
+

cpp/example_code/cognito/README.md

@@ -0,0 +1,92 @@
+# Amazon Cognito code examples for the SDK for C++
+
+## Overview
+
+Shows how to use the AWS SDK for C++ with Amazon Cognito to sign up users, set users up for multi-factor authentication (MFA), and sign in to
+get access tokens.
+
+*Amazon Cognito provides authentication, authorization, and user management for your web and mobile apps. Your users can sign in directly with a user name and password, or through a third party such as Facebook, Amazon, Google or Apple.*
+
+## ⚠️ Important
+
+* Running this code might result in charges to your AWS account. 
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege). 
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+
+## Code examples
+
+### Single actions
+
+Code excerpts that show you how to call individual service functions.
+
+* [Confirm a user](./getting_started_with_user_pools.cpp) (ConfirmSignUp)
+* [Delete a user](./getting_started_with_user_pools.cpp) (DeleteUser)
+* [Get a token to associate an MFA application with a user](./getting_started_with_user_pools.cpp) (AssociateSoftwareToken)
+* [Get information about a user](./getting_started_with_user_pools.cpp) (AdminGetUser)
+* [Resend a confirmation code](./getting_started_with_user_pools.cpp) (ResendConfirmationCode)
+* [Respond to SRP authentication challenges](./getting_started_with_user_pools.cpp) (RespondToAuthChallenge)
+* [Sign up a user](./getting_started_with_user_pools.cpp) (SignUp)
+* [Start authentication with a tracked device](./getting_started_with_user_pools.cpp) (InitiateAuth)
+* [Verify an MFA application with a user](./getting_started_with_user_pools.cpp) (VerifySoftwareToken)
+
+### Scenarios
+
+Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.
+
+* [Sign up a user with a user pool that requires MFA](./getting_started_with_user_pools.cpp) (ConfirmSignUp, DeleteUser,
+  AssociateSoftwareToken, AdminGetUser, ResendConfirmationCode, RespondToAuthChallenge, SignUp, InitiateAuth, VerifySoftwareToken)
+
+## Run the examples
+
+### Prerequisites
+Before using the code examples, first complete the installation and setup steps
+for [Getting started](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html) in the AWS SDK for
+C++ Developer Guide.
+This section covers how to get and build the SDK, and how to build your own code by using the SDK with a
+sample Hello World-style application.
+
+Next, for information on code example structures and how to build and run the examples, see [Getting started with the AWS SDK for C++ code examples](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html).
+
+#### Running the `Sign up a user with a user pool that requires MFA` scenario.
+
+The Amazon Cognito resources for `Sign up a user with a user pool that requires MFA` can be created by running the AWS CloudFormation
+`setup.yaml` script in [resources/cdk/cognito_scenario_user_pool_with_mfa](../../../resources/cdk/cognito_scenario_user_pool_with_mfa/setup.yaml).
+
+For instructions on how to run the script, see the [README](../../../resources/cdk/cognito_scenario_user_pool_with_mfa/README.md).
+
+Optionally, build [Sign up a user with a user pool that requires MFA](./getting_started_with_user_pools.cpp) to use the
+[qr-code-generator](https://github.com/nayuki/QR-Code-generator) library. This creates a QR code image for MFA authentication. 
+A [conanfile.txt](conanfile.txt) is included with the sample code. You can install the qr-code-generator library by using the [Conan C++ package manager](https://conan.io/).
+
+To install the `qr-code-generator` library using Conan, run the following command from the build directory.
+
+On Linux and Mac.
+
+`conan install <path_to_source_dir> --build=missing`
+
+On Windows.
+
+`conan install <path_to_source_dir> --build=missing -s build_type=Debug`
+
+Next, enable the `USING_CONAN` variable in [CMakeLists.txt](CMakeLists.txt).
+
+`set(USING_CONAN TRUE)  # Setting to true enables generation of a QR code.`
+
+## Tests
+⚠️ Running the tests might result in charges to your AWS account.
+
+```sh
+   cd <BUILD_DIR>
+   cmake <path-to-root-of-this-source-code> -DBUILD_TESTS=ON
+   make
+   ctest 
+```   
+
+## Additional resources
+
+* [Amazon Cognito Developer Guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html)
+* [Amazon Cognito API Reference](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/Welcome.html)
+* [AWS SDK for C++ Documentation](https://docs.aws.amazon.com/sdk-for-cpp/index.html)
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0

cpp/example_code/cognito/cognito_samples.h

@@ -0,0 +1,28 @@
+/*
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
+
+#pragma once
+
+#ifndef COGNITO_EXAMPLES_COGNITO_SAMPLES_H
+#define COGNITO_EXAMPLES_COGNITO_SAMPLES_H
+
+namespace AwsDoc {
+    namespace Cognito {
+        //! Scenario that adds a user to an Amazon Cognito user pool.
+        /*!
+          \sa gettingStartedWithUserPools()
+          \param clientID: Client ID associated with an Amazon Cognito user pool.
+          \param userPoolID: An Amazon Cognito user pool ID.
+          \param clientConfig: Aws client configuration.
+          \return bool: Successful completion.
+         */
+        bool gettingStartedWithUserPools(const Aws::String &clientID,
+                                         const Aws::String &userPoolID,
+                                         const Aws::Client::ClientConfiguration &clientConfig);
+    } // namespace Cognito
+} // namespace AwsDoc
+
+
+#endif //COGNITO_EXAMPLES_COGNITO_SAMPLES_H