Compare commits
14 Commits
v1.0.0-pre
...
deps
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8f6da19802 | ||
|
|
25d4579b29 | ||
|
|
5fb3516d15 | ||
|
|
eb70826a70 | ||
|
|
6308c66ab7 | ||
|
|
f6b72f1907 | ||
|
|
03770e0d38 | ||
|
|
1ea8b00efd | ||
|
|
21a78a9d2d | ||
|
|
5cea53af26 | ||
|
|
8dcaefbf3a | ||
|
|
caaa0204b8 | ||
|
|
8c932e0eb8 | ||
|
|
83227f36a7 |
@@ -31,7 +31,7 @@ formatters:
|
||||
settings:
|
||||
goimports:
|
||||
local-prefixes:
|
||||
- github.com/selesy/go-varsig
|
||||
- github.com/ucan-wg/go-varsig
|
||||
exclusions:
|
||||
generated: lax
|
||||
paths:
|
||||
|
||||
@@ -31,7 +31,7 @@ repos:
|
||||
- id: my-cmd-repo
|
||||
alias: govulncheck
|
||||
name: govulncheck
|
||||
args: ["bash", "-c", "go tool golang.org/x/vuln/cmd/govulncheck ./..."]
|
||||
args: ["bash", "-c", "go run golang.org/x/vuln/cmd/govulncheck@v1.1.4 ./..."]
|
||||
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
|
||||
rev: v9.22.0
|
||||
hooks:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
act 0.2.79
|
||||
golang 1.24.4
|
||||
golangci-lint 2.2.1
|
||||
pre-commit 4.0.1
|
||||
pre-commit 4.2.0
|
||||
|
||||
212
LICENSE
212
LICENSE
@@ -1,201 +1,25 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
The contents of this repository are Copyright (c) corresponding authors and
|
||||
contributors, licensed under the `Permissive License Stack` meaning either of:
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
- Apache-2.0 Software License: https://www.apache.org/licenses/LICENSE-2.0
|
||||
([...4tr2kfsq](https://dweb.link/ipfs/bafkreiankqxazcae4onkp436wag2lj3ccso4nawxqkkfckd6cg4tr2kfsq))
|
||||
|
||||
1. Definitions.
|
||||
- MIT Software License: https://opensource.org/licenses/MIT
|
||||
([...vljevcba](https://dweb.link/ipfs/bafkreiepofszg4gfe2gzuhojmksgemsub2h4uy2gewdnr35kswvljevcba))
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
You may not use the contents of this repository except in compliance
|
||||
with one of the listed Licenses. For an extended clarification of the
|
||||
intent behind the choice of Licensing please refer to
|
||||
https://protocol.ai/blog/announcing-the-permissive-license-stack/
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the terms listed in this notice is distributed on
|
||||
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
either express or implied. See each License for the specific language
|
||||
governing permissions and limitations under that License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
<!--- SPDX-License-Identifier: Apache-2.0 OR MIT -->
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
`SPDX-License-Identifier: Apache-2.0 OR MIT`
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
Verbatim copies of both licenses are included in the LICENSE-APACHE-2.0 and LICENSE-MIT files.
|
||||
|
||||
201
LICENSE-APACHE-2.0
Normal file
201
LICENSE-APACHE-2.0
Normal file
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2025 UCAN Working Group - All right reserved
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
21
LICENSE-MIT
Normal file
21
LICENSE-MIT
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 UCAN Working Group - All rights reserved
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
55
README.md
55
README.md
@@ -1,3 +1,56 @@
|
||||
# go-varsig
|
||||
|
||||
`go-varsig` implements v0.1.0 of the [`varsig` specification]
|
||||
`go-varsig` implements the upcoming v1.0.0 release of the [`varsig` specification](https://github.com/ChainAgnostic/varsig/pull/18)
|
||||
with limited (and soon to be deprecated) support for the `varsig` < v1.0
|
||||
specification. This is predominantly included to support the UCAN v1.0
|
||||
use-case.
|
||||
|
||||
## Usage
|
||||
|
||||
Include the `go-varsig` library by running the following command:
|
||||
|
||||
```bash
|
||||
go get github.com/ucan-wg/go-varsig@latest
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Documentation for this library is provided as Go docs at
|
||||
https://pkg.go.dev/github.com/ucan-wg/go-varsig.
|
||||
|
||||
## Development
|
||||
|
||||
Install the required development tools using `asdf` by running the
|
||||
following command in this repository (or install them manually):
|
||||
|
||||
```bash
|
||||
asdf install
|
||||
```
|
||||
|
||||
### Checks
|
||||
|
||||
This repository contains a set of pre-commit hooks that are run prior to
|
||||
each `git commit`. You can also run these checks manually using the
|
||||
following command:
|
||||
|
||||
```bash
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
||||
### Github workflows development
|
||||
|
||||
ASDF installs `act` to support Github workflow development - in general,
|
||||
follow these steps to test the workflow:
|
||||
|
||||
If you're using `podman` instead of `docker`, use the `podman` socket to
|
||||
simulate the `docker` daemon:
|
||||
|
||||
```bash
|
||||
export DOCKER_HOST=unix:///var/run/podman/podman.sock
|
||||
```
|
||||
|
||||
Since there's only one workflow, the simplest command to test it is:
|
||||
|
||||
```bash
|
||||
act
|
||||
```
|
||||
|
||||
20
common.go
20
common.go
@@ -3,39 +3,39 @@ package varsig
|
||||
// Ed25519 produces a varsig that describes the associated algorithm defined
|
||||
// by the [IANA JOSE specification].
|
||||
//
|
||||
// [IANA JOSE specidication]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func Ed25519(payloadEncoding PayloadEncoding, opts ...Option) (*EdDSAVarsig, error) {
|
||||
// [IANA JOSE specification]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func Ed25519(payloadEncoding PayloadEncoding, opts ...Option) (EdDSAVarsig, error) {
|
||||
return NewEdDSAVarsig(CurveEd25519, HashAlgorithmSHA512, payloadEncoding, opts...)
|
||||
}
|
||||
|
||||
// Ed448 produces a varsig that describes the associated algorithm defined
|
||||
// by the [IANA JOSE specification].
|
||||
//
|
||||
// [IANA JOSE specidication]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func Ed448(payloadEncoding PayloadEncoding, opts ...Option) (*EdDSAVarsig, error) {
|
||||
// [IANA JOSE specification]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func Ed448(payloadEncoding PayloadEncoding, opts ...Option) (EdDSAVarsig, error) {
|
||||
return NewEdDSAVarsig(CurveEd448, HashAlgorithmShake256, payloadEncoding, opts...)
|
||||
}
|
||||
|
||||
// RS256 produces a varsig that describes the associated algorithm defined
|
||||
// by the [IANA JOSE specification].
|
||||
//
|
||||
// [IANA JOSE specidication]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS256(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (*RSAVarsig, error) {
|
||||
// [IANA JOSE specification]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS256(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (RSAVarsig, error) {
|
||||
return NewRSAVarsig(HashAlgorithmSHA256, keyLength, payloadEncoding, opts...)
|
||||
}
|
||||
|
||||
// RS384 produces a varsig that describes the associated algorithm defined
|
||||
// by the [IANA JOSE specification].
|
||||
//
|
||||
// [IANA JOSE specidication]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS384(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (*RSAVarsig, error) {
|
||||
// [IANA JOSE specification]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS384(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (RSAVarsig, error) {
|
||||
return NewRSAVarsig(HashAlgorithmSHA384, keyLength, payloadEncoding, opts...)
|
||||
}
|
||||
|
||||
// RS512 produces a varsig that describes the associated algorithm defined
|
||||
// by the [IANA JOSE specification].
|
||||
//
|
||||
// [IANA JOSE specidication]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS512(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (*RSAVarsig, error) {
|
||||
// [IANA JOSE specification]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
func RS512(keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (RSAVarsig, error) {
|
||||
return NewRSAVarsig(HashAlgorithmSHA512, keyLength, payloadEncoding, opts...)
|
||||
}
|
||||
|
||||
@@ -5,13 +5,14 @@ import (
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestEd25519(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
in := mustVarsig[varsig.EdDSAVarsig](t)(varsig.Ed25519(varsig.PayloadEncodingDAGCBOR))
|
||||
in, err := varsig.Ed25519(varsig.PayloadEncodingDAGCBOR)
|
||||
mustVarsig(t, in, err)
|
||||
out := roundTrip(t, in, "3401ed01ed011371")
|
||||
assertEdDSAEqual(t, in, out)
|
||||
}
|
||||
@@ -19,7 +20,8 @@ func TestEd25519(t *testing.T) {
|
||||
func TestEd448(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
in := mustVarsig[varsig.EdDSAVarsig](t)(varsig.Ed448(varsig.PayloadEncodingDAGCBOR))
|
||||
in, err := varsig.Ed448(varsig.PayloadEncodingDAGCBOR)
|
||||
mustVarsig(t, in, err)
|
||||
out := roundTrip(t, in, "3401ed0183241971")
|
||||
assertEdDSAEqual(t, in, out)
|
||||
}
|
||||
@@ -27,7 +29,8 @@ func TestEd448(t *testing.T) {
|
||||
func TestRS256(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
in := mustVarsig[varsig.RSAVarsig](t)(varsig.RS256(0x100, varsig.PayloadEncodingDAGCBOR))
|
||||
in, err := varsig.RS256(0x100, varsig.PayloadEncodingDAGCBOR)
|
||||
mustVarsig(t, in, err)
|
||||
out := roundTrip(t, in, "3401852412800271")
|
||||
assertRSAEqual(t, in, out)
|
||||
}
|
||||
@@ -35,7 +38,8 @@ func TestRS256(t *testing.T) {
|
||||
func TestRS384(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
in := mustVarsig[varsig.RSAVarsig](t)(varsig.RS384(0x100, varsig.PayloadEncodingDAGCBOR))
|
||||
in, err := varsig.RS384(0x100, varsig.PayloadEncodingDAGCBOR)
|
||||
mustVarsig(t, in, err)
|
||||
out := roundTrip(t, in, "3401852420800271")
|
||||
assertRSAEqual(t, in, out)
|
||||
}
|
||||
@@ -43,19 +47,20 @@ func TestRS384(t *testing.T) {
|
||||
func TestRS512(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
in := mustVarsig[varsig.RSAVarsig](t)(varsig.RS512(0x100, varsig.PayloadEncodingDAGCBOR))
|
||||
in, err := varsig.RS512(0x100, varsig.PayloadEncodingDAGCBOR)
|
||||
mustVarsig(t, in, err)
|
||||
out := roundTrip(t, in, "3401852413800271")
|
||||
assertRSAEqual(t, in, out)
|
||||
}
|
||||
|
||||
func assertEdDSAEqual(t *testing.T, in, out *varsig.EdDSAVarsig) {
|
||||
func assertEdDSAEqual(t *testing.T, in, out varsig.EdDSAVarsig) {
|
||||
t.Helper()
|
||||
|
||||
assert.Equal(t, in.Curve(), out.Curve())
|
||||
assert.Equal(t, in.HashAlgorithm(), out.HashAlgorithm())
|
||||
}
|
||||
|
||||
func assertRSAEqual(t *testing.T, in, out *varsig.RSAVarsig) {
|
||||
func assertRSAEqual(t *testing.T, in, out varsig.RSAVarsig) {
|
||||
t.Helper()
|
||||
|
||||
assert.Equal(t, in.HashAlgorithm(), out.HashAlgorithm())
|
||||
|
||||
95
constant.go
95
constant.go
@@ -1,28 +1,30 @@
|
||||
package varsig
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/binary"
|
||||
"fmt"
|
||||
|
||||
"github.com/multiformats/go-multicodec"
|
||||
)
|
||||
|
||||
// HashAlgorithm is the multicodec.Code that specifies the hash algorithm
|
||||
// that's used to reduced the signed content
|
||||
// Prefix is the value for the varsig's varuint prefix byte.
|
||||
const Prefix = uint64(0x34)
|
||||
|
||||
// HashAlgorithm is the value that specifies the hash algorithm
|
||||
// that's used to reduce the signed content
|
||||
type HashAlgorithm uint64
|
||||
|
||||
// Constant values that allow Varsig implementations to specify how
|
||||
// the payload content is hashed before the signature is generated.
|
||||
const (
|
||||
HashAlgorithmUnspecified HashAlgorithm = 0x00
|
||||
HashAlgorithmSHA256 = HashAlgorithm(multicodec.Sha2_256)
|
||||
HashAlgorithmSHA384 = HashAlgorithm(multicodec.Sha2_384)
|
||||
HashAlgorithmSHA512 = HashAlgorithm(multicodec.Sha2_512)
|
||||
HashAlgorithmShake256 = HashAlgorithm(multicodec.Shake256)
|
||||
HashAlgorithmSHA256 = HashAlgorithm(0x12)
|
||||
HashAlgorithmSHA384 = HashAlgorithm(0x20)
|
||||
HashAlgorithmSHA512 = HashAlgorithm(0x13)
|
||||
HashAlgorithmShake256 = HashAlgorithm(0x19)
|
||||
)
|
||||
|
||||
// DecodeHashAlgorithm reads and validates the expected hash algorithm
|
||||
// (for varsig types include a variable hash algorithm.)
|
||||
func DecodeHashAlgorithm(r *bytes.Reader) (HashAlgorithm, error) {
|
||||
func DecodeHashAlgorithm(r BytesReader) (HashAlgorithm, error) {
|
||||
u, err := binary.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return HashAlgorithmUnspecified, fmt.Errorf("%w: %w", ErrUnknownHashAlgorithm, err)
|
||||
@@ -30,17 +32,15 @@ func DecodeHashAlgorithm(r *bytes.Reader) (HashAlgorithm, error) {
|
||||
|
||||
h := HashAlgorithm(u)
|
||||
|
||||
if _, ok := map[HashAlgorithm]struct{}{
|
||||
HashAlgorithmUnspecified: {},
|
||||
HashAlgorithmSHA256: {},
|
||||
HashAlgorithmSHA384: {},
|
||||
HashAlgorithmSHA512: {},
|
||||
HashAlgorithmShake256: {},
|
||||
}[h]; !ok {
|
||||
switch h {
|
||||
case HashAlgorithmSHA256,
|
||||
HashAlgorithmSHA384,
|
||||
HashAlgorithmSHA512,
|
||||
HashAlgorithmShake256:
|
||||
return h, nil
|
||||
default:
|
||||
return HashAlgorithmUnspecified, fmt.Errorf("%w: %x", ErrUnknownHashAlgorithm, h)
|
||||
}
|
||||
|
||||
return h, nil
|
||||
}
|
||||
|
||||
// PayloadEncoding specifies the encoding of the data being (hashed and)
|
||||
@@ -48,19 +48,22 @@ func DecodeHashAlgorithm(r *bytes.Reader) (HashAlgorithm, error) {
|
||||
// consistent hashes and signatures.
|
||||
type PayloadEncoding uint64
|
||||
|
||||
// Constant values that allow Varsig implementations to specify how the
|
||||
// payload content is encoded before being hashed.
|
||||
// In varsig >= v1, only canonical encoding is allowed.
|
||||
const (
|
||||
PayloadEncodingUnspecified PayloadEncoding = 0x00
|
||||
PayloadEncodingVerbatim PayloadEncoding = 0x5f
|
||||
PayloadEncodingDAGPB = PayloadEncoding(multicodec.DagPb)
|
||||
PayloadEncodingDAGCBOR = PayloadEncoding(multicodec.DagCbor)
|
||||
PayloadEncodingDAGJSON = PayloadEncoding(multicodec.DagJson)
|
||||
PayloadEncodingEIP191 = PayloadEncoding(multicodec.Eip191)
|
||||
PayloadEncodingDAGPB = PayloadEncoding(0x70)
|
||||
PayloadEncodingDAGCBOR = PayloadEncoding(0x71)
|
||||
PayloadEncodingDAGJSON = PayloadEncoding(0x0129)
|
||||
PayloadEncodingEIP191 = PayloadEncoding(0xd191)
|
||||
PayloadEncodingJWT PayloadEncoding = 0x6a77
|
||||
)
|
||||
|
||||
// DecodePayloadEncoding reads and validates the expected canonical payload
|
||||
// encoding of the data to be signed.
|
||||
func DecodePayloadEncoding(r *bytes.Reader, vers Version) (PayloadEncoding, error) {
|
||||
func DecodePayloadEncoding(r BytesReader, vers Version) (PayloadEncoding, error) {
|
||||
u, err := binary.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return PayloadEncodingUnspecified, fmt.Errorf("%w: %w", ErrUnsupportedPayloadEncoding, err)
|
||||
@@ -80,42 +83,40 @@ func DecodePayloadEncoding(r *bytes.Reader, vers Version) (PayloadEncoding, erro
|
||||
|
||||
// https://github.com/ChainAgnostic/varsig#4-payload-encoding
|
||||
func decodeEncodingInfoV0(payEnc PayloadEncoding) (PayloadEncoding, error) {
|
||||
if _, ok := map[PayloadEncoding]struct{}{
|
||||
PayloadEncodingVerbatim: {},
|
||||
PayloadEncodingDAGPB: {},
|
||||
PayloadEncodingDAGCBOR: {},
|
||||
PayloadEncodingDAGJSON: {},
|
||||
PayloadEncodingJWT: {},
|
||||
PayloadEncodingEIP191: {},
|
||||
}[payEnc]; !ok {
|
||||
switch payEnc {
|
||||
case PayloadEncodingVerbatim,
|
||||
PayloadEncodingDAGPB,
|
||||
PayloadEncodingDAGCBOR,
|
||||
PayloadEncodingDAGJSON,
|
||||
PayloadEncodingJWT,
|
||||
PayloadEncodingEIP191:
|
||||
return payEnc, nil
|
||||
default:
|
||||
return PayloadEncodingUnspecified, fmt.Errorf("%w: version=%d, encoding=%x", ErrUnsupportedPayloadEncoding, Version0, payEnc)
|
||||
}
|
||||
|
||||
return payEnc, nil
|
||||
}
|
||||
|
||||
// https://github.com/expede/varsig/blob/main/README.md#payload-encoding
|
||||
func decodeEncodingInfoV1(payEnc PayloadEncoding) (PayloadEncoding, error) {
|
||||
if _, ok := map[PayloadEncoding]struct{}{
|
||||
PayloadEncodingVerbatim: {},
|
||||
PayloadEncodingDAGCBOR: {},
|
||||
PayloadEncodingDAGJSON: {},
|
||||
PayloadEncodingEIP191: {},
|
||||
}[payEnc]; !ok {
|
||||
switch payEnc {
|
||||
case PayloadEncodingVerbatim,
|
||||
PayloadEncodingDAGCBOR,
|
||||
PayloadEncodingDAGJSON,
|
||||
PayloadEncodingEIP191:
|
||||
return payEnc, nil
|
||||
default:
|
||||
return PayloadEncodingUnspecified, fmt.Errorf("%w: version=%d, encoding=%x", ErrUnsupportedPayloadEncoding, Version1, payEnc)
|
||||
}
|
||||
|
||||
return payEnc, nil
|
||||
}
|
||||
|
||||
// SignAlgorithm is (usually) the multicodec.Code representing the public
|
||||
// key type of the algorithm used to create the signature.
|
||||
// Discriminator is (usually) the value representing the public key type of
|
||||
// the algorithm used to create the signature.
|
||||
//
|
||||
// There is not set list of constants here, nor is there a decode function
|
||||
// as the author of an implementation should include the constant with the
|
||||
// implementation, and the decoding is handled by the Handler, which uses
|
||||
// the SignAlgorithm to choose the correct implementation. Also note that
|
||||
// some of the SignAlgorithm values for a specific implementation have
|
||||
// the Discriminator to choose the correct implementation. Also note that
|
||||
// some of the Discriminator values for a specific implementation have
|
||||
// changed between varsig v0 and v1, so it's possible to have more than one
|
||||
// constant defined per implementation.
|
||||
type SignAlgorithm uint64
|
||||
type Discriminator uint64
|
||||
|
||||
@@ -7,7 +7,7 @@ import (
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestDecodeHashAlgorithm(t *testing.T) {
|
||||
@@ -39,6 +39,14 @@ func TestDecodeHashAlgorithm(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkDecodeHashAlgorithm(b *testing.B) {
|
||||
b.ReportAllocs()
|
||||
data := []byte{0x12}
|
||||
for i := 0; i < b.N; i++ {
|
||||
_, _ = varsig.DecodeHashAlgorithm(bytes.NewReader(data))
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodePayloadEncoding(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
@@ -105,3 +113,11 @@ func TestDecodePayloadEncoding(t *testing.T) {
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func BenchmarkDecodePayloadEncoding(b *testing.B) {
|
||||
b.ReportAllocs()
|
||||
data := []byte{0x5f}
|
||||
for i := 0; i < b.N; i++ {
|
||||
_, _ = varsig.DecodePayloadEncoding(bytes.NewReader(data), varsig.Version1)
|
||||
}
|
||||
}
|
||||
|
||||
8
ecdsa.go
8
ecdsa.go
@@ -2,8 +2,8 @@ package varsig
|
||||
|
||||
// Stub
|
||||
const (
|
||||
SignAlgorithmECDSASecp256k1 SignAlgorithm = 0xe7
|
||||
SignAlgorithmECDSAP256 SignAlgorithm = 0x1200
|
||||
SignAlgorithmECDSAP384 SignAlgorithm = 0x1201
|
||||
SignAlgorithmECDSAP521 SignAlgorithm = 0x1202
|
||||
DiscriminatorECDSASecp256k1 Discriminator = 0xe7
|
||||
DiscriminatorECDSAP256 Discriminator = 0x1200
|
||||
DiscriminatorECDSAP384 Discriminator = 0x1201
|
||||
DiscriminatorECDSAP521 Discriminator = 0x1202
|
||||
)
|
||||
|
||||
110
eddsa.go
110
eddsa.go
@@ -1,72 +1,97 @@
|
||||
package varsig
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/ed25519"
|
||||
"encoding/binary"
|
||||
|
||||
"github.com/multiformats/go-multicodec"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Constants containing values that specify EdDSA signatures.
|
||||
const (
|
||||
SignAlgorithmEdDSA = SignAlgorithm(multicodec.Ed25519Pub)
|
||||
SignAlgorithmEd25519 = SignAlgorithm(multicodec.Ed25519Pub)
|
||||
SignAlgorithmEd448 = SignAlgorithm(multicodec.Ed448Pub)
|
||||
DiscriminatorEdDSA = Discriminator(0xed)
|
||||
DiscriminatorEd25519 = Discriminator(0xed)
|
||||
DiscriminatorEd448 = Discriminator(0x1203)
|
||||
)
|
||||
|
||||
// EdDSACurve are values that specify which Edwards curve is used when
|
||||
// generating the signature.
|
||||
type EdDSACurve uint64
|
||||
|
||||
// Constants describing the values for each specific Edwards curve that can
|
||||
// be encoded into a Varsig.
|
||||
const (
|
||||
CurveEd25519 = EdDSACurve(multicodec.Ed25519Pub)
|
||||
CurveEd448 = EdDSACurve(multicodec.Ed448Pub)
|
||||
CurveEd25519 = EdDSACurve(0xed)
|
||||
CurveEd448 = EdDSACurve(0x1203)
|
||||
)
|
||||
|
||||
var _ Varsig = (*EdDSAVarsig)(nil)
|
||||
func decodeEdDSACurve(r BytesReader) (EdDSACurve, error) {
|
||||
u, err := binary.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
switch curve := EdDSACurve(u); curve {
|
||||
case CurveEd25519, CurveEd448:
|
||||
return curve, nil
|
||||
default:
|
||||
return 0, fmt.Errorf("%w: %x", ErrUnknownEdDSACurve, u)
|
||||
}
|
||||
}
|
||||
|
||||
var _ Varsig = EdDSAVarsig{}
|
||||
|
||||
// EdDSAVarsig is a varsig that encodes the parameters required to describe
|
||||
// an EdDSA signature.
|
||||
type EdDSAVarsig struct {
|
||||
varsig[EdDSAVarsig]
|
||||
varsig
|
||||
|
||||
curve EdDSACurve
|
||||
hashAlg HashAlgorithm
|
||||
}
|
||||
|
||||
func NewEdDSAVarsig(curve EdDSACurve, hashAlgorithm HashAlgorithm, payloadEncoding PayloadEncoding, opts ...Option) (*EdDSAVarsig, error) {
|
||||
// NewEdDSAVarsig creates and validates an EdDSA varsig with the provided
|
||||
// curve, hash algorithm and payload encoding.
|
||||
func NewEdDSAVarsig(curve EdDSACurve, hashAlgorithm HashAlgorithm, payloadEncoding PayloadEncoding, opts ...Option) (EdDSAVarsig, error) {
|
||||
options := newOptions(opts...)
|
||||
|
||||
var (
|
||||
vers = Version1
|
||||
signAlg = SignAlgorithmEdDSA
|
||||
sig = []byte{}
|
||||
vers = Version1
|
||||
disc = DiscriminatorEdDSA
|
||||
sig []byte
|
||||
)
|
||||
|
||||
if options.ForceVersion0() {
|
||||
vers = Version0
|
||||
signAlg = SignAlgorithm(curve)
|
||||
disc = Discriminator(curve)
|
||||
sig = options.Signature()
|
||||
}
|
||||
|
||||
v := &EdDSAVarsig{
|
||||
varsig: varsig[EdDSAVarsig]{
|
||||
vers: vers,
|
||||
signAlg: signAlg,
|
||||
payEnc: payloadEncoding,
|
||||
sig: sig,
|
||||
v := EdDSAVarsig{
|
||||
varsig: varsig{
|
||||
vers: vers,
|
||||
disc: disc,
|
||||
payEnc: payloadEncoding,
|
||||
sig: sig,
|
||||
},
|
||||
curve: curve,
|
||||
hashAlg: hashAlgorithm,
|
||||
}
|
||||
|
||||
return v.validateSig(v, ed25519.PrivateKeySize)
|
||||
return validateSig(v, ed25519.SignatureSize)
|
||||
}
|
||||
|
||||
func (v *EdDSAVarsig) Curve() EdDSACurve {
|
||||
// Curve returns the Edwards curve used to generate the EdDSA signature.
|
||||
func (v EdDSAVarsig) Curve() EdDSACurve {
|
||||
return v.curve
|
||||
}
|
||||
|
||||
func (v *EdDSAVarsig) HashAlgorithm() HashAlgorithm {
|
||||
// HashAlgorithm returns the value describing the hash algorithm used to hash
|
||||
// the payload content before the signature is generated.
|
||||
func (v EdDSAVarsig) HashAlgorithm() HashAlgorithm {
|
||||
return v.hashAlg
|
||||
}
|
||||
|
||||
// Encode returns the encoded byte format of the EdDSAVarsig.
|
||||
func (v EdDSAVarsig) Encode() []byte {
|
||||
buf := v.encode()
|
||||
|
||||
@@ -81,36 +106,35 @@ func (v EdDSAVarsig) Encode() []byte {
|
||||
return buf
|
||||
}
|
||||
|
||||
func decodeEd25519(r *bytes.Reader, vers Version, signAlg SignAlgorithm) (Varsig, error) {
|
||||
curve := uint64(signAlg)
|
||||
func decodeEd25519(r BytesReader, vers Version, disc Discriminator) (Varsig, error) {
|
||||
curve := EdDSACurve(disc)
|
||||
if vers != Version0 {
|
||||
u, err := binary.ReadUvarint(r)
|
||||
var err error
|
||||
|
||||
curve, err = decodeEdDSACurve(r)
|
||||
if err != nil {
|
||||
return nil, err // TODO: wrap error?
|
||||
return nil, err
|
||||
}
|
||||
|
||||
curve = u
|
||||
}
|
||||
|
||||
hashAlg, err := binary.ReadUvarint(r)
|
||||
hashAlg, err := DecodeHashAlgorithm(r)
|
||||
if err != nil {
|
||||
return nil, err // TODO: wrap error?
|
||||
return nil, err
|
||||
}
|
||||
|
||||
v := &EdDSAVarsig{
|
||||
varsig: varsig[EdDSAVarsig]{
|
||||
vers: vers,
|
||||
signAlg: signAlg,
|
||||
v := EdDSAVarsig{
|
||||
varsig: varsig{
|
||||
vers: vers,
|
||||
disc: disc,
|
||||
},
|
||||
curve: EdDSACurve(curve),
|
||||
hashAlg: HashAlgorithm(hashAlg),
|
||||
curve: curve,
|
||||
hashAlg: hashAlg,
|
||||
}
|
||||
|
||||
return v.decodePayEncAndSig(r, v, ed25519.PrivateKeySize)
|
||||
}
|
||||
v.payEnc, v.sig, err = v.decodePayEncAndSig(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// TODO: remove this when parseEd25519 is added to the DefaultRegistry.
|
||||
func Junk() {
|
||||
_, _ = decodeEd25519(nil, 0, 0)
|
||||
return validateSig(v, ed25519.SignatureSize)
|
||||
}
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
package varsig_test
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestDecodeEd25519(t *testing.T) {
|
||||
@@ -31,11 +32,11 @@ func TestDecodeEd25519(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, v)
|
||||
assert.Equal(t, varsig.Version0, v.Version())
|
||||
assert.Equal(t, varsig.SignAlgorithmEd25519, v.SignatureAlgorithm())
|
||||
assert.Equal(t, varsig.DiscriminatorEd25519, v.Discriminator())
|
||||
assert.Equal(t, varsig.PayloadEncodingDAGCBOR, v.PayloadEncoding())
|
||||
assert.Len(t, v.Signature(), 64)
|
||||
|
||||
impl, ok := v.(*varsig.EdDSAVarsig)
|
||||
impl, ok := v.(varsig.EdDSAVarsig)
|
||||
require.True(t, ok)
|
||||
assert.Equal(t, varsig.CurveEd25519, impl.Curve())
|
||||
assert.Equal(t, varsig.HashAlgorithmSHA512, impl.HashAlgorithm())
|
||||
@@ -56,3 +57,44 @@ func TestDecodeEd25519(t *testing.T) {
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestUCANExampleV1(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
// This test is the value shown in the UCAN v1.0.0 example, which is
|
||||
// an EdDSA varsig = v1 with the Ed25519 curve, SHA2_256 hashing and
|
||||
// DAG-CBOR content encoding.
|
||||
example, err := base64.RawStdEncoding.DecodeString("NAHtAe0BE3E")
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run("Decode", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
v, err := varsig.Decode(example)
|
||||
require.NoError(t, err)
|
||||
|
||||
rsaV, ok := v.(varsig.EdDSAVarsig)
|
||||
require.True(t, ok)
|
||||
|
||||
assert.Equal(t, varsig.Version1, rsaV.Version())
|
||||
assert.Equal(t, varsig.DiscriminatorEdDSA, rsaV.Discriminator())
|
||||
assert.Equal(t, varsig.CurveEd25519, rsaV.Curve())
|
||||
assert.Equal(t, varsig.HashAlgorithmSHA512, rsaV.HashAlgorithm())
|
||||
assert.Equal(t, varsig.PayloadEncodingDAGCBOR, rsaV.PayloadEncoding())
|
||||
assert.Len(t, rsaV.Signature(), 0)
|
||||
})
|
||||
|
||||
t.Run("Encode", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
edDSAVarsig, err := varsig.NewEdDSAVarsig(
|
||||
varsig.CurveEd25519,
|
||||
varsig.HashAlgorithmSHA512,
|
||||
varsig.PayloadEncodingDAGCBOR,
|
||||
)
|
||||
require.NoError(t, err)
|
||||
|
||||
assert.Equal(t, example, edDSAVarsig.Encode())
|
||||
t.Log(base64.RawStdEncoding.EncodeToString(edDSAVarsig.Encode()))
|
||||
})
|
||||
}
|
||||
|
||||
14
error.go
14
error.go
@@ -13,7 +13,7 @@ var ErrMissingSignature = errors.New("missing signature expected in varsig v0")
|
||||
var ErrNotYetImplemented = errors.New("not yet implemented")
|
||||
|
||||
// ErrUnexpectedSignaturePresent is returned when a signature is present
|
||||
// in a varsig >= v1.
|
||||
// in a varsig >= v1.
|
||||
var ErrUnexpectedSignaturePresent = errors.New("unexpected signature present in varsig >= v1")
|
||||
|
||||
// ErrUnexpectedSignatureSize is returned when the length of the decoded
|
||||
@@ -21,7 +21,7 @@ var ErrUnexpectedSignaturePresent = errors.New("unexpected signature present in
|
||||
// signing algorithm or sent via a Varsig field.
|
||||
var ErrUnexpectedSignatureSize = errors.New("unexpected signature size in varsig v0")
|
||||
|
||||
// ErrUnknownHashAlgoritm is returned when an unexpected value is provided
|
||||
// ErrUnknownHashAlgorithm is returned when an unexpected value is provided
|
||||
// while decoding the hashing algorithm.
|
||||
var ErrUnknownHashAlgorithm = errors.New("unknown hash algorithm")
|
||||
|
||||
@@ -30,14 +30,18 @@ var ErrUnknownHashAlgorithm = errors.New("unknown hash algorithm")
|
||||
// for this field may vary based on the varsig version.
|
||||
var ErrUnsupportedPayloadEncoding = errors.New("unsupported payload encoding")
|
||||
|
||||
// ErrUnknownSignAlgorith is returned when the Registry doesn't have a
|
||||
// ErrUnknownDiscriminator is returned when the Registry doesn't have a
|
||||
// parsing function for the decoded signing algorithm.
|
||||
var ErrUnknownSignAlgorithm = errors.New("unknown signing algorithm")
|
||||
var ErrUnknownDiscriminator = errors.New("unknown signing algorithm")
|
||||
|
||||
// ErrUnknownEdDSACurve is returned when the decoded uvarint isn't either
|
||||
// CurveEd25519 or CurveEd448.
|
||||
var ErrUnknownEdDSACurve = errors.New("unknown Edwards curve")
|
||||
|
||||
// ErrUnsupportedVersion is returned when an unsupported varsig version
|
||||
// field is present.
|
||||
var ErrUnsupportedVersion = errors.New("unsupported version")
|
||||
|
||||
// ErrBadPrefix is returned when the prefix field contains a value other
|
||||
// than 0x34 (encoded as a uvarint).
|
||||
// than 0x34 (encoded as an uvarint).
|
||||
var ErrBadPrefix = errors.New("varsig prefix not found")
|
||||
|
||||
15
go.mod
15
go.mod
@@ -1,22 +1,11 @@
|
||||
module github.com/selesy/go-varsig
|
||||
module github.com/ucan-wg/go-varsig
|
||||
|
||||
go 1.24.4
|
||||
|
||||
require (
|
||||
github.com/multiformats/go-multicodec v0.9.2
|
||||
github.com/stretchr/testify v1.10.0
|
||||
)
|
||||
require github.com/stretchr/testify v1.10.0
|
||||
|
||||
require (
|
||||
github.com/davecgh/go-spew v1.1.1 // indirect
|
||||
github.com/pmezard/go-difflib v1.0.0 // indirect
|
||||
golang.org/x/mod v0.22.0 // indirect
|
||||
golang.org/x/sync v0.10.0 // indirect
|
||||
golang.org/x/sys v0.29.0 // indirect
|
||||
golang.org/x/telemetry v0.0.0-20240522233618-39ace7a40ae7 // indirect
|
||||
golang.org/x/tools v0.29.0 // indirect
|
||||
golang.org/x/vuln v1.1.4 // indirect
|
||||
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||
)
|
||||
|
||||
tool golang.org/x/vuln/cmd/govulncheck
|
||||
|
||||
20
go.sum
20
go.sum
@@ -1,29 +1,9 @@
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/google/go-cmdtest v0.4.1-0.20220921163831-55ab3332a786 h1:rcv+Ippz6RAtvaGgKxc+8FQIpxHgsF+HBzPyYL2cyVU=
|
||||
github.com/google/go-cmdtest v0.4.1-0.20220921163831-55ab3332a786/go.mod h1:apVn/GCasLZUVpAJ6oWAuyP7Ne7CEsQbTnc0plM3m+o=
|
||||
github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
|
||||
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
|
||||
github.com/google/renameio v0.1.0 h1:GOZbcHa3HfsPKPlmyPyN2KEohoMXOhdMbHrvbpl2QaA=
|
||||
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
|
||||
github.com/multiformats/go-multicodec v0.9.2 h1:YrlXCuqxjqm3bXl+vBq5LKz5pz4mvAsugdqy78k0pXQ=
|
||||
github.com/multiformats/go-multicodec v0.9.2/go.mod h1:LLWNMtyV5ithSBUo3vFIMaeDy+h3EbkMTek1m+Fybbo=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
|
||||
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
|
||||
golang.org/x/mod v0.22.0 h1:D4nJWe9zXqHOmWqj4VMOJhvzj7bEZg4wEYa759z1pH4=
|
||||
golang.org/x/mod v0.22.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
|
||||
golang.org/x/sync v0.10.0 h1:3NQrjDixjgGwUOCaF8w2+VYHv0Ve/vGYSbdkTa98gmQ=
|
||||
golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
|
||||
golang.org/x/sys v0.29.0 h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=
|
||||
golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||
golang.org/x/telemetry v0.0.0-20240522233618-39ace7a40ae7 h1:FemxDzfMUcK2f3YY4H+05K9CDzbSVr2+q/JKN45pey0=
|
||||
golang.org/x/telemetry v0.0.0-20240522233618-39ace7a40ae7/go.mod h1:pRgIJT+bRLFKnoM1ldnzKoxTIn14Yxz928LQRYYgIN0=
|
||||
golang.org/x/tools v0.29.0 h1:Xx0h3TtM9rzQpQuR4dKLrdglAmCEN5Oi+P74JdhdzXE=
|
||||
golang.org/x/tools v0.29.0/go.mod h1:KMQVMRsVxU6nHCFXrBPhDB8XncLNLM0lIy/F14RP588=
|
||||
golang.org/x/vuln v1.1.4 h1:Ju8QsuyhX3Hk8ma3CesTbO8vfJD9EvUBgHvkxHBzj0I=
|
||||
golang.org/x/vuln v1.1.4/go.mod h1:F+45wmU18ym/ca5PLTPLsSzr2KppzswxPP603ldA67s=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
|
||||
47
registry.go
47
registry.go
@@ -6,8 +6,11 @@ import (
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Version represents which version of the varsig specification was used
|
||||
// to produce Varsig value.
|
||||
type Version uint64
|
||||
|
||||
// Constants for the existing varsig specifications
|
||||
const (
|
||||
Version0 Version = 0
|
||||
Version1 Version = 1
|
||||
@@ -15,22 +18,22 @@ const (
|
||||
|
||||
// DecodeFunc is a function that parses the varsig representing a specific
|
||||
// signing algorithm.
|
||||
type DecodeFunc func(*bytes.Reader, Version, SignAlgorithm) (Varsig, error)
|
||||
type DecodeFunc func(BytesReader, Version, Discriminator) (Varsig, error)
|
||||
|
||||
// Registry contains a mapping between known signing algorithms, and
|
||||
// Registry contains a mapping between known signing algorithms and
|
||||
// functions that can parse varsigs for that signing algorithm.
|
||||
type Registry map[SignAlgorithm]DecodeFunc
|
||||
type Registry map[Discriminator]DecodeFunc
|
||||
|
||||
// DefaultRegistry provides a Registry containing the mappings for the
|
||||
// signing algorithms which have an implementation within this library.
|
||||
func DefaultRegistry() Registry {
|
||||
return map[SignAlgorithm]DecodeFunc{
|
||||
SignAlgorithmRSA: decodeRSA,
|
||||
SignAlgorithmEdDSA: decodeEd25519,
|
||||
SignAlgorithmEd448: decodeEd25519,
|
||||
SignAlgorithmECDSAP256: notYetImplementedVarsigDecoder,
|
||||
SignAlgorithmECDSASecp256k1: notYetImplementedVarsigDecoder,
|
||||
SignAlgorithmECDSAP521: notYetImplementedVarsigDecoder,
|
||||
return map[Discriminator]DecodeFunc{
|
||||
DiscriminatorRSA: decodeRSA,
|
||||
DiscriminatorEdDSA: decodeEd25519,
|
||||
DiscriminatorEd448: decodeEd25519,
|
||||
DiscriminatorECDSAP256: notYetImplementedVarsigDecoder,
|
||||
DiscriminatorECDSASecp256k1: notYetImplementedVarsigDecoder,
|
||||
DiscriminatorECDSAP521: notYetImplementedVarsigDecoder,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,7 +44,7 @@ func NewRegistry() Registry {
|
||||
|
||||
// Register allows new mappings between a signing algorithm and its parsing
|
||||
// function to the Registry.
|
||||
func (rs Registry) Register(alg SignAlgorithm, decodeFunc DecodeFunc) {
|
||||
func (rs Registry) Register(alg Discriminator, decodeFunc DecodeFunc) {
|
||||
rs[alg] = decodeFunc
|
||||
}
|
||||
|
||||
@@ -53,7 +56,7 @@ func (rs Registry) Decode(data []byte) (Varsig, error) {
|
||||
|
||||
// DecodeStream converts data read from the provided io.Reader into one
|
||||
// of the registered Varsig types.
|
||||
func (rs Registry) DecodeStream(r *bytes.Reader) (Varsig, error) {
|
||||
func (rs Registry) DecodeStream(r BytesReader) (Varsig, error) {
|
||||
pre, err := binary.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("%w: %w", ErrBadPrefix, err)
|
||||
@@ -63,20 +66,20 @@ func (rs Registry) DecodeStream(r *bytes.Reader) (Varsig, error) {
|
||||
return nil, fmt.Errorf("%w: expected %d, got %d", ErrBadPrefix, Prefix, pre)
|
||||
}
|
||||
|
||||
vers, signAlg, err := rs.decodeVersAndSignAlg(r)
|
||||
vers, disc, err := rs.decodeVersAnddisc(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
decodeFunc, ok := rs[SignAlgorithm(signAlg)]
|
||||
decodeFunc, ok := rs[Discriminator(disc)]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("%w: %x", ErrUnknownSignAlgorithm, signAlg)
|
||||
return nil, fmt.Errorf("%w: %x", ErrUnknownDiscriminator, disc)
|
||||
}
|
||||
|
||||
return decodeFunc(r, vers, signAlg)
|
||||
return decodeFunc(r, vers, disc)
|
||||
}
|
||||
|
||||
func (rs Registry) decodeVersAndSignAlg(r *bytes.Reader) (Version, SignAlgorithm, error) {
|
||||
func (rs Registry) decodeVersAnddisc(r BytesReader) (Version, Discriminator, error) {
|
||||
vers, err := binary.ReadUvarint(r)
|
||||
if err != nil {
|
||||
return Version(vers), 0, err
|
||||
@@ -87,14 +90,14 @@ func (rs Registry) decodeVersAndSignAlg(r *bytes.Reader) (Version, SignAlgorithm
|
||||
}
|
||||
|
||||
if vers >= 64 {
|
||||
return 0, SignAlgorithm(vers), nil
|
||||
return 0, Discriminator(vers), nil
|
||||
}
|
||||
|
||||
signAlg, err := binary.ReadUvarint(r)
|
||||
disc, err := binary.ReadUvarint(r)
|
||||
|
||||
return Version(vers), SignAlgorithm(signAlg), err
|
||||
return Version(vers), Discriminator(disc), err
|
||||
}
|
||||
|
||||
func notYetImplementedVarsigDecoder(_ *bytes.Reader, vers Version, signAlg SignAlgorithm) (Varsig, error) {
|
||||
return nil, fmt.Errorf("%w: Version: %d, SignAlgorithm: %x", ErrNotYetImplemented, vers, signAlg)
|
||||
func notYetImplementedVarsigDecoder(_ BytesReader, vers Version, disc Discriminator) (Varsig, error) {
|
||||
return nil, fmt.Errorf("%w: Version: %d, Discriminator: %x", ErrNotYetImplemented, vers, disc)
|
||||
}
|
||||
|
||||
@@ -8,7 +8,7 @@ import (
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestRegistry_Decode(t *testing.T) {
|
||||
@@ -25,7 +25,7 @@ func TestRegistry_Decode(t *testing.T) {
|
||||
vs, err := reg.DecodeStream(bytes.NewReader(data))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, varsig.Version0, vs.Version())
|
||||
assert.Equal(t, testSignAlgorithm1, vs.SignatureAlgorithm())
|
||||
assert.Equal(t, testDiscriminator1, vs.Discriminator())
|
||||
})
|
||||
|
||||
t.Run("passes - v1", func(t *testing.T) {
|
||||
@@ -39,21 +39,21 @@ func TestRegistry_Decode(t *testing.T) {
|
||||
vs, err := reg.DecodeStream(bytes.NewReader(data))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, varsig.Version1, vs.Version())
|
||||
assert.Equal(t, testSignAlgorithm1, vs.SignatureAlgorithm())
|
||||
assert.Equal(t, testDiscriminator1, vs.Discriminator())
|
||||
})
|
||||
}
|
||||
|
||||
const (
|
||||
testSignAlgorithm0 varsig.SignAlgorithm = 0x1000
|
||||
testSignAlgorithm1 varsig.SignAlgorithm = 0x1001
|
||||
testDiscriminator0 varsig.Discriminator = 0x1000
|
||||
testDiscriminator1 varsig.Discriminator = 0x1001
|
||||
)
|
||||
|
||||
func testRegistry(t *testing.T) varsig.Registry {
|
||||
t.Helper()
|
||||
|
||||
reg := varsig.NewRegistry()
|
||||
reg.Register(testSignAlgorithm0, testDecodeFunc(t))
|
||||
reg.Register(testSignAlgorithm1, testDecodeFunc(t))
|
||||
reg.Register(testDiscriminator0, testDecodeFunc(t))
|
||||
reg.Register(testDiscriminator1, testDecodeFunc(t))
|
||||
|
||||
return reg
|
||||
}
|
||||
@@ -61,41 +61,41 @@ func testRegistry(t *testing.T) varsig.Registry {
|
||||
func testDecodeFunc(t *testing.T) varsig.DecodeFunc {
|
||||
t.Helper()
|
||||
|
||||
return func(r *bytes.Reader, vers varsig.Version, signAlg varsig.SignAlgorithm) (varsig.Varsig, error) {
|
||||
return func(r varsig.BytesReader, vers varsig.Version, disc varsig.Discriminator) (varsig.Varsig, error) {
|
||||
v := &testVarsig{
|
||||
vers: vers,
|
||||
signAlg: signAlg,
|
||||
vers: vers,
|
||||
disc: disc,
|
||||
}
|
||||
|
||||
return v, nil
|
||||
}
|
||||
}
|
||||
|
||||
var _ varsig.Varsig = (*testVarsig)(nil)
|
||||
var _ varsig.Varsig = testVarsig{}
|
||||
|
||||
type testVarsig struct {
|
||||
vers varsig.Version
|
||||
signAlg varsig.SignAlgorithm
|
||||
payEnc varsig.PayloadEncoding
|
||||
sig []byte
|
||||
vers varsig.Version
|
||||
disc varsig.Discriminator
|
||||
payEnc varsig.PayloadEncoding
|
||||
sig []byte
|
||||
}
|
||||
|
||||
func (v *testVarsig) Version() varsig.Version {
|
||||
func (v testVarsig) Version() varsig.Version {
|
||||
return v.vers
|
||||
}
|
||||
|
||||
func (v *testVarsig) SignatureAlgorithm() varsig.SignAlgorithm {
|
||||
return v.signAlg
|
||||
func (v testVarsig) Discriminator() varsig.Discriminator {
|
||||
return v.disc
|
||||
}
|
||||
|
||||
func (v *testVarsig) PayloadEncoding() varsig.PayloadEncoding {
|
||||
func (v testVarsig) PayloadEncoding() varsig.PayloadEncoding {
|
||||
return v.payEnc
|
||||
}
|
||||
|
||||
func (v *testVarsig) Signature() []byte {
|
||||
func (v testVarsig) Signature() []byte {
|
||||
return v.sig
|
||||
}
|
||||
|
||||
func (v *testVarsig) Encode() []byte {
|
||||
func (v testVarsig) Encode() []byte {
|
||||
return nil
|
||||
}
|
||||
|
||||
57
rsa.go
57
rsa.go
@@ -1,32 +1,30 @@
|
||||
package varsig
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/binary"
|
||||
|
||||
"github.com/multiformats/go-multicodec"
|
||||
)
|
||||
|
||||
const SignAlgorithmRSA = SignAlgorithm(multicodec.RsaPub)
|
||||
// DiscriminatorRSA is the value specifying an RSA signature.
|
||||
const DiscriminatorRSA = Discriminator(0x1205)
|
||||
|
||||
var _ Varsig = (*RSAVarsig)(nil)
|
||||
var _ Varsig = RSAVarsig{}
|
||||
|
||||
// RSAVarsig is a varsig that encodes the parameters required to describe
|
||||
// and RSA signature.
|
||||
// an RSA signature.
|
||||
type RSAVarsig struct {
|
||||
varsig[RSAVarsig]
|
||||
varsig
|
||||
hashAlg HashAlgorithm
|
||||
sigLen uint64
|
||||
}
|
||||
|
||||
// NewRSAVarsig creates and validates an RSA varsig with the provided
|
||||
// parameters.
|
||||
func NewRSAVarsig(hashAlgorithm HashAlgorithm, keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (*RSAVarsig, error) {
|
||||
// hash algorithm, key length and payload encoding.
|
||||
func NewRSAVarsig(hashAlgorithm HashAlgorithm, keyLength uint64, payloadEncoding PayloadEncoding, opts ...Option) (RSAVarsig, error) {
|
||||
options := newOptions(opts...)
|
||||
|
||||
var (
|
||||
vers = Version1
|
||||
sig = []byte{}
|
||||
sig []byte
|
||||
)
|
||||
|
||||
if options.ForceVersion0() {
|
||||
@@ -34,21 +32,21 @@ func NewRSAVarsig(hashAlgorithm HashAlgorithm, keyLength uint64, payloadEncoding
|
||||
sig = options.Signature()
|
||||
}
|
||||
|
||||
v := &RSAVarsig{
|
||||
varsig: varsig[RSAVarsig]{
|
||||
vers: vers,
|
||||
signAlg: SignAlgorithmRSA,
|
||||
payEnc: payloadEncoding,
|
||||
sig: sig,
|
||||
v := RSAVarsig{
|
||||
varsig: varsig{
|
||||
vers: vers,
|
||||
disc: DiscriminatorRSA,
|
||||
payEnc: payloadEncoding,
|
||||
sig: sig,
|
||||
},
|
||||
hashAlg: hashAlgorithm,
|
||||
sigLen: keyLength,
|
||||
}
|
||||
|
||||
return v.validateSig(v, v.sigLen)
|
||||
return validateSig(v, v.sigLen)
|
||||
}
|
||||
|
||||
// Encode returns the encoded byte formation of the RSAVarsig.
|
||||
// Encode returns the encoded byte format of the RSAVarsig.
|
||||
func (v RSAVarsig) Encode() []byte {
|
||||
buf := v.encode()
|
||||
buf = binary.AppendUvarint(buf, uint64(v.hashAlg))
|
||||
@@ -60,17 +58,17 @@ func (v RSAVarsig) Encode() []byte {
|
||||
}
|
||||
|
||||
// HashAlgorithm returns the hash algorithm used to has the payload content.
|
||||
func (v *RSAVarsig) HashAlgorithm() HashAlgorithm {
|
||||
func (v RSAVarsig) HashAlgorithm() HashAlgorithm {
|
||||
return v.hashAlg
|
||||
}
|
||||
|
||||
// KeyLength returns the length of the RSA key used to sign the payload
|
||||
// content.
|
||||
func (v *RSAVarsig) KeyLength() uint64 {
|
||||
func (v RSAVarsig) KeyLength() uint64 {
|
||||
return v.sigLen
|
||||
}
|
||||
|
||||
func decodeRSA(r *bytes.Reader, vers Version, signAlg SignAlgorithm) (Varsig, error) {
|
||||
func decodeRSA(r BytesReader, vers Version, disc Discriminator) (Varsig, error) {
|
||||
hashAlg, err := DecodeHashAlgorithm(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -81,14 +79,19 @@ func decodeRSA(r *bytes.Reader, vers Version, signAlg SignAlgorithm) (Varsig, er
|
||||
return nil, err
|
||||
}
|
||||
|
||||
vs := &RSAVarsig{
|
||||
varsig: varsig[RSAVarsig]{
|
||||
vers: vers,
|
||||
signAlg: signAlg,
|
||||
vs := RSAVarsig{
|
||||
varsig: varsig{
|
||||
vers: vers,
|
||||
disc: disc,
|
||||
},
|
||||
hashAlg: HashAlgorithm(hashAlg),
|
||||
hashAlg: hashAlg,
|
||||
sigLen: sigLen,
|
||||
}
|
||||
|
||||
return vs.decodePayEncAndSig(r, vs, sigLen)
|
||||
vs.payEnc, vs.sig, err = vs.decodePayEncAndSig(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return validateSig(vs, vs.sigLen)
|
||||
}
|
||||
|
||||
12
rsa_test.go
12
rsa_test.go
@@ -7,7 +7,7 @@ import (
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestRSAVarsig(t *testing.T) {
|
||||
@@ -26,11 +26,11 @@ func TestRSAVarsig(t *testing.T) {
|
||||
vs, err := varsig.Decode(example)
|
||||
require.NoError(t, err)
|
||||
|
||||
rsaVs, ok := vs.(*varsig.RSAVarsig)
|
||||
rsaVs, ok := vs.(varsig.RSAVarsig)
|
||||
require.True(t, ok)
|
||||
|
||||
assert.Equal(t, varsig.Version1, rsaVs.Version())
|
||||
assert.Equal(t, varsig.SignAlgorithmRSA, rsaVs.SignatureAlgorithm())
|
||||
assert.Equal(t, varsig.DiscriminatorRSA, rsaVs.Discriminator())
|
||||
assert.Equal(t, varsig.HashAlgorithmSHA256, rsaVs.HashAlgorithm())
|
||||
assert.Equal(t, varsig.PayloadEncodingDAGCBOR, rsaVs.PayloadEncoding())
|
||||
assert.Equal(t, uint64(keyLen), rsaVs.KeyLength())
|
||||
@@ -52,7 +52,7 @@ func TestRSAVarsig(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func TestUCANExample(t *testing.T) {
|
||||
func TestUCANExampleV0(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
const keyLen = 0x100
|
||||
@@ -69,11 +69,11 @@ func TestUCANExample(t *testing.T) {
|
||||
vs, err := varsig.Decode(example)
|
||||
require.ErrorIs(t, err, varsig.ErrMissingSignature)
|
||||
|
||||
rsaVs, ok := vs.(*varsig.RSAVarsig)
|
||||
rsaVs, ok := vs.(varsig.RSAVarsig)
|
||||
require.True(t, ok)
|
||||
|
||||
assert.Equal(t, varsig.Version0, rsaVs.Version())
|
||||
assert.Equal(t, varsig.SignAlgorithmRSA, rsaVs.SignatureAlgorithm())
|
||||
assert.Equal(t, varsig.DiscriminatorRSA, rsaVs.Discriminator())
|
||||
assert.Equal(t, varsig.HashAlgorithmSHA256, rsaVs.HashAlgorithm())
|
||||
assert.Equal(t, varsig.PayloadEncodingDAGCBOR, rsaVs.PayloadEncoding())
|
||||
assert.Equal(t, uint64(keyLen), rsaVs.KeyLength())
|
||||
|
||||
116
varsig.go
116
varsig.go
@@ -1,45 +1,47 @@
|
||||
// Package varsig implements v0.1.0 of the [Varsig specification].
|
||||
// Package varsig implements v1.0.0 of the [Varsig specification] with
|
||||
// limited support for varsig < v1. This is primarily in support of the
|
||||
// UCAN v1.0.0 specification and will be deprecated in the future.
|
||||
//
|
||||
// # Algorithm naming
|
||||
// # Common algorithm naming
|
||||
//
|
||||
// While there is no strict need for compatibility with JWA/JWT/JWE/JWS,
|
||||
// all attempts are made to keep the algorithm names here consistent with
|
||||
// the table provided in [section 3.1] of RFC7518 titled "JSON Web Algorithms.
|
||||
// In cases where there is no equivalent name for an algorithm, a best-
|
||||
// effort attempt at creating a name in the spirit of that specification is
|
||||
// made.
|
||||
// list made available at the [IANA Registry] titled "JSON Web Signature
|
||||
// and Encryption Algorithms" (JOSE.)
|
||||
//
|
||||
// It should also be noted that algorithm in this context might in fact be
|
||||
// a pseudonym - for cryptographical signing algorithms that require the
|
||||
// signed data to be hashed first, these names commonly refer to the
|
||||
// combination of that signing algorithm and the hash algorithm.
|
||||
//
|
||||
// [section 3.1]: https://datatracker.ietf.org/doc/html/rfc7518#section-3.1
|
||||
//
|
||||
// [IANA Registry]]: https://www.iana.org/assignments/jose/jose.xhtml#web-signature-encryption-algorithms
|
||||
// [Varsig Specification]: https://github.com/ChainAgnostic/varsig
|
||||
package varsig
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/binary"
|
||||
"errors"
|
||||
"io"
|
||||
|
||||
"github.com/multiformats/go-multicodec"
|
||||
)
|
||||
|
||||
// Prefix is the multicodec.Code for the varsig's varuint prefix byte.
|
||||
const Prefix = uint64(multicodec.Varsig)
|
||||
|
||||
// Varsig represents types that describe how a signature was generated
|
||||
// and thus how to interpret the signature and verify the signed data.
|
||||
type Varsig interface {
|
||||
// accessors for fields that are common to all varsig
|
||||
// Version returns the varsig's version field.
|
||||
Version() Version
|
||||
SignatureAlgorithm() SignAlgorithm
|
||||
|
||||
// Discriminator returns the algorithm used to produce the corresponding signature.
|
||||
Discriminator() Discriminator
|
||||
|
||||
// PayloadEncoding returns the codec that was used to encode the signed data.
|
||||
PayloadEncoding() PayloadEncoding
|
||||
|
||||
// Signature returns the cryptographic signature of the signed data.
|
||||
// This value is never present in a varsig >= v1 and must either be a valid
|
||||
// signature with the correct length or empty in varsig < v1.
|
||||
Signature() []byte
|
||||
|
||||
// Operations that are common to all varsig
|
||||
// Encode returns the encoded byte format of the varsig.
|
||||
Encode() []byte
|
||||
}
|
||||
|
||||
@@ -51,42 +53,42 @@ func Decode(data []byte) (Varsig, error) {
|
||||
|
||||
// DecodeStream converts data read from the provided io.Reader into one
|
||||
// of the Varsig types provided by the DefaultRegistry.
|
||||
func DecodeStream(r *bytes.Reader) (Varsig, error) {
|
||||
func DecodeStream(r BytesReader) (Varsig, error) {
|
||||
return DefaultRegistry().DecodeStream(r)
|
||||
}
|
||||
|
||||
type varsig[T Varsig] struct {
|
||||
vers Version
|
||||
signAlg SignAlgorithm
|
||||
payEnc PayloadEncoding
|
||||
sig []byte
|
||||
type varsig struct {
|
||||
vers Version
|
||||
disc Discriminator
|
||||
payEnc PayloadEncoding
|
||||
sig []byte
|
||||
}
|
||||
|
||||
// Version returns the varsig's version field.
|
||||
func (v varsig[_]) Version() Version {
|
||||
func (v varsig) Version() Version {
|
||||
return v.vers
|
||||
}
|
||||
|
||||
// SignatureAlgorithm returns the algorithm used to produce corresponding
|
||||
// Discriminator returns the algorithm used to produce the corresponding
|
||||
// signature.
|
||||
func (v varsig[_]) SignatureAlgorithm() SignAlgorithm {
|
||||
return v.signAlg
|
||||
func (v varsig) Discriminator() Discriminator {
|
||||
return v.disc
|
||||
}
|
||||
|
||||
// PayloadEncoding returns the codec that was used to encode the signed
|
||||
// data.
|
||||
func (v varsig[_]) PayloadEncoding() PayloadEncoding {
|
||||
func (v varsig) PayloadEncoding() PayloadEncoding {
|
||||
return v.payEnc
|
||||
}
|
||||
|
||||
// Signature returns the cryptographic signature of the signed data. This
|
||||
// value is never present in a varsig >= v1 and must either be a valid
|
||||
// signature with the correct length or empty in varsig < v1.
|
||||
func (v varsig[_]) Signature() []byte {
|
||||
func (v varsig) Signature() []byte {
|
||||
return v.sig
|
||||
}
|
||||
|
||||
func (v *varsig[_]) encode() []byte {
|
||||
func (v varsig) encode() []byte {
|
||||
var buf []byte
|
||||
|
||||
buf = binary.AppendUvarint(buf, Prefix)
|
||||
@@ -95,42 +97,56 @@ func (v *varsig[_]) encode() []byte {
|
||||
buf = binary.AppendUvarint(buf, uint64(Version1))
|
||||
}
|
||||
|
||||
buf = binary.AppendUvarint(buf, uint64(v.signAlg))
|
||||
buf = binary.AppendUvarint(buf, uint64(v.disc))
|
||||
|
||||
return buf
|
||||
}
|
||||
|
||||
func (v *varsig[T]) decodePayEncAndSig(r *bytes.Reader, varsig *T, expectedLength uint64) (*T, error) {
|
||||
func (v varsig) decodePayEncAndSig(r BytesReader) (PayloadEncoding, []byte, error) {
|
||||
payEnc, err := DecodePayloadEncoding(r, v.Version())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
return 0, nil, err
|
||||
}
|
||||
|
||||
v.payEnc = payEnc
|
||||
|
||||
signature, err := io.ReadAll(r)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
var signature []byte
|
||||
switch v.Version() {
|
||||
case Version0:
|
||||
signature, err = io.ReadAll(r)
|
||||
if err != nil {
|
||||
return 0, nil, err
|
||||
}
|
||||
case Version1:
|
||||
_, err := r.ReadByte()
|
||||
if err != nil && !errors.Is(err, io.EOF) {
|
||||
return 0, nil, err
|
||||
}
|
||||
if err == nil {
|
||||
return 0, nil, ErrUnexpectedSignaturePresent
|
||||
}
|
||||
default:
|
||||
return 0, nil, ErrUnsupportedVersion
|
||||
}
|
||||
|
||||
v.sig = signature
|
||||
|
||||
return v.validateSig(varsig, expectedLength)
|
||||
return payEnc, signature, nil
|
||||
}
|
||||
|
||||
func (v *varsig[T]) validateSig(varsig *T, expectedLength uint64) (*T, error) {
|
||||
if v.Version() == Version0 && len(v.sig) == 0 {
|
||||
return varsig, ErrMissingSignature
|
||||
func validateSig[T Varsig](v T, expectedLength uint64) (T, error) {
|
||||
if v.Version() == Version0 && len(v.Signature()) == 0 {
|
||||
return v, ErrMissingSignature
|
||||
}
|
||||
|
||||
if v.Version() == Version0 && uint64(len(v.sig)) != expectedLength {
|
||||
return nil, ErrUnexpectedSignatureSize
|
||||
if v.Version() == Version0 && uint64(len(v.Signature())) != expectedLength {
|
||||
return *new(T), ErrUnexpectedSignatureSize
|
||||
}
|
||||
|
||||
if v.Version() == Version1 && len(v.sig) != 0 {
|
||||
return nil, ErrUnexpectedSignaturePresent
|
||||
if v.Version() == Version1 && len(v.Signature()) != 0 {
|
||||
return *new(T), ErrUnexpectedSignaturePresent
|
||||
}
|
||||
|
||||
return varsig, nil
|
||||
|
||||
return v, nil
|
||||
}
|
||||
|
||||
type BytesReader interface {
|
||||
io.ByteReader
|
||||
io.Reader
|
||||
}
|
||||
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/selesy/go-varsig"
|
||||
"github.com/ucan-wg/go-varsig"
|
||||
)
|
||||
|
||||
func TestDecode(t *testing.T) {
|
||||
@@ -66,7 +66,7 @@ func TestDecode(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
|
||||
vs, err := varsig.Decode(data)
|
||||
require.ErrorIs(t, err, varsig.ErrUnknownSignAlgorithm)
|
||||
require.ErrorIs(t, err, varsig.ErrUnknownDiscriminator)
|
||||
assert.Nil(t, vs)
|
||||
})
|
||||
|
||||
@@ -77,7 +77,7 @@ func TestDecode(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
|
||||
vs, err := varsig.Decode(data)
|
||||
require.ErrorIs(t, err, varsig.ErrUnknownSignAlgorithm)
|
||||
require.ErrorIs(t, err, varsig.ErrUnknownDiscriminator)
|
||||
assert.Nil(t, vs)
|
||||
})
|
||||
|
||||
@@ -133,7 +133,7 @@ func TestDecode(t *testing.T) {
|
||||
|
||||
vs, err := varsig.Decode(data)
|
||||
require.ErrorIs(t, err, varsig.ErrUnexpectedSignatureSize)
|
||||
assert.Nil(t, vs)
|
||||
assert.Zero(t, vs)
|
||||
})
|
||||
|
||||
t.Run("fails - unexpected signature present - v1", func(t *testing.T) {
|
||||
@@ -158,15 +158,11 @@ func TestDecode(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func mustVarsig[T varsig.Varsig](t *testing.T) func(*T, error) *T {
|
||||
func mustVarsig[T varsig.Varsig](t *testing.T, v T, err error) {
|
||||
t.Helper()
|
||||
|
||||
return func(v *T, err error) *T {
|
||||
if err != nil && ((*v).Version() != varsig.Version0 || !errors.Is(err, varsig.ErrMissingSignature)) {
|
||||
t.Error(err)
|
||||
}
|
||||
|
||||
return v
|
||||
if err != nil && (v.Version() != varsig.Version0 || !errors.Is(err, varsig.ErrMissingSignature)) {
|
||||
t.Error(err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -180,7 +176,7 @@ func roundTrip[T varsig.Varsig](t *testing.T, in T, expEncHex string) T {
|
||||
}
|
||||
|
||||
assert.Equal(t, in.Version(), out.Version())
|
||||
assert.Equal(t, in.SignatureAlgorithm(), out.SignatureAlgorithm())
|
||||
assert.Equal(t, in.Discriminator(), out.Discriminator())
|
||||
assert.Equal(t, in.PayloadEncoding(), out.PayloadEncoding())
|
||||
assert.Equal(t, in.Signature(), out.Signature())
|
||||
|
||||
|
||||
Reference in New Issue
Block a user