Add utility for retrieving an LDK payment preimage#1216

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.

Sign up for GitHub

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

Merged
TheBlueMatt merged 4 commits into from
Dec 17, 2021
Merged

Add utility for retrieving an LDK payment preimage #1216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e0820c
Salt inbound payment ExpandedKey
valentinewallace Dec 17, 2021
d20239b
create_inbound_payment: warn about dup hashes
valentinewallace Dec 17, 2021
d734ad8
inbound_payment: DRY verify method for use in getting preimage
valentinewallace Dec 13, 2021
41cfd83
inbound_payment: Add utility to get payment preimage given hash/secret
valentinewallace Dec 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 65 additions & 20 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
use alloc::string::ToString;

@jkczyzjkczyzDec 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not needed?

@valentinewallacevalentinewallaceDec 17, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line

@jkczyzjkczyzDec 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;

@TheBlueMattTheBlueMattDec 17, 2021

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I don't get a compile warn here.

@jkczyzjkczyzDec 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364

@TheBlueMattTheBlueMattDec 17, 2021

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.

@jkczyzjkczyzDec 17, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string

use bitcoin::hashes::{Hash, HashEngine};
use bitcoin::hashes::cmp::fixed_time_eq;
use bitcoin::hashes::hmac::{Hmac, HmacEngine};
use bitcoin::hashes::sha256::Hash as Sha256;
use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
use ln::channelmanager::APIError;
use ln::msgs;
use ln::msgs::MAX_VALUE_MSAT;
use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

impl ExpandedKey {
pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
hkdf_extract_expand(&vec![0], &key_material)
hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
}
}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
where L::Target: Logger
{
let mut iv_bytes = [0; IV_LEN];
let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
iv_bytes.copy_from_slice(iv_slice);

let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
for i in 0..METADATA_LEN {
metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
}
let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
}
},
Ok(Method::LdkPaymentHash) => {
let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
hmac.input(&iv_bytes);
hmac.input(&metadata_bytes);
let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
return Err(())
match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
Ok(preimage) => payment_preimage = Some(preimage),
Err(bad_preimage_bytes) => {
log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
return Err(())
}
}
payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
},
Err(unknown_bits) => {
log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
Ok(payment_preimage)
}

pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
Ok(Method::LdkPaymentHash) => {
derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
.map_err(|bad_preimage_bytes| APIError::APIMisuseError {
err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
})
},
Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
}),
Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
}
}

fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
let mut iv_bytes = [0; IV_LEN];
let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
iv_bytes.copy_from_slice(iv_slice);

let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
for i in 0..METADATA_LEN {
metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
}

(iv_bytes, metadata_bytes)
}

// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
// this case.
fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
hmac.input(iv_bytes);
hmac.input(metadata_bytes);
let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
return Err(decoded_payment_preimage);
}
return Ok(PaymentPreimage(decoded_payment_preimage))
}

fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
let mut hmac = HmacEngine::<Sha256>::new(salt);
hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
/// the `min_value_msat` provided here, if one is provided.
///
/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
/// method may return an Err if another payment with the same payment_hash is still pending.
/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
/// note that LDK will not stop you from registering duplicate payment hashes for inbound
/// payments.
///
/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
}

/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
/// previously returned from [`create_inbound_payment`].
///
/// [`create_inbound_payment`]: Self::create_inbound_payment
pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
}

#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
let events = core::cell::RefCell::new(Vec::new());
Expand Down
34 changes: 33 additions & 1 deletion lightning/src/ln/payment_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
// it had already considered the payment fulfilled, and now they just got free money.
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
let chanmon_cfgs = create_chanmon_cfgs(2);
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

let amt_msat = 60_000;
let expiry_secs = 60 * 60;
let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
.with_features(InvoiceFeatures::known());
let scorer = test_utils::TestScorer::with_fixed_penalty(0);
let route = get_route(
&nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
check_added_monitors!(nodes[0], 1);

// Make sure to use `get_payment_preimage`
let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
let mut events = nodes[0].node.get_and_clear_pending_msg_events();
assert_eq!(events.len(), 1);
pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add utility for retrieving an LDK payment preimage#1216

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.

 Sign up for GitHub

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

 Merged

TheBlueMatt
merged 4 commits into

from

Dec 17, 2021
 Merged


Add utility for retrieving an LDK payment preimage
#1216
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
6e0820c

Salt inbound payment ExpandedKey


valentinewallace Dec 17, 2021
d20239b

create_inbound_payment: warn about dup hashes


valentinewallace Dec 17, 2021
d734ad8

inbound_payment: DRY verify method for use in getting preimage


valentinewallace Dec 13, 2021
41cfd83

inbound_payment: Add utility to get payment preimage given hash/secret


valentinewallace Dec 13, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


85 changes: 65 additions & 20 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,12 +73,14 @@ use core::ops::Deref;
use std::time::Instant;

mod inbound_payment {
	use alloc::string::ToString;
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Not needed?
@valentinewallacevalentinewallaceDec 17, 2021•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

cd lightning && cargo test --verbose --color always --no-default-features --features no-std (part of CI) fails without that line
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, I see. Seems other uses are covered by use prelude::*;
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I don't get a compile warn here.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

https://github.com/lightningdevkit/rust-lightning/actions/runs/1590076364
@TheBlueMattTheBlueMattDec 17, 2021

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Oh, no, I meant I don't get a compile warn that this use is unnecessary.
@jkczyzjkczyzDec 17, 2021

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Ah, just haven't seen that use elsewhere in the repo when needing to_string
	use bitcoin::hashes::{Hash, HashEngine};
	use bitcoin::hashes::cmp::fixed_time_eq;
	use bitcoin::hashes::hmac::{Hmac, HmacEngine};
	use bitcoin::hashes::sha256::Hash as Sha256;
	use chain::keysinterface::{KeyMaterial, KeysInterface, Sign};
	use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
	use ln::channelmanager::APIError;
	use ln::msgs;
	use ln::msgs::MAX_VALUE_MSAT;
	use util::chacha20::ChaCha20;
Expand DownExpand Up@@ -113,7 +115,7 @@ mod inbound_payment {

	impl ExpandedKey {
 pub(super) fn new(key_material: &KeyMaterial) -> ExpandedKey {
 hkdf_extract_expand(&vec![0], &key_material)
 hkdf_extract_expand(b"LDK Inbound Payment Key Expansion", &key_material)
 }
	}

Expand DownExpand Up@@ -237,15 +239,7 @@ mod inbound_payment {
	pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>
 where L::Target: Logger
	{
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_data.payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_data.payment_secret, keys);

 let payment_type_res = Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET);
 let mut amt_msat_bytes = [0; AMT_MSAT_LEN];
Expand All@@ -269,15 +263,13 @@ mod inbound_payment {
 }
 },
 Ok(Method::LdkPaymentHash) => {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(&iv_bytes);
 hmac.input(&metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 log_trace!(logger, "Failing HTLC with payment_hash {}: payment preimage {} did not match", log_bytes!(payment_hash.0), log_bytes!(decoded_payment_preimage));
 return Err(())
 match derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys) {
 Ok(preimage) => payment_preimage = Some(preimage),
 Err(bad_preimage_bytes) => {
 log_trace!(logger, "Failing HTLC with payment_hash {} due to mismatching preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes));
 return Err(())
 }
 }
 payment_preimage = Some(PaymentPreimage(decoded_payment_preimage));
 },
 Err(unknown_bits) => {
 log_trace!(logger, "Failing HTLC with payment hash {} due to unknown payment type {}", log_bytes!(payment_hash.0), unknown_bits);
Expand All@@ -298,6 +290,50 @@ mod inbound_payment {
 Ok(payment_preimage)
	}

	pub(super) fn get_payment_preimage(payment_hash: PaymentHash, payment_secret: PaymentSecret, keys: &ExpandedKey) -> Result<PaymentPreimage, APIError> {
 let (iv_bytes, metadata_bytes) = decrypt_metadata(payment_secret, keys);

 match Method::from_bits((metadata_bytes[0] & 0b1110_0000) >> METHOD_TYPE_OFFSET) {
 Ok(Method::LdkPaymentHash) => {
 derive_ldk_payment_preimage(payment_hash, &iv_bytes, &metadata_bytes, keys)
 .map_err(|bad_preimage_bytes| APIError::APIMisuseError {
 err: format!("Payment hash {} did not match decoded preimage {}", log_bytes!(payment_hash.0), log_bytes!(bad_preimage_bytes))
 })
 },
 Ok(Method::UserPaymentHash) => Err(APIError::APIMisuseError {
 err: "Expected payment type to be LdkPaymentHash, instead got UserPaymentHash".to_string()
 }),
 Err(other) => Err(APIError::APIMisuseError { err: format!("Unknown payment type: {}", other) }),
 }
	}

	fn decrypt_metadata(payment_secret: PaymentSecret, keys: &ExpandedKey) -> ([u8; IV_LEN], [u8; METADATA_LEN]) {
 let mut iv_bytes = [0; IV_LEN];
 let (iv_slice, encrypted_metadata_bytes) = payment_secret.0.split_at(IV_LEN);
 iv_bytes.copy_from_slice(iv_slice);

 let chacha_block = ChaCha20::get_single_block(&keys.metadata_key, &iv_bytes);
 let mut metadata_bytes: [u8; METADATA_LEN] = [0; METADATA_LEN];
 for i in 0..METADATA_LEN {
 metadata_bytes[i] = chacha_block[i] ^ encrypted_metadata_bytes[i];
 }

 (iv_bytes, metadata_bytes)
	}

	// Errors if the payment preimage doesn't match `payment_hash`. Returns the bad preimage bytes in
	// this case.
	fn derive_ldk_payment_preimage(payment_hash: PaymentHash, iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METADATA_LEN], keys: &ExpandedKey) -> Result<PaymentPreimage, [u8; 32]> {
 let mut hmac = HmacEngine::<Sha256>::new(&keys.ldk_pmt_hash_key);
 hmac.input(iv_bytes);
 hmac.input(metadata_bytes);
 let decoded_payment_preimage = Hmac::from_engine(hmac).into_inner();
 if !fixed_time_eq(&payment_hash.0, &Sha256::hash(&decoded_payment_preimage).into_inner()) {
 return Err(decoded_payment_preimage);
 }
 return Ok(PaymentPreimage(decoded_payment_preimage))
	}

	fn hkdf_extract_expand(salt: &[u8], ikm: &KeyMaterial) -> ExpandedKey {
 let mut hmac = HmacEngine::<Sha256>::new(salt);
 hmac.input(&ikm.0);
Expand DownExpand Up@@ -5026,8 +5062,9 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
	/// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
	/// the `min_value_msat` provided here, if one is provided.
	///
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
	/// method may return an Err if another payment with the same payment_hash is still pending.
	/// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
	/// note that LDK will not stop you from registering duplicate payment hashes for inbound
	/// payments.
	///
	/// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
	/// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
Expand DownExpand Up@@ -5079,6 +5116,14 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
	}

	/// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
	/// previously returned from [`create_inbound_payment`].
	///
	/// [`create_inbound_payment`]: Self::create_inbound_payment
	pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
	}

	#[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
	pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
 let events = core::cell::RefCell::new(Vec::new());
Expand Down

34 changes: 33 additions & 1 deletion
lightning/src/ln/payment_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,9 +15,10 @@ use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
use chain::transaction::OutPoint;
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
use ln::features::InitFeatures;
use ln::features::{InitFeatures, InvoiceFeatures};
use ln::msgs;
use ln::msgs::ChannelMessageHandler;
use routing::router::{Payee, get_route};
use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
use util::test_utils;
use util::errors::APIError;
Expand DownExpand Up@@ -706,3 +707,34 @@ fn test_fulfill_restart_failure() {
	// it had already considered the payment fulfilled, and now they just got free money.
	assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
}

#[test]
fn get_ldk_payment_preimage() {
	// Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
	let chanmon_cfgs = create_chanmon_cfgs(2);
	let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
	let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
	let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
	create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());

	let amt_msat = 60_000;
	let expiry_secs = 60 * 60;
	let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();

	let payee = Payee::from_node_id(nodes[1].node.get_our_node_id())
 .with_features(InvoiceFeatures::known());
	let scorer = test_utils::TestScorer::with_fixed_penalty(0);
	let route = get_route(
 &nodes[0].node.get_our_node_id(), &payee, &nodes[0].network_graph,
 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
	let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
	check_added_monitors!(nodes[0], 1);

	// Make sure to use `get_payment_preimage`
	let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
	let mut events = nodes[0].node.get_and_clear_pending_msg_events();
	assert_eq!(events.len(), 1);
	pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
	claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
}