Skip to content

Commit

Permalink
SGX heartbeat documentation (#259)
Browse files Browse the repository at this point in the history
- Added note to heartbeat documentation stating that it is currently unsupported for SGX
- Added corresponding unsupported notes in protocol operations within the protocol documentation
  • Loading branch information
amendelzon authored Jan 14, 2025
1 parent 3a186bb commit 2652b3d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Foreword

Currently, just like what happens in the case of [attestation](./attestation.md), heartbeat is a feature supported only in the Ledger version of powHSM. A heartbeat implementation for the SGX version of powHSM is currently under development. Therefore, all the information contained herein must be interpreted as applying exclusively to the Ledger version of powHSM.
Currently, heartbeat is a feature supported only in the Ledger version of powHSM. A heartbeat implementation for the SGX version of powHSM is currently under development. Therefore, all the information contained herein must be interpreted as applying exclusively to the Ledger version of powHSM.

## Abstract

Expand Down
4 changes: 4 additions & 0 deletions docs/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,8 @@ This operation can return `0` and generic errors. See the error codes section fo

**Error codes:**
This operation can return `0`, `-301` and generic errors. See the error codes section for details.
**Important:**
Currently, this operation is unsupported for the SGX version of powHSM, returning error `-905` upon an otherwise correct invocation.

### UI heartbeat

Expand Down Expand Up @@ -390,6 +392,8 @@ This operation can return `0`, `-301` and generic errors. See the error codes se

**Error codes:**
This operation can return `0`, `-301` and generic errors. See the error codes section for details.
**Important:**
Currently, this operation is unsupported for the SGX version of powHSM, returning error `-905` upon an otherwise correct invocation.

### Error and success codes

Expand Down

0 comments on commit 2652b3d

Please sign in to comment.