Merge pull request #8 from lucab/ups/iopl-eperm

backdoor: allow avoiding iopl permission errors

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "vmw_backdoor"
-version = "0.1.4-alpha.0"
+version = "0.2.0-alpha.0"
 authors = ["Luca BRUNO <[email protected]>"]
 edition = "2018"
 license = "MIT/Apache-2.0"

examples/check-backdoor.rs

@@ -5,7 +5,7 @@ fn main() {
     let is_vmw = vmw::is_vmware_cpu();
     println!("VMware CPU detected: {}.", is_vmw);
 
-    let mut backdoor = vmw::access_backdoor().unwrap();
+    let mut backdoor = vmw::access_backdoor_privileged().unwrap();
     println!("Raised I/O access to reach backdoor port.");
 
     let found = match backdoor.probe_vmware_backdoor() {

examples/get-guestinfo.rs

@@ -14,7 +14,7 @@ fn main() {
         panic!("Hypervisor not present");
     }
 
-    let mut backdoor = vmw::probe_backdoor().unwrap();
+    let mut backdoor = vmw::probe_backdoor_privileged().unwrap();
     eprintln!("Got backdoor access.");
 
     let mut erpc = backdoor.open_enhanced_chan().unwrap();

examples/log.rs

@@ -14,7 +14,7 @@ fn main() {
         panic!("Hypervisor not present");
     }
 
-    let mut backdoor = vmw::probe_backdoor().unwrap();
+    let mut backdoor = vmw::probe_backdoor_privileged().unwrap();
     eprintln!("Got backdoor access.");
 
     let mut erpc = backdoor.open_enhanced_chan().unwrap();

examples/report-agent.rs

@@ -8,7 +8,7 @@ fn main() {
         panic!("Hypervisor not present");
     }
 
-    let mut backdoor = vmw::probe_backdoor().unwrap();
+    let mut backdoor = vmw::probe_backdoor_privileged().unwrap();
     eprintln!("Got backdoor access.");
 
     let mut erpc = backdoor.open_enhanced_chan().unwrap();

src/backdoor.rs

@@ -17,18 +17,31 @@ pub(crate) const COMMAND_ERPC: u32 = 0x1E;
 
 /// Try to acquire access to the backdoor, but do NOT probe its presence.
 ///
-/// On Linux, this requires running with `CAP_SYS_RAWIO` privileges.
-pub fn access_backdoor() -> Result<BackdoorGuard, VmwError> {
+/// On Linux, this tries to change I/O access level via `iopl()`. That requires
+/// running with `CAP_SYS_RAWIO` capability and it is not compatible with
+/// `kernel_lockdown`.
+pub fn access_backdoor_privileged() -> Result<BackdoorGuard, VmwError> {
     BackdoorGuard::change_io_access(true)?;
     Ok(BackdoorGuard {
         release_on_drop: true,
     })
 }
 
+/// Try to acquire access to the backdoor, but do NOT probe its presence.
+///
+/// Wherever possible, use `access_backdoor_privileged()` instead.
+pub fn access_backdoor() -> Result<BackdoorGuard, VmwError> {
+    Ok(BackdoorGuard {
+        release_on_drop: false,
+    })
+}
+
 /// Try to acquire access to the backdoor, and probe its presence.
 ///
-/// On Linux, this requires running with `CAP_SYS_RAWIO` privileges.
-pub fn probe_backdoor() -> Result<BackdoorGuard, VmwError> {
+/// On Linux, this tries to change I/O access level via `iopl()`. That requires
+/// running with `CAP_SYS_RAWIO` capability and it is not compatible with
+/// `kernel_lockdown`.
+pub fn probe_backdoor_privileged() -> Result<BackdoorGuard, VmwError> {
     BackdoorGuard::change_io_access(true)?;
     let mut guard = BackdoorGuard {
         release_on_drop: true,
@@ -37,6 +50,17 @@ pub fn probe_backdoor() -> Result<BackdoorGuard, VmwError> {
     Ok(guard)
 }
 
+/// Try to acquire access to the backdoor, and probe its presence.
+///
+/// Wherever possible, use `probe_backdoor_privileged()` instead.
+pub fn probe_backdoor() -> Result<BackdoorGuard, VmwError> {
+    let mut guard = BackdoorGuard {
+        release_on_drop: false,
+    };
+    guard.probe_vmware_backdoor()?;
+    Ok(guard)
+}
+
 /// Guard for an open backdoor.
 ///
 /// This can be acquired via [`access_backdoor`](fn.access_backdoor.html) or
@@ -69,6 +93,7 @@ impl BackdoorGuard {
         EnhancedChan::open(self)
     }
 
+    /// Try to change I/O ports access level.
     pub(crate) fn change_io_access(acquire: bool) -> Result<(), VmwError> {
         // NOTE(lucab): `ioperm()` is not enough here, as the backdoor
         //  protocol uses a dynamic range of I/O ports.
@@ -85,8 +110,10 @@ impl BackdoorGuard {
 
 impl Drop for BackdoorGuard {
     fn drop(&mut self) {
-        if self.release_on_drop && Self::change_io_access(false).is_err() {
-            log::warn!("failed to release backdoor access");
+        if self.release_on_drop {
+            if let Err(e) = Self::change_io_access(false) {
+                log::error!("failed to release backdoor access: {}", e);
+            }
         }
     }
 }

src/lib.rs

@@ -24,7 +24,7 @@
 //! let is_vmw = vmw_backdoor::is_vmware_cpu();
 //! println!("VMware CPU detected: {}.", is_vmw);
 //!
-//! let mut guard = vmw_backdoor::access_backdoor().unwrap();
+//! let mut guard = vmw_backdoor::access_backdoor_privileged().unwrap();
 //! println!("Raised I/O access to reach backdoor port.");
 //!
 //! let found = guard.probe_vmware_backdoor().unwrap_or(false);
@@ -54,8 +54,11 @@ cfg_if::cfg_if! {
         mod erpc;
         mod low_bw;
 
-        pub use backdoor::{access_backdoor, probe_backdoor, BackdoorGuard};
         pub use asm::is_vmware_cpu;
+        pub use backdoor::{
+            access_backdoor, access_backdoor_privileged, probe_backdoor, probe_backdoor_privileged,
+            BackdoorGuard,
+        };
         pub use erpc::EnhancedChan;
     }
 }