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 1 commit
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
15 changes: 15 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,21 @@ EdgeLock 2GO Concepts
* **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
arnout marked this conversation as resolved.
Show resolved Hide resolved
------------------------------------

Any additional Secure Objects that are defined in EdgeLock 2GO and provisioned into the secure element when the device registers.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is a bit off to me. I think the purpose here is to say that any additional secure objects <....> can be installed, or maybe list which are the expected additional objects. I think something is missing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The and should be are. But the sentence is still off. How about:

Additional Secure Objects can be defined in EdgeLock 2GO through the API.
These objects are provisioned into the Secure Element when the device registers.

arnout marked this conversation as resolved.
Show resolved Hide resolved
Additionally, keypairs and certificates are loaded into PKCS#11 so they are accessible to e.g. OpenSSL.
kprosise marked this conversation as resolved.
Show resolved Hide resolved
arnout marked this conversation as resolved.
Show resolved Hide resolved
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).
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

arnout marked this conversation as resolved.
Show resolved Hide resolved
# recipes-support/lmp-el2go-auto-register/lmp-el2go-auto-register/default.env
REPOID=<YOUR ID FROM fioctl factories>
GENERIC_KEYPAIRS="0x10000010"

`GENERIC_KEYPAIRS` defaults to 0X83000044 which is the OID used by AWS IoT.
arnout marked this conversation as resolved.
Show resolved Hide resolved

arnout marked this conversation as resolved.
Show resolved Hide resolved

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

Expand Down