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 BIP352 silentpayments module #1519

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
51 changes: 51 additions & 0 deletions include/secp256k1_silentpayments.h
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,57 @@ SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_silentpayments_sender_c
size_t n_plain_seckeys
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(5);

/** Create Silent Payment label tweak and label.
*
* Given a recipient's scan key b_scan and a label integer m, calculate the
* corresponding label tweak and label:
*
* label_tweak = hash(b_scan || m)
* label = label_tweak * G
*
* Returns: 1 if label tweak and label creation was successful.
* 0 if an error occured.
* Args: ctx: pointer to a context object
* Out: label: pointer to the resulting label public key
* label_tweak32: pointer to the 32 byte label tweak
* In: recipient_scan_key: pointer to the recipient's scan key
* m: label integer (0 is used for change outputs)
*/
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_silentpayments_recipient_create_label_tweak(
Copy link
Contributor

Choose a reason for hiding this comment

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

micronit: could be just called secp256k1_silentpayments_recipient_create_label to save typing because it computes both label and tweak.

const secp256k1_context *ctx,
secp256k1_pubkey *label,
unsigned char *label_tweak32,
const unsigned char *recipient_scan_key,
Copy link

Choose a reason for hiding this comment

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

nit: this change makes it clear that what is expected is the secret key

Suggested change
const unsigned char *recipient_scan_key,
const unsigned char *recipient_scan_seckey,

Copy link
Member Author

Choose a reason for hiding this comment

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

The scan key isn't really a secret key, so I've been trying to avoid using seckey in the variable names. Conceptually, a scan key is more similar to an xpub in that whoever has the scan key can find the transactions, but cannot spend them. The scan key is also safe to give to a 3rd party without loss of funds. In hindsight, we probably should have chosen a better name in the BIP e.g. scan entropy or scan code (like chain code).

unsigned int m
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4);

/** Create Silent Payment labelled spend public key.
*
* Given a recipient's spend public key B_spend and a label, calculate the
* corresponding serialized labelled spend public key:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* corresponding serialized labelled spend public key:
* corresponding labelled spend public key:

(I assume that's a leftover from an earlier version of the API where the resulting label was indeed serialized)

*
* B_m = B_spend + label
*
* The result is used by the recipient to create a Silent Payment address,
* consisting of the serialized and concatenated scan public key and
* (labelled) spend public key each.
*
* Returns: 1 if labelled spend public key creation was successful.
* 0 if an error occured.
* Args: ctx: pointer to a context object
* Out: labelled_spend_pubkey: pointer to the resulting labelled spend
* public key
* In: recipient_spend_pubkey: pointer to the recipient's spend pubkey
* label: pointer to the the recipient's label public
* key
*/
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(
const secp256k1_context *ctx,
secp256k1_pubkey *labelled_spend_pubkey,
const secp256k1_pubkey *recipient_spend_pubkey,
const secp256k1_pubkey *label
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4);

#ifdef __cplusplus
}
#endif
Expand Down
70 changes: 70 additions & 0 deletions src/modules/silentpayments/main_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -252,4 +252,74 @@ int secp256k1_silentpayments_sender_create_outputs(
return ret;
}

/** Set hash state to the BIP340 tagged hash midstate for "BIP0352/Label". */
static void secp256k1_silentpayments_sha256_init_label(secp256k1_sha256* hash) {
secp256k1_sha256_initialize(hash);
hash->s[0] = 0x26b95d63ul;
hash->s[1] = 0x8bf1b740ul;
hash->s[2] = 0x10a5986ful;
hash->s[3] = 0x06a387a5ul;
hash->s[4] = 0x2d1c1c30ul;
hash->s[5] = 0xd035951aul;
hash->s[6] = 0x2d7f0f96ul;
hash->s[7] = 0x29e3e0dbul;

hash->bytes = 64;
}

int secp256k1_silentpayments_recipient_create_label_tweak(const secp256k1_context *ctx, secp256k1_pubkey *label, unsigned char *label_tweak32, const unsigned char *recipient_scan_key, unsigned int m) {
secp256k1_sha256 hash;
unsigned char m_serialized[4];

/* Sanity check inputs. */
VERIFY_CHECK(ctx != NULL);
ARG_CHECK(label != NULL);
ARG_CHECK(label_tweak32 != NULL);
ARG_CHECK(recipient_scan_key != NULL);

/* Compute label_tweak = hash(ser_256(b_scan) || ser_32(m)) [sha256 with tag "BIP0352/Label"] */
secp256k1_silentpayments_sha256_init_label(&hash);
secp256k1_sha256_write(&hash, recipient_scan_key, 32);
secp256k1_write_be32(m_serialized, m);
secp256k1_sha256_write(&hash, m_serialized, sizeof(m_serialized));
secp256k1_sha256_finalize(&hash, label_tweak32);

/* Compute label = label_tweak * G */
return secp256k1_ec_pubkey_create(ctx, label, label_tweak32);
}

int secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(const secp256k1_context *ctx, secp256k1_pubkey *labelled_spend_pubkey, const secp256k1_pubkey *recipient_spend_pubkey, const secp256k1_pubkey *label) {
secp256k1_ge B_m, label_addend;
secp256k1_gej result_gej;
secp256k1_ge result_ge;
int ret;

/* Sanity check inputs. */
VERIFY_CHECK(ctx != NULL);
ARG_CHECK(labelled_spend_pubkey != NULL);
ARG_CHECK(recipient_spend_pubkey != NULL);
ARG_CHECK(label != NULL);

/* Calculate B_m = B_spend + label
* If either the label or spend public key is an invalid public key,
* return early
*/
ret = secp256k1_pubkey_load(ctx, &B_m, recipient_spend_pubkey);
ret &= secp256k1_pubkey_load(ctx, &label_addend, label);
if (!ret) {
return ret;
}
secp256k1_gej_set_ge(&result_gej, &B_m);
secp256k1_gej_add_ge_var(&result_gej, &result_gej, &label_addend, NULL);
Copy link
Contributor

Choose a reason for hiding this comment

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

should we add a check here if the result is the point at infinity and return 0?

if (secp256k1_gej_is_infinity(&result_gej)) {
return 0;
}

/* Serialize B_m */
secp256k1_ge_set_gej(&result_ge, &result_gej);
secp256k1_pubkey_save(labelled_spend_pubkey, &result_ge);

return 1;
}

#endif
27 changes: 27 additions & 0 deletions src/modules/silentpayments/tests_impl.h
Original file line number Diff line number Diff line change
Expand Up @@ -225,9 +225,36 @@ static void test_send_api(void) {
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_sender_create_outputs(CTX, op, rp, 1, SMALLEST_OUTPOINT, NULL, 0, p, 1));
}

static void test_label_api(void) {
secp256k1_pubkey l, s, ls, e; /* label pk, spend pk, labelled spend pk, expected labelled spend pk */
unsigned char lt[32]; /* label tweak */
const unsigned char expected[33] = {
0x03,0xdc,0x7f,0x09,0x9a,0xbe,0x95,0x7a,
0x58,0x43,0xd2,0xb6,0xbb,0x35,0x79,0x61,
0x5c,0x60,0x36,0xa4,0x9b,0x86,0xf4,0xbe,
0x46,0x38,0x60,0x28,0xa8,0x1a,0x77,0xd4,0x91
};

/* Create a label and labelled spend public key, verify we get the expected result */
CHECK(secp256k1_ec_pubkey_parse(CTX, &s, BOB_ADDRESS[1], 33));
CHECK(secp256k1_silentpayments_recipient_create_label_tweak(CTX, &l, lt, ALICE_SECKEY, 1));
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: could also check the label and label tweak results here

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, although the values are used in the next call, _create_labelled_spend_pubkey and then the final result of that is checked against an exact expected value, so the extra checks don't seem worth the added verbosity?

CHECK(secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(CTX, &ls, &s, &l));
CHECK(secp256k1_ec_pubkey_parse(CTX, &e, expected, 33));
CHECK(secp256k1_ec_pubkey_cmp(CTX, &ls, &e) == 0);

/* Check null values are handled */
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_label_tweak(CTX, NULL, lt, ALICE_SECKEY, 1));
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_label_tweak(CTX, &l, NULL, ALICE_SECKEY, 1));
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_label_tweak(CTX, &l, lt, NULL, 1));
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(CTX, NULL, &s, &l));
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(CTX, &ls, NULL, &l));
CHECK_ILLEGAL(CTX, secp256k1_silentpayments_recipient_create_labelled_spend_pubkey(CTX, &ls, &s, NULL));
}

void run_silentpayments_tests(void) {
test_recipient_sort();
test_send_api();
test_label_api();
}

#endif