Skip to content

Fix race between handshake_complete and timer_tick_occurred#2993

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 1 commit into from
Apr 15, 2024
Merged

Fix race between handshake_complete and timer_tick_occurred #2993

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
104 changes: 101 additions & 3 deletions lightning/src/ln/peer_handler.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
let networks = self.message_handler.chan_handler.get_chain_hashes();
let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
self.enqueue_message(peer, &resp);
peer.awaiting_pong_timer_tick_intervals = 0;
},
NextNoiseStep::ActThree => {
let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
let networks = self.message_handler.chan_handler.get_chain_hashes();
let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
self.enqueue_message(peer, &resp);
peer.awaiting_pong_timer_tick_intervals = 0;
},
NextNoiseStep::NoiseComplete => {
if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
return Err(PeerHandleError { }.into());
}

peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.
peer_lock.their_features = Some(msg.features);
return Ok(None);
} else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
use crate::ln::ChannelId;
use crate::ln::features::{InitFeatures, NodeFeatures};
use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
use crate::ln::{msgs, wire};
use crate::ln::msgs::{LightningError, SocketAddress};
use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
}

#[test]
fn test_inbound_conn_handshake_complete_awaiting_pong() {
// Test that we do not disconnect an outbound peer after the noise handshake completes due
// to a pong timeout for a ping that was never sent if a timer tick fires after we send act
// two of the noise handshake along with our init message but before we receive their init
// message.
let logger = test_utils::TestLogger::new();
let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
let peer_a = PeerManager::new(MessageHandler {
chan_handler: ErroringMessageHandler::new(),
route_handler: IgnoringMessageHandler {},
onion_message_handler: IgnoringMessageHandler {},
custom_message_handler: IgnoringMessageHandler {},
}, 0, &[0; 32], &logger, &node_signer_a);
let peer_b = PeerManager::new(MessageHandler {
chan_handler: ErroringMessageHandler::new(),
route_handler: IgnoringMessageHandler {},
onion_message_handler: IgnoringMessageHandler {},
custom_message_handler: IgnoringMessageHandler {},
}, 0, &[1; 32], &logger, &node_signer_b);

let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
let mut fd_a = FileDescriptor {
fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
disconnect: Arc::new(AtomicBool::new(false)),
};
let mut fd_b = FileDescriptor {
fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
disconnect: Arc::new(AtomicBool::new(false)),
};

// Exchange messages with both peers until they both complete the init handshake.
let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
peer_a.process_events();

let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
peer_b.process_events();

// Calling this here triggers the race on inbound connections.
peer_b.timer_tick_occurred();

let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
peer_a.process_events();
assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
assert!(!init_a.is_empty());

assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
peer_b.process_events();
assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

// Make sure we're still connected.
assert_eq!(peer_b.peers.read().unwrap().len(), 1);

// B should send a ping on the first timer tick after `handshake_complete`.
assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
peer_b.timer_tick_occurred();
peer_b.process_events();
assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

let mut send_warning = || {
{
let peers = peer_a.peers.read().unwrap();
let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
channel_id: ChannelId([0; 32]),
data: "no disconnect plz".to_string(),
});
}
peer_a.process_events();
let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
assert!(!msg.is_empty());
assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
peer_b.process_events();
};

// Fire more ticks until we reach the pong timeout. We send any message except pong to
// pretend the connection is still alive.
send_warning();
for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
peer_b.timer_tick_occurred();
send_warning();
}
assert_eq!(peer_b.peers.read().unwrap().len(), 1);

// One more tick should enforce the pong timeout.
peer_b.timer_tick_occurred();
assert_eq!(peer_b.peers.read().unwrap().len(), 0);
}

#[test]
fn test_filter_addresses(){
// Tests the filter_addresses function.
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix race between handshake_complete and timer_tick_occurred by wpaulino · Pull Request #2993 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix race between handshake_complete and timer_tick_occurred#2993

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down

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

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down

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

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down

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

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix race between handshake_complete and timer_tick_occurred by wpaulino · Pull Request #2993 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix race between handshake_complete and timer_tick_occurred#2993

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
Fix race between handshake_complete and timer_tick_occurred by wpaulino · Pull Request #2993 · lightningdevkit/rust-lightning · GitHub
Skip to content
Fix race between handshake_complete and timer_tick_occurred#2993

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 1 commit into

from

Apr 15, 2024
 Merged


Fix race between handshake_complete and timer_tick_occurred
#2993
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


104 changes: 101 additions & 3 deletions
lightning/src/ln/peer_handler.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1475,7 +1475,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::ActThree => {
 let their_node_id = try_potential_handleerror!(peer,
Expand All@@ -1488,7 +1487,6 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 let networks = self.message_handler.chan_handler.get_chain_hashes();
 let resp = msgs::Init { features, networks, remote_network_address: filter_addresses(peer.their_socket_address.clone()) };
 self.enqueue_message(peer, &resp);
 peer.awaiting_pong_timer_tick_intervals = 0;
 },
 NextNoiseStep::NoiseComplete => {
 if peer.pending_read_is_header {
Expand DownExpand Up@@ -1681,6 +1679,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, OM: Deref, L: Deref, CM
 return Err(PeerHandleError { }.into());
 }

 peer_lock.awaiting_pong_timer_tick_intervals = 0;
Comment thread
wpaulino marked this conversation as resolved.

 peer_lock.their_features = Some(msg.features);
 return Ok(None);
 } else if peer_lock.their_features.is_none() {
Expand DownExpand Up@@ -2674,7 +2673,7 @@ mod tests {
	use crate::ln::ChannelId;
	use crate::ln::features::{InitFeatures, NodeFeatures};
	use crate::ln::peer_channel_encryptor::PeerChannelEncryptor;
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses};
	use crate::ln::peer_handler::{CustomMessageHandler, PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler, filter_addresses, ErroringMessageHandler, MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER};
	use crate::ln::{msgs, wire};
	use crate::ln::msgs::{LightningError, SocketAddress};
	use crate::util::test_utils;
Expand DownExpand Up@@ -3216,6 +3215,105 @@ mod tests {
 assert!(peers[0].read_event(&mut fd_a, &b_data).is_err());
	}

	#[test]
	fn test_inbound_conn_handshake_complete_awaiting_pong() {
 // Test that we do not disconnect an outbound peer after the noise handshake completes due
 // to a pong timeout for a ping that was never sent if a timer tick fires after we send act
 // two of the noise handshake along with our init message but before we receive their init
 // message.
 let logger = test_utils::TestLogger::new();
 let node_signer_a = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[42; 32]).unwrap());
 let node_signer_b = test_utils::TestNodeSigner::new(SecretKey::from_slice(&[43; 32]).unwrap());
 let peer_a = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[0; 32], &logger, &node_signer_a);
 let peer_b = PeerManager::new(MessageHandler {
 chan_handler: ErroringMessageHandler::new(),
 route_handler: IgnoringMessageHandler {},
 onion_message_handler: IgnoringMessageHandler {},
 custom_message_handler: IgnoringMessageHandler {},
 }, 0, &[1; 32], &logger, &node_signer_b);

 let a_id = node_signer_a.get_node_id(Recipient::Node).unwrap();
 let mut fd_a = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };
 let mut fd_b = FileDescriptor {
 fd: 1, outbound_data: Arc::new(Mutex::new(Vec::new())),
 disconnect: Arc::new(AtomicBool::new(false)),
 };

 // Exchange messages with both peers until they both complete the init handshake.
 let act_one = peer_b.new_outbound_connection(a_id, fd_b.clone(), None).unwrap();
 peer_a.new_inbound_connection(fd_a.clone(), None).unwrap();

 assert_eq!(peer_a.read_event(&mut fd_a, &act_one).unwrap(), false);
 peer_a.process_events();

 let act_two = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert_eq!(peer_b.read_event(&mut fd_b, &act_two).unwrap(), false);
 peer_b.process_events();

 // Calling this here triggers the race on inbound connections.
 peer_b.timer_tick_occurred();

 let act_three_with_init_b = fd_b.outbound_data.lock().unwrap().split_off(0);
 assert!(!peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_a.read_event(&mut fd_a, &act_three_with_init_b).unwrap(), false);
 peer_a.process_events();
 assert!(peer_a.peers.read().unwrap().get(&fd_a).unwrap().lock().unwrap().handshake_complete());

 let init_a = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!init_a.is_empty());

 assert!(!peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());
 assert_eq!(peer_b.read_event(&mut fd_b, &init_a).unwrap(), false);
 peer_b.process_events();
 assert!(peer_b.peers.read().unwrap().get(&fd_b).unwrap().lock().unwrap().handshake_complete());

 // Make sure we're still connected.
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // B should send a ping on the first timer tick after `handshake_complete`.
 assert!(fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());
 peer_b.timer_tick_occurred();
 peer_b.process_events();
 assert!(!fd_b.outbound_data.lock().unwrap().split_off(0).is_empty());

 let mut send_warning = || {
 {
 let peers = peer_a.peers.read().unwrap();
 let mut peer_b = peers.get(&fd_a).unwrap().lock().unwrap();
 peer_a.enqueue_message(&mut peer_b, &msgs::WarningMessage {
 channel_id: ChannelId([0; 32]),
 data: "no disconnect plz".to_string(),
 });
 }
 peer_a.process_events();
 let msg = fd_a.outbound_data.lock().unwrap().split_off(0);
 assert!(!msg.is_empty());
 assert_eq!(peer_b.read_event(&mut fd_b, &msg).unwrap(), false);
 peer_b.process_events();
 };

 // Fire more ticks until we reach the pong timeout. We send any message except pong to
 // pretend the connection is still alive.
 send_warning();
 for _ in 0..MAX_BUFFER_DRAIN_TICK_INTERVALS_PER_PEER {
 peer_b.timer_tick_occurred();
 send_warning();
 }
 assert_eq!(peer_b.peers.read().unwrap().len(), 1);

 // One more tick should enforce the pong timeout.
 peer_b.timer_tick_occurred();
 assert_eq!(peer_b.peers.read().unwrap().len(), 0);
	}

	#[test]
	fn test_filter_addresses(){
 // Tests the filter_addresses function.
Expand Down