Initial code + basic workflows #1

dssei · 2024-10-07T20:47:22Z

This PR adds:

the first part of the cryptography library - encryption.
essential github workflows
- unit test
- linting
- test coverge

Testing

unit tests

- basic workflows

- address linting issues

…feature/init_and_workflows

github-advanced-security · 2024-10-07T21:46:34Z

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

- update readme

mj850

Thanks for making these changes! Love the new tests, workflow and cleaner code.

We should discuss the interface of the teg object: I see the utility of being able to swap out the curves in the future for other uses, but also think Static functions would be slightly easier to use and understand.

If we want this to be a general use encryption library, maybe we should add an application specific layer that uses the ED25519 curve directly, and deals with application specific things like denoms etc.

mj850 · 2024-10-09T15:39:30Z

pkg/encryption/elgamal/encryption.go

+	maxMapping map[MaxBits]bool
+}
+
+func NewTwistedElgamal(curve *curves.Curve) *TwistedElGamal {


I think we should abstract away the curve from the user here - once we commit to a curve all ciphertexts/points are going to be on that curve so it's unlikely that we'll ever change the curve used. Asking user to input the curve here would add an extra step of having to find out what curve our application is using.

Ok, got your point. Wanted to keep it more generic, with ability to plug in other curves if we decide so. I can add specific constructor for ed25519 curve.

mj850 · 2024-10-09T15:48:07Z

pkg/encryption/elgamal/encryption_test.go

+}
+
+func TestTwistedElGamal_DecryptWithZeroBits(t *testing.T) {
+	denom := "factory/sei1239081236472sd/testToken"


Nit: Maybe we can add this as CONST at the top of the file

mj850 · 2024-10-09T15:55:09Z

pkg/encryption/elgamal/common.go

+)
+
+// H_STRING H is a random point on the elliptic curve that is unrelated to G.
+const H_STRING = "gPt25pi0eDphSiXWu0BIeIvyVATCtwhslTqfqvNhW2c"


Haven't tested but this H value might be specific to the ED25519 curve

Ok, will add the test with another curve to see if this still works.

mj850 · 2024-10-09T15:58:04Z

pkg/encryption/elgamal/common.go

+	}
+
+	// Initialize the scalar (private key) using the generated bytes
+	s, err := curves.ED25519().Scalar.SetBytesWide(scalarBytes[:])


This function uses the ED25519 curve directly - should either do this throughout (my preference) or use the curve under the teg object.

mj850 · 2024-10-09T16:03:30Z

pkg/encryption/elgamal/operations.go

+	G := teg.GetG()
+	// Create a scalar from the amount.
+	bigIntAmount := new(big.Int).SetUint64(amount)
+	scalarAmount, err := curves.ED25519().Scalar.SetBigInt(bigIntAmount)


Same comment here with using the curve

mj850 · 2024-10-09T16:03:42Z

pkg/encryption/elgamal/operations.go

+	G := teg.GetG()
+	// Create a scalar from the amount.
+	bigIntAmount := new(big.Int).SetUint64(amount)
+	scalarAmount, err := curves.ED25519().Scalar.SetBigInt(bigIntAmount)


Using the curve directly here

- Plug in new ED25519 curve constructors in tests

dssei · 2024-10-09T18:01:26Z

@mj850 addressed the comments, ptal

mj850 · 2024-10-09T19:16:19Z

pkg/encryption/elgamal/encryption.go

+	maxMapping map[MaxBits]bool
+}
+
+func NewTwistedElgamalWithED25519Curve() *TwistedElGamal {


Can we call this NewDefaultTwistedElgamal instead?

I imagine the users of this library would probably either one of:
us - for building the module in chain - would only use ED25519

not important since to us since we know what curve our module is using

sei builders - who want to build dapps to interact with the confidential tokens module etc.

Confusing because they need to figure out what curve to use?

other builders - who just want some encryption library

not important since they can use whatever curve they want

Removed the other constructor, making ED25519 curve the only option, and caching it in the field

mj850 · 2024-10-09T19:20:51Z

pkg/encryption/elgamal/encryption.go

+}
+
+// EncryptWithRand encrypts a message using the public key pk and a given random factor.
+func (teg TwistedElGamal) EncryptWithRand(pk curves.Point, message uint64, randomFactor curves.Scalar) (*Ciphertext, curves.Scalar, error) {


Actually would recommend not exposing this function - it was added to test certain properties about the proofs, but this should never be used to encrypt stuff since encryption should be done with a random value to be secure.

Made it private for now.

mj850 · 2024-10-09T19:22:46Z

pkg/encryption/elgamal/types.go

+
+	// Convert the byte arrays back into curve points
+	// Assuming `FromCompressed` is a method to parse compressed points
+	pointC, err := curves.ED25519().Point.FromAffineCompressed(temp.C)


Another instance of assuming the curve.

Will keep it (since ED25519) would be the only option, but reduce to just one invocation.

…init calls - add marshaling test

dssei · 2024-10-09T22:16:36Z

@mj850 addressed comments, ptal

mj850

LGTM!

dssei added 3 commits October 7, 2024 13:45

- initial code

3c6b6fa

- basic workflows

- fix unit tests path

6086fa7

- address linting issues

Merge branch 'main' of github.com:sei-protocol/sei-cryptography into …

f6ae4d5

…feature/init_and_workflows

dssei added 7 commits October 7, 2024 17:43

- update tests

4d9f8e2

- update readme

Twisted ElGamal

fca4d71

increase time out

3956e6c

increase time out to 20m

4762d5f

update setup to run elgamal tests in parallel

4ed93ee

more tests + refactoring

c27e96c

even more tests

6f9c8fc

dssei requested a review from mj850 October 8, 2024 23:34

golang docs

d66547c

dssei self-assigned this Oct 8, 2024

mj850 reviewed Oct 9, 2024

View reviewed changes

dssei added 2 commits October 9, 2024 10:35

address review comments

d2d9278

- More test for different curves.

c63c513

- Plug in new ED25519 curve constructors in tests

mj850 reviewed Oct 9, 2024

View reviewed changes

dssei added 2 commits October 9, 2024 14:48

- Only allow ED25519 curve for now, but cache it to reduce amount of …

906f272

…init calls - add marshaling test

- fix linting issue

ee26f2d

mj850 approved these changes Oct 9, 2024

View reviewed changes

dssei requested review from stevenlanders, besated and codebycarson October 9, 2024 23:35

stevenlanders approved these changes Oct 16, 2024

View reviewed changes

dssei merged commit b5ce267 into main Oct 16, 2024
11 checks passed

dssei deleted the feature/init_and_workflows branch October 16, 2024 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial code + basic workflows #1

Initial code + basic workflows #1

dssei commented Oct 7, 2024 •

edited

Loading

github-advanced-security bot commented Oct 7, 2024

mj850 left a comment

mj850 Oct 9, 2024

dssei Oct 9, 2024

mj850 Oct 9, 2024

mj850 Oct 9, 2024

dssei Oct 9, 2024

mj850 Oct 9, 2024

mj850 Oct 9, 2024

mj850 Oct 9, 2024

dssei commented Oct 9, 2024

mj850 Oct 9, 2024

dssei Oct 9, 2024

mj850 Oct 9, 2024

dssei Oct 9, 2024

mj850 Oct 9, 2024

dssei Oct 9, 2024

dssei commented Oct 9, 2024

mj850 left a comment

Initial code + basic workflows #1

Initial code + basic workflows #1

Conversation

dssei commented Oct 7, 2024 • edited Loading

github-advanced-security bot commented Oct 7, 2024

mj850 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dssei commented Oct 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dssei commented Oct 9, 2024

mj850 left a comment

Choose a reason for hiding this comment

dssei commented Oct 7, 2024 •

edited

Loading