X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fmsgs.rs;h=3042b4d32e0a344e185ef9756654aefa759606aa;hb=31e78ff258195837abafa045c12c036528696d7f;hp=b17b4aa083df31a5d128c1bbc3ebe7d7b643e5b4;hpb=0d755456328d68151cdb66a1d8280912de7eb50c;p=rust-lightning diff --git a/lightning/src/ln/msgs.rs b/lightning/src/ln/msgs.rs index b17b4aa0..cb857ed5 100644 --- a/lightning/src/ln/msgs.rs +++ b/lightning/src/ln/msgs.rs @@ -1,254 +1,486 @@ +// This file is Copyright its original authors, visible in version control +// history. +// +// This file is licensed under the Apache License, Version 2.0 or the MIT license +// , at your option. +// You may not use this file except in accordance with one or both of these +// licenses. + //! Wire messages, traits representing wire message handlers, and a few error types live here. //! //! For a normal node you probably don't need to use anything here, however, if you wish to split a //! node into an internet-facing route/message socket handling daemon and a separate daemon (or //! server entirely) which handles only channel-related messages you may wish to implement -//! ChannelMessageHandler yourself and use it to re-serialize messages and pass them across +//! [`ChannelMessageHandler`] yourself and use it to re-serialize messages and pass them across //! daemons/servers. //! //! Note that if you go with such an architecture (instead of passing raw socket events to a //! non-internet-facing system) you trust the frontend internet-facing system to not lie about the -//! source node_id of the message, however this does allow you to significantly reduce bandwidth +//! source `node_id` of the message, however this does allow you to significantly reduce bandwidth //! between the systems as routing messages can represent a significant chunk of bandwidth usage //! (especially for non-channel-publicly-announcing nodes). As an alternate design which avoids //! this issue, if you have sufficient bidirectional bandwidth between your systems, you may send //! raw socket events into your non-internet-facing system and then send routing events back to //! track the network on the less-secure system. -use secp256k1::key::PublicKey; -use secp256k1::Signature; -use secp256k1; -use bitcoin_hashes::sha256d::Hash as Sha256dHash; +use bitcoin::secp256k1::PublicKey; +use bitcoin::secp256k1::ecdsa::Signature; +use bitcoin::secp256k1; use bitcoin::blockdata::script::Script; +use bitcoin::hash_types::{Txid, BlockHash}; + +use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures}; +use crate::ln::onion_utils; +use crate::onion_message; -use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures}; +use crate::prelude::*; +use core::fmt; +use core::fmt::Debug; +use crate::io::{self, Read}; +use crate::io_extras::read_to_end; -use std::{cmp, fmt}; -use std::io::Read; -use std::result::Result; +use crate::events::{MessageSendEventsProvider, OnionMessageProvider}; +use crate::util::logger; +use crate::util::ser::{LengthReadable, Readable, ReadableArgs, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedBigSize, Hostname}; -use util::events; -use util::ser::{Readable, Writeable, Writer, FixedLengthReader, HighZeroBytesDroppedVarInt}; +use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret}; -use ln::channelmanager::{PaymentPreimage, PaymentHash, PaymentSecret}; +use crate::routing::gossip::NodeId; /// 21 million * 10^8 * 1000 pub(crate) const MAX_VALUE_MSAT: u64 = 21_000_000_0000_0000_000; /// An error in decoding a message or struct. -#[derive(Debug)] +#[derive(Clone, Debug, PartialEq, Eq)] pub enum DecodeError { /// A version byte specified something we don't know how to handle. - /// Includes unknown realm byte in an OnionHopData packet + /// + /// Includes unknown realm byte in an onion hop data packet. UnknownVersion, - /// Unknown feature mandating we fail to parse message (eg TLV with an even, unknown type) + /// Unknown feature mandating we fail to parse message (e.g., TLV with an even, unknown type) UnknownRequiredFeature, - /// Value was invalid, eg a byte which was supposed to be a bool was something other than a 0 + /// Value was invalid. + /// + /// For example, a byte which was supposed to be a bool was something other than a 0 /// or 1, a public key/private key/signature was invalid, text wasn't UTF-8, TLV was - /// syntactically incorrect, etc + /// syntactically incorrect, etc. InvalidValue, - /// Buffer too short + /// The buffer to be read was too short. ShortRead, - /// A length descriptor in the packet didn't describe the later data correctly + /// A length descriptor in the packet didn't describe the later data correctly. BadLengthDescriptor, - /// Error from std::io - Io(::std::io::Error), + /// Error from [`std::io`]. + Io(io::ErrorKind), + /// The message included zlib-compressed values, which we don't support. + UnsupportedCompression, } -/// An init message to be sent or received from a peer +/// An [`init`] message to be sent to or received from a peer. +/// +/// [`init`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-init-message +#[derive(Clone, Debug, PartialEq, Eq)] pub struct Init { - #[cfg(not(feature = "fuzztarget"))] - pub(crate) features: InitFeatures, - #[cfg(feature = "fuzztarget")] + /// The relevant features which the sender supports. pub features: InitFeatures, + /// The receipient's network address. + /// + /// This adds the option to report a remote IP address back to a connecting peer using the init + /// message. A node can decide to use that information to discover a potential update to its + /// public IPv4 address (NAT) and use that for a [`NodeAnnouncement`] update message containing + /// the new address. + pub remote_network_address: Option, } -/// An error message to be sent or received from a peer -#[derive(Clone)] +/// An [`error`] message to be sent to or received from a peer. +/// +/// [`error`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages +#[derive(Clone, Debug, PartialEq, Eq)] pub struct ErrorMessage { - pub(crate) channel_id: [u8; 32], - pub(crate) data: String, + /// The channel ID involved in the error. + /// + /// All-0s indicates a general error unrelated to a specific channel, after which all channels + /// with the sending peer should be closed. + pub channel_id: [u8; 32], + /// A possibly human-readable error description. + /// + /// The string should be sanitized before it is used (e.g., emitted to logs or printed to + /// `stdout`). Otherwise, a well crafted error message may trigger a security vulnerability in + /// the terminal emulator or the logging subsystem. + pub data: String, } -/// A ping message to be sent or received from a peer +/// A [`warning`] message to be sent to or received from a peer. +/// +/// [`warning`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-error-and-warning-messages +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct WarningMessage { + /// The channel ID involved in the warning. + /// + /// All-0s indicates a warning unrelated to a specific channel. + pub channel_id: [u8; 32], + /// A possibly human-readable warning description. + /// + /// The string should be sanitized before it is used (e.g. emitted to logs or printed to + /// stdout). Otherwise, a well crafted error message may trigger a security vulnerability in + /// the terminal emulator or the logging subsystem. + pub data: String, +} + +/// A [`ping`] message to be sent to or received from a peer. +/// +/// [`ping`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages +#[derive(Clone, Debug, PartialEq, Eq)] pub struct Ping { - pub(crate) ponglen: u16, - pub(crate) byteslen: u16, + /// The desired response length. + pub ponglen: u16, + /// The ping packet size. + /// + /// This field is not sent on the wire. byteslen zeros are sent. + pub byteslen: u16, } -/// A pong message to be sent or received from a peer +/// A [`pong`] message to be sent to or received from a peer. +/// +/// [`pong`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages +#[derive(Clone, Debug, PartialEq, Eq)] pub struct Pong { - pub(crate) byteslen: u16, + /// The pong packet size. + /// + /// This field is not sent on the wire. byteslen zeros are sent. + pub byteslen: u16, } -/// An open_channel message to be sent or received from a peer -#[derive(Clone)] +/// An [`open_channel`] message to be sent to or received from a peer. +/// +/// [`open_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message +#[derive(Clone, Debug, PartialEq, Eq)] pub struct OpenChannel { - pub(crate) chain_hash: Sha256dHash, - pub(crate) temporary_channel_id: [u8; 32], - pub(crate) funding_satoshis: u64, - pub(crate) push_msat: u64, - pub(crate) dust_limit_satoshis: u64, - pub(crate) max_htlc_value_in_flight_msat: u64, - pub(crate) channel_reserve_satoshis: u64, - pub(crate) htlc_minimum_msat: u64, - pub(crate) feerate_per_kw: u32, - pub(crate) to_self_delay: u16, - pub(crate) max_accepted_htlcs: u16, - pub(crate) funding_pubkey: PublicKey, - pub(crate) revocation_basepoint: PublicKey, - pub(crate) payment_basepoint: PublicKey, - pub(crate) delayed_payment_basepoint: PublicKey, - pub(crate) htlc_basepoint: PublicKey, - pub(crate) first_per_commitment_point: PublicKey, - pub(crate) channel_flags: u8, - pub(crate) shutdown_scriptpubkey: OptionalField