X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fln%2Fmsgs.rs;h=1d0ea1c637235c02774fe3e111238c6a25ed15d4;hb=3b498378620d4294f188804c97497112e3693297;hp=a36202e4681c02991081d4e3bc9edbf8d8f58a8b;hpb=e93c9fbeaf6312fb77bce1ad96a2abb44124f136;p=rust-lightning diff --git a/src/ln/msgs.rs b/src/ln/msgs.rs index a36202e4..1d0ea1c6 100644 --- a/src/ln/msgs.rs +++ b/src/ln/msgs.rs @@ -1,11 +1,12 @@ use secp256k1::key::PublicKey; use secp256k1::{Secp256k1, Signature}; +use secp256k1; use bitcoin::util::hash::Sha256dHash; use bitcoin::network::serialize::{deserialize,serialize}; use bitcoin::blockdata::script::Script; use std::error::Error; -use std::fmt; +use std::{cmp, fmt}; use std::result::Result; use util::{byte_utils, internal_traits, events}; @@ -27,14 +28,21 @@ pub trait MsgEncodable { pub enum DecodeError { /// Unknown realm byte in an OnionHopData packet UnknownRealmByte, + /// Unknown feature mandating we fail to parse message + UnknownRequiredFeature, /// Failed to decode a public key (ie it's invalid) BadPublicKey, /// Failed to decode a signature (ie it's invalid) BadSignature, - /// Buffer not of right length (either too short or too long) - WrongLength, + /// Value expected to be text wasn't decodable as text + BadText, + /// Buffer too short + ShortRead, /// node_announcement included more than one address of a given type! ExtraAddressesPerType, + /// A length descriptor in the packet didn't describe the later data correctly + /// (currently only generated in node_announcement) + BadLengthDescriptor, } pub trait MsgDecodable: Sized { fn decode(v: &[u8]) -> Result; @@ -138,6 +146,11 @@ pub struct Init { pub local_features: LocalFeatures, } +pub struct ErrorMessage { + pub channel_id: [u8; 32], + pub data: String, +} + pub struct Ping { pub ponglen: u16, pub byteslen: u16, @@ -265,12 +278,16 @@ pub struct UpdateFee { pub feerate_per_kw: u32, } +pub struct DataLossProtect { + pub your_last_per_commitment_secret: [u8; 32], + pub my_current_per_commitment_point: PublicKey, +} + pub struct ChannelReestablish { pub channel_id: [u8; 32], pub next_local_commitment_number: u64, pub next_remote_commitment_number: u64, - pub your_last_per_commitment_secret: Option<[u8; 32]>, - pub my_current_per_commitment_point: PublicKey, + pub data_loss_protect: Option, } #[derive(Clone)] @@ -322,6 +339,8 @@ pub struct UnsignedNodeAnnouncement { /// List of addresses on which this node is reachable. Note that you may only have up to one /// address of each type, if you have more, they may be silently discarded or we may panic! pub addresses: Vec, + pub excess_address_data: Vec, + pub excess_data: Vec, } pub struct NodeAnnouncement { pub signature: Signature, @@ -337,6 +356,7 @@ pub struct UnsignedChannelAnnouncement { pub node_id_2: PublicKey, pub bitcoin_key_1: PublicKey, pub bitcoin_key_2: PublicKey, + pub excess_data: Vec, } #[derive(PartialEq, Clone)] pub struct ChannelAnnouncement { @@ -357,6 +377,7 @@ pub struct UnsignedChannelUpdate { pub htlc_minimum_msat: u64, pub fee_base_msat: u32, pub fee_proportional_millionths: u32, + pub excess_data: Vec, } #[derive(PartialEq, Clone)] pub struct ChannelUpdate { @@ -366,15 +387,16 @@ pub struct ChannelUpdate { /// Used to put an error message in a HandleError pub enum ErrorAction { - /// Indicates an inbound HTLC add resulted in a failure, and the UpdateFailHTLC provided in msg - /// should be sent back to the sender. - UpdateFailHTLC { - msg: UpdateFailHTLC - }, /// The peer took some action which made us think they were useless. Disconnect them. - DisconnectPeer, + DisconnectPeer { + msg: Option + }, /// The peer did something harmless that we weren't able to process, just log and ignore IgnoreError, + /// The peer did something incorrect. Tell them. + SendErrorMessage { + msg: ErrorMessage + }, } pub struct HandleError { //TODO: rename me @@ -388,6 +410,7 @@ pub struct CommitmentUpdate { pub update_add_htlcs: Vec, pub update_fulfill_htlcs: Vec, pub update_fail_htlcs: Vec, + pub update_fail_malformed_htlcs: Vec, pub commitment_signed: CommitmentSigned, } @@ -428,20 +451,22 @@ pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync { // Channel-to-announce: fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &AnnouncementSignatures) -> Result<(), HandleError>; - // Informational: + // Error conditions: /// Indicates a connection to the peer failed/an existing connection was lost. If no connection /// is believed to be possible in the future (eg they're sending us messages we don't /// understand or indicate they require unknown feature bits), no_connection_possible is set /// and any outstanding channels should be failed. fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool); + + fn handle_error(&self, their_node_id: &PublicKey, msg: &ErrorMessage); } pub trait RoutingMessageHandler : Send + Sync { - fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<(), HandleError>; + fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result; /// Handle a channel_announcement message, returning true if it should be forwarded on, false /// or returning an Err otherwise. fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result; - fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<(), HandleError>; + fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result; fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate); } @@ -462,7 +487,10 @@ unsafe impl internal_traits::NoDealloc for OnionHopData{} #[derive(Clone)] pub struct OnionPacket { pub version: u8, - pub public_key: PublicKey, + /// In order to ensure we always return an error on Onion decode in compliance with BOLT 4, we + /// have to deserialize OnionPackets contained in UpdateAddHTLCs even if the ephemeral public + /// key (here) is bogus, so we hold a Result instead of a PublicKey as we'd like. + pub public_key: Result, pub hop_data: [u8; 20*65], pub hmac: [u8; 32], } @@ -484,10 +512,13 @@ impl Error for DecodeError { fn description(&self) -> &str { match *self { DecodeError::UnknownRealmByte => "Unknown realm byte in Onion packet", + DecodeError::UnknownRequiredFeature => "Unknown required feature preventing decode", DecodeError::BadPublicKey => "Invalid public key in packet", DecodeError::BadSignature => "Invalid signature in packet", - DecodeError::WrongLength => "Data was wrong length for packet", + DecodeError::BadText => "Invalid text in packet", + DecodeError::ShortRead => "Packet extended beyond the provided bytes", DecodeError::ExtraAddressesPerType => "More than one address of a single type", + DecodeError::BadLengthDescriptor => "A length descriptor in the packet didn't describe the later data correctly", } } } @@ -523,9 +554,9 @@ macro_rules! secp_signature { impl MsgDecodable for LocalFeatures { fn decode(v: &[u8]) -> Result { - if v.len() < 2 { return Err(DecodeError::WrongLength); } + if v.len() < 2 { return Err(DecodeError::ShortRead); } let len = byte_utils::slice_to_be16(&v[0..2]) as usize; - if v.len() < len + 2 { return Err(DecodeError::WrongLength); } + if v.len() < len + 2 { return Err(DecodeError::ShortRead); } let mut flags = Vec::with_capacity(len); flags.extend_from_slice(&v[2..2 + len]); Ok(Self { @@ -545,9 +576,9 @@ impl MsgEncodable for LocalFeatures { impl MsgDecodable for GlobalFeatures { fn decode(v: &[u8]) -> Result { - if v.len() < 2 { return Err(DecodeError::WrongLength); } + if v.len() < 2 { return Err(DecodeError::ShortRead); } let len = byte_utils::slice_to_be16(&v[0..2]) as usize; - if v.len() < len + 2 { return Err(DecodeError::WrongLength); } + if v.len() < len + 2 { return Err(DecodeError::ShortRead); } let mut flags = Vec::with_capacity(len); flags.extend_from_slice(&v[2..2 + len]); Ok(Self { @@ -569,7 +600,7 @@ impl MsgDecodable for Init { fn decode(v: &[u8]) -> Result { let global_features = GlobalFeatures::decode(v)?; if v.len() < global_features.flags.len() + 4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let local_features = LocalFeatures::decode(&v[global_features.flags.len() + 2..])?; Ok(Self { @@ -590,12 +621,12 @@ impl MsgEncodable for Init { impl MsgDecodable for Ping { fn decode(v: &[u8]) -> Result { if v.len() < 4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ponglen = byte_utils::slice_to_be16(&v[0..2]); let byteslen = byte_utils::slice_to_be16(&v[2..4]); if v.len() < 4 + byteslen as usize { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } Ok(Self { ponglen, @@ -615,11 +646,11 @@ impl MsgEncodable for Ping { impl MsgDecodable for Pong { fn decode(v: &[u8]) -> Result { if v.len() < 2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let byteslen = byte_utils::slice_to_be16(&v[0..2]); if v.len() < 2 + byteslen as usize { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } Ok(Self { byteslen @@ -638,7 +669,7 @@ impl MsgEncodable for Pong { impl MsgDecodable for OpenChannel { fn decode(v: &[u8]) -> Result { if v.len() < 2*32+6*8+4+2*2+6*33+1 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ctx = Secp256k1::without_caps(); @@ -646,16 +677,15 @@ impl MsgDecodable for OpenChannel { if v.len() >= 321 { let len = byte_utils::slice_to_be16(&v[319..321]) as usize; if v.len() < 321+len { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } shutdown_scriptpubkey = Some(Script::from(v[321..321+len].to_vec())); - } else if v.len() != 2*32+6*8+4+2*2+6*33+1 { // Message cant have 1 extra byte - return Err(DecodeError::WrongLength); } - + let mut temp_channel_id = [0; 32]; + temp_channel_id[..].copy_from_slice(&v[32..64]); Ok(OpenChannel { chain_hash: deserialize(&v[0..32]).unwrap(), - temporary_channel_id: deserialize(&v[32..64]).unwrap(), + temporary_channel_id: temp_channel_id, funding_satoshis: byte_utils::slice_to_be64(&v[64..72]), push_msat: byte_utils::slice_to_be64(&v[72..80]), dust_limit_satoshis: byte_utils::slice_to_be64(&v[80..88]), @@ -711,7 +741,7 @@ impl MsgEncodable for OpenChannel { impl MsgDecodable for AcceptChannel { fn decode(v: &[u8]) -> Result { if v.len() < 32+4*8+4+2*2+6*33 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ctx = Secp256k1::without_caps(); @@ -719,11 +749,9 @@ impl MsgDecodable for AcceptChannel { if v.len() >= 272 { let len = byte_utils::slice_to_be16(&v[270..272]) as usize; if v.len() < 272+len { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } shutdown_scriptpubkey = Some(Script::from(v[272..272+len].to_vec())); - } else if v.len() != 32+4*8+4+2*2+6*33 { // Message cant have 1 extra byte - return Err(DecodeError::WrongLength); } let mut temporary_channel_id = [0; 32]; @@ -778,7 +806,7 @@ impl MsgEncodable for AcceptChannel { impl MsgDecodable for FundingCreated { fn decode(v: &[u8]) -> Result { if v.len() < 32+32+2+64 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ctx = Secp256k1::without_caps(); let mut temporary_channel_id = [0; 32]; @@ -806,7 +834,7 @@ impl MsgEncodable for FundingCreated { impl MsgDecodable for FundingSigned { fn decode(v: &[u8]) -> Result { if v.len() < 32+64 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ctx = Secp256k1::without_caps(); let mut channel_id = [0; 32]; @@ -829,7 +857,7 @@ impl MsgEncodable for FundingSigned { impl MsgDecodable for FundingLocked { fn decode(v: &[u8]) -> Result { if v.len() < 32+33 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let ctx = Secp256k1::without_caps(); let mut channel_id = [0; 32]; @@ -852,11 +880,11 @@ impl MsgEncodable for FundingLocked { impl MsgDecodable for Shutdown { fn decode(v: &[u8]) -> Result { if v.len() < 32 + 2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let scriptlen = byte_utils::slice_to_be16(&v[32..34]) as usize; if v.len() < 32 + 2 + scriptlen { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -879,7 +907,7 @@ impl MsgEncodable for Shutdown { impl MsgDecodable for ClosingSigned { fn decode(v: &[u8]) -> Result { if v.len() < 32 + 8 + 64 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let secp_ctx = Secp256k1::without_caps(); let mut channel_id = [0; 32]; @@ -905,7 +933,7 @@ impl MsgEncodable for ClosingSigned { impl MsgDecodable for UpdateAddHTLC { fn decode(v: &[u8]) -> Result { if v.len() < 32+8+8+32+4+1+33+20*65+32 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -923,7 +951,7 @@ impl MsgDecodable for UpdateAddHTLC { } impl MsgEncodable for UpdateAddHTLC { fn encode(&self) -> Vec { - let mut res = Vec::with_capacity(32+8+8+32+4+1+1366); + let mut res = Vec::with_capacity(32+8+8+32+4+1366); res.extend_from_slice(&self.channel_id); res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id)); res.extend_from_slice(&byte_utils::be64_to_array(self.amount_msat)); @@ -937,7 +965,7 @@ impl MsgEncodable for UpdateAddHTLC { impl MsgDecodable for UpdateFulfillHTLC { fn decode(v: &[u8]) -> Result { if v.len() < 32+8+32 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -963,7 +991,7 @@ impl MsgEncodable for UpdateFulfillHTLC { impl MsgDecodable for UpdateFailHTLC { fn decode(v: &[u8]) -> Result { if v.len() < 32+8 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -988,7 +1016,7 @@ impl MsgEncodable for UpdateFailHTLC { impl MsgDecodable for UpdateFailMalformedHTLC { fn decode(v: &[u8]) -> Result { if v.len() < 32+8+32+2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -1016,14 +1044,14 @@ impl MsgEncodable for UpdateFailMalformedHTLC { impl MsgDecodable for CommitmentSigned { fn decode(v: &[u8]) -> Result { if v.len() < 32+64+2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); let htlcs = byte_utils::slice_to_be16(&v[96..98]) as usize; if v.len() < 32+64+2+htlcs*64 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut htlc_signatures = Vec::with_capacity(htlcs); let secp_ctx = Secp256k1::without_caps(); @@ -1054,7 +1082,7 @@ impl MsgEncodable for CommitmentSigned { impl MsgDecodable for RevokeAndACK { fn decode(v: &[u8]) -> Result { if v.len() < 32+32+33 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -1081,7 +1109,7 @@ impl MsgEncodable for RevokeAndACK { impl MsgDecodable for UpdateFee { fn decode(v: &[u8]) -> Result { if v.len() < 32+4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut channel_id = [0; 32]; channel_id[..].copy_from_slice(&v[0..32]); @@ -1101,20 +1129,51 @@ impl MsgEncodable for UpdateFee { } impl MsgDecodable for ChannelReestablish { - fn decode(_v: &[u8]) -> Result { - unimplemented!(); + fn decode(v: &[u8]) -> Result { + if v.len() < 32+2*8 { + return Err(DecodeError::ShortRead); + } + + let data_loss_protect = if v.len() > 32+2*8 { + if v.len() < 32+2*8 + 33+32 { + return Err(DecodeError::ShortRead); + } + let mut inner_array = [0; 32]; + inner_array.copy_from_slice(&v[48..48+32]); + Some(DataLossProtect { + your_last_per_commitment_secret: inner_array, + my_current_per_commitment_point: secp_pubkey!(&Secp256k1::without_caps(), &v[48+32..48+32+33]), + }) + } else { None }; + + Ok(Self { + channel_id: deserialize(&v[0..32]).unwrap(), + next_local_commitment_number: byte_utils::slice_to_be64(&v[32..40]), + next_remote_commitment_number: byte_utils::slice_to_be64(&v[40..48]), + data_loss_protect: data_loss_protect, + }) } } impl MsgEncodable for ChannelReestablish { fn encode(&self) -> Vec { - unimplemented!(); + let mut res = Vec::with_capacity(if self.data_loss_protect.is_some() { 32+2*8+33+32 } else { 32+2*8 }); + + res.extend_from_slice(&serialize(&self.channel_id).unwrap()[..]); + res.extend_from_slice(&byte_utils::be64_to_array(self.next_local_commitment_number)); + res.extend_from_slice(&byte_utils::be64_to_array(self.next_remote_commitment_number)); + + if let &Some(ref data_loss_protect) = &self.data_loss_protect { + res.extend_from_slice(&data_loss_protect.your_last_per_commitment_secret[..]); + res.extend_from_slice(&data_loss_protect.my_current_per_commitment_point.serialize()); + } + res } } impl MsgDecodable for AnnouncementSignatures { fn decode(v: &[u8]) -> Result { if v.len() < 32+8+64*2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let secp_ctx = Secp256k1::without_caps(); let mut channel_id = [0; 32]; @@ -1142,8 +1201,12 @@ impl MsgEncodable for AnnouncementSignatures { impl MsgDecodable for UnsignedNodeAnnouncement { fn decode(v: &[u8]) -> Result { let features = GlobalFeatures::decode(&v[..])?; + if features.requires_unknown_bits() { + return Err(DecodeError::UnknownRequiredFeature); + } + if v.len() < features.encoded_len() + 4 + 33 + 3 + 32 + 2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let start = features.encoded_len(); @@ -1155,22 +1218,22 @@ impl MsgDecodable for UnsignedNodeAnnouncement { let addrlen = byte_utils::slice_to_be16(&v[start + 72..start + 74]) as usize; if v.len() < start + 74 + addrlen { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } + let addr_read_limit = start + 74 + addrlen; let mut addresses = Vec::with_capacity(4); let mut read_pos = start + 74; loop { - if v.len() <= read_pos { break; } + if addr_read_limit <= read_pos { break; } match v[read_pos] { - 0 => { read_pos += 1; }, 1 => { - if v.len() < read_pos + 1 + 6 { - return Err(DecodeError::WrongLength); - } if addresses.len() > 0 { return Err(DecodeError::ExtraAddressesPerType); } + if addr_read_limit < read_pos + 1 + 6 { + return Err(DecodeError::BadLengthDescriptor); + } let mut addr = [0; 4]; addr.copy_from_slice(&v[read_pos + 1..read_pos + 5]); addresses.push(NetAddress::IPv4 { @@ -1180,12 +1243,12 @@ impl MsgDecodable for UnsignedNodeAnnouncement { read_pos += 1 + 6; }, 2 => { - if v.len() < read_pos + 1 + 18 { - return Err(DecodeError::WrongLength); - } if addresses.len() > 1 || (addresses.len() == 1 && addresses[0].get_id() != 1) { return Err(DecodeError::ExtraAddressesPerType); } + if addr_read_limit < read_pos + 1 + 18 { + return Err(DecodeError::BadLengthDescriptor); + } let mut addr = [0; 16]; addr.copy_from_slice(&v[read_pos + 1..read_pos + 17]); addresses.push(NetAddress::IPv6 { @@ -1195,12 +1258,12 @@ impl MsgDecodable for UnsignedNodeAnnouncement { read_pos += 1 + 18; }, 3 => { - if v.len() < read_pos + 1 + 12 { - return Err(DecodeError::WrongLength); - } if addresses.len() > 2 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 2) { return Err(DecodeError::ExtraAddressesPerType); } + if addr_read_limit < read_pos + 1 + 12 { + return Err(DecodeError::BadLengthDescriptor); + } let mut addr = [0; 10]; addr.copy_from_slice(&v[read_pos + 1..read_pos + 11]); addresses.push(NetAddress::OnionV2 { @@ -1210,12 +1273,12 @@ impl MsgDecodable for UnsignedNodeAnnouncement { read_pos += 1 + 12; }, 4 => { - if v.len() < read_pos + 1 + 37 { - return Err(DecodeError::WrongLength); - } if addresses.len() > 3 || (addresses.len() > 0 && addresses.last().unwrap().get_id() > 3) { return Err(DecodeError::ExtraAddressesPerType); } + if addr_read_limit < read_pos + 1 + 37 { + return Err(DecodeError::BadLengthDescriptor); + } let mut ed25519_pubkey = [0; 32]; ed25519_pubkey.copy_from_slice(&v[read_pos + 1..read_pos + 33]); addresses.push(NetAddress::OnionV3 { @@ -1230,6 +1293,15 @@ impl MsgDecodable for UnsignedNodeAnnouncement { } } + let excess_address_data = if read_pos < addr_read_limit { + let mut excess_address_data = Vec::with_capacity(addr_read_limit - read_pos); + excess_address_data.extend_from_slice(&v[read_pos..addr_read_limit]); + excess_address_data + } else { Vec::new() }; + + let mut excess_data = Vec::with_capacity(v.len() - addr_read_limit); + excess_data.extend_from_slice(&v[addr_read_limit..]); + let secp_ctx = Secp256k1::without_caps(); Ok(Self { features, @@ -1238,13 +1310,15 @@ impl MsgDecodable for UnsignedNodeAnnouncement { rgb, alias, addresses, + excess_address_data, + excess_data, }) } } impl MsgEncodable for UnsignedNodeAnnouncement { fn encode(&self) -> Vec { let features = self.features.encode(); - let mut res = Vec::with_capacity(74 + features.len() + self.addresses.len()); + let mut res = Vec::with_capacity(74 + features.len() + self.addresses.len()*7 + self.excess_address_data.len() + self.excess_data.len()); res.extend_from_slice(&features[..]); res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp)); res.extend_from_slice(&self.node_id.serialize()); @@ -1280,8 +1354,10 @@ impl MsgEncodable for UnsignedNodeAnnouncement { }, } } - res.extend_from_slice(&byte_utils::be16_to_array(addr_slice.len() as u16)); + res.extend_from_slice(&byte_utils::be16_to_array((addr_slice.len() + self.excess_address_data.len()) as u16)); res.extend_from_slice(&addr_slice[..]); + res.extend_from_slice(&self.excess_address_data[..]); + res.extend_from_slice(&self.excess_data[..]); res } } @@ -1289,7 +1365,7 @@ impl MsgEncodable for UnsignedNodeAnnouncement { impl MsgDecodable for NodeAnnouncement { fn decode(v: &[u8]) -> Result { if v.len() < 64 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let secp_ctx = Secp256k1::without_caps(); Ok(Self { @@ -1312,11 +1388,16 @@ impl MsgEncodable for NodeAnnouncement { impl MsgDecodable for UnsignedChannelAnnouncement { fn decode(v: &[u8]) -> Result { let features = GlobalFeatures::decode(&v[..])?; + if features.requires_unknown_bits() { + return Err(DecodeError::UnknownRequiredFeature); + } if v.len() < features.encoded_len() + 32 + 8 + 33*4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let start = features.encoded_len(); let secp_ctx = Secp256k1::without_caps(); + let mut excess_data = Vec::with_capacity(v.len() - start - 172); + excess_data.extend_from_slice(&v[start + 172..]); Ok(Self { features, chain_hash: deserialize(&v[start..start + 32]).unwrap(), @@ -1325,13 +1406,14 @@ impl MsgDecodable for UnsignedChannelAnnouncement { node_id_2: secp_pubkey!(&secp_ctx, &v[start + 73..start + 106]), bitcoin_key_1: secp_pubkey!(&secp_ctx, &v[start + 106..start + 139]), bitcoin_key_2: secp_pubkey!(&secp_ctx, &v[start + 139..start + 172]), + excess_data, }) } } impl MsgEncodable for UnsignedChannelAnnouncement { fn encode(&self) -> Vec { let features = self.features.encode(); - let mut res = Vec::with_capacity(172 + features.len()); + let mut res = Vec::with_capacity(172 + features.len() + self.excess_data.len()); res.extend_from_slice(&features[..]); res.extend_from_slice(&self.chain_hash[..]); res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id)); @@ -1339,6 +1421,7 @@ impl MsgEncodable for UnsignedChannelAnnouncement { res.extend_from_slice(&self.node_id_2.serialize()); res.extend_from_slice(&self.bitcoin_key_1.serialize()); res.extend_from_slice(&self.bitcoin_key_2.serialize()); + res.extend_from_slice(&self.excess_data[..]); res } } @@ -1346,7 +1429,7 @@ impl MsgEncodable for UnsignedChannelAnnouncement { impl MsgDecodable for ChannelAnnouncement { fn decode(v: &[u8]) -> Result { if v.len() < 64*4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let secp_ctx = Secp256k1::without_caps(); Ok(Self { @@ -1375,8 +1458,10 @@ impl MsgEncodable for ChannelAnnouncement { impl MsgDecodable for UnsignedChannelUpdate { fn decode(v: &[u8]) -> Result { if v.len() < 32+8+4+2+2+8+4+4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } + let mut excess_data = Vec::with_capacity(v.len() - 64); + excess_data.extend_from_slice(&v[64..]); Ok(Self { chain_hash: deserialize(&v[0..32]).unwrap(), short_channel_id: byte_utils::slice_to_be64(&v[32..40]), @@ -1386,12 +1471,13 @@ impl MsgDecodable for UnsignedChannelUpdate { htlc_minimum_msat: byte_utils::slice_to_be64(&v[48..56]), fee_base_msat: byte_utils::slice_to_be32(&v[56..60]), fee_proportional_millionths: byte_utils::slice_to_be32(&v[60..64]), + excess_data }) } } impl MsgEncodable for UnsignedChannelUpdate { fn encode(&self) -> Vec { - let mut res = Vec::with_capacity(64); + let mut res = Vec::with_capacity(64 + self.excess_data.len()); res.extend_from_slice(&self.chain_hash[..]); res.extend_from_slice(&byte_utils::be64_to_array(self.short_channel_id)); res.extend_from_slice(&byte_utils::be32_to_array(self.timestamp)); @@ -1400,6 +1486,7 @@ impl MsgEncodable for UnsignedChannelUpdate { res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat)); res.extend_from_slice(&byte_utils::be32_to_array(self.fee_base_msat)); res.extend_from_slice(&byte_utils::be32_to_array(self.fee_proportional_millionths)); + res.extend_from_slice(&self.excess_data[..]); res } } @@ -1407,7 +1494,7 @@ impl MsgEncodable for UnsignedChannelUpdate { impl MsgDecodable for ChannelUpdate { fn decode(v: &[u8]) -> Result { if v.len() < 128 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let secp_ctx = Secp256k1::without_caps(); Ok(Self { @@ -1428,7 +1515,7 @@ impl MsgEncodable for ChannelUpdate { impl MsgDecodable for OnionRealm0HopData { fn decode(v: &[u8]) -> Result { if v.len() < 32 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } Ok(OnionRealm0HopData { short_channel_id: byte_utils::slice_to_be64(&v[0..8]), @@ -1451,7 +1538,7 @@ impl MsgEncodable for OnionRealm0HopData { impl MsgDecodable for OnionHopData { fn decode(v: &[u8]) -> Result { if v.len() < 65 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let realm = v[0]; if realm != 0 { @@ -1479,7 +1566,7 @@ impl MsgEncodable for OnionHopData { impl MsgDecodable for OnionPacket { fn decode(v: &[u8]) -> Result { if v.len() < 1+33+20*65+32 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut hop_data = [0; 20*65]; hop_data.copy_from_slice(&v[34..1334]); @@ -1488,7 +1575,7 @@ impl MsgDecodable for OnionPacket { let secp_ctx = Secp256k1::without_caps(); Ok(Self { version: v[0], - public_key: secp_pubkey!(&secp_ctx, &v[1..34]), + public_key: PublicKey::from_slice(&secp_ctx, &v[1..34]), hop_data, hmac, }) @@ -1498,7 +1585,10 @@ impl MsgEncodable for OnionPacket { fn encode(&self) -> Vec { let mut res = Vec::with_capacity(1 + 33 + 20*65 + 32); res.push(self.version); - res.extend_from_slice(&self.public_key.serialize()); + match self.public_key { + Ok(pubkey) => res.extend_from_slice(&pubkey.serialize()), + Err(_) => res.extend_from_slice(&[0; 33]), + } res.extend_from_slice(&self.hop_data); res.extend_from_slice(&self.hmac); res @@ -1508,15 +1598,15 @@ impl MsgEncodable for OnionPacket { impl MsgDecodable for DecodedOnionErrorPacket { fn decode(v: &[u8]) -> Result { if v.len() < 32 + 4 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let failuremsg_len = byte_utils::slice_to_be16(&v[32..34]) as usize; if v.len() < 32 + 4 + failuremsg_len { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let padding_len = byte_utils::slice_to_be16(&v[34 + failuremsg_len..]) as usize; if v.len() < 32 + 4 + failuremsg_len + padding_len { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let mut hmac = [0; 32]; @@ -1543,11 +1633,11 @@ impl MsgEncodable for DecodedOnionErrorPacket { impl MsgDecodable for OnionErrorPacket { fn decode(v: &[u8]) -> Result { if v.len() < 2 { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } let len = byte_utils::slice_to_be16(&v[0..2]) as usize; if v.len() < 2 + len { - return Err(DecodeError::WrongLength); + return Err(DecodeError::ShortRead); } Ok(Self { data: v[2..len+2].to_vec(), @@ -1562,3 +1652,78 @@ impl MsgEncodable for OnionErrorPacket { res } } + +impl MsgEncodable for ErrorMessage { + fn encode(&self) -> Vec { + let mut res = Vec::with_capacity(34 + self.data.len()); + res.extend_from_slice(&self.channel_id); + res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16)); + res.extend_from_slice(&self.data.as_bytes()); + res + } +} +impl MsgDecodable for ErrorMessage { + fn decode(v: &[u8]) -> Result { + if v.len() < 34 { + return Err(DecodeError::ShortRead); + } + // Unlike most messages, BOLT 1 requires we truncate our read if the value is out of range + let len = cmp::min(byte_utils::slice_to_be16(&v[32..34]) as usize, v.len() - 34); + let data = match String::from_utf8(v[34..34 + len].to_vec()) { + Ok(s) => s, + Err(_) => return Err(DecodeError::BadText), + }; + let mut channel_id = [0; 32]; + channel_id[..].copy_from_slice(&v[0..32]); + Ok(Self { + channel_id, + data, + }) + } +} + +#[cfg(test)] +mod tests { + use hex; + use ln::msgs::MsgEncodable; + use ln::msgs; + use secp256k1::key::{PublicKey,SecretKey}; + use secp256k1::Secp256k1; + + #[test] + fn encoding_channel_reestablish_no_secret() { + let cr = msgs::ChannelReestablish { + channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0], + next_local_commitment_number: 3, + next_remote_commitment_number: 4, + data_loss_protect: None, + }; + + let encoded_value = cr.encode(); + assert_eq!( + encoded_value, + vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4] + ); + } + + #[test] + fn encoding_channel_reestablish_with_secret() { + let public_key = { + let secp_ctx = Secp256k1::new(); + PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap()) + }; + + let cr = msgs::ChannelReestablish { + channel_id: [4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0], + next_local_commitment_number: 3, + next_remote_commitment_number: 4, + data_loss_protect: Some(msgs::DataLossProtect { your_last_per_commitment_secret: [9;32], my_current_per_commitment_point: public_key}), + }; + + let encoded_value = cr.encode(); + assert_eq!( + encoded_value, + vec![4, 0, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 6, 0, 0, 0, 0, 0, 0, 0, 7, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0, 0, 0, 0, 0, 4, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 3, 27, 132, 197, 86, 123, 18, 100, 64, 153, 93, 62, 213, 170, 186, 5, 101, 215, 30, 24, 52, 96, 72, 25, 255, 156, 23, 245, 233, 213, 221, 7, 143] + ); + } +}