File Explorer

1/*2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.3 * SPDX-License-Identifier: Apache-2.0.4 */5 6import * as test_env from "@test/test_env"7import * as retry from "@test/retry"8import * as mqtt311 from "./mqtt";9import * as aws_iot_mqtt311 from "./aws_iot";10import * as io from "./io"11import * as auth from "./auth"12import { v4 as uuid } from 'uuid';13import {once} from "events";14import {cRuntime, CRuntimeType} from "./binding"15import {newLiftedPromise} from "../common/promise";16import {TlsCipherPreference} from "./io";17import {platform} from "os";18 19jest.setTimeout(30000);20 21test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_custom_auth_unsigned())('Aws Iot Core Mqtt over websockets with Non-Signing Custom Auth - Connection Success', async () => {22    await retry.networkTimeoutRetryWrapper( async () => {23        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_builder_for_websocket();24        builder.with_custom_authorizer(25            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_USERNAME,26            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_NAME,27            "",28            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_PASSWORD,29            undefined,30            undefined,31        )32        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);33        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)34        let config = builder.build();35        let client = new mqtt311.MqttClient();36        let connection = client.new_connection(config);37        await connection.connect();38        await connection.disconnect();39    })40});41 42test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_custom_auth_signed())('Aws Iot Core Mqtt over websockets with Signing Custom Auth - Connection Success', async () => {43    await retry.networkTimeoutRetryWrapper( async () => {44        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_builder_for_websocket();45        builder.with_custom_authorizer(46            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_USERNAME,47            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_NAME,48            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_SIGNATURE,49            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_PASSWORD,50            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_KEY_NAME,51            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_TOKEN,52        )53        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);54        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)55        let config = builder.build();56        let client = new mqtt311.MqttClient();57        let connection = client.new_connection(config);58        await connection.connect();59        await connection.disconnect();60    })61});62 63/**64 * Skip test if cruntime is Musl. Softhsm library crashes on Alpine if we don't use AWS_PKCS11_LIB_STRICT_INITIALIZE_FINALIZE.65 * Supporting AWS_PKCS11_LIB_STRICT_INITIALIZE_FINALIZE on Node-js is not trivial due to non-deterministic cleanup.66 * TODO: Support AWS_PKCS11_LIB_STRICT_INITIALIZE_FINALIZE67 */68test_env.conditional_test(cRuntime !== CRuntimeType.MUSL && test_env.AWS_IOT_ENV.mqtt311_is_valid_pkcs11())('Aws Iot Core PKCS11 connection', async () => {69    await retry.networkTimeoutRetryWrapper( async () => {70        const pkcs11_lib = new io.Pkcs11Lib(test_env.AWS_IOT_ENV.MQTT311_PKCS11_LIB_PATH);71        const builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_mtls_pkcs11_builder({72            pkcs11_lib: pkcs11_lib,73            user_pin: test_env.AWS_IOT_ENV.MQTT311_PKCS11_PIN,74            token_label: test_env.AWS_IOT_ENV.MQTT311_PKCS11_TOKEN_LABEL,75            private_key_object_label: test_env.AWS_IOT_ENV.MQTT311_PKCS11_PRIVATE_KEY_LABEL,76            cert_file_path: test_env.AWS_IOT_ENV.MQTT311_PKCS11_CERT,77        });78        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);79        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)80        let config = builder.build();81        let client = new mqtt311.MqttClient();82        let connection = client.new_connection(config);83        await connection.connect();84        await connection.disconnect();85    })86});87 88test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_pkcs12())('Aws Iot Core PKCS12 connection', async () => {89    await retry.networkTimeoutRetryWrapper( async () => {90        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_mtls_pkcs12_builder({91            pkcs12_file: test_env.AWS_IOT_ENV.MQTT311_PKCS12_FILE,92            pkcs12_password: test_env.AWS_IOT_ENV.MQTT311_PKCS12_PASSWORD93        });94        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);95        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)96        let config = builder.build();97        let client = new mqtt311.MqttClient();98        let connection = client.new_connection(config);99        await connection.connect();100        await connection.disconnect();101    })102});103 104test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_windows_cert())('Aws Iot Core Windows Cert connection', async () => {105    await retry.networkTimeoutRetryWrapper( async () => {106        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_mtls_windows_cert_store_path_builder(107            test_env.AWS_IOT_ENV.MQTT311_WINDOWS_CERT);108        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);109        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)110        let config = builder.build();111        let client = new mqtt311.MqttClient();112        let connection = client.new_connection(config);113        await connection.connect();114        await connection.disconnect();115    })116});117 118test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_custom_auth_unsigned())('Aws Iot Core - Direct MQTT Custom Auth unsigned', async () => {119    await retry.networkTimeoutRetryWrapper( async () => {120        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_default_builder();121        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);122        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)123        builder.with_custom_authorizer(124            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_USERNAME,125            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_NAME,126            "",127            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_UNSIGNED_PASSWORD,128            undefined,129            undefined)130        let config = builder.build();131        let client = new mqtt311.MqttClient();132        let connection = client.new_connection(config);133        await connection.connect();134        await connection.disconnect();135    })136});137 138test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_custom_auth_signed())('Aws Iot Core - Direct MQTT Custom Auth signed', async () => {139    await retry.networkTimeoutRetryWrapper( async () => {140        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_default_builder();141        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);142        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)143        builder.with_custom_authorizer(144            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_USERNAME,145            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_NAME,146            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_SIGNATURE,147            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_PASSWORD,148            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_KEY_NAME,149            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_TOKEN)150        let config = builder.build();151        let client = new mqtt311.MqttClient();152        let connection = client.new_connection(config);153        await connection.connect();154        await connection.disconnect();155    })156});157 158test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_custom_auth_signed())('Aws Iot Core - Direct MQTT Custom Auth signed, unencoded signature', async () => {159    await retry.networkTimeoutRetryWrapper( async () => {160        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_default_builder();161        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);162        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)163        builder.with_custom_authorizer(164            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_USERNAME,165            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_NAME,166            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_SIGNATURE_UNENCODED,167            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_PASSWORD,168            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_KEY_NAME,169            test_env.AWS_IOT_ENV.MQTT311_CUSTOM_AUTH_SIGNED_TOKEN)170        let config = builder.build();171        let client = new mqtt311.MqttClient();172        let connection = client.new_connection(config);173        await connection.connect();174        await connection.disconnect();175    })176});177 178test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_cred())('MQTT Native Websocket Connect/Disconnect', async () => {179    await retry.networkTimeoutRetryWrapper( async () => {180        let websocket_config = {181            region: test_env.AWS_IOT_ENV.MQTT311_REGION,182            credentials_provider: auth.AwsCredentialsProvider.newStatic(183                test_env.AWS_IOT_ENV.MQTT311_CRED_ACCESS_KEY,184                test_env.AWS_IOT_ENV.MQTT311_CRED_SECRET_ACCESS_KEY,185                test_env.AWS_IOT_ENV.MQTT311_CRED_SESSION_TOKEN186            ),187        }188        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets(websocket_config);189        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);190        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)191        let config = builder.build();192        let client = new mqtt311.MqttClient(new io.ClientBootstrap());193        let connection = client.new_connection(config);194        await connection.connect();195        await connection.disconnect();196    })197});198 199test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_cred())('MQTT Native Websocket Connect/Disconnect No Bootstrap', async () => {200    await retry.networkTimeoutRetryWrapper( async () => {201        let websocket_config = {202            region: test_env.AWS_IOT_ENV.MQTT311_REGION,203            credentials_provider: auth.AwsCredentialsProvider.newStatic(204                test_env.AWS_IOT_ENV.MQTT311_CRED_ACCESS_KEY,205                test_env.AWS_IOT_ENV.MQTT311_CRED_SECRET_ACCESS_KEY,206                test_env.AWS_IOT_ENV.MQTT311_CRED_SESSION_TOKEN207            ),208        }209        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets(websocket_config);210        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);211        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)212        let config = builder.build();213        let client = new mqtt311.MqttClient();214        let connection = client.new_connection(config);215 216        const connectionSuccess = once(connection, "connection_success");217        await connection.connect();218 219        let connectionSuccessEvent: mqtt311.OnConnectionSuccessResult = (await connectionSuccess)[0];220        expect(connectionSuccessEvent.session_present).toBeFalsy();221        expect(connectionSuccessEvent.reason_code).toBeDefined();222        expect(connectionSuccessEvent.reason_code).toBe(0); // Success223 224        const closed = once(connection, "closed");225        await connection.disconnect();226        await closed;227    })228});229 230test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_cred())('MQTT Native Websocket Connect/Disconnect - Connection Failure', async () => {231    await retry.networkTimeoutRetryWrapper( async () => {232        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets();233        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)234        builder.with_credentials(235            test_env.AWS_IOT_ENV.MQTT311_REGION,236            test_env.AWS_IOT_ENV.MQTT311_CRED_ACCESS_KEY,237            test_env.AWS_IOT_ENV.MQTT311_CRED_SECRET_ACCESS_KEY,238            test_env.AWS_IOT_ENV.MQTT311_CRED_SESSION_TOKEN239        );240        /* Use the wrong port and endpoint ensure a fail */241        builder.with_endpoint("testendpointhere");242        builder.with_port(321);243        let config = builder.build();244 245        let failurePromise = newLiftedPromise<mqtt311.OnConnectionFailedResult>();246 247        let client = new mqtt311.MqttClient();248        let connection = client.new_connection(config);249        connection.on('error', () => {250        });251        connection.on('connection_failure', (result) => {252            failurePromise.resolve(result)253        });254 255        let expected_error = false;256        try {257            await connection.connect();258        } catch (error) {259            expected_error = true;260        }261        expect(expected_error).toBeTruthy();262 263        let connectionFailedEvent: mqtt311.OnConnectionFailedResult = await failurePromise.promise;264        expect(connectionFailedEvent).toBeDefined();265        expect(connectionFailedEvent.error).toBeDefined();266    })267});268 269// requires correct credentials to be sourced from the default credentials provider chain270test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_websocket())('MQTT Native Websocket Default AWS Credentials', async () => {271    await retry.networkTimeoutRetryWrapper( async () => {272        let websocket_config = {273            region: test_env.AWS_IOT_ENV.MQTT311_REGION,274            credentials_provider: auth.AwsCredentialsProvider.newDefault()275        }276        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets(websocket_config);277        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);278        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)279        builder.with_port(443);280        let config = builder.build();281        let client = new mqtt311.MqttClient();282        let connection = client.new_connection(config);283 284        await connection.connect();285        await connection.disconnect();286    })287});288 289test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_cognito())('MQTT Native Websocket Cognito Credentials', async () => {290    await retry.networkTimeoutRetryWrapper( async () => {291        let websocket_config = {292            region: test_env.AWS_IOT_ENV.MQTT311_REGION,293            credentials_provider: auth.AwsCredentialsProvider.newCognito({294                identity: test_env.AWS_IOT_ENV.MQTT311_COGNITO_IDENTITY,295                endpoint: test_env.AWS_IOT_ENV.MQTT311_COGNITO_ENDPOINT296            })297        }298        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets(websocket_config);299        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);300        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)301        let config = builder.build();302        let client = new mqtt311.MqttClient();303        let connection = client.new_connection(config);304        await connection.connect();305        await connection.disconnect();306    })307});308 309test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt311_is_valid_x509())('MQTT Native Websocket X509 Credentials', async () => {310    await retry.networkTimeoutRetryWrapper( async () => {311        let tls_ctx_options: io.TlsContextOptions = io.TlsContextOptions.create_client_with_mtls_from_path(312            test_env.AWS_IOT_ENV.MQTT311_X509_CERT,313            test_env.AWS_IOT_ENV.MQTT311_X509_KEY314        );315        let tls_ctx = new io.ClientTlsContext(tls_ctx_options);316        let websocket_config = {317            region: test_env.AWS_IOT_ENV.MQTT311_REGION,318            credentials_provider: auth.AwsCredentialsProvider.newX509({319                endpoint: test_env.AWS_IOT_ENV.MQTT311_X509_ENDPOINT,320                thingName: test_env.AWS_IOT_ENV.MQTT311_X509_THING_NAME,321                roleAlias: test_env.AWS_IOT_ENV.MQTT311_X509_ROLE_ALIAS,322                tlsContext: tls_ctx323            })324        }325        let builder = aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_with_websockets(websocket_config);326        builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT311_HOST);327        builder.with_client_id(`node-mqtt-unit-test-${uuid()}`)328        let config = builder.build();329        let client = new mqtt311.MqttClient();330        let connection = client.new_connection(config);331        await connection.connect();332        await connection.disconnect();333    })334});335 336function do_successful_cipher_preference_test(tls_cipher_preference: TlsCipherPreference) {337    let builder =  aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_mtls_builder_from_path(338        test_env.AWS_IOT_ENV.MQTT5_RSA_CERT,339        test_env.AWS_IOT_ENV.MQTT5_RSA_KEY);340    builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT5_HOST);341    builder.with_client_id(`node-mqtt-unit-test-${uuid()}`);342    builder.with_tls_cipher_preference(tls_cipher_preference);343 344    let config = builder.build();345    let client = new mqtt311.MqttClient();346    let connection = client.new_connection(config);347    expect(connection).toBeDefined();348}349 350function do_unsuccessful_cipher_preference_test(tls_cipher_preference: TlsCipherPreference) {351    let builder =  aws_iot_mqtt311.AwsIotMqttConnectionConfigBuilder.new_mtls_builder_from_path(352        test_env.AWS_IOT_ENV.MQTT5_RSA_CERT,353        test_env.AWS_IOT_ENV.MQTT5_RSA_KEY);354    builder.with_endpoint(test_env.AWS_IOT_ENV.MQTT5_HOST);355    builder.with_client_id(`node-mqtt-unit-test-${uuid()}`);356    builder.with_tls_cipher_preference(tls_cipher_preference);357 358    expect(() => {359        builder.build();360    }).toThrow("AWS_IO_TLS_CIPHER_PREF_UNSUPPORTED");361}362 363function do_cipher_preference_test(tls_cipher_preference: TlsCipherPreference, should_be_successful: boolean) {364    if (should_be_successful) {365        do_successful_cipher_preference_test(tls_cipher_preference);366    } else {367        do_unsuccessful_cipher_preference_test(tls_cipher_preference);368    }369}370 371test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt5_is_valid_mtls_rsa())("Mqtt311 client builder supports default TlsCipherPreference", () => {372    do_cipher_preference_test(TlsCipherPreference.Default, true);373});374 375test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt5_is_valid_mtls_rsa())("Mqtt311 client builder per-platform conditional support of PQ default TlsCipherPreference", () => {376    do_cipher_preference_test(TlsCipherPreference.PQ_Default, platform() === "linux");377});378 379test_env.conditional_test(test_env.AWS_IOT_ENV.mqtt5_is_valid_mtls_rsa())("Mqtt311 client builder per-platform conditional support of latest 1.2 policy TlsCipherPreference", () => {380    do_cipher_preference_test(TlsCipherPreference.TLSv1_2_2025_07, platform() === "linux");381});