Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit cfebeee

Browse files
authored
Update the getting started scripts (#43)
Signed-off-by: steve lasker <[email protected]>
1 parent 1a9922a commit cfebeee

File tree

1 file changed

+27
-34
lines changed

1 file changed

+27
-34
lines changed

README.md

Lines changed: 27 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,6 @@ On Ubuntu, run the following to install Python:
1616
sudo apt install python3.10-venv
1717
```
1818

19-
### Optional Dependencies
20-
21-
If you want to use conda, first install it:
22-
23-
- [Install Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
24-
25-
You can get things setup with the following:
26-
27-
```sh
28-
conda env create -f environment.yml
29-
conda activate scitt
30-
```
31-
3219
## Clone the Emulator
3320

3421
1. Clone the scitt-api-emulator repository and change into the scitt-api-emulator folder:
@@ -43,6 +30,19 @@ conda activate scitt
4330
cd scitt-api-emulator
4431
```
4532

33+
### Optional Dependencies
34+
35+
If you want to use conda, first install it:
36+
37+
- [Install Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
38+
39+
You can get things setup with the following:
40+
41+
```sh
42+
conda env create -f environment.yml
43+
conda activate scitt
44+
```
45+
4646
## Start the Proxy Server
4747

4848
The proxy server supports 2 options currently:
@@ -63,7 +63,7 @@ The proxy server supports 2 options currently:
6363
1. The server is running at http://localhost:8000/ and uses the `workspace/` folder to store the service parameters and service state
6464
**Note:** _The default port is `8000` but can be changed with the `--port` argument._
6565
1. Start another shell to run the test scripts, leaving the above shell for diagnostic output
66-
1. Skip to [Create Claims](#create-claims)
66+
1. Skip to [Create Signed Claims](#create-signed-claims)
6767

6868
### Start an RKVST SCITT Proxy Service
6969

@@ -121,42 +121,35 @@ They can be used with the built-in server or an external service implementation.
121121
Receipt: ./claim.receipt.cbor
122122
```
123123

124-
1. Save the entryId to an environment variable
124+
1. Create an environment variable (`ENTRY_ID`) for the value of `entryId` above:
125125

126126
```sh
127127
ENTRY_ID=<entryId>
128128
```
129129

130-
### Retrieve Claims
130+
### Retrieve Statements and Receipts
131131

132-
1. Retrieve the claim, based on the ENTRY_ID set from the `submit-claim` command above
132+
1. Retrieve the Statement, based on the ENTRY_ID set from the `submit-claim` command above
133133

134-
```sh
135-
./scitt-emulator.sh client retrieve-claim \
136-
--entry-id $ENTRY_ID \
137-
--out claim.cose
138-
```
139-
140-
This command sends the following request:
141-
142-
- `GET /entries/<entry_id>` to retrieve the claim.
134+
```sh
135+
./scitt-emulator.sh client retrieve-claim \
136+
--entry-id $ENTRY_ID \
137+
--out claim.cose
138+
```
143139

144-
### Retrieve Receipts
140+
`retrieve-claim` sends the following request:
141+
`GET /entries/<entry_id>` to retrieve the claim.
145142

146-
1. Replace the `<entryId>` with the value from the `submit-claim` command above
143+
1. Retrieve the Receipt, based on the ENTRY_ID set from the `submit-claim` command above
147144

148145
```sh
149146
./scitt-emulator.sh client retrieve-receipt \
150147
--entry-id $ENTRY_ID \
151148
--out receipt.cbor
152149
```
153150

154-
The `retrieve-receipt` command uses the default service URL `http://127.0.0.1:8000` which can be changed with the `--url` argument.
155-
It can be used with the built-in server or an external service implementation.
156-
157-
This command sends the following request:
158-
159-
- `GET /entries/<entry_id>/receipt` to retrieve the receipt.
151+
`retrieve-receipt` sends the following request:
152+
`GET /entries/<entry_id>/receipt` to retrieve the receipt.
160153

161154
### Validate Receipts
162155

0 commit comments

Comments
 (0)