Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enhance reports folder README.md and also top level README.md #93

Merged
merged 2 commits into from
Jul 28, 2022
Merged

Enhance reports folder README.md and also top level README.md #93

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1fbed9
Enhance reports folder README.md and also top level README.md
yogeshbdeshpande Jul 26, 2022
6a88269
Review comments
yogeshbdeshpande Jul 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,19 +110,23 @@ per RFC 8152, are rejected by the go-cose library.

### Conformance Tests

go-cose runs the [GlueCOSE](https://github.com/gluecose/test-vectors) test suite on every local `go test` execution.
`go-cose` runs the [GlueCOSE](https://github.com/gluecose/test-vectors) test suite on every local `go test` execution.
These are also executed on every CI job.

### Fuzz Tests

go-cose implements several fuzz tests using [Go's native fuzzing](https://go.dev/doc/fuzz).
`go-cose` implements several fuzz tests using [Go's native fuzzing](https://go.dev/doc/fuzz).

Fuzzing requires Go 1.18 or higher, and can be executed as follows:

```bash
go test -fuzz=FuzzSign1
```

### Security Reviews

`go-cose` undergoes periodic security review. The security review reports are located [here](https://github.com/veraison/go-cose/tree/main/reports)
yogeshbdeshpande marked this conversation as resolved.
Show resolved Hide resolved

[cose-spec]: https://datatracker.ietf.org/doc/draft-ietf-cose-rfc8152bis-struct/
[mozilla-contributors]: https://github.com/mozilla-services/go-cose/graphs/contributors
[mozilla-go-cose]: http://github.com/mozilla-services/go-cose
Expand Down
11 changes: 10 additions & 1 deletion reports/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
## This folder contains the reports for go-cose repository
# Security Reports
Contains all the security review reports for the go-cose library.
yogeshbdeshpande marked this conversation as resolved.
Show resolved Hide resolved


## List of Security Reports

| Name of Security Review | Report Location |
|:--------------------------------------|-------------------------------
| NCC Group go-cose Security Assessment | [NCC Report](https://github.com/veraison/go-cose/blob/main/reports/NCC_Microsoft-go-cose-Report_2022-05-26_v1.0.pdf)
yogeshbdeshpande marked this conversation as resolved.
Show resolved Hide resolved
| |