Skip to content

Commit ed16296

Browse files
committed
Update E-121 to change endpoint name
Update Enhancement #121 to use /verify/evidency instead of just /verify since /verify/identity already exists. Also change to use "valid" return parameter instead of "success" to matter match other Keylime APIs Signed-off-by: Michael Peters <[email protected]>
1 parent 3821211 commit ed16296

File tree

1 file changed

+2
-32
lines changed

1 file changed

+2
-32
lines changed

121-verification-api.md renamed to 121-verify-evidence-api.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,3 @@
1-
<!--
2-
**Note:** When your enhancement is complete, all of these comment blocks should be removed.
3-
4-
To get started with this template:
5-
6-
- [ ] **Create an issue in keylime/enhancements**
7-
When filing an enhancement tracking issue, please ensure to complete all
8-
fields in that template. One of the fields asks for a link to the enhancement. You
9-
can leave that blank until this enhancement is made a pull request, and then
10-
go back to the enhancement and add the link.
11-
- [ ] **Make a copy of this template.**
12-
name it `NNNN-short-descriptive-title`, where `NNNN` is the issue number (with no
13-
leading-zero padding) assigned to your enhancement above.
14-
- [ ] **Fill out this file as best you can.**
15-
At minimum, you should fill in the "Summary", and "Motivation" sections.
16-
These should be easy if you've preflighted the idea of the enhancement with the
17-
appropriate SIG(s).
18-
- [ ] **Merge early and iterate.**
19-
Avoid getting hung up on specific details and instead aim to get the goals of
20-
the enhancement clarified and merged quickly. The best way to do this is to just
21-
start with the high-level sections and fill out details incrementally in
22-
subsequent PRs.
23-
-->
241
# enhancement-121: Verification API
252

263
<!--
@@ -108,7 +85,7 @@ We are not implementing the proposed agent-driven attestation model.
10885

10986
## Proposal
11087

111-
Create a new API on the verifier at `/verify` that will take the
88+
Create a new API on the verifier at `/verify/evidence` that will take the
11289
following example JSON data payload:
11390

11491
{
@@ -150,7 +127,7 @@ response as we can for the failure(s).
150127
The API will return a response like the following:
151128

152129
{
153-
"success": 0,
130+
"valid": 0,
154131
"failures": [
155132
{
156133
"type": "ima.validation.ima-ng.not_in_allowlist",
@@ -173,15 +150,8 @@ to the API for validation. It will serve as a sample client of the new
173150
API as well as being a useful tool for people to use on target hosts.
174151

175152

176-
177153
### User Stories (optional)
178154

179-
<!--
180-
Detail the things that people will be able to do if this enhancement is implemented.
181-
Include as much detail as possible so that people can understand the "how" of
182-
the system. The goal here is to make this feel real for users without getting
183-
bogged down.
184-
-->
185155

186156
#### Story 1
187157

0 commit comments

Comments
 (0)