Skip to content

README.md

Latest commit

 

History

History
126 lines (106 loc) · 5.65 KB

README.md

File metadata and controls

126 lines (106 loc) · 5.65 KB

MQTT5 Custom Authorizer Signed PubSub

Return to main sample list

Jump To:

Introduction

The Custom Authorizer Signed sample illustrate how to connect to the AWS IoT Message Broker with the MQTT5 Client by authenticating with a signed Custom Authorizer Lambda Function

You can read more about MQTT5 for the CPP IoT Device SDK V2 in the MQTT5 user guide.

Requirements

You will need to setup your Custom Authorizer so the Lambda function returns a policy document. See this page on the documentation for more details and example return result. You can customize this lambda function as needed for your application to provide your own security measures based on the needs of your application.

The policy Policy provided by your Custom Authorizer Lambda must provide iot connect, subscribe, publish, and receive privileges for this sample to run successfully.

Below is a sample policy that provides the necessary privileges.

(see sample policy) 
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "iot:Publish",
        "iot:Receive"
      ],
      "Resource": [
        "arn:aws:iot:region:account:topic/test/topic"
      ]
    },
    {
      "Effect": "Allow",
      "Action": [
        "iot:Subscribe"
      ],
      "Resource": [
        "arn:aws:iot:region:account:topicfilter/test/topic"
      ]
    },
    {
      "Effect": "Allow",
      "Action": [
        "iot:Connect"
      ],
      "Resource": [
        "arn:aws:iot:region:account:client/mqtt5-sample-*"
      ]
    }
  ]
}

Replace with the following with the data from your AWS account:

  • <region>: The AWS IoT Core region where you created your AWS IoT Core thing you wish to use with this sample. For example us-east-1.
  • <account>: Your AWS IoT Core account ID. This is the set of numbers in the top right next to your AWS account name when using the AWS IoT Core website.

Note that in a real application, you may want to avoid the use of wildcards in your ClientID or use them selectively. Please follow best practices when working with AWS on production applications using the SDK. Also, for the purposes of this sample, please make sure your policy allows a client ID of mqtt5-sample-* to connect or use --client_id <client ID here> to send the client ID your policy supports.

How to build

To build the sample, change directory into the sample's folder and run the cmake commands. The sample executable will be built into the samples/mqtt/mqtt5_custom_auth_signed/build folder.

cd samples/mqtt/mqtt5_custom_auth_signed/
# If you followed the SDK build instruction, you would use the path to `sdk-workspace` folder for `CMAKE_PREFIX_PATH` here
cmake -B build -S . -DCMAKE_PREFIX_PATH="<absolute path sdk-workspace dir>" -DCMAKE_BUILD_TYPE="Debug" .
cmake --build build --config "Debug"

How to run

To run this sample, navigate to the build directory where the executable was created:

# From samples/mqtt/mqtt5_custom_auth_signed/, go to the build directory
cd build
# For a signed custom authorizer
./mqtt5_custom_auth_signed \
    --endpoint <AWS IoT endpoint> \
    --authorizer_name <The name of the custom authorizer to connect to invoke> \
    --auth_token_key_name <Authorizer token key name> \
    --auth_token_key_value <Authorizer token key value> \
    --auth_signature <Custom authorizer signature> \
    --auth_username <The name to send when connecting through the custom authorizer> \
    --auth_password <The password to send when connecting through a custom authorizer>

If you would like to see what optional arguments are available, use the --help argument:

./mqtt5_custom_auth_signed --help

will result in the following output:

MQTT5 Signed Custom Authorizer Sample
options:
  --help        show this help message and exit
required arguments:
  --endpoint    IoT endpoint hostname
  --authorizer_name    The name of the custom authorizer to connect to invoke
  --auth_signature     Custom authorizer signature
  --auth_token_key_name    Authorizer token key name
  --auth_token_key_value   Authorizer token key value
  --auth_username      The name to send when connecting through the custom authorizer
  --auth_password      The password to send when connecting through a custom authorizer
optional arguments:
  --client_id   Client ID (default: mqtt5-sample-<uuid>)
  --topic       Topic (default: test/topic)
  --message     Message payload (default: Hello from mqtt5 sample)
  --count       Messages to publish (0 = infinite) (default: 5)

The sample will not run without the required arguments and will notify you of missing arguments.

Additional Information

Additional help with the MQTT5 Client can be found in the MQTT5 Userguide. This guide will provide more details on MQTT5 operations, lifecycle events, connection methods, and other useful information.