secure-device-onboard / docs Goto Github PK

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
Within Notes section of Device Initialization, Ownership proxy needs to be replaced with Ownership voucher

In the Data Transmission & Persistence section, under Transmission of Messages over a RESTful Protocol subsection, the hyperlink mentions about the table, but clicking on points to a section where there is no such table is present.
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/data-transmission-persistence/#transmission-of-messages-over-a-restful-protocol

the above hyperlink is redirected to the following section where there is no table present.

In the section Protocol Data Types and at the end of document, for given example of python program, for the mentioned value of 5 in range function, the output should be till value 4 only and also s='abcdefghijklmnop' can be on new line
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-data-types/#fn:5

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
In SDO Module Flow, with Pre Service Info (PSI) Section , "touple" word is seen twice whether its a typo for tuple.

Section: Rest Contracts between OCS (server) and OPS/To0Scheduler (client):
Link:https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/development-guide/#rest-contracts-between-ocs-server-and-opsto0scheduler-client

In second line " Both OPS and To0Scheduler makes...". Should be make instead.

Section: Rest Contracts between To0Scheduler (server) and OCS (client)
Link:https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/development-guide/#rest-contracts-between-to0scheduler-server-and-ocs-client

In first line "implementation must, also, acta as a client to trigger TO0 ", implementation must also act as a is mispelled

Section: Message Types:
Link:https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/development-guide/#message-types

In third line of the first paragraph "JavaScript Object Notation (JSON), represents the purpose of the field." should be represent

Section: Message Types -> ModuleMessage:
Link:https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/development-guide/#modulemessage

Second line, extra commas in "...store,both,the device's serviceinfo, and...."

Section: Message Types -> Message47Store:
Link: https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/development-guide/#message47store

First line: "...temporarily, untill till the". Till is repetitive.

Section: Introduction

1. In the first paragraph, it should be "..integration of an owner's IoT Platform..."

Section: Components

1. Inconsistent indentation of different subsections. Bullets can be added to differentiate sections and subsections.

2. In Components->TO0 scheduler:

The first line has Ownership Proxies instead of ownership voucher

3. In Components->TO0 scheduler->to0serviceimpl:

The third line has T00 instead of TO0

4. In Components->OPS:

The First line has T02 instead of TO2

5. In Components->OPS->restimpl

The third line has call toOCS. Space required. Should be to OCS

Section: Development Environment Specifications:

Table 1. Development Environment Specifications
Docker versions can be changed.

Inside the different sections, mentioned hyperlinks are not rendered properly, some of the links and snapshots are given below.

Link 1: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#message-passing-protocol

Link 2: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-data-types/

Link 3: https://secure-device-onboard.github.io/docs/latest/protocol-specification/data-transmission-persistence/#message-format

Page Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/

Section Link: https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#device-initialization
In PunctuationsRequired Image : Replace "Running the device" with "Running the device,"[Within Notes]

Section Link: https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#owner-service-info-osi
In PunctuationsRequired2 Image : Replace "A module must expect to remain active unless it explicitly receives a deactivation message " with "A module must expect to remain active unless it explicitly receives a deactivation message,"[Within Owner Service Info(OSI) , third paragragh]

Section Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#device-service-info-dsi
In PunctuationsRequired3 Image : Replace "The module may choose to ignore the ‘index’ sent by the SDK but it is advisable for the module to return key-value data based on this index." with "The module may choose to ignore the ‘index’ sent by the SDK, but it is advisable for the module to return key-value data based on this index."[third paragragh]

Section Link: https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#device-service-info-dsi
In PunctuationsRequired4 Image : Replace "The very first key-value returned by a module (‘index’ zero) must be an activation value indicating whether the module is active or not. The key value must be “active” and the value must be “1” if the module is active or “0” if the module is not active. " with "The very first key-value returned by a module (‘index’ zero) must be an activation value indicating whether the module is active or not. The key value must be “active”, and the value must be “1” if the module is active or “0” if the module is not active. "[third paragraph]

Section: Running The Demo: -> Setting up Resources for OCS
Link: https://secure-device-onboard.github.io/docs/latest/iot-platform-sdk/running-the-demo/#setting-up-resources-for-ocs

The last, 3rd last and 4th last paragraph has directory "/demo/ocs/config/db/v1/devices". The directory has an extra character/Not rendering properly

Doc Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/appendix-b-device-provisioning-with-ecdsa/
Last bullet point, Ownership Voucher referenced by section number.
The section number should be replaced by link for the seciton.

Under Protocol Entity Interactions subsection, in Figure 1, Ownership Proxy needs to be replaced with Ownership Voucher.
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#protocol-entity-interactions

In Ownership Voucher subsection, Ownership Proxy needs to be replaced with Ownership Voucher
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#building-the-ownership-credential-ownership-voucher

In Ownership Voucher subsection, Ownership Proxy needs to be replaced with Ownership Voucher
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#building-the-ownership-credential-ownership-voucher

In Ownership Voucher and Owner Verification of Device Certificate Chain subsection, Ownership Proxy needs to be replaced with Ownership Voucher
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#owner-verification-of-device-certificate-chain

Under Protocol Description section and Protocols subsection, in Figure 2, TO1 inside brackets needs to be replaced with TO2
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#protocols

Link: https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
Within Known Issues and limitation section, bulletins were not alignes properly second bulletin should be in new line.

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
In table of Prerequisites section , First row Ubuntu version 16.04 should be removed , modify openssl version to 1.1.1g and align bulletins properly.

Issue 1 :- Example under Database and Toolkit Installation -> Setup: Manual -> Point number 8

what is the issue :- ./reseller-webapp-1.8.war should be replaced with 1.9 version.

Issue 2 :- Example under Import Customer Public Key

what is the issue :- We cannot add individual owner public keys to DB . We can only add key blob.

Issue 1 :- Line1 in Step4 of "Production Deployment"

what is the issue :- Link Device DI Setup is not redirecting.

Issue 2 :- Example under Database and Toolkit Installation -> Setup: Manual -> Point number 10

what is the issue :- ./manufacturer-webapp-1.8.war should be replaced with 1.9 version.

Issue 3 :- Example under Import Customer Public Key

what is the issue :- We cannot add individual owner public keys to DB . We can only add key blob.

Under Protocol Description and Diffie-Hellman Key Exchange Protocol section, improper rendering of ga and gb and p is missing after gb mod
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#diffie-hellman-key-exchange-protocol

Under Protocol Description and ECDH Key Exchange Protocol section, improper rendering of Shx and Shy in NOTE
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#ecdh-key-exchange-protocol

Under Protocol Description and Key Derivation Function subsection, missing hyperlink for Table 3 and some character missing after See in Note
Link: https://secure-device-onboard.github.io/docs/latest/protocol-specification/protocol-description/#secure-device-onboard-10-and-secure-device-onboard-11-protocol-specification

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
Block Diagram 1 in Client SDK Overview Section, has Ubuntu OS v16.04 needs to be changed as Ununtu OS v18.04

Link : https://secure-device-onboard.github.io/docs/latest/reference/
In Terminology Section , in heading TO1 "DMS" is mentioned which should be changed as "SDO IOT Platform SDK"
In SDO Module Flow, with Pre Service Info (PSI) Section , "touple" word is seen twice whether its a typo for tuple.

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/
Section Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#module-errors
Replace "The Application will need to retry onboarding at a later time. " with "The Application will need to retry onboarding later."[First Paragraph]

Section Link: https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#pre-service-info-psi
Replace: "A failure response will cause the entire onboarding sequence to fail and the Application must retry it at a later time." with "A failure response will cause the entire onboarding sequence to fail and the Application must retry it later."[third paragraph]

Section Link :https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#device-service-info-dsi
Replace "The sv.key must strictly be an NULL terminated ASCII string. " with "The sv.key must strictly be a NULL terminated ASCII string. "[fourth paragraph]

Section Link :https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#owner-service-info-osi
Replace "The sv.key must strictly be an NULL terminated ASCII string. " with "The sv.key must strictly be a NULL terminated ASCII string. "[second paragraph]

Section Link:https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#module-errors
Replace "hash verification, malformed messages and also if a module returns a failure while processing a PSI, DSI, or OSI command/request." with "hash verification, malformed messages and if a module returns a failure while processing a PSI, DSI, or OSI command/request."[first paragraph]

Section Link:https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-reference-guide/#device-service-info-dsi
Replace "It is assumed that the Owner Server knows how to interpret a particular key-value from a particular module. " with "It is assumed that the Owner Server knows how to interpret a particular key-value from a module. ".[fifth paragraph]

Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-api-reference/
Section Link:https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-api-reference/#execute-sdo-sdk-onboarding-protocol
Replace "Additionally, module-specific callbacks will be invoked when Service Information is received from the Owner Server during the course of the TO2 stage." with "Additionally, module-specific callbacks will be invoked when Service Information is received from the Owner Server during the TO2 stage. ".

Section Link:https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-api-reference/#error-handling-callback
Replace " It is advisable to abort the operation and retry at a later time." with " It is advisable to abort the operation and retry later.".

Section Link : https://secure-device-onboard.github.io/docs/latest/client-sdk/client-sdk-api-reference/#error-handling-callback
Replace "The Application can re-invoke this API at a later time to re-initiate the SDO onboarding process." with "The Application can re-invoke this API later to re-initiate the SDO onboarding process.".[Within errorcode]