Change the key encoding from base64 to hex #165

zhangchiqing · 2020-11-21T00:59:04Z

This PR changes the key encoding to be hex instead of the base64, which is the default for []byte

Why this matters?

Before this PR, the key generation will produce networking key and staking keys in base64 , for instance:

go run -tags relic ./cmd/bootstrap key --address "example.com:3569" --role "consensus" -o ./bootstrap/partner-node-infos

will produce :
Note the NetworkPubKey and StakingPubKey are both in base64

{
  "Role": "consensus",
  "Address": "example.com:3569",
  "NodeID": "f1c2f6590da364793f8515712855dae00b135d53de646a4f17f381b28a0cbd2b",
  "Stake": 0,
  "NetworkPubKey": "1b24gbD5zmVgj7r1texoptzoaMZSw1iixRZsvByShLIzyEzKvJP5seTr5U9xF4q7HLrNduc0QaVCqTYsZsSWmQ==",
  "StakingPubKey": "l6Xy4gEisi+kBSocoNdt1P1a+mdzLkOLPS6kXGYDFDFIw24bhBZYOIIz+tZ/QmBxByyByHS0ZurB3SjwOplBz7CVEtm5Fwx4Sk2l16s7izGSED7qzhNvScjVXTZX9Zxm"
}

After the change, it now produces:
Note both NetworkPubKey and StakingPubKey are in hex format

{
  "Role": "consensus",
  "Address": "example.com:3569",
  "NodeID": "0fac00c2ff673307f327a3516f2d41ebaf7ebda9fc7e4b85f20cd7ebdb9d9714",
  "Stake": 0,
  "NetworkPubKey": "aa795dd59ee9fe9f9cca92f162b99a568f08b2f6b63fe9c8f9b7b7e15a606b7c4d81ff698730c6292334816961fe8c4fccb3d8ffdff2fd5a8b50eb063f5d14d0",
  "StakingPubKey": "aa2e0da5a5a8501ae61e163ad51605b9227e14bf30db969d56b036a330b357ca66c2aabc6bac7b44ce6ab65331c6661409786a8a268ecddd1ee5fb247e46bd5e1c6b692208c6dca6a6a71f6f32bf45ff118a0032ee641f08384c01d6784a15af"
}

zhangchiqing · 2020-11-21T01:03:43Z

model/encodable/keys_test.go

@@ -23,6 +47,8 @@ func TestEncodableNetworkPubKey(t *testing.T) {
 	err = json.Unmarshal(enc, &dec)
 	require.NoError(t, err)
 	require.True(t, key.Equals(dec.PublicKey))
+
+	require.NoError(t, isHexString(enc))


this check will fail on master, because the previous encoding was base64

tarakby

Thanks Leo 👏

tarakby · 2020-11-21T01:38:44Z

model/encodable/keys.go

@@ -21,18 +34,19 @@ func (pub NetworkPubKey) MarshalJSON() ([]byte, error) {
 	if pub.PublicKey == nil {
 		return json.Marshal(nil)
 	}
-	return json.Marshal(pub.Encode())
+	return json.Marshal(toHex(pub.Encode()))


We could also call pub.String() but that function prefixes the value with 0x

yeah, didn't want to include 0x, because golang's hex.DecodeString doesn't handle that case

tarakby · 2020-11-21T01:40:00Z

model/encodable/keys_test.go

+	return err
+}
+
+func TestIsHexString(t *testing.T) {


The diff contains: - a lot of changes that concern parts of the library we don't use (other curves a la BN, BLS24-X, BLS12-383 ...), integer protocols (ETRS), field extension machinery ... - otherwise irrelevant changes, e.g. CI/CD - some memory bug fixing [Full Changeset](https://github.com/relic-toolkit/relic/compare/7a9bba7f..9206ae5) **Fixed bugs:** - Unexpected failure of ep2\_mul\[\_lwnaf\] above the prime group order [\onflow#64](relic-toolkit/relic#64) **Closed issues:** - Other way to construct towered extension fields [\onflow#203](relic-toolkit/relic#203) - blake2.h:101:5: error: size of array element is not a multiple of its alignment [\onflow#202](relic-toolkit/relic#202) - ECIES 160bit [\onflow#201](relic-toolkit/relic#201) - Compilation with "ARITH gmp" fails [\onflow#200](relic-toolkit/relic#200) - Support for armv8-a ? [\onflow#198](relic-toolkit/relic#198) - Function name bn\_init conflicts with OpenSSL when used in tandem [\onflow#196](relic-toolkit/relic#196) - 16-bit MSP430 [\onflow#193](relic-toolkit/relic#193) - Modular exponentiation returns 1 if exponent is 0 and modulo is 1 [\onflow#185](relic-toolkit/relic#185) - Compilation of RELIC with bls12-446 and bls12-455 fails [\onflow#182](relic-toolkit/relic#182) - test\_bn fails with BLS12-381 preset [\onflow#181](relic-toolkit/relic#181) - \[BUG\] undefined reference to `bench_init', `bench\_clean' [\onflow#180](relic-toolkit/relic#180) - Tests FTBFS because of missing symbol in header [\onflow#179](relic-toolkit/relic#179) - Builds are broken [\onflow#178](relic-toolkit/relic#178) - compile error inlining failed in call to always\_inline ‘\_mm\_alignr\_epi8’ on unbantu20.04 gcc9 [\onflow#177](relic-toolkit/relic#177) - bn\_write\_str buffer overflow [\onflow#176](relic-toolkit/relic#176) - ECDSA verify succeeds when it should fail [\onflow#175](relic-toolkit/relic#175) - ec\_mul\_gen hangs with curve SECG\_K256 [\onflow#174](relic-toolkit/relic#174) - Wrong square root computation [\onflow#173](relic-toolkit/relic#173) - Out-of-bounds read via bn\_sqr\_basic [\onflow#172](relic-toolkit/relic#172) - OSS-Fuzz integration [\onflow#171](relic-toolkit/relic#171) - Building Relic with Curve NIST\_P256 throws FATAL ERROR in relic\_fp\_prime.c:120 [\onflow#170](relic-toolkit/relic#170) - Compressing \(packing\) a point to binary array does not comply with X9.62 standard [\onflow#169](relic-toolkit/relic#169) - ‘ctx\_t’ {aka ‘struct \_ctx\_t’} has no member named ‘total’ [\onflow#168](relic-toolkit/relic#168) - relic does not work with C++ [\onflow#167](relic-toolkit/relic#167) - Memory leak in ep2\_curve\_init/clean with ALLOC=DYNAMIC [\onflow#166](relic-toolkit/relic#166) - \*\_is\_valid\(\) functions produce false negative for not normalized points [\onflow#147](relic-toolkit/relic#147) - Bench and Test doesnt build [\onflow#122](relic-toolkit/relic#122) **Merged pull requests:** - Add pairing delegation protocols [\onflow#199](relic-toolkit/relic#199) ([dfaranha](https://github.com/dfaranha)) - Fix support for Win64/MSVC targets. [\onflow#197](relic-toolkit/relic#197) ([dfaranha](https://github.com/dfaranha)) - Simplify generator getting for Gt. [\onflow#194](relic-toolkit/relic#194) ([luozejiaqun](https://github.com/luozejiaqun)) - cmake: Always use user defined CFLAGS, not only for release builds [\onflow#187](relic-toolkit/relic#187) ([xdustinface](https://github.com/xdustinface)) - Fix MinGW build [\onflow#186](relic-toolkit/relic#186) ([xdustinface](https://github.com/xdustinface)) - Remove debug printf in bn\_mxp\_slide [\onflow#184](relic-toolkit/relic#184) ([guidovranken](https://github.com/guidovranken)) - Remove ALLOC = STACK to simplify memory allocation. [\onflow#183](relic-toolkit/relic#183) ([dfaranha](https://github.com/dfaranha)) - Update relic\_alloc.h [\onflow#165](relic-toolkit/relic#165) ([aguycalled](https://github.com/aguycalled)) - Add correct support for FreeBSD and NetBSD [\onflow#164](relic-toolkit/relic#164) ([hoffmang9](https://github.com/hoffmang9))

zhangchiqing requested review from jordanschalm, tarakby, AlexHentschel and Kay-Zee November 21, 2020 00:59

zhangchiqing commented Nov 21, 2020

View reviewed changes

jordanschalm approved these changes Nov 21, 2020

View reviewed changes

zhangchiqing force-pushed the leo/encode-keys-as-hex branch from a389243 to e9add88 Compare November 21, 2020 01:05

tarakby approved these changes Nov 21, 2020

View reviewed changes

zhangchiqing requested a review from danuio November 21, 2020 22:29

zhangchiqing added 3 commits November 22, 2020 21:59

change key encoding to hex

a4001fd

update test case

33aa523

add more test cases

54465bc

zhangchiqing force-pushed the leo/encode-keys-as-hex branch from e9add88 to 54465bc Compare November 23, 2020 05:59

Fix unittests

14a1405

danuio approved these changes Nov 23, 2020

View reviewed changes

danuio and others added 2 commits November 23, 2020 11:47

Fix linting

a406926

small refactor

d86d022

zhangchiqing merged commit a9f6522 into master Nov 23, 2020

zhangchiqing deleted the leo/encode-keys-as-hex branch November 23, 2020 17:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change the key encoding from base64 to hex #165

Change the key encoding from base64 to hex #165

zhangchiqing commented Nov 21, 2020 •

edited

Loading

zhangchiqing Nov 21, 2020

tarakby left a comment

tarakby Nov 21, 2020

zhangchiqing Nov 21, 2020

tarakby Nov 21, 2020

Change the key encoding from base64 to hex #165

Change the key encoding from base64 to hex #165

Conversation

zhangchiqing commented Nov 21, 2020 • edited Loading

Why this matters?

zhangchiqing Nov 21, 2020

Choose a reason for hiding this comment

tarakby left a comment

Choose a reason for hiding this comment

tarakby Nov 21, 2020

Choose a reason for hiding this comment

zhangchiqing Nov 21, 2020

Choose a reason for hiding this comment

tarakby Nov 21, 2020

Choose a reason for hiding this comment

zhangchiqing commented Nov 21, 2020 •

edited

Loading