Skip to content

Commit dbef2a9

Browse files
committed
chore: refactor for use in Veraison book
Minor fixes and refactor to allow some parts of the documentation to be included in the Veraison book. Signed-off-by: setrofim <[email protected]>
1 parent 0e339a8 commit dbef2a9

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

api/challenge-response/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Interaction models
1+
# Challenge/Response
2+
3+
## Interaction models
24

35
The APIs described here are meant to be instantiations of the abstract
46
protocols described in [Reference Interaction Models for Remote Attestation
57
Procedures](https://datatracker.ietf.org/doc/draft-ietf-rats-reference-interaction-models/).
68

7-
## Challenge/Response
9+
## Session flow
810

911
Each Challenge-Response session is associated to its own resource, with the
1012
following attributes:

api/endorsement-provisioning/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ format is CoRIM.
9191
{ "status": "processing|success|failed" }
9292
```
9393

94+
9495
* Client submits the endorsement provisioning request
9596
* Server responds with response code `201` indicating that the request has been accepted and will be processed asynchronously
9697
* Server returns the URI of a time-bound session resource in the `Location` header. The resource can be polled at regular intervals to check the progress of the submission, until the processing is complete (either successfully or with a failure)
9798

98-
### Example
99-
99+
### Example
100100

101101
```text
102102
>> Request:

api/management/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The API described here are intended to assist with the operation and management
44
of a Veraison services deployment. They are not meant to be utilized by the
55
services' users.
66

7-
## Policy management
7+
# Policy management
88

99
Policies allow augmenting attestation scheme generated [Attestation Results] on
1010
per-deployment basis, by specifying additional rules to be applied to these

repo-guide.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,15 @@ Veraison services expose REST APIs. This set of libraries provides convenient co
3131
This collection of libraries provides manipulation and verification functionality for Attestation formats of various architectures.
3232

3333
[psatoken](https://github.com/veraison/psatoken): Platform Security Abstraction (PSA) Attestation Token manipulation library.
34+
3435
[ccatoken](https://github.com/veraison/ccatoken)
3536
A library for the Arm Confidential Computing Architecture (CCA) Attestation Token.
37+
3638
[dice](https://github.com/veraison/dice): library providing support functions for manipulating various profiles of DICE.
39+
3740
[parsec](https://github.com/veraison/parsec): Library support for handling the Parsec Key Attestation formats used in the attested TLS PoC.
38-
[enact-demo](https://github.com/veraison/enact-demo): EnactTrust TPM/Veraison interop demo and related docs
3941

42+
[enact-demo](https://github.com/veraison/enact-demo): EnactTrust TPM/Veraison interop demo and related docs
4043

4144

4245
## CLI tools
@@ -200,4 +203,4 @@ subgraph Veraison["<b>Administrative Repositories</b>"]
200203
VA
201204
end
202205
203-
```
206+
```

0 commit comments

Comments
 (0)