Generated file

Copy as Markdown

Other Tools

//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/security/manager/ssl/nsICtapCableHandshake.idl
//
/// `interface nsICtapCableInitiatorHandshake : nsISupports`
///
/// ```text
/// /**
/// * Noise initiator handshake interface, used for WebAuthn over Hybrid/caBLE
/// * transports.
/// */
/// ```
///
// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.
#[repr(C)]
pub struct nsICtapCableInitiatorHandshake {
vtable: &'static nsICtapCableInitiatorHandshakeVTable,
/// This field is a phantomdata to ensure that the VTable type and any
/// struct containing it is not safe to send across threads by default, as
/// XPCOM is generally not threadsafe.
///
/// If this type is marked as [rust_sync], there will be explicit `Send` and
/// `Sync` implementations on this type, which will override the inherited
/// negative impls from `Rc`.
__nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
// Make the rust compiler aware that there might be interior mutability
// in what actually implements the interface. This works around UB
// that a rust lint would make blatantly obvious, but doesn't exist.
// This prevents optimizations, but those optimizations weren't available
// before rustc switched to LLVM 16, and they now cause problems because
// of the UB.
// Until there's a lint available to find all our UB, it's simpler to
// avoid the UB in the first place, at the cost of preventing optimizations
// in places that don't cause UB. But again, those optimizations weren't
// available before.
__maybe_interior_mutability: ::std::cell::UnsafeCell<[u8; 0]>,
}
// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsICtapCableInitiatorHandshake.
unsafe impl XpCom for nsICtapCableInitiatorHandshake {
const IID: nsIID = nsID(0x969ef799, 0xb1aa, 0x4d8e,
[0x83, 0x42, 0x6a, 0x41, 0x80, 0x31, 0xc7, 0x77]);
}
// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsICtapCableInitiatorHandshake {
#[inline]
unsafe fn addref(&self) {
self.AddRef();
}
#[inline]
unsafe fn release(&self) {
self.Release();
}
}
// This trait is implemented on all types which can be coerced to from nsICtapCableInitiatorHandshake.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsICtapCableInitiatorHandshakeCoerce {
/// Cheaply cast a value of this type from a `nsICtapCableInitiatorHandshake`.
fn coerce_from(v: &nsICtapCableInitiatorHandshake) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsICtapCableInitiatorHandshakeCoerce for nsICtapCableInitiatorHandshake {
#[inline]
fn coerce_from(v: &nsICtapCableInitiatorHandshake) -> &Self {
v
}
}
impl nsICtapCableInitiatorHandshake {
/// Cast this `nsICtapCableInitiatorHandshake` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsICtapCableInitiatorHandshakeCoerce>(&self) -> &T {
T::coerce_from(self)
}
}
// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsICtapCableInitiatorHandshake {
type Target = nsISupports;
#[inline]
fn deref(&self) -> &nsISupports {
unsafe {
::std::mem::transmute(self)
}
}
}
// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsISupportsCoerce> nsICtapCableInitiatorHandshakeCoerce for T {
#[inline]
fn coerce_from(v: &nsICtapCableInitiatorHandshake) -> &Self {
T::coerce_from(v)
}
}
// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsICtapCableInitiatorHandshake
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsICtapCableInitiatorHandshakeVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* readonly attribute Array<octet> initialMessage; */
pub GetInitialMessage: unsafe extern "system" fn (this: *const nsICtapCableInitiatorHandshake, aInitialMessage: *mut thin_vec::ThinVec<u8>) -> ::nserror::nsresult,
/* readonly attribute boolean consumed; */
pub GetConsumed: unsafe extern "system" fn (this: *const nsICtapCableInitiatorHandshake, aConsumed: *mut bool) -> ::nserror::nsresult,
/* nsICtapCableInitiator processHandshakeResponse (in Array<octet> aResponseMessage); */
pub ProcessHandshakeResponse: unsafe extern "system" fn (this: *const nsICtapCableInitiatorHandshake, aResponseMessage: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableInitiator) -> ::nserror::nsresult,
}
// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsICtapCableInitiatorHandshake {
/// ```text
/// /**
/// * Initial message to send to the responder to complete the handshake.
/// */
/// ```
///
/// `readonly attribute Array<octet> initialMessage;`
#[inline]
pub unsafe fn GetInitialMessage(&self, aInitialMessage: *mut thin_vec::ThinVec<u8>) -> ::nserror::nsresult {
((*self.vtable).GetInitialMessage)(self, aInitialMessage)
}
/// ```text
/// /**
/// * `true` if the handshake state has been "consumed", and so any
/// * `processHandshakeResponse` call will fail.
/// */
/// ```
///
/// `readonly attribute boolean consumed;`
#[inline]
pub unsafe fn GetConsumed(&self, aConsumed: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetConsumed)(self, aConsumed)
}
/// ```text
/// /**
/// * Complete a caBLE handshake as the initiating party.
/// *
/// * This mutates internal state, even on errors, so can only be called once.
/// * After the first call, this will always return errors, and the `consumed`
/// * attribute will be set to `true`.
/// *
/// * @param aResponseMessage [in] message from the responder
/// *
/// * @returns Noise channel for further communication with the responder,
/// * after the handshake has completed, and handshake hash
/// */
/// ```
///
/// `nsICtapCableInitiator processHandshakeResponse (in Array<octet> aResponseMessage);`
#[inline]
pub unsafe fn ProcessHandshakeResponse(&self, aResponseMessage: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableInitiator) -> ::nserror::nsresult {
((*self.vtable).ProcessHandshakeResponse)(self, aResponseMessage, _retval)
}
}
/// `interface nsICtapCableHandshakeService : nsISupports`
///
/// ```text
/// /**
/// * Noise handshake service singleton.
/// */
/// ```
///
// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.
#[repr(C)]
pub struct nsICtapCableHandshakeService {
vtable: &'static nsICtapCableHandshakeServiceVTable,
/// This field is a phantomdata to ensure that the VTable type and any
/// struct containing it is not safe to send across threads by default, as
/// XPCOM is generally not threadsafe.
///
/// If this type is marked as [rust_sync], there will be explicit `Send` and
/// `Sync` implementations on this type, which will override the inherited
/// negative impls from `Rc`.
__nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
// Make the rust compiler aware that there might be interior mutability
// in what actually implements the interface. This works around UB
// that a rust lint would make blatantly obvious, but doesn't exist.
// This prevents optimizations, but those optimizations weren't available
// before rustc switched to LLVM 16, and they now cause problems because
// of the UB.
// Until there's a lint available to find all our UB, it's simpler to
// avoid the UB in the first place, at the cost of preventing optimizations
// in places that don't cause UB. But again, those optimizations weren't
// available before.
__maybe_interior_mutability: ::std::cell::UnsafeCell<[u8; 0]>,
}
// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsICtapCableHandshakeService.
unsafe impl XpCom for nsICtapCableHandshakeService {
const IID: nsIID = nsID(0x27cd5d83, 0x2778, 0x40dd,
[0x92, 0x98, 0x10, 0x67, 0x6f, 0x83, 0x01, 0x86]);
}
// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsICtapCableHandshakeService {
#[inline]
unsafe fn addref(&self) {
self.AddRef();
}
#[inline]
unsafe fn release(&self) {
self.Release();
}
}
// This trait is implemented on all types which can be coerced to from nsICtapCableHandshakeService.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsICtapCableHandshakeServiceCoerce {
/// Cheaply cast a value of this type from a `nsICtapCableHandshakeService`.
fn coerce_from(v: &nsICtapCableHandshakeService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsICtapCableHandshakeServiceCoerce for nsICtapCableHandshakeService {
#[inline]
fn coerce_from(v: &nsICtapCableHandshakeService) -> &Self {
v
}
}
impl nsICtapCableHandshakeService {
/// Cast this `nsICtapCableHandshakeService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsICtapCableHandshakeServiceCoerce>(&self) -> &T {
T::coerce_from(self)
}
}
// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsICtapCableHandshakeService {
type Target = nsISupports;
#[inline]
fn deref(&self) -> &nsISupports {
unsafe {
::std::mem::transmute(self)
}
}
}
// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsISupportsCoerce> nsICtapCableHandshakeServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsICtapCableHandshakeService) -> &Self {
T::coerce_from(v)
}
}
// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsICtapCableHandshakeService
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsICtapCableHandshakeServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* nsICtapCableInitiatorHandshake newQrInitiatedInitiatorHandshake (in Array<octet> aPsk, in Array<octet> aLocalIdentity); */
pub NewQrInitiatedInitiatorHandshake: unsafe extern "system" fn (this: *const nsICtapCableHandshakeService, aPsk: *const thin_vec::ThinVec<u8>, aLocalIdentity: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableInitiatorHandshake) -> ::nserror::nsresult,
/* nsICtapCableResponder newQrInitiatedResponder (in Array<octet> aPsk, in Array<octet> aPeerPubKey, in Array<octet> aInitialMessage); */
pub NewQrInitiatedResponder: unsafe extern "system" fn (this: *const nsICtapCableHandshakeService, aPsk: *const thin_vec::ThinVec<u8>, aPeerPubKey: *const thin_vec::ThinVec<u8>, aInitialMessage: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableResponder) -> ::nserror::nsresult,
}
// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsICtapCableHandshakeService {
/// ```text
/// /**
/// * Start a caBLE QR-initiated handshake (Noise `KNpsk0_P256_AESGCM_SHA256`) as the initiator.
/// *
/// * @param aPsk [in] 32-byte pre-shared key, negotiated
/// * out-of-band
/// * @param aLocalIdentity [in] local ECDH keypair, encoded in DER
/// * @param aHandshakeState [out] nsICtapCableInitiatorHandshake for
/// * processing the responder's response
/// *
/// */
/// ```
///
/// `nsICtapCableInitiatorHandshake newQrInitiatedInitiatorHandshake (in Array<octet> aPsk, in Array<octet> aLocalIdentity);`
#[inline]
pub unsafe fn NewQrInitiatedInitiatorHandshake(&self, aPsk: *const thin_vec::ThinVec<u8>, aLocalIdentity: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableInitiatorHandshake) -> ::nserror::nsresult {
((*self.vtable).NewQrInitiatedInitiatorHandshake)(self, aPsk, aLocalIdentity, _retval)
}
/// ```text
/// /**
/// * Complete a caBLE QR-initiated handshake (Noise `KNpsk0_P256_AESGCM_SHA256`) as the responder
/// * (authenticator).
/// *
/// * @param aPsk [in] 32-byte pre-shared key, negotiated
/// * out-of-band
/// * @param aPeerPubKey [in] remote peer's public key, as an
/// * uncompressed, X9.62 P-256 point
/// * @param aInitialMessage [in] initial message from the initiator
/// *
/// * @returns Noise channel for further communication the initiator, and the
/// * response message to sent to the initiator
/// *
/// */
/// ```
///
/// `nsICtapCableResponder newQrInitiatedResponder (in Array<octet> aPsk, in Array<octet> aPeerPubKey, in Array<octet> aInitialMessage);`
#[inline]
pub unsafe fn NewQrInitiatedResponder(&self, aPsk: *const thin_vec::ThinVec<u8>, aPeerPubKey: *const thin_vec::ThinVec<u8>, aInitialMessage: *const thin_vec::ThinVec<u8>, _retval: *mut *const nsICtapCableResponder) -> ::nserror::nsresult {
((*self.vtable).NewQrInitiatedResponder)(self, aPsk, aPeerPubKey, aInitialMessage, _retval)
}
}