Skip to content

Commit

Permalink
docs: fix links inside documents
Browse files Browse the repository at this point in the history
Signed-off-by: Xynnn007 <[email protected]>
  • Loading branch information
Xynnn007 committed Nov 14, 2023
1 parent 5a832c9 commit b19ac73
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions attestation-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ please refer to [the doc](./docs/rvps.md#run-mode) for more details.

### Evidence format:

The attestation evidence is included in a [KBS defined Attestation payload](https://github.com/confidential-containers/kbs/blob/main/docs/kbs_attestation_protocol.md#attestation):
The attestation evidence is included in a [KBS defined Attestation payload](../kbs/docs/kbs_attestation_protocol.md#attestation):

```json
{
Expand All @@ -78,7 +78,7 @@ The attestation evidence is included in a [KBS defined Attestation payload](http
```

- `tee-pubkey`: A JWK-formatted public key, generated by the client running in the HW-TEE.
For more details on the `tee-pubkey` format, see the [KBS protocol](https://github.com/confidential-containers/kbs/blob/main/docs/kbs_attestation_protocol.md#key-format).
For more details on the `tee-pubkey` format, see the [KBS protocol](../kbs/docs/kbs_attestation_protocol.md#key-format).

- `tee-evidence`: The attestation evidence generated by the HW-TEE platform software and hardware in the AA's execution environment.
The tee-evidence formats depend on the TEE and are typically defined by the each TEE verifier driver of AS.
Expand Down Expand Up @@ -113,7 +113,7 @@ Claims format of the attestation results token is:
* `exp`: Token expire time in Unix timestamp format.
* `nbf`: Token effective time in Unix timestamp format.
* `tee-pubkey`: A JWK-formatted public key, generated by the client running in the HW-TEE.
For more details on the `tee-pubkey` format, see the [KBS protocol](https://github.com/confidential-containers/kbs/blob/main/docs/kbs_attestation_protocol.md#key-format).
For more details on the `tee-pubkey` format, see the [KBS protocol](../kbs/docs/kbs_attestation_protocol.md#key-format).
* `tcb_status`: Contains HW-TEE informations and software measurements of AA's execution environment.
* `evaluation-report` : The output of the policy engine, it is AS policy's evaluation opinion on TEE evidence.

Expand Down
2 changes: 1 addition & 1 deletion kbs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ We provide a [quick start](./quickstart.md) guide to deploy KBS locally and cond

### Attestation Protocol
The KBS implements and supports a simple, vendor and hardware-agnostic
[implementation protocol](https://github.com/confidential-containers/kbs/blob/main/docs/kbs_attestation_protocol.md) to perform attestation.
[implementation protocol](./docs/kbs_attestation_protocol.md) to perform attestation.

### API
KBS implements an HTTP-based, [OpenAPI 3.1](https://spec.openapis.org/oas/v3.1.0) compliant API.
Expand Down
2 changes: 1 addition & 1 deletion kbs/docs/kbs_attestation_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ format is used for that purpose:
## OpenAPI Description

The KBS HTTP endpoints and payloads are
[formally described](https://github.com/confidential-containers/kbs/blob/main/docs/kbs.yaml)
[formally described](./kbs.yaml)
in an [OpenAPI](https://www.openapis.org/) compliant format.

# Acknowledgements
Expand Down

0 comments on commit b19ac73

Please sign in to comment.