Skip to content

Commit 56f5270

Browse files
AdithyaBaglodyAdithyaBaglody
authored
doc: updated the reference to reflect the correct build cmds. (secure-device-onboard#15)
In 1.9 client-sdk moved from make build system to cmake. This patch reflects the same in the reference doc. This also removes EPID info from Client-SDK documentation. Signed-off-by: Adithya Baglody <[email protected]>
1 parent 5b29443 commit 56f5270

File tree

1 file changed

+4
-12
lines changed

1 file changed

+4
-12
lines changed

‎docs/client-sdk/client-sdk-reference-guide.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ Figure 1. SDO Client Block Diagram
3131
![SDO Client Block Diagram](img/1-Intel SDO Client Block Diagram.JPG)
3232

3333
!!! note
34-
EPID is an acronym for Enhanced Privacy ID.
3534
SDO is an acronym for Secure Device Onboard.
3635

3736
Before initiating the Secure Device Onboard functionality, the Application must first initialize the SDK. After initializing the SDK, the Application can initiate the onboarding by calling the `sdo_sdk_run()`API.
@@ -185,20 +184,14 @@ Table 1. Prerequisites
185184
| | |
186185
|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
187186
| Software | · Linux\* Ubuntu\* 16.04 / Ubuntu\* 18.04 using OpenSSL\* 1.1.1f <br/>· JDK11 <br/> · SDO release binaries package (for running test servers) <br/> o The root directory of extracted binary package is referred to as <sdo_sdk_binaries> in subsequent sections. <br/> · SDO Client SDK alpha-release binary package <br/> o The root directory of extracted binary package is referred to as < SDOClientSDK> in subsequent sections. <br/> · SDO Client SDK alpha-release sources package <br/> o The root directory of extracted source code is referred to as < SDOClientSDK> in subsequent sections. <br/> · Apache Maven\* (for building sample Java\* based test owner service) <br/> Additional Ubuntu\* 16.04/18.04 prerequisites can be found in the <releases source>/SDOClientSDK/README.md |
188-
| Enhanced Privacy ID (EPID) | EPID SDK v6.0.1 <br/>· Download EPID SDK v6.0.1: https://github.com/Intel-EPID-SDK/epid-sdk/releases <br/> · Extract the tar.gz and open doc/index.html in a browser <br/> · Follow the instructions in the “Building from Source” topic <br/> · Recommend using scons for build |
189187
| Safestring library | Safestring library v1.0.0 <br/> · Download safestringlib from https://github.com/intel/safestringlib <br/> · `cd safestringlib` <br/> · `mkdir obj` <br/> · `make ` <br/> · The library file libsafestring.a will be created after make. |
190188
| Java\* | Set the $JAVA_HOME environment variable. |123456
191189

192190
### Run the Binary Package
193191
The following subsections provide the steps to run the binary package.
194192

195-
#### Get the Device Private Key (EPID or ECDSA P-256 based)
196-
The SDK requires a device Private Key as input for device attestation process (to prove itself to Rendezvous or Owner Server during TO1 or TO2 protocol). The key could be based on EPID or ECDSA (on curve P-256/P-384) based on the device attestation method being used on the field. This key must be stored in a specific file and is read by the SDK on startup.
197-
198-
_**For EPID based device-attestation method:**_
199-
200-
In case of EPID, place the EPID private Key with the name epidprivkey.dat in the following location:
201-
`data/epidprivkey.dat`
193+
#### Get the Device Private Key (ECDSA P-256 based)
194+
The SDK requires a device Private Key as input for device attestation process (to prove itself to Rendezvous or Owner Server during TO1 or TO2 protocol). The key could be based on ECDSA (on curve P-256/P-384) based on the device attestation method being used on the field. This key must be stored in a specific file and is read by the SDK on startup.
202195

203196
_**For ECDSA (P-256) based device-attestation method:**_
204197

@@ -278,8 +271,8 @@ To use **sdo_sys** device module, follow these steps:
278271

279272
```
280273
$ cd client-sdk/
281-
$ make pristine
282-
$ make MODULES=true
274+
$ cmake -DMODULES=true .
275+
$ make -j(nproc)
283276
```
284277

285278
The binary would be created either in build/linux/debug or build/linux/release folder. Copy them to the root folder before proceeding with the next steps.
@@ -309,6 +302,5 @@ The following are the known issues:
309302

310303
The following are the known limitations:
311304

312-
• EPID based device-attestation (DA) method is not supported with STM32F429ZI MCU due to memory constraints in the underlying development board NUCLEO-F429ZI.
313305
• Network discovery and CSR feature is not supported for ARM Cortex M4, M7, and A7 devices.
314306

0 commit comments

Comments
 (0)