diff --git a/common/core/src/authentication_provider.ts b/common/core/src/authentication_provider.ts index 920d0efd3..f60c5447e 100644 --- a/common/core/src/authentication_provider.ts +++ b/common/core/src/authentication_provider.ts @@ -8,7 +8,7 @@ import { TransportConfig } from './authorization'; */ export enum AuthenticationType { /** - * X509 authentication uses X509 certificate and key pairs. + * X509 Certificate based authentication. */ X509, /** diff --git a/common/core/src/authorization.ts b/common/core/src/authorization.ts index 9abafe300..7d9b5aa43 100644 --- a/common/core/src/authorization.ts +++ b/common/core/src/authorization.ts @@ -91,10 +91,12 @@ export interface X509 { * Passphrase used to decode the key associated with the X509 certificate. */ passphrase?: string; + /** * @private */ - certFile?: string; + + certFile?: string; /** * @private */ diff --git a/provisioning/device/readme.md b/provisioning/device/readme.md index b7f5498cd..77809a5ff 100644 --- a/provisioning/device/readme.md +++ b/provisioning/device/readme.md @@ -5,7 +5,7 @@ This package (**azure-iot-provisioning-device**) provides the device client that ## Install There are at least 3 different packages involved when writing code to take advantage of the Azure IoT Hub Device Provisioning Service: -- The "client" package that will be used to create a provisioning client. This is this package. +- The "client" package that will be used to create a provisioning client. (This package). - the "transport" package that will decide which protocol will be used to communicate with the provisioning service. One of **azure-iot-provisioning-device-amqp**, **azure-iot-provisioning-device-mqtt**, or **azure-iot-provisioning-device-http**. Please note that X509 authentication is supported with all protocols but TPM authentication is supported only with AMQP and HTTP. - The "security client" package that will be used to interface with whatever type of security (x509 or TPM) is used to authenticate the device. diff --git a/provisioning/device/samples/package.json b/provisioning/device/samples/package.json index 2c932277b..3437d8b9e 100644 --- a/provisioning/device/samples/package.json +++ b/provisioning/device/samples/package.json @@ -6,12 +6,12 @@ "license": "MIT", "dependencies": { "azure-iot-provisioning-device": "0.0.1", - "azure-iot-provisioning-device-http": "0.0.1", "azure-iot-provisioning-device-amqp": "0.0.1", + "azure-iot-provisioning-device-http": "0.0.1", "azure-iot-provisioning-device-mqtt": "0.0.1", "azure-iot-security-x509": "0.0.1" }, - "scripts" : { + "scripts": { "build": "echo nothing to do" }, "engines": { @@ -25,4 +25,4 @@ "url": "https://github.com/Azure/azure-iot-sdk-node/issues" }, "homepage": "https://github.com/Azure/azure-iot-sdk-node#readme" -} \ No newline at end of file +} diff --git a/provisioning/device/samples/readme.md b/provisioning/device/samples/readme.md index 6d8303f6a..d90490ebd 100644 --- a/provisioning/device/samples/readme.md +++ b/provisioning/device/samples/readme.md @@ -2,7 +2,7 @@ This file can be found in https://github.com/Azure/azure-iot-sdk-node/tree/master/provisioning/device/samples -This folder contains simple samples showing how to use the various features of the Microsoft Azure IoT Device Provisioning Service from an application running JavaScript or TypeScript code. +This folder contains simple samples showing how to use the various features of the Microsoft Azure IoT Hub Device Provisioning Service from an application running JavaScript or TypeScript code. ## List of samples diff --git a/provisioning/transport/amqp/src/amqp.ts b/provisioning/transport/amqp/src/amqp.ts index db67c083e..bffb8aae4 100644 --- a/provisioning/transport/amqp/src/amqp.ts +++ b/provisioning/transport/amqp/src/amqp.ts @@ -89,7 +89,6 @@ export class Amqp extends EventEmitter implements X509ProvisioningTransport { } }, registrationRequest: (request, callback) => { - // TODO: this only works for x509 this._amqpStateMachine.transition('connecting', request, (err) => { if (err) { callback(err); @@ -99,7 +98,6 @@ export class Amqp extends EventEmitter implements X509ProvisioningTransport { }); }, queryOperationStatus: (request, operationId, callback) => { - // TODO: this only works for x509 this._amqpStateMachine.transition('connecting', request, (err) => { if (err) { callback(err);