Skip to content

Commit

Permalink
Merge pull request #19 from openmls/keks/more-updates
Browse files Browse the repository at this point in the history 
Update dashboard
  • Loading branch information
@keks
keks authored Nov 28, 2024
2 parents 2416434 + 1e72e49 commit a10876c
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 39 deletions.
11 changes: 7 additions & 4 deletions checksets/01-leaf_node.dhall
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ let checks =
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
"maybe this should be an application-level check?"
"This is about what leaf nodes get passed into OpenMLS rather than what we do with them. Therefore this is an application-level check."
)
, types.Check/new
2
Expand Down Expand Up @@ -121,10 +121,10 @@ let checks =
''
[ "section-7.3-4.5.1", "section-7.3-4.5.2.2" ]
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
(types.Notes/single "check is implemented, still needs to be tested.")
, types.Check/new
7
( types.RfcRef/single
Expand Down Expand Up @@ -191,7 +191,10 @@ let checks =
[ "section-7.3-4.7.1", "section-7.3-4.7.2.3" ]
)
types.Status.Partial
(types.CodeRefs/single "openmls::treesync::treekem::UpdatePathIn::into_verified" "https://github.com/openmls/openmls/blob/20042d7ed0df813cbe792a2c216092d85845dff4/openmls/src/treesync/treekem.rs#L411-L423")
( types.CodeRefs/single
"openmls::treesync::treekem::UpdatePathIn::into_verified"
"https://github.com/openmls/openmls/blob/20042d7ed0df813cbe792a2c216092d85845dff4/openmls/src/treesync/treekem.rs#L411-L423"
)
types.CodeRefs/empty
(types.Notes/single "TODO: find and document where this is tested")
, types.Check/new
Expand Down
2 changes: 1 addition & 1 deletion checksets/02-key_package.dhall
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ let checks =
''
"section-10.1-4.2"
)
types.Status.Unknown
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
Expand Down
57 changes: 35 additions & 22 deletions checksets/03-regular_commit_proposal_list.dhall
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,15 @@ let checks =
''
"section-12.2-3.4"
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/new
[ ''
reported in https://github.com/xmtp/openmls/pull/19
''
, ''
this check seems contradictory; if a forbidden thing happens, use this
resolution strategy. We likely don't do the right thing, but it's also
not clear what the right thing would be.
We do the check but need to test it.
''
]
)
Expand All @@ -104,16 +102,17 @@ let checks =
''
"section-12.2-3.5"
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/new
[ ''
reported in https://github.com/xmtp/openmls/pull/19
''
, ''
possibly an app-level concern, but then we at least need to give the app the
tools to valiate this
We check that keys are unique.
Beyond that it's an application-level concern.
We still need to give the app an API to validate this.
''
]
)
Expand All @@ -128,16 +127,17 @@ let checks =
''
"section-12.2-3.6"
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/new
[ ''
reported in https://github.com/xmtp/openmls/pull/19
''
, ''
possibly an app-level concern, but then we at least need to give the app the
tools to valiate this
We check that keys are unique.
Beyond that it's an application-level concern.
We still need to give the app an API to validate this.
''
]
)
Expand Down Expand Up @@ -187,24 +187,32 @@ let checks =
types.Status.Missing
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
''
reported in https://github.com/xmtp/openmls/pull/19
''
( types.Notes/new
[ ''
reported in https://github.com/xmtp/openmls/pull/19
''
, ''
We don't support ReInit yet (<a href="https://github.com/openmls/openmls/issues/1685">openmls#1685</a>)
''
]
)
, types.Check/new
10
( types.RfcRef/single
"It contains an ExternalInit proposal."
"section-12.2-3.10"
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
''
reported in https://github.com/xmtp/openmls/pull/19
''
( types.Notes/new
[ ''
Check is in code, need tests
''
, ''
reported in https://github.com/xmtp/openmls/pull/19
''
]
)
, types.Check/new
11
Expand All @@ -217,12 +225,12 @@ let checks =
''
"section-12.2-3.11"
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
''
reported in https://github.com/xmtp/openmls/pull/19
implemented, still needs tests
''
)
, types.Check/new
Expand All @@ -238,7 +246,12 @@ let checks =
types.Status.Missing
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
( types.Notes/single
''
This is difficult to check, because at that point the state has already been changed.
It would be nice if we instead could show before applying the diff, that applying the diff will result in a valid tree.
''
)
]

in types.CheckSet/new id name desc checks
16 changes: 11 additions & 5 deletions checksets/04-external_commit_proposal_list.dhall
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ let checks =
[ types.Check/new
1
(types.RfcRef/single "Exactly one ExternalInit" "section-12.2-6.1")
types.Status.Unknown
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
Expand Down Expand Up @@ -58,17 +58,23 @@ let checks =
"Zero or more PreSharedKey proposals"
"section-12.2-6.3"
)
types.Status.Unknown
types.Status.Complete
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
( types.Notes/single
''
Since we can only include a non-negative integer number of proposals, it necessarily is "zero or more". There is no check required.
''
)
, types.Check/new
4
(types.RfcRef/single "No other proposals" "section-12.2-6.4")
types.Status.Unknown
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
( types.Notes/single
"The check is implemented, but we need to test that we do it correctly"
)
]

in types.CheckSet/new id name desc checks
24 changes: 17 additions & 7 deletions checksets/12-commit.dhall
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,13 @@ let checks =
''
"section-12.4.2-2.5"
)
types.Status.Unknown
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
( types.Notes/single
"of course you need all the proposals and all the psks before being able to apply the commit... This is implicit in the code"
''
We need to test that we do the right thing here.
''
)
, types.Check/new
6
Expand All @@ -119,7 +121,9 @@ let checks =
"https://github.com/openmls/openmls/blob/5067034708f2332b0dfd8d7d28eb6618fd38f4c7/openmls/src/group/public_group/staged_commit.rs#L243-L246"
)
types.CodeRefs/empty
(types.Notes/single "todo: find test refs")
( types.Notes/single
"TODO: Find Tests and reference them here or annotate them"
)
, types.Check/new
7
( types.RfcRef/new
Expand All @@ -130,10 +134,14 @@ let checks =
''
[ "section-12.4.2-2.8.1", "section-12.4.2-2.8.2.2" ]
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
( types.Notes/single
''
This is done when parsing the update path
''
)
, types.Check/new
8
( types.RfcRef/new
Expand All @@ -144,10 +152,12 @@ let checks =
''
[ "section-12.4.2-2.8.1", "section-12.4.2-2.8.2.3" ]
)
types.Status.Missing
types.Status.Partial
types.CodeRefs/empty
types.CodeRefs/empty
types.Notes/empty
( types.Notes/simple
"we check that it is different from the keys of _any_ current member. Still need to test this check."
)
, types.Check/new
9
( types.RfcRef/new
Expand Down

0 comments on commit a10876c

Please sign in to comment.