_ 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 /// Checks if two Packets contain equal inner contents.
 151 /// This ignores pointers and is_owned flags and looks at the values in fields.
 152 /// Two objects with NULL inner values will be considered "equal" here.
 153 #[no_mangle]
 154 pub extern "C" fn Packet_eq(a: &Packet, b: &Packet) -> bool {
 155         if a.inner == b.inner { return true; }
 156         if a.inner.is_null() || b.inner.is_null() { return false; }
 157         if a.get_native_ref() == b.get_native_ref() { true } else { false }
 158 }
 159 #[no_mangle]
 160 /// Serialize the Packet object into a byte array which can be read by Packet_read
 161 pub extern "C" fn Packet_write(obj: &crate::lightning::onion_message::packet::Packet) -> crate::c_types::derived::CVec_u8Z {
 162         crate::c_types::serialize_obj(unsafe { &*obj }.get_native_ref())
 163 }
 164 #[allow(unused)]
 165 pub(crate) extern "C" fn Packet_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 166         crate::c_types::serialize_obj(unsafe { &*(obj as *const nativePacket) })
 167 }
 168 /// The contents of an [`OnionMessage`] as read from the wire.
 169 ///
 170 /// [`OnionMessage`]: crate::ln::msgs::OnionMessage
 171 #[derive(Clone)]
 172 #[must_use]
 173 #[repr(C)]
 174 pub enum ParsedOnionMessageContents {
 175         /// A message related to BOLT 12 Offers.
 176         Offers(
 177                 crate::lightning::onion_message::offers::OffersMessage),
 178         /// A custom onion message specified by the user.
 179         Custom(
 180                 crate::lightning::onion_message::packet::OnionMessageContents),
 181 }
 182 use lightning::onion_message::packet::ParsedOnionMessageContents as ParsedOnionMessageContentsImport;
 183 pub(crate) type nativeParsedOnionMessageContents = ParsedOnionMessageContentsImport<crate::lightning::onion_message::packet::OnionMessageContents>;
 184
 185 impl ParsedOnionMessageContents {
 186         #[allow(unused)]
 187         pub(crate) fn to_native(&self) -> nativeParsedOnionMessageContents {
 188                 match self {
 189                         ParsedOnionMessageContents::Offers (ref a, ) => {
 190                                 let mut a_nonref = Clone::clone(a);
 191                                 nativeParsedOnionMessageContents::Offers (
 192                                         a_nonref.into_native(),
 193                                 )
 194                         },
 195                         ParsedOnionMessageContents::Custom (ref a, ) => {
 196                                 let mut a_nonref = Clone::clone(a);
 197                                 nativeParsedOnionMessageContents::Custom (
 198                                         a_nonref,
 199                                 )
 200                         },
 201                 }
 202         }
 203         #[allow(unused)]
 204         pub(crate) fn into_native(self) -> nativeParsedOnionMessageContents {
 205                 match self {
 206                         ParsedOnionMessageContents::Offers (mut a, ) => {
 207                                 nativeParsedOnionMessageContents::Offers (
 208                                         a.into_native(),
 209                                 )
 210                         },
 211                         ParsedOnionMessageContents::Custom (mut a, ) => {
 212                                 nativeParsedOnionMessageContents::Custom (
 213                                         a,
 214                                 )
 215                         },
 216                 }
 217         }
 218         #[allow(unused)]
 219         pub(crate) fn from_native(native: &nativeParsedOnionMessageContents) -> Self {
 220                 match native {
 221                         nativeParsedOnionMessageContents::Offers (ref a, ) => {
 222                                 let mut a_nonref = Clone::clone(a);
 223                                 ParsedOnionMessageContents::Offers (
 224                                         crate::lightning::onion_message::offers::OffersMessage::native_into(a_nonref),
 225                                 )
 226                         },
 227                         nativeParsedOnionMessageContents::Custom (ref a, ) => {
 228                                 let mut a_nonref = Clone::clone(a);
 229                                 ParsedOnionMessageContents::Custom (
 230                                         Into::into(a_nonref),
 231                                 )
 232                         },
 233                 }
 234         }
 235         #[allow(unused)]
 236         pub(crate) fn native_into(native: nativeParsedOnionMessageContents) -> Self {
 237                 match native {
 238                         nativeParsedOnionMessageContents::Offers (mut a, ) => {
 239                                 ParsedOnionMessageContents::Offers (
 240                                         crate::lightning::onion_message::offers::OffersMessage::native_into(a),
 241                                 )
 242                         },
 243                         nativeParsedOnionMessageContents::Custom (mut a, ) => {
 244                                 ParsedOnionMessageContents::Custom (
 245                                         Into::into(a),
 246                                 )
 247                         },
 248                 }
 249         }
 250 }
 251 /// Frees any resources used by the ParsedOnionMessageContents
 252 #[no_mangle]
 253 pub extern "C" fn ParsedOnionMessageContents_free(this_ptr: ParsedOnionMessageContents) { }
 254 /// Creates a copy of the ParsedOnionMessageContents
 255 #[no_mangle]
 256 pub extern "C" fn ParsedOnionMessageContents_clone(orig: &ParsedOnionMessageContents) -> ParsedOnionMessageContents {
 257         orig.clone()
 258 }
 259 #[allow(unused)]
 260 /// Used only if an object of this type is returned as a trait impl by a method
 261 pub(crate) extern "C" fn ParsedOnionMessageContents_clone_void(this_ptr: *const c_void) -> *mut c_void {
 262         Box::into_raw(Box::new(unsafe { (*(this_ptr as *const ParsedOnionMessageContents)).clone() })) as *mut c_void
 263 }
 264 #[allow(unused)]
 265 /// Used only if an object of this type is returned as a trait impl by a method
 266 pub(crate) extern "C" fn ParsedOnionMessageContents_free_void(this_ptr: *mut c_void) {
 267         let _ = unsafe { Box::from_raw(this_ptr as *mut ParsedOnionMessageContents) };
 268 }
 269 #[no_mangle]
 270 /// Utility method to constructs a new Offers-variant ParsedOnionMessageContents
 271 pub extern "C" fn ParsedOnionMessageContents_offers(a: crate::lightning::onion_message::offers::OffersMessage) -> ParsedOnionMessageContents {
 272         ParsedOnionMessageContents::Offers(a, )
 273 }
 274 #[no_mangle]
 275 /// Utility method to constructs a new Custom-variant ParsedOnionMessageContents
 276 pub extern "C" fn ParsedOnionMessageContents_custom(a: crate::lightning::onion_message::packet::OnionMessageContents) -> ParsedOnionMessageContents {
 277         ParsedOnionMessageContents::Custom(a, )
 278 }
 279 impl From<nativeParsedOnionMessageContents> for crate::lightning::onion_message::packet::OnionMessageContents {
 280         fn from(obj: nativeParsedOnionMessageContents) -> Self {
 281                 let rust_obj = crate::lightning::onion_message::packet::ParsedOnionMessageContents::native_into(obj);
 282                 let mut ret = ParsedOnionMessageContents_as_OnionMessageContents(&rust_obj);
 283                 // We want to free rust_obj when ret gets drop()'d, not rust_obj, so forget it and set ret's free() fn
 284                 core::mem::forget(rust_obj);
 285                 ret.free = Some(ParsedOnionMessageContents_free_void);
 286                 ret
 287         }
 288 }
 289 /// Constructs a new OnionMessageContents which calls the relevant methods on this_arg.
 290 /// This copies the `inner` pointer in this_arg and thus the returned OnionMessageContents must be freed before this_arg is
 291 #[no_mangle]
 292 pub extern "C" fn ParsedOnionMessageContents_as_OnionMessageContents(this_arg: &ParsedOnionMessageContents) -> crate::lightning::onion_message::packet::OnionMessageContents {
 293         crate::lightning::onion_message::packet::OnionMessageContents {
 294                 this_arg: unsafe { ObjOps::untweak_ptr(this_arg as *const ParsedOnionMessageContents as *mut ParsedOnionMessageContents) as *mut c_void },
 295                 free: None,
 296                 tlv_type: ParsedOnionMessageContents_OnionMessageContents_tlv_type,
 297                 write: ParsedOnionMessageContents_write_void,
 298                 cloned: Some(OnionMessageContents_ParsedOnionMessageContents_cloned),
 299         }
 300 }
 301
 302 #[must_use]
 303 extern "C" fn ParsedOnionMessageContents_OnionMessageContents_tlv_type(this_arg: *const c_void) -> u64 {
 304         let mut ret = <nativeParsedOnionMessageContents as lightning::onion_message::packet::OnionMessageContents<>>::tlv_type(unsafe { &mut *(this_arg as *mut nativeParsedOnionMessageContents) }, );
 305         ret
 306 }
 307 extern "C" fn OnionMessageContents_ParsedOnionMessageContents_cloned(new_obj: &mut crate::lightning::onion_message::packet::OnionMessageContents) {
 308         new_obj.this_arg = ParsedOnionMessageContents_clone_void(new_obj.this_arg);
 309         new_obj.free = Some(ParsedOnionMessageContents_free_void);
 310 }
 311
 312 #[no_mangle]
 313 /// Serialize the ParsedOnionMessageContents object into a byte array which can be read by ParsedOnionMessageContents_read
 314 pub extern "C" fn ParsedOnionMessageContents_write(obj: &crate::lightning::onion_message::packet::ParsedOnionMessageContents) -> crate::c_types::derived::CVec_u8Z {
 315         crate::c_types::serialize_obj(&unsafe { &*obj }.to_native())
 316 }
 317 #[allow(unused)]
 318 pub(crate) extern "C" fn ParsedOnionMessageContents_write_void(obj: *const c_void) -> crate::c_types::derived::CVec_u8Z {
 319         ParsedOnionMessageContents_write(unsafe { &*(obj as *const ParsedOnionMessageContents) })
 320 }
 321 /// The contents of an onion message.
 322 #[repr(C)]
 323 pub struct OnionMessageContents {
 324         /// An opaque pointer which is passed to your function implementations as an argument.
 325         /// This has no meaning in the LDK, and can be NULL or any other value.
 326         pub this_arg: *mut c_void,
 327         /// Returns the TLV type identifying the message contents. MUST be >= 64.
 328         pub tlv_type: extern "C" fn (this_arg: *const c_void) -> u64,
 329         /// Serialize the object into a byte array
 330         pub write: extern "C" fn (this_arg: *const c_void) -> crate::c_types::derived::CVec_u8Z,
 331         /// Called, if set, after this OnionMessageContents has been cloned into a duplicate object.
 332         /// The new OnionMessageContents is provided, and should be mutated as needed to perform a
 333         /// deep copy of the object pointed to by this_arg or avoid any double-freeing.
 334         pub cloned: Option<extern "C" fn (new_OnionMessageContents: &mut OnionMessageContents)>,
 335         /// Frees any resources associated with this object given its this_arg pointer.
 336         /// Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
 337         pub free: Option<extern "C" fn(this_arg: *mut c_void)>,
 338 }
 339 unsafe impl Send for OnionMessageContents {}
 340 unsafe impl Sync for OnionMessageContents {}
 341 #[allow(unused)]
 342 pub(crate) fn OnionMessageContents_clone_fields(orig: &OnionMessageContents) -> OnionMessageContents {
 343         OnionMessageContents {
 344                 this_arg: orig.this_arg,
 345                 tlv_type: Clone::clone(&orig.tlv_type),
 346                 write: Clone::clone(&orig.write),
 347                 cloned: Clone::clone(&orig.cloned),
 348                 free: Clone::clone(&orig.free),
 349         }
 350 }
 351 impl lightning::util::ser::Writeable for OnionMessageContents {
 352         fn write<W: lightning::util::ser::Writer>(&self, w: &mut W) -> Result<(), crate::c_types::io::Error> {
 353                 let vec = (self.write)(self.this_arg);
 354                 w.write_all(vec.as_slice())
 355         }
 356 }
 357 #[no_mangle]
 358 /// Creates a copy of a OnionMessageContents
 359 pub extern "C" fn OnionMessageContents_clone(orig: &OnionMessageContents) -> OnionMessageContents {
 360         let mut res = OnionMessageContents_clone_fields(orig);
 361         if let Some(f) = orig.cloned { (f)(&mut res) };
 362         res
 363 }
 364 impl Clone for OnionMessageContents {
 365         fn clone(&self) -> Self {
 366                 OnionMessageContents_clone(self)
 367         }
 368 }
 369
 370 use lightning::onion_message::packet::OnionMessageContents as rustOnionMessageContents;
 371 impl rustOnionMessageContents for OnionMessageContents {
 372         fn tlv_type(&self) -> u64 {
 373                 let mut ret = (self.tlv_type)(self.this_arg);
 374                 ret
 375         }
 376 }
 377
 378 // We're essentially a pointer already, or at least a set of pointers, so allow us to be used
 379 // directly as a Deref trait in higher-level structs:
 380 impl core::ops::Deref for OnionMessageContents {
 381         type Target = Self;
 382         fn deref(&self) -> &Self {
 383                 self
 384         }
 385 }
 386 impl core::ops::DerefMut for OnionMessageContents {
 387         fn deref_mut(&mut self) -> &mut Self {
 388                 self
 389         }
 390 }
 391 /// Calls the free function if one is set
 392 #[no_mangle]
 393 pub extern "C" fn OnionMessageContents_free(this_ptr: OnionMessageContents) { }
 394 impl Drop for OnionMessageContents {
 395         fn drop(&mut self) {
 396                 if let Some(f) = self.free {
 397                         f(self.this_arg);
 398                 }
 399         }
 400 }