Skip to content

Latest commit

 

History

History
128 lines (98 loc) · 6.31 KB

README.md

File metadata and controls

128 lines (98 loc) · 6.31 KB

Websocket Connect

Return to main sample list

This sample makes an MQTT connection via Websockets and then disconnects. On startup, the device connects to the server via Websockets and then disconnects right after. This sample is for reference on connecting via Websockets. This sample demonstrates the most straightforward way to connect via Websockets by querying the AWS credentials for the connection from the device's environment variables or local files.

Your IoT Core Thing's Policy must provide privileges for this sample to connect. Below is a sample policy that can be used on your IoT Core Thing that will allow this sample to run as intended.

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

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 test-* to connect or use --client_id <client ID here> to send the client ID your policy supports.

For this sample, using Websockets will attempt to fetch the AWS credentials to authorize the connection from your environment variables or local files. See the authorizing direct AWS page for documentation on how to get the AWS credentials, which then you can set to the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN environment variables.

How to run

To run the websocket connect sample, go to the node/websocket_connect folder and run the following commands:

npm install
node dist/index.js --endpoint <endpoint> --ca_file <file> --signing_region <signing region>

Alternate connection configuration methods supported by AWS IoT Core

MQTT over WebSockets with static AWS credentials

With the help of a static credentials provider your application can use a fixed set of AWS credentials. For that, you need to instantiate the StaticCredentialsProviderBuilder class and provide it with the AWS credentials. The following code snippet demonstrates how to set up an MQTT3 connection using static AWS credentials for SigV4-based authentication.

function build_connection(): mqtt.MqttClientConnection {
    let config_builder = iot.AwsIotMqttConnectionConfigBuilder.new_with_websockets({
        region: "<signing region>",
        credentials_provider: auth.AwsCredentialsProvider.newStatic("<access key>", "<secret key>", "<session token>")
    });

    let client_endpoint : string = "<prefix>-ats.iot.<region>.amazonaws.com";
    config_builder.with_endpoint(client_endpoint);
    const config = config_builder.build();

    const client = new mqtt.MqttClient();
    return client.new_connection(config);
}

MQTT over WebSockets with Custom Authorizer

An MQTT3 direct connection can be made using a Custom Authorizer. When making a connection using a Custom Authorizer, the MQTT3 client can optionally passing username, password, and/or token signature arguments based on the configuration of the Custom Authorizer on AWS IoT Core.

You will need to setup your Custom Authorizer so that the lambda function returns a policy document to properly connect. See this page on the documentation for more details and example return results.

If your Custom Authorizer does not use signing, you don't specify anything related to the token signature and can use the following code:

function build_connection(): mqtt.MqttClientConnection {
    let config_builder = iot.AwsIotMqttConnectionConfigBuilder.new_with_websockets({
        region: "<signing region>"
    });

    config_builder.with_custom_authorizer(
        authorizer_name: "<Name of your custom authorizer>",
        username: "<Value of the username field that should be passed to the authorizer's lambda>",
        password: <Binary data value of the password field to be passed to the authorizer lambda>);

    let client_endpoint : string = "<prefix>-ats.iot.<region>.amazonaws.com";
    config_builder.with_endpoint(client_endpoint);
    const config = config_builder.build();

    const client = new mqtt.MqttClient();
    return client.new_connection(config);
}

If your custom authorizer uses signing, you must specify the three signed token properties as well. It is your responsibility to URI-encode the username, authorizerName, and tokenKeyName parameters.

function build_connection(): mqtt.MqttClientConnection {
    let config_builder = iot.AwsIotMqttConnectionConfigBuilder.new_with_websockets({
        region: "<signing region>"
    });

    config_builder.with_custom_authorizer(
        authorizer_name: "<Name of your custom authorizer>",
        username: "<Value of the username field that should be passed to the authorizer's lambda>",
        password: <Binary data value of the password field to be passed to the authorizer lambda>,
        token_key_name: "<Name of the username query param that will contain the token value>",
        token_value: "<Value of the username query param that holds the token value that has been signed>",
        authorizer_signature: "<URI-encoded base64-encoded digital signature of tokenValue>");

    let client_endpoint : string = "<prefix>-ats.iot.<region>.amazonaws.com";
    config_builder.with_endpoint(client_endpoint);
    const config = config_builder.build();

    const client = new mqtt.MqttClient();
    return client.new_connection(config);
}