Limit SharedSecret to 32 byte buffer by tcharding · Pull Request #402 · rust-bitcoin/rust-secp256k1

tcharding · 2022-02-10T10:39:30Z

Currently SharedSecret provides a way to get a shared secret using SHA256 as well as a way to use a custom hash function to get the shared secret. Internally SharedSecret uses a 256 byte buffer, this is a tad wasteful. We would like to keep the current functionality but reduce memory usage.

Patch 1: Pulls the new_with_hash logic out into a standalone public function that just returns the 64 bytes representing the x,y co-ordinates of the computed shared secret point. Callers are then responsible for hashing this point to get the shared secret (idea by @Kixunil, thanks).
Patch 2: Does trivial refactor
Patch 3: Uses a 32 byte buffer internally for SharedSecret. This is basically a revert of the work @elichai did to add the custom hashing logic. @elichai please holla if you are not happy with me walking all over this code :)

Note to reviewers

Secret obfuscation is done on top of this in #396, they could be reviewed in order if this work is of interest to you.

src/ecdh.rs

apoelstra · 2022-02-10T15:44:19Z

The 256-byte buffer was added in #180 which tried to make the shared secret more generic. Unfortunately the discussion there is overwhelmed by safety discussion regarding panics and callbacks. But I think the motivation was that users might implement a callback that provides larger hashes, or serializes the whole point, or something like that.

I agree that 256 seems extraordinarily large and also looks like it might've been a confusion between bits and bytes. I will try to review this PR more carefully today and see if I can understand.

Kixunil · 2022-02-10T15:53:29Z

If custom hashing is still desired then I think SharedSecret should be generic with [u8; 32] being the default.

or serializes the whole point

To my knowledge this is a very bad idea and I'm not sure if the library should support it. At least without "dangerous" word being part of the API.

elichai · 2022-02-10T16:18:02Z

The point was to allow this function: https://docs.rs/secp256k1/latest/secp256k1/ecdh/struct.SharedSecret.html#method.new_with_hash to use something other than sha2, it could for example use sha512, or even something bigger(or a bit smaller like RIPEMD160). So I capped it at 256 bytes, there wasn't a specific reason for that number, I just thought that 64 bytes (e.g. sha512) is definitely reasonable, so I gave it a bit more leeway.

As for safety, why is that dangerous? the API requires at least 128 bits, and should be pretty safe AFAIU

Kixunil · 2022-02-10T16:27:25Z

As far as I understand if the point is used directly it could unexpectedly interact with other cryptography and cause vulnerabilities. That's why hashing is required.

elichai · 2022-02-10T17:23:04Z

As far as I understand if the point is used directly it could unexpectedly interact with other cryptography and cause vulnerabilities. That's why hashing is required.

Yeah, but sadly some applications hash only the x-coordinate while others hash the full compressed point. Also, some applications might want to use a domain separated hash function

Kixunil · 2022-02-10T17:36:58Z

Sure, I have no problem with custom hash functions.

tcharding · 2022-02-16T09:11:15Z

I've implemented all review suggestions but I'm still unsure from the discussion if this PR is a good idea or not?

The point was to allow this function: https://docs.rs/secp256k1/latest/secp256k1/ecdh/struct.SharedSecret.html#method.new_with_hash to use something other than sha2, it could for example use sha512, or even something bigger(or a bit smaller like RIPEMD160).

Does this mean this PR is not useful and we should keep the current implementation in your opinion @elichai?

Kixunil · 2022-02-16T10:00:39Z

@tcharding I believe if variable-sized hash function is still required then generic parameter is the best way to go.

tcharding · 2022-02-16T18:40:05Z

I messed around a bit with this but cannot work out how to do it in a way that is cleaner than the code is now. If you feel like writing up some ideas please do but its not really that important. I'll just close this after a while if nothing comes of it.

Cheers

Kixunil · 2022-02-17T10:20:15Z

I will try to do it to better understand where the problem is.

elichai · 2022-02-17T12:44:44Z

I'm not sure what's the motivation here or what's the problem you're trying to fix.

Is it not to "waste" 256 bytes for what's usually just 32 bytes?
if so, then:

Is that really a problem/bottleneck?
We can try and sprinkle some generics over it or make the custom hash one accept a mutable reference for the output array or something like that.

Kixunil · 2022-02-17T12:50:00Z

Not just bottleneck but also makes code confusing and forces us to track the actual length.

apoelstra · 2022-02-17T14:28:49Z

I wouldn't mind a PR to change the size to 64 bytes, which would let users get the whole point out (I know, a bad idea, but we've made it fairly unergonomic and this is needed for some deployed systems), and then if they actually need some crazy-wide hash they can just pull the explicit point out of the SharedSecret and do it themselves.

If anything there is value in reducing "256" because it is a confusing number.

Kixunil · 2022-02-17T15:20:33Z

How about having a standalone function computing the point that doesn't use the SharedSecret type? Could be named with dangerous_ prefix and documentation saying it should be hashed.

apoelstra · 2022-02-17T17:03:46Z

I'm ambivalent -- my feeling is the custom hash API is already dangerous, because you can put a broken hash in there, and also unergonomic relative to just using the default. So I think the current situation is ok, and adding more_dangerous functions would be an incomplete solution and increase the API surface.

Kixunil · 2022-02-17T19:51:41Z

Sorry, I meant to replace the current custom hash API with a standalone function. SharedSecret would use sha256 only.

apoelstra · 2022-02-17T20:16:55Z

I'd be fine with that.

In preparation for simplifying the `SharedSecret` internals pull the `new_with_hash` function logic out into a standalone public function that provides similar functionality without use of the `SharedSecret` struct. Function now returns the 64 bytes of data representing a shared point on the curve, callers are expected to the hash these bytes to get a shared secret.

tcharding · 2022-02-18T09:58:36Z

I've done a total re-write with ideas from the thread of discussion above. The PR message has been re-written. Thanks.

src/ecdh.rs

Kixunil · 2022-02-18T10:11:32Z

src/ecdh.rs

+    fn as_ref(&self) -> &[u8] {
+        &self.0
+    }
+}


I think Borrow would be also useful.

oh yes, this was discussed elsewhere already recently, my bad. Just to clarify, we should use Borrow and remove AsRef, right?

We have src/ecdsa/mod.rs:83:impl AsRef<[u8]> for SerializedSignature {, should this be changed to implement Borrow instead?

No, we should implement both AsRef and Borrow for shared secret.
For other types we have to evaluate them one-by-one since Borrow<U> for T requires that T::Eq and T::Hash behave exactly same as U::Eq and U::Hash provided the instance of U was obtained by calling Borrow on T.

No, we should implement both AsRef and Borrow for shared secret.

Cool, will add.

since Borrow for T requires that T::Eq and T::Hash behave exactly same as U::Eq and U::Hash provided the instance of U was obtained by calling Borrow on T.

I read that in the docs but I do not understand what it implies. I'll have to take direction from others on this until I do get it.

Your code is correct. It would've been incorrect if SharedSecret overrode Hash or Eq implementation to behave differently than one on the slice it returns.

Kixunil · 2022-02-18T10:15:43Z

src/ecdh.rs

-        let mut ss = SharedSecret::empty();
+        let mut buf = [0u8; 32];
        let res = unsafe {
             ffi::secp256k1_ecdh(


I'm not sure this is better than calling shared_secret_point and then hashing it. If it is, then a test that compares them would be useful.

~~Of course, that is better. Thanks~~ Doing so would introduce a dependency on bitocin_hashes (assuming we used that lib to do the hashing) where as now bitcoin_hashes dependency is optional. Left as is for now.

That's a good reason, I believe. OTOH it annoys me that there are two SHA256 implementations in the code if you enable bitcoin_hashes

Do you mean, the implementation inside libsecp as well as the implementation in bitcoin_hashes? That is a problem for all users of libsecp, even upstream, and has been the subject of much discussion e.g. bitcoin-core/secp256k1#702

For now there's nothing we can do about it from the Rust bindings. (Well, ok, we could actually expose the hash functionality ourselves by patching the vendored library, but I think the solution we'd rather have is to somehow use the bitcoin_hashes implementations when available.)

Yes, I meant it. Would be a nice change later if/when it's available.

tcharding · 2022-02-18T10:56:18Z

Thanks @Kixunil, implemented suggestions and force pushed!

src/ecdh.rs

The `SharedSecret` uses sha256 to hash the secret, this implies the secret is 32 bytes of data. Currently we use a buffer of 256 bytes, this is unnecessary. Change the implementation of `SharedSecret` to use a 32 byte buffer.

apoelstra · 2022-02-21T15:14:17Z

no_std_test/src/main.rs

-        y.into()
-    });
-    assert_ne!(x_arr, [0u8; 32]);
-    assert_ne!(&y_arr[..], &[0u8; 32][..]);


In 834f63c:

I think you coulrd've kept these asserts in place.

When removing these I could not see what functionality they were testing that was specific to no-std, so I removed them. Or am I missing something? If a test that checks the point returned is non-zero is useful I can add it as a unit test, but again, I don't understand the value of it.

I think they were just there as a sanity check. I agree they don't seem to have a very clear value (and also that they should be a unit test, if they exist at all).

apoelstra

ACK 5603d71

apoelstra · 2022-02-23T18:51:49Z

@Kixunil do you have open issues here or can I merge this?

Kixunil · 2022-02-23T19:54:04Z

I don't see any obvious defect but wasn't able to review deeply. The change is quite simple so I guess that's OK.

dspicher · 2022-03-10T10:53:29Z

This PR removed the possibility to create a SharedSecret from a byte serialization, also from the still applying [u8; 32]. Was this intentional?

Kixunil · 2022-03-10T10:56:24Z

@dspicher good question. I don't think it was intentional but I don't see a huge harm. Why would anyone pretend that some arbitrary bytes are shared secret? Why would anyone compute the actual secret differently than calling SharedSecret::new()?

dspicher · 2022-03-10T11:00:38Z

In my case, they are not arbitrary bytes but arise from a previous serialization of a valid SharedSecret, for example for storage in a database.

Kixunil · 2022-03-10T11:15:14Z

I'm not sure if it's a good idea to store SharedSecret but that use case sounds reasonable. You could also just turn SharedSecret into an array or better your own specific newtype. Still seems better to support it.

apoelstra · 2022-03-10T13:39:35Z

Yeah, oops, we should support this. FWIW I think you can get this effect through the serde API.

apoelstra · 2022-03-10T13:40:28Z

Oh, it looks like we don't even have serde de/serialization for this type. We should.

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

463148f bump version to 0.22.1 (Dominik Spicher) 9be8e74 Allow SharedSecret to be created from byte array (Dominik Spicher) Pull request description: This was accidentally removed in 8b2edad. See also the discussion on #402 Closes #416. ACKs for top commit: apoelstra: ACK 463148f Tree-SHA512: 04e16226efa2cf6fd461eabb0c78e5b00f347c78e20c1c7561591ffa74a7259fb3265b49a9d7326caf70e4d5ce32a620485f1bd5538c292654f91eb68c2a57dc

@Kixunil

…buffer 5603d71ad3057ab2572c508b057b7e10f9ae0595 Limit SharedSecret to 32 byte buffer (Tobin Harding) d5eeb099ad2fea4b28e7a72464224e1fd5355de9 Use more intuitive local var numbering (Tobin Harding) 834f63c26cf8b479c1fb288f9887ab72221b3303 Separate new_with_hash into public function (Tobin Harding) Pull request description: Currently `SharedSecret` provides a way to get a shared secret using SHA256 _as well as_ a way to use a custom hash function to get the shared secret. Internally `SharedSecret` uses a 256 byte buffer, this is a tad wasteful. We would like to keep the current functionality but reduce memory usage. - Patch 1: Pulls the `new_with_hash` logic out into a standalone public function that just returns the 64 bytes representing the x,y co-ordinates of the computed shared secret point. Callers are then responsible for hashing this point to get the shared secret (idea by @Kixunil, thanks). - Patch 2: Does trivial refactor - Patch 3: Uses a 32 byte buffer internally for `SharedSecret`. This is basically a revert of the work @elichai did to add the custom hashing logic. @elichai please holla if you are not happy with me walking all over this code :) ### Note to reviewers Secret obfuscation is done on top of this in rust-bitcoin/rust-secp256k1#396, they could be reviewed in order if this work is of interest to you. ACKs for top commit: apoelstra: ACK 5603d71ad3057ab2572c508b057b7e10f9ae0595 Tree-SHA512: 48982a4a6a700a111e4c1d5d21d62503d34f433d8cb303d11ff018d2f2be2467fa806107018db16b6d0fcc5ff1a0325dd5790c62c47831c7cd2141a1b6f9467d

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402

…ed from byte array 463148f9a0a316c5f2cf5cb89078ed59d87dfdf6 bump version to 0.22.1 (Dominik Spicher) 9be8e7410751f47e8b5d2ab90945a7618482bd0e Allow SharedSecret to be created from byte array (Dominik Spicher) Pull request description: This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402 Closes #416. ACKs for top commit: apoelstra: ACK 463148f9a0a316c5f2cf5cb89078ed59d87dfdf6 Tree-SHA512: 04e16226efa2cf6fd461eabb0c78e5b00f347c78e20c1c7561591ffa74a7259fb3265b49a9d7326caf70e4d5ce32a620485f1bd5538c292654f91eb68c2a57dc

@Kixunil

…buffer 5603d71ad3057ab2572c508b057b7e10f9ae0595 Limit SharedSecret to 32 byte buffer (Tobin Harding) d5eeb099ad2fea4b28e7a72464224e1fd5355de9 Use more intuitive local var numbering (Tobin Harding) 834f63c26cf8b479c1fb288f9887ab72221b3303 Separate new_with_hash into public function (Tobin Harding) Pull request description: Currently `SharedSecret` provides a way to get a shared secret using SHA256 _as well as_ a way to use a custom hash function to get the shared secret. Internally `SharedSecret` uses a 256 byte buffer, this is a tad wasteful. We would like to keep the current functionality but reduce memory usage. - Patch 1: Pulls the `new_with_hash` logic out into a standalone public function that just returns the 64 bytes representing the x,y co-ordinates of the computed shared secret point. Callers are then responsible for hashing this point to get the shared secret (idea by @Kixunil, thanks). - Patch 2: Does trivial refactor - Patch 3: Uses a 32 byte buffer internally for `SharedSecret`. This is basically a revert of the work @elichai did to add the custom hashing logic. @elichai please holla if you are not happy with me walking all over this code :) ### Note to reviewers Secret obfuscation is done on top of this in rust-bitcoin/rust-secp256k1#396, they could be reviewed in order if this work is of interest to you. ACKs for top commit: apoelstra: ACK 5603d71ad3057ab2572c508b057b7e10f9ae0595 Tree-SHA512: 48982a4a6a700a111e4c1d5d21d62503d34f433d8cb303d11ff018d2f2be2467fa806107018db16b6d0fcc5ff1a0325dd5790c62c47831c7cd2141a1b6f9467d

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402

…ed from byte array 463148f9a0a316c5f2cf5cb89078ed59d87dfdf6 bump version to 0.22.1 (Dominik Spicher) 9be8e7410751f47e8b5d2ab90945a7618482bd0e Allow SharedSecret to be created from byte array (Dominik Spicher) Pull request description: This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402 Closes #416. ACKs for top commit: apoelstra: ACK 463148f9a0a316c5f2cf5cb89078ed59d87dfdf6 Tree-SHA512: 04e16226efa2cf6fd461eabb0c78e5b00f347c78e20c1c7561591ffa74a7259fb3265b49a9d7326caf70e4d5ce32a620485f1bd5538c292654f91eb68c2a57dc

tcharding mentioned this pull request Feb 10, 2022

Obfuscate shared secret when printing #396

Merged

tcharding force-pushed the shared-secret-32-bytes branch from 721637b to c266e11 Compare February 10, 2022 10:53

Kixunil reviewed Feb 10, 2022

View reviewed changes

src/ecdh.rs Show resolved Hide resolved

src/ecdh.rs Outdated Show resolved Hide resolved

src/ecdh.rs Show resolved Hide resolved

tcharding force-pushed the shared-secret-32-bytes branch from c266e11 to f9d674a Compare February 16, 2022 09:09

tcharding force-pushed the shared-secret-32-bytes branch from f9d674a to 5dd7d4a Compare February 18, 2022 09:51

Kixunil reviewed Feb 18, 2022

View reviewed changes

tcharding force-pushed the shared-secret-32-bytes branch 2 times, most recently from 2f2eb35 to b9afd27 Compare February 18, 2022 10:55

Kixunil reviewed Feb 18, 2022

View reviewed changes

src/ecdh.rs Show resolved Hide resolved

src/ecdh.rs Show resolved Hide resolved

tcharding force-pushed the shared-secret-32-bytes branch from b9afd27 to c7c8056 Compare February 20, 2022 12:29

tcharding force-pushed the shared-secret-32-bytes branch from d22f1c0 to 1ae9a53 Compare February 21, 2022 13:17

Limit SharedSecret to 32 byte buffer

5603d71

The `SharedSecret` uses sha256 to hash the secret, this implies the secret is 32 bytes of data. Currently we use a buffer of 256 bytes, this is unnecessary. Change the implementation of `SharedSecret` to use a 32 byte buffer.

tcharding force-pushed the shared-secret-32-bytes branch from 1ae9a53 to 5603d71 Compare February 21, 2022 13:33

apoelstra reviewed Feb 21, 2022

View reviewed changes

apoelstra approved these changes Feb 21, 2022

View reviewed changes

apoelstra mentioned this pull request Feb 23, 2022

update libsecp to latest ersion; bump major version number #384

Merged

apoelstra merged commit 8b2edad into rust-bitcoin:master Feb 24, 2022

tcharding deleted the shared-secret-32-bytes branch March 1, 2022 16:21

apoelstra mentioned this pull request Mar 10, 2022

SharedSecret should have a "deserialize from bytes" method and serde impls #416

Closed

dspicher added a commit to dspicher/rust-secp256k1 that referenced this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array

6b2c4d4

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

dspicher mentioned this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array #417

Merged

dspicher added a commit to dspicher/rust-secp256k1 that referenced this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array

16e37ec

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

dspicher added a commit to dspicher/rust-secp256k1 that referenced this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array

f78ac8c

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

dspicher added a commit to dspicher/rust-secp256k1 that referenced this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array

30ab354

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

dspicher added a commit to dspicher/rust-secp256k1 that referenced this pull request Mar 10, 2022

Allow SharedSecret to be created from byte array

9be8e74

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin#402

chain-forgexcr45 added a commit to chain-forgexcr45/rust-secp256k1 that referenced this pull request Sep 28, 2025

Allow SharedSecret to be created from byte array

3a1bbc9

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402

william2332-limf added a commit to william2332-limf/rust-secp256k1 that referenced this pull request Oct 2, 2025

Allow SharedSecret to be created from byte array

286363f

This was accidentally removed in 8b2edad. See also the discussion on rust-bitcoin/rust-secp256k1#402

Conversation

tcharding commented Feb 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Note to reviewers

Uh oh!

Uh oh!

Uh oh!

Uh oh!

apoelstra commented Feb 10, 2022

Uh oh!

Kixunil commented Feb 10, 2022

Uh oh!

elichai commented Feb 10, 2022

Uh oh!

Kixunil commented Feb 10, 2022

Uh oh!

elichai commented Feb 10, 2022

Uh oh!

Kixunil commented Feb 10, 2022

Uh oh!

tcharding commented Feb 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Kixunil commented Feb 16, 2022

Uh oh!

tcharding commented Feb 16, 2022

Uh oh!

Kixunil commented Feb 17, 2022

Uh oh!

elichai commented Feb 17, 2022

Uh oh!

Kixunil commented Feb 17, 2022

Uh oh!

apoelstra commented Feb 17, 2022

Uh oh!

Kixunil commented Feb 17, 2022

Uh oh!

apoelstra commented Feb 17, 2022

Uh oh!

Kixunil commented Feb 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apoelstra commented Feb 17, 2022

Uh oh!

tcharding commented Feb 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tcharding Feb 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tcharding commented Feb 18, 2022

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tcharding commented Feb 10, 2022 •

edited

Loading

tcharding commented Feb 16, 2022 •

edited

Loading

Kixunil commented Feb 17, 2022 •

edited

Loading

tcharding Feb 18, 2022 •

edited

Loading

dspicher commented Mar 10, 2022 •

edited

Loading