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.

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

Add support for BLS keys and BBS+ signatures #288

Merged
merged 59 commits into from
Mar 23, 2023
Merged

Add support for BLS keys and BBS+ signatures #288

merged 59 commits into from
Mar 23, 2023

Conversation

decentralgabe
Copy link
Member

@decentralgabe decentralgabe commented Feb 17, 2023

Fixes #27

@codecov-commenter
Copy link

codecov-commenter commented Feb 18, 2023

Codecov Report

Merging #288 (625fe9c) into main (c9cdf21) will decrease coverage by 1.37%.
The diff coverage is 48.84%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #288      +/-   ##
==========================================
- Coverage   58.68%   57.31%   -1.37%     
==========================================
  Files          42       46       +4     
  Lines        4717     5467     +750     
==========================================
+ Hits         2768     3133     +365     
- Misses       1462     1759     +297     
- Partials      487      575      +88     
Impacted Files Coverage Δ
crypto/jwt.go 46.15% <0.00%> (ø)
cryptosuite/jsonwebkey2020.go 47.48% <0.00%> (+1.33%) ⬆️
did/util.go 52.69% <0.00%> (ø)
crypto/bbs.go 24.14% <24.14%> (ø)
cryptosuite/bls12381g2key2020.go 49.32% <49.32%> (ø)
cryptosuite/cryptosuite.go 58.62% <50.00%> (-3.88%) ⬇️
cryptosuite/jwssignaturesuite.go 52.24% <50.00%> (-1.90%) ⬇️
cryptosuite/bbsplussignaturesuite.go 52.83% <52.83%> (ø)
cryptosuite/bbsplussignatureproofsuite.go 55.17% <55.17%> (ø)
did/key.go 72.87% <100.00%> (ø)
... and 2 more

@decentralgabe decentralgabe marked this pull request as ready for review February 22, 2023 22:08
Copy link
Contributor

@andresuribe87 andresuribe87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL - sorry for long review cycle.

// helpers

func prepareBBSMessage(msg []byte) [][]byte {
rows := strings.Split(string(msg), "\n")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - weird... the link seems to be broken for me. Something must be up :/

cryptosuite/bbsplussignaturesuite.go Show resolved Hide resolved
b.ProofValue = proofValue
}

func (b *BBSPlusSignature2020Proof) ToGenericProof() (crypto.Proof, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missed this - was the documentation added elsewhere?

cryptosuite/bls12381g2key2020.go Show resolved Hide resolved
}

// GenerateBLSKey2020 https://w3c-ccg.github.io/ldp-bbs2020/#bls-12-381-g2-public-key
func GenerateBLSKey2020() (*BLSKey2020, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is creating a G2, should it be named appropriately?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kept the name and added a param, also updated broken link

cryptosuite/bbsplussignaturesuite.go Outdated Show resolved Hide resolved
}

// CreateDeriveProof https://w3c-ccg.github.io/ldp-bbs2020/#create-derive-proof-data-algorithm
func (b BBSPlusSignatureProofSuite) CreateDeriveProof(inputProofDocument Provable, revealDocument map[string]interface{}) (*DeriveProofResult, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the inputProofDocument need to be of type Provable? Should it be any instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated to any

cryptosuite/bbsplussignatureproofsuite.go Outdated Show resolved Hide resolved
Comment on lines 72 to 82
// orig
p, _ := util.PrettyJSON(testCred)
println(string(p))

// frame
p, _ = util.PrettyJSON(revealDoc)
println(string(p))

// // reveal
p, _ = util.PrettyJSON(selectiveDisclosure)
println(string(p))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the println statements intentional? I'm guessing you wanted to test that the reveal does not contain credentialSubject. If so, can you encode that?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for the demo I gave, removing

cryptosuite/bbsplussignatureproofsuite.go Outdated Show resolved Hide resolved
decentralgabe and others added 7 commits March 21, 2023 09:17
Co-authored-by: Andres Uribe <auribe@tbd.email>
Co-authored-by: Andres Uribe <auribe@tbd.email>
Co-authored-by: Andres Uribe <auribe@tbd.email>
* origin/main:
  Bump github.com/multiformats/go-multibase from 0.1.1 to 0.2.0 (#313)
  Bump github.com/go-playground/validator/v10 from 10.11.2 to 10.12.0 (#311)
  Bump github.com/goccy/go-json from 0.10.0 to 0.10.2 (#310)
  Bump golang.org/x/term from 0.5.0 to 0.6.0 (#299)
  Update JWX lib to use v2 (#308)
  Added style and best practices (#298)
  Add models for Credential Issuer Metadata (#304)
  Upgrade go version to 1.20.2 (#305)
  add missing param (#297)
  interface to any (#296)

# Conflicts:
#	cryptosuite/cryptosuite.go
#	cryptosuite/jsonwebkey2020.go
#	cryptosuite/jwssignaturesuite.go
#	cryptosuite/jwssignaturesuite_test.go
#	go.mod
#	go.sum
#	util/helpers.go
#	wasm/static/main.wasm
@decentralgabe
Copy link
Member Author

@andresuribe87 should have addressed all comments

)

type BBSPlusSignatureProofSuite struct {
CryptoSuiteProofType
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is a misunderstanding there. Embedding does not force implementation of the interface. Instead, you are saying that the BBSPlusSignatureProofSuite has an element inside it that implements that interface. Said another way, BBSPlusSignatureProofSuite.CryptoSuiteProofType will always be nil, since GetBBSPlusSignatureProofSuite() does not instantiate it. See the example below

type suite struct {
	fooInter
}

type fooInter interface{}

func GetSuite() *suite {
	return new(suite)
}

func TestFoo(t *testing.T) {
	assert.Nil(t, GetSuite().fooInter)
}

I think that's different from your intention, which is that BBSPlusSignatureProofSuite should comply with the interface. That is achieved with line 325 alone.

BBSPlusSignatureSuiteCanonicalizationAlgorithm string = "https://w3id.org/security#URDNA2015"
// BBSPlusSignatureSuiteDigestAlgorithm uses https://www.rfc-editor.org/rfc/rfc4634
BBSPlusSignatureSuiteDigestAlgorithm gocrypto.Hash = gocrypto.BLAKE2b_384
// BBSPlusSignatureSuiteProofAlgorithm uses https://www.rfc-editor.org/rfc/rfc7797
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no const named BBSPlusSignatureSuiteProofAlgorithm. Is that intentional?

)

type BBSPlusSignatureSuite struct {
CryptoSuiteProofType
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As above, I think this should be removed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree


var _ CryptoSuiteProofType = (*BBSPlusSignatureSuite)(nil)

func (BBSPlusSignatureSuite) Marshal(data interface{}) ([]byte, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer any over interface{}. I think you had already done that in a PR?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah this pr predated the other, will update

cryptosuite/bbsplussignaturesuite.go Show resolved Hide resolved
* origin/main:
  make target optional (#316)
  ION SDK (#307)

# Conflicts:
#	go.mod
#	go.sum
#	wasm/static/main.wasm
Copy link
Contributor

@andresuribe87 andresuribe87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work! One minor reminder

)

type BBSPlusSignatureProofSuite struct {
CryptoSuiteProofType
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reminder to do this.

github.com/klauspost/cpuid/v2 v2.0.9 // indirect
github.com/hyperledger/aries-framework-go/spi v0.0.0-20221025204933-b807371b6f1e // indirect
github.com/kilic/bls12-381 v0.1.1-0.20210503002446-7b7597926c69 // indirect
github.com/kr/text v0.2.0 // indirect
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks sus haha. Who's using this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

github.com/hyperledger/aries-framework-go@v0.1.9-0.20230217102417-a948231f8452 github.com/klauspost/compress@v1.10.0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like they have widely used packages https://github.com/klauspost/compress

Copy link
Member Author

@decentralgabe decentralgabe Mar 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing some CPUs can't generate these keys properly https://github.com/klauspost/cpuid but this is an indirect dep even for aries so im not certain

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support BBS+ signatures with BLS curves
3 participants