_ Git - ldk-c-bindings/blob - lightning-c-bindings/src/lightning/onion_message/packet.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history and in the source files from which this was generated.
   3 //
   4 // This file is licensed under the license available in the LICENSE or LICENSE.md
   5 // file in the root of this repository or, if no such file exists, the same
   6 // license as that which applies to the original source files from which this
   7 // source was automatically generated.
   8
   9 //! Structs and enums useful for constructing and reading an onion message packet.
  10
  11 use alloc::str::FromStr;
  12 use alloc::string::String;
  13 use core::ffi::c_void;
  14 use core::convert::Infallible;
  15 use bitcoin::hashes::Hash;
  16 use crate::c_types::*;
  17 #[cfg(feature="no-std")]
  18 use alloc::{vec::Vec, boxed::Box};
  19
  20
  21 use lightning::onion_message::packet::Packet as nativePacketImport;
  22 pub(crate) type nativePacket = nativePacketImport;
  23
  24 /// Packet of hop data for next peer
  25 #[must_use]
  26 #[repr(C)]
  27 pub struct Packet {
  28         /// A pointer to the opaque Rust object.
  29
  30         /// Nearly everywhere, inner must be non-null, however in places where
  31         /// the Rust equivalent takes an Option, it may be set to null to indicate None.
  32         pub inner: *mut nativePacket,
  33         /// Indicates that this is the only struct which contains the same pointer.
  34
  35         /// Rust functions which take ownership of an object provided via an argument require
  36         /// this to be true and invalidate the object pointed to by inner.
  37         pub is_owned: bool,
  38 }
  39
  40 impl Drop for Packet {
  41         fn drop(&mut self) {
  42                 if self.is_owned && !<*mut nativePacket>::is_null(self.inner) {
  43                         let _ = unsafe { Box::from_raw(ObjOps::untweak_ptr(self.inner)) };
  44                 }
  45         }
  46 }
  47 /// Frees any resources used by the Packet, if is_owned is set and inner is non-NULL.
  48 #[no_mangle]
  49 pub extern "C" fn Packet_free(this_obj: Packet) { }
  50 #[allow(unused)]
  51 /// Used only if an object of this type is returned as a trait impl by a method
  52 pub(crate) extern "C" fn Packet_free_void(this_ptr: *mut c_void) {
  53         let _ = unsafe { Box::from_raw(this_ptr as *mut nativePacket) };
  54 }
  55 #[allow(unused)]
  56 impl Packet {
  57         pub(crate) fn get_native_ref(&self) -> &'static nativePacket {
  58                 unsafe { &*ObjOps::untweak_ptr(self.inner) }
  59         }
  60         pub(crate) fn get_native_mut_ref(&self) -> &'static mut nativePacket {
  61                 unsafe { &mut *ObjOps::untweak_ptr(self.inner) }
  62         }
  63         /// When moving out of the pointer, we have to ensure we aren't a reference, this makes that easy
  64         pub(crate) fn take_inner(mut self) -> *mut nativePacket {
  65                 assert!(self.is_owned);
  66                 let ret = ObjOps::untweak_ptr(self.inner);
  67                 self.inner = core::ptr::null_mut();
  68                 ret
  69         }
  70 }
  71 /// Bolt 04 version number
  72 #[no_mangle]
  73 pub extern "C" fn Packet_get_version(this_ptr: &Packet) -> u8 {
  74         let mut inner_val = &mut this_ptr.get_native_mut_ref().version;
  75         *inner_val
  76 }
  77 /// Bolt 04 version number
  78 #[no_mangle]
  79 pub extern "C" fn Packet_set_version(this_ptr: &mut Packet, mut val: u8) {
  80         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.version = val;
  81 }
  82 /// A random sepc256k1 point, used to build the ECDH shared secret to decrypt hop_data
  83 #[no_mangle]
  84 pub extern "C" fn Packet_get_public_key(this_ptr: &Packet) -> crate::c_types::PublicKey {
  85         let mut inner_val = &mut this_ptr.get_native_mut_ref().public_key;
  86         crate::c_types::PublicKey::from_rust(&inner_val)
  87 }
  88 /// A random sepc256k1 point, used to build the ECDH shared secret to decrypt hop_data
  89 #[no_mangle]
  90 pub extern "C" fn Packet_set_public_key(this_ptr: &mut Packet, mut val: crate::c_types::PublicKey) {
  91         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.public_key = val.into_rust();
  92 }
  93 /// Encrypted payload for the next hop
  94 ///
  95 /// Returns a copy of the field.
  96 #[no_mangle]
  97 pub extern "C" fn Packet_get_hop_data(this_ptr: &Packet) -> crate::c_types::derived::CVec_u8Z {
  98         let mut inner_val = this_ptr.get_native_mut_ref().hop_data.clone();
  99         let mut local_inner_val = Vec::new(); for mut item in inner_val.drain(..) { local_inner_val.push( { item }); };
 100         local_inner_val.into()
 101 }
 102 /// Encrypted payload for the next hop
 103 #[no_mangle]
 104 pub extern "C" fn Packet_set_hop_data(this_ptr: &mut Packet, mut val: crate::c_types::derived::CVec_u8Z) {
 105         let mut local_val = Vec::new(); for mut item in val.into_rust().drain(..) { local_val.push( { item }); };
 106         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.hop_data = local_val;
 107 }
 108 /// HMAC to verify the integrity of hop_data
 109 #[no_mangle]
 110 pub extern "C" fn Packet_get_hmac(this_ptr: &Packet) -> *const [u8; 32] {
 111         let mut inner_val = &mut this_ptr.get_native_mut_ref().hmac;
 112         inner_val
 113 }
 114 /// HMAC to verify the integrity of hop_data
 115 #[no_mangle]
 116 pub extern "C" fn Packet_set_hmac(this_ptr: &mut Packet, mut val: crate::c_types::ThirtyTwoBytes) {
 117         unsafe { &mut *ObjOps::untweak_ptr(this_ptr.inner) }.hmac = val.data;
 118 }
 119 /// Constructs a new Packet given each field
 120 #[must_use]
 121 #[no_mangle]
 122 pub extern "C" fn Packet_new(mut version_arg: u8, mut public_key_arg: crate::c_types::PublicKey, mut hop_data_arg: crate::c_types::derived::CVec_u8Z, mut hmac_arg: crate::c_types::ThirtyTwoBytes) -> Packet {
 123         let mut local_hop_data_arg = Vec::new(); for mut item in hop_data_arg.into_rust().drain(..) { local_hop_data_arg.push( { item }); };
 124         Packet { inner: ObjOps::heap_alloc(nativePacket {
 125                 version: version_arg,
 126                 public_key: public_key_arg.into_rust(),
 127                 hop_data: local_hop_data_arg,
 128                 hmac: hmac_arg.data,
 129         }), is_owned: true }
 130 }
 131 impl Clone for Packet {
 132         fn clone(&self) -> Self {
 133                 Self {
 134                         inner: if <*mut nativePacket>::is_null(self.inner) { core::ptr::null_mut() } else {
 135                                 ObjOps::heap_alloc(unsafe { &*ObjOps::untweak_ptr(self.inner) }.clone()) },
 136                         is_owned: true,
 137                 }
 138         }
 139 }
 140 #[allow(unused)]
 141 /// Used only if an object of this type is returned as a trait impl by a method
 142 pub(crate) extern "C" fn Packet_clone_void(this_ptr: *const c_void) -> *mut c_void {
 143         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const nativePacket)).clone() })) as *mut c_void
 144 }
 145 #[no_mangle]
 146 /// Creates a copy of the Packet
 147 pub extern "C" fn Packet_clone(orig: &Packet) -> Packet {
 148         orig.clone()
 149 }
 150 /// Get a string which allows debug introspection of a Packet object
 151 pub extern "C" fn Packet_debug_str_void(o: *const c_void) -> Str {
 152         alloc::format!("{:?}", unsafe { o as *const crate::lightning::onion_message::packet::Packet }).into()}
 153 /// Generates a non-cryptographic 64-bit hash of the Packet.
 154 #[no_mangle]
 155 pub extern "C" fn Packet_hash(o: &Packet) -> u64 {
 156         if o.inner.is_null() { return 0; }
 157         // Note that we'd love to use alloc::collections::hash_map::DefaultHasher but it's not in core
 158         #[allow(deprecated)]
 159         let mut hasher = core::hash::SipHasher::new();
 160         core::hash::Hash::hash(o.get_native_ref(), &mut hasher);
 161         core::hash::Hasher::finish(&hasher)
 162 }
 163 /// Checks if two Packets contain equal inner contents.
 164 /// This ignores pointers and is_owned flags and looks at the values in fields.
 165 /// Two objects with NULL inner values will be considered "equal" here.
 166 #[no_mangle]
 167 pub extern "C" fn Packet_eq(a: &Packet, b: &Packet) -> bool {
 168         if a.inner == b.inner { return true; }
 169         if a.inner.is_null() || b.inner.is_null() { return false; }
 170         if a.get_native_ref() == b.get_native_ref() { true } else { false }
 171 }
 172 #[no_mangle]
 173 /// Serialize the Packet object into a byte array which can be read by Packet_read
 174 pub extern "C" fn Packet_write(obj: &crate::lightning::onion_message::packet::Packet) -> crate::c_types::derived::CVec_u8Z {
 175         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 176 }
 177 #[allow(unused)]
 178 pub(crate) extern "C" fn Packet_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 179         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativePacket) })
 180 }
 181 /// The contents of an [`OnionMessage`] as read from the wire.
 182 ///
 183 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
 184 #[derive(Clone)]
 185 #[must_use]
 186 #[repr(C)]
 187 pub enum ParsedOnionMessageContents {
 188         /// A message related to BOLT 12 Offers.
 189         Offers(
 190                 crate::lightning::onion_message::offers::OffersMessage),
 191         /// A custom onion message specified by the user.
 192         Custom(
 193                 crate::lightning::onion_message::packet::OnionMessageContents),
 194 }
 195 use lightning::onion_message::packet::ParsedOnionMessageContents as ParsedOnionMessageContentsImport;
 196 pub(crate) type nativeParsedOnionMessageContents = ParsedOnionMessageContentsImport<crate::lightning::onion_message::packet::OnionMessageContents>;
 197
 198 impl ParsedOnionMessageContents {
 199         #[allow(unused)]
 200         pub(crate) fn to_native(&self) -> nativeParsedOnionMessageContents {
 201                 match self {
 202                         ParsedOnionMessageContents::Offers (ref a, ) => {
 203                                 let mut a_nonref = Clone::clone(a);
 204                                 nativeParsedOnionMessageContents::Offers (
 205                                         a_nonref.into_native(),
 206                                 )
 207                         },
 208                         ParsedOnionMessageContents::Custom (ref a, ) => {
 209                                 let mut a_nonref = Clone::clone(a);
 210                                 nativeParsedOnionMessageContents::Custom (
 211                                         a_nonref,
 212                                 )
 213                         },
 214                 }
 215         }
 216         #[allow(unused)]
 217         pub(crate) fn into_native(self) -> nativeParsedOnionMessageContents {
 218                 match self {
 219                         ParsedOnionMessageContents::Offers (mut a, ) => {
 220                                 nativeParsedOnionMessageContents::Offers (
 221                                         a.into_native(),
 222                                 )
 223                         },
 224                         ParsedOnionMessageContents::Custom (mut a, ) => {
 225                                 nativeParsedOnionMessageContents::Custom (
 226                                         a,
 227                                 )
 228                         },
 229                 }
 230         }
 231         #[allow(unused)]
 232         pub(crate) fn from_native(native: &ParsedOnionMessageContentsImport<crate::lightning::onion_message::packet::OnionMessageContents>) -> Self {
 233                 let native = unsafe { &*(native as *const _ as *const c_void as *const nativeParsedOnionMessageContents) };
 234                 match native {
 235                         nativeParsedOnionMessageContents::Offers (ref a, ) => {
 236                                 let mut a_nonref = Clone::clone(a);
 237                                 ParsedOnionMessageContents::Offers (
 238                                         crate::lightning::onion_message::offers::OffersMessage::native_into(a_nonref),
 239                                 )
 240                         },
 241                         nativeParsedOnionMessageContents::Custom (ref a, ) => {
 242                                 let mut a_nonref = Clone::clone(a);
 243                                 ParsedOnionMessageContents::Custom (
 244                                         Into::into(a_nonref),
 245                                 )
 246                         },
 247                 }
 248         }
 249         #[allow(unused)]
 250         pub(crate) fn native_into(native: nativeParsedOnionMessageContents) -> Self {
 251                 match native {
 252                         nativeParsedOnionMessageContents::Offers (mut a, ) => {
 253                                 ParsedOnionMessageContents::Offers (
 254                                         crate::lightning::onion_message::offers::OffersMessage::native_into(a),
 255                                 )
 256                         },
 257                         nativeParsedOnionMessageContents::Custom (mut a, ) => {
 258                                 ParsedOnionMessageContents::Custom (
 259                                         Into::into(a),
 260                                 )
 261                         },
 262                 }
 263         }
 264 }
 265 /// Frees any resources used by the ParsedOnionMessageContents
 266 #[no_mangle]
 267 pub extern "C" fn ParsedOnionMessageContents_free(this_ptr: ParsedOnionMessageContents) { }
 268 /// Creates a copy of the ParsedOnionMessageContents
 269 #[no_mangle]
 270 pub extern "C" fn ParsedOnionMessageContents_clone(orig: &ParsedOnionMessageContents) -> ParsedOnionMessageContents {
 271         orig.clone()
 272 }
 273 #[allow(unused)]
 274 /// Used only if an object of this type is returned as a trait impl by a method
 275 pub(crate) extern "C" fn ParsedOnionMessageContents_clone_void(this_ptr: *const c_void) -> *mut c_void {
 276         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const ParsedOnionMessageContents)).clone() })) as *mut c_void
 277 }
 278 #[allow(unused)]
 279 /// Used only if an object of this type is returned as a trait impl by a method
 280 pub(crate) extern "C" fn ParsedOnionMessageContents_free_void(this_ptr: *mut c_void) {
 281         let _ = unsafe { Box::from_raw(this_ptr as *mut ParsedOnionMessageContents) };
 282 }
 283 #[no_mangle]
 284 /// Utility method to constructs a new Offers-variant ParsedOnionMessageContents
 285 pub extern "C" fn ParsedOnionMessageContents_offers(a: crate::lightning::onion_message::offers::OffersMessage) -> ParsedOnionMessageContents {
 286         ParsedOnionMessageContents::Offers(a, )
 287 }
 288 #[no_mangle]
 289 /// Utility method to constructs a new Custom-variant ParsedOnionMessageContents
 290 pub extern "C" fn ParsedOnionMessageContents_custom(a: crate::lightning::onion_message::packet::OnionMessageContents) -> ParsedOnionMessageContents {
 291         ParsedOnionMessageContents::Custom(a, )
 292 }
 293 /// Get a string which allows debug introspection of a ParsedOnionMessageContents object
 294 pub extern "C" fn ParsedOnionMessageContents_debug_str_void(o: *const c_void) -> Str {
 295         alloc::format!("{:?}", unsafe { o as *const crate::lightning::onion_message::packet::ParsedOnionMessageContents }).into()}
 296 impl From<nativeParsedOnionMessageContents> for crate::lightning::onion_message::packet::OnionMessageContents {
 297         fn from(obj: nativeParsedOnionMessageContents) -> Self {
 298                 let rust_obj = crate::lightning::onion_message::packet::ParsedOnionMessageContents::native_into(obj);
 299                 let mut ret = ParsedOnionMessageContents_as_OnionMessageContents(&rust_obj);
 300                 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
 301                 core::mem::forget(rust_obj);
 302                 ret.free = Some(ParsedOnionMessageContents_free_void);
 303                 ret
 304         }
 305 }
 306 /// Constructs a new OnionMessageContents which calls the relevant methods on this_arg.
 307 /// This copies the `inner` pointer in this_arg and thus the returned OnionMessageContents must be freed before this_arg is
 308 #[no_mangle]
 309 pub extern "C" fn ParsedOnionMessageContents_as_OnionMessageContents(this_arg: &ParsedOnionMessageContents) -> crate::lightning::onion_message::packet::OnionMessageContents {
 310         crate::lightning::onion_message::packet::OnionMessageContents {
 311                 this_arg: unsafe { ObjOps::untweak_ptr(this_arg as *const ParsedOnionMessageContents as *mut ParsedOnionMessageContents) as *mut c_void },
 312                 free: None,
 313                 tlv_type: ParsedOnionMessageContents_OnionMessageContents_tlv_type,
 314                 write: ParsedOnionMessageContents_write_void,
 315                 debug_str: ParsedOnionMessageContents_debug_str_void,
 316                 cloned: Some(OnionMessageContents_ParsedOnionMessageContents_cloned),
 317         }
 318 }
 319
 320 #[must_use]
 321 extern "C" fn ParsedOnionMessageContents_OnionMessageContents_tlv_type(this_arg: *const c_void) -> u64 {
 322         let mut ret = <nativeParsedOnionMessageContents as lightning::onion_message::packet::OnionMessageContents<>>::tlv_type(unsafe { &mut *(this_arg as *mut nativeParsedOnionMessageContents) }, );
 323         ret
 324 }
 325 extern "C" fn OnionMessageContents_ParsedOnionMessageContents_cloned(new_obj: &mut crate::lightning::onion_message::packet::OnionMessageContents) {
 326         new_obj.this_arg = ParsedOnionMessageContents_clone_void(new_obj.this_arg);
 327         new_obj.free = Some(ParsedOnionMessageContents_free_void);
 328 }
 329
 330 #[no_mangle]
 331 /// Serialize the ParsedOnionMessageContents object into a byte array which can be read by ParsedOnionMessageContents_read
 332 pub extern "C" fn ParsedOnionMessageContents_write(obj: &crate::lightning::onion_message::packet::ParsedOnionMessageContents) -> crate::c_types::derived::CVec_u8Z {
 333         crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
 334 }
 335 #[allow(unused)]
 336 pub(crate) extern "C" fn ParsedOnionMessageContents_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 337         ParsedOnionMessageContents_write(unsafe { &*(obj as *const ParsedOnionMessageContents) })
 338 }
 339 /// The contents of an onion message.
 340 #[repr(C)]
 341 pub struct OnionMessageContents {
 342         /// An opaque pointer which is passed to your function implementations as an argument.
 343         /// This has no meaning in the LDK, and can be NULL or any other value.
 344         pub this_arg: *mut c_void,
 345         /// Returns the TLV type identifying the message contents. MUST be >= 64.
 346         pub tlv_type: extern "C" fn (this_arg: *const c_void) -> u64,
 347         /// Serialize the object into a byte array
 348         pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
 349         /// Return a human-readable "debug" string describing this object
 350         pub debug_str: extern "C" fn (this_arg: *const c_void) -> crate::c_types::Str,
 351         /// Called, if set, after this OnionMessageContents has been cloned into a duplicate object.
 352         /// The new OnionMessageContents is provided, and should be mutated as needed to perform a
 353         /// deep copy of the object pointed to by this_arg or avoid any double-freeing.
 354         pub cloned: Option<extern "C" fn (new_OnionMessageContents: &mut OnionMessageContents)>,
 355         /// Frees any resources associated with this object given its this_arg pointer.
 356         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
 357         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
 358 }
 359 unsafe impl Send for OnionMessageContents {}
 360 unsafe impl Sync for OnionMessageContents {}
 361 #[allow(unused)]
 362 pub(crate) fn OnionMessageContents_clone_fields(orig: &OnionMessageContents) -> OnionMessageContents {
 363         OnionMessageContents {
 364                 this_arg: orig.this_arg,
 365                 tlv_type: Clone::clone(&orig.tlv_type),
 366                 write: Clone::clone(&orig.write),
 367                 debug_str: Clone::clone(&orig.debug_str),
 368                 cloned: Clone::clone(&orig.cloned),
 369                 free: Clone::clone(&orig.free),
 370         }
 371 }
 372 impl lightning::util::ser::Writeable for OnionMessageContents {
 373         fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {
 374                 let vec = (self.write)(self.this_arg);
 375                 w.write_all(vec.as_slice())
 376         }
 377 }
 378 impl core::fmt::Debug for OnionMessageContents {
 379         fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
 380                 f.write_str((self.debug_str)(self.this_arg).into_str())
 381         }
 382 }
 383 #[no_mangle]
 384 /// Creates a copy of a OnionMessageContents
 385 pub extern "C" fn OnionMessageContents_clone(orig: &OnionMessageContents) -> OnionMessageContents {
 386         let mut res = OnionMessageContents_clone_fields(orig);
 387         if let Some(f) = orig.cloned { (f)(&mut res) };
 388         res
 389 }
 390 impl Clone for OnionMessageContents {
 391         fn clone(&self) -> Self {
 392                 OnionMessageContents_clone(self)
 393         }
 394 }
 395
 396 use lightning::onion_message::packet::OnionMessageContents as rustOnionMessageContents;
 397 impl rustOnionMessageContents for OnionMessageContents {
 398         fn tlv_type(&self) -> u64 {
 399                 let mut ret = (self.tlv_type)(self.this_arg);
 400                 ret
 401         }
 402 }
 403
 404 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
 405 // directly as a Deref trait in higher-level structs:
 406 impl core::ops::Deref for OnionMessageContents {
 407         type Target = Self;
 408         fn deref(&self) -> &Self {
 409                 self
 410         }
 411 }
 412 impl core::ops::DerefMut for OnionMessageContents {
 413         fn deref_mut(&mut self) -> &mut Self {
 414                 self
 415         }
 416 }
 417 /// Calls the free function if one is set
 418 #[no_mangle]
 419 pub extern "C" fn OnionMessageContents_free(this_ptr: OnionMessageContents) { }
 420 impl Drop for OnionMessageContents {
 421         fn drop(&mut self) {
 422                 if let Some(f) = self.free {
 423                         f(self.this_arg);
 424                 }
 425         }
 426 }