Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

el2g: add documentation for GENERIC_KEYPAIRS #611

Merged
merged 3 commits into from
Oct 26, 2023
Merged

el2g: add documentation for GENERIC_KEYPAIRS #611

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ab8290
el2g: add documentation for GENERIC_KEYPAIRS
Oct 6, 2023
f98943a
Apply suggestions from code review
arnout Oct 11, 2023
5105319
Apply suggestions from code review
arnout Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions source/user-guide/el2g.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,22 @@
* **Subdomain** — Every EdgeLock 2GO account has a "device-link" subdomain that a device's ``nxp_iot_agent_demo`` binary connects to.
This is the service where secure objects will be exchanged.

Installing Additional Secure Objects
------------------------------------

Additional Secure Objects can be defined in EdgeLock 2GO through the API.
These objects are provisioned into the Secure Element when the device registers.
On top of this, keypairs and certificates are loaded into PKCS#11 so they are accessible, e.g., OpenSSL.
The convention is that the keypair secure object has an even-numbered OID (e.g. 0x10000010) and the corresponding certificate has an OID one higher (e.g. 0x10000011).

Check warning on line 240 in source/user-guide/el2g.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.sentence-length] Aim for sentences no longer than 25 words

Raw Output:
{"message": "[Fio-docs.sentence-length] Aim for sentences no longer than 25 words", "location": {"path": "source/user-guide/el2g.rst", "range": {"start": {"line": 240, "column": 1}}}, "severity": "INFO"}
To enable automatic loading of the keypair and certificate, the ``GENERIC_KEYPAIRS`` variable must be set in ``/etc/default/lmp-el2go-auto-register`` e.g.,

arnout marked this conversation as resolved.
Show resolved Hide resolved
::
# recipes-support/lmp-el2go-auto-register/lmp-el2go-auto-register/default.env

Check failure on line 244 in source/user-guide/el2g.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'

Raw Output:
{"message": "[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'", "location": {"path": "source/user-guide/el2g.rst", "range": {"start": {"line": 244, "column": 21}}}, "severity": "ERROR"}

Check failure on line 244 in source/user-guide/el2g.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'

Raw Output:
{"message": "[Fio-docs.Branding-and-names] Use 'LmP' instead of 'lmp'", "location": {"path": "source/user-guide/el2g.rst", "range": {"start": {"line": 244, "column": 45}}}, "severity": "ERROR"}
REPOID=<YOUR ID FROM fioctl factories>

Check failure on line 245 in source/user-guide/el2g.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.Branding-and-names] Use 'Fioctl' instead of 'fioctl'

Raw Output:
{"message": "[Fio-docs.Branding-and-names] Use 'Fioctl' instead of 'fioctl'", "location": {"path": "source/user-guide/el2g.rst", "range": {"start": {"line": 245, "column": 24}}}, "severity": "ERROR"}
GENERIC_KEYPAIRS="0x10000010"

``GENERIC_KEYPAIRS`` defaults to 0X83000044 which is the OID used by AWS IoT.

Further Details
---------------

Expand Down
Loading