{"id":21377226,"url":"https://github.com/softchef/iot-just-in-time-registration-javascript","last_synced_at":"2025-03-16T09:44:37.100Z","repository":{"id":46543439,"uuid":"385547299","full_name":"SoftChef/iot-just-in-time-registration-javascript","owner":"SoftChef","description":null,"archived":false,"fork":false,"pushed_at":"2021-12-14T00:11:16.000Z","size":7761,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T21:45:26.565Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SoftChef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-13T09:22:35.000Z","updated_at":"2021-10-14T07:21:22.000Z","dependencies_parsed_at":"2022-09-04T15:32:23.476Z","dependency_job_id":null,"html_url":"https://github.com/SoftChef/iot-just-in-time-registration-javascript","commit_stats":null,"previous_names":[],"tags_count":71,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fiot-just-in-time-registration-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fiot-just-in-time-registration-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fiot-just-in-time-registration-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SoftChef%2Fiot-just-in-time-registration-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SoftChef","download_url":"https://codeload.github.com/SoftChef/iot-just-in-time-registration-javascript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243852432,"owners_count":20358270,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-22T09:19:38.618Z","updated_at":"2025-03-16T09:44:37.074Z","avatar_url":"https://github.com/SoftChef.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AWS IoT Just-In-Time-Registration (JavaScript)\n\n## Overview\n\nThis document will help your device connect to AWS IoT quickly. Mainly to speed up the process of certificate exchanging complied to AWS IoT authentication.\n\n## Prepare\n\nEnvironment\n\n- Create \"certs\" directory in your develop path.\n\nPackages\n\n- AWS IoT SDK for JavaScript https://github.com/aws/aws-iot-device-sdk-js\n\nsensor.live\n\n- Enable SATR on sensor.live, you will get root_ca.cert.pem, ca.cert.pem and ca.private_key.pem.\n- Put the pem files into ./certs directory.\n\n## Installation\n\n```\nnpm install @softchef/iot-just-in-time-registration\n\nor\n\nyarn add @softchef/iot-just-in-time-registration\n```\n## Examples\n\n[Example code](https://github.com/SoftChefiot-just-in-time-registration-javascript/tree/main/example/)\n\n## API Documentation\n\n#### ThingRegistry.generateDeviceCertificate(thingName, options)\n\nDefault options:\n```\noptions = {\n    countryName = 'TW',\n    stateName = 'Taipei',\n    localityName = 'Neihu',\n    organizationName = 'SoftChef',\n    organizationUnitName = 'IT'\n}\n```\nYou can customize the thing name, please ensure the thing name is given uniquely.\n\nThe naming rule is based on AWS IoT requirement: Must contain only alphanumeric characters and/or the following: -_:\n\nIf your thing_name is null, alternatively, the thing name will generate from the device certificate.\n\n#### ThingRegistry.thingName\n\nGet the thing name. Your customized name or from the device certificate.\n\n#### ThingRegistry.keysPath\n\nReturn the keys path, properties follow AWS IoT connection options.\n\n#### ThingRegistry.setCertsPath(path)\n\nChange the default certificate files directory.\n\n#### ThingRegistry.setCACertificateName(name)\n\nChange the default CA certificate file name.\n\n#### ThingRegistry.setCAPrivateKeyName(name)\n\nChange the default CA private key file name.\n\n#### ThingRegistry.setRootCACertificateName(name)\n\nChange the default RootCA certificate file name.\n\n#### ThingRegistry.setDeviceCsrName(name)\n\nChange the default device certificate request file name.\n\n#### ThingRegistry.setDeviceCertificateName(name)\n\nChange the default device certificate file name.\n\n#### ThingRegistry.setDevicePublicKeyName(name)\n\nChange the default device public key file name.\n\n#### ThingRegistry.setDevicePrivateKeyName(name)\n\nChange the default device private key file name.\n\n## License\n\nThis SDK is distributed under the GNU GENERAL PUBLIC LICENSE Version 3, see LICENSE for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftchef%2Fiot-just-in-time-registration-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftchef%2Fiot-just-in-time-registration-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftchef%2Fiot-just-in-time-registration-javascript/lists"}