isabella232 / dps-keygen

Helper tool to deal with the device keys :closed_lock_with_key:

Azure IoT DPS Symmetric Key Generator

Helper tool to create device SAS key and/or connection string.

Requirements

node.js version 8+

Install

npm i -g dps-keygen

Usage

dps-keygen <args>

args:
-di:<deviceId> : device id
-dk:<deviceKey> : device primary or secondary key
-mk:<masterKey> : admin primary or secondary key
-si:<scopeId> : scope id
-mr:<uri> : model repository uri
-mc:<uri> : model capability uri. Leave blank if its value is similar to model rep. uri.
-mi:<modelId> : model id

Calculating a device key from admin/master key

This operation doesn't require an active connection. However, you will need the master/admin (primary/secondary) key at your presence.

Device Id below is up to you. Make sure it's unique.

dps-keygen -mk:put_master_key_here -di:ie_dev1

Retrieve hub connection string [deprecated]

The connection string retrieval feature is deprecated. On January 31st 2020 this feature will no longer be available in this tool. IoT Central best practice is to use DPS (Device Provisioning Service) for connecting devices. You can find more details about connecting to IoT Central with DPS at https://docs.microsoft.com/en-us/azure/iot-central/core/concepts-connectivity

dps-keygen -di:dev1 -dk:devicekeyhere -si:scopeidhere

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.