1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
/*!
This module contains functions related to the Inventory system for Connectors and Os-Plugins.
All functionality in this module is gated behind `plugins` feature.
*/
use crate::cglue::*;
use cglue::trait_group::c_void;
use core::convert::{TryFrom, TryInto};
use std::prelude::v1::*;
pub mod args;
#[doc(hidden)]
pub use args::{ArgDescriptor, Args, ArgsValidator};
// cbindgen fails to properly parse this as return type
pub type OptionVoid = Option<&'static mut c_void>;
pub type LibArc = CArc<c_void>;
pub mod connector;
pub use connector::{
cglue_connectorinstance::*, ConnectorArgs, ConnectorDescriptor, ConnectorMiddlewareArgs,
LoadableConnector,
};
pub type ConnectorInputArg = <LoadableConnector as Loadable>::InputArg;
pub mod os;
pub use os::{
cglue_intoprocessinstance::*, cglue_osinstance::*, cglue_processinstance::*,
IntoProcessInstanceArcBox, LoadableOs, MuOsInstanceArcBox, OsArgs, OsDescriptor,
OsInstanceArcBox, ProcessInstanceArcBox,
};
pub type OsInputArg = <LoadableOs as Loadable>::InputArg;
pub mod logger;
pub use logger::*; // TODO: restrict
pub(crate) mod util;
pub use util::{wrap, wrap_with_input};
use crate::error::{Result, *};
use log::{debug, error, info, warn, LevelFilter};
use std::fs::read_dir;
use std::mem::MaybeUninit;
use std::path::{Path, PathBuf};
use abi_stable::{type_layout::TypeLayout, StableAbi};
use libloading::Library;
use once_cell::sync::OnceCell;
/// Exported memflow plugins version
pub const MEMFLOW_PLUGIN_VERSION: i32 = 1;
/// Help and Target callbacks
pub type HelpCallback<'a> = OpaqueCallback<'a, ReprCString>;
/// Context for a single library.
pub struct LibContext {
lib: Library,
logger: OnceCell<Box<PluginLogger>>,
}
impl From<Library> for LibContext {
fn from(lib: Library) -> Self {
Self {
lib,
logger: Default::default(),
}
}
}
impl LibContext {
/// Get a static logger for this library context.
///
/// # Safety
///
/// The returned logger is not actually static. Caller must ensure the reference won't dangle
/// after the library is unloaded. This is typically ensured by only passing this reference to
/// the underlying library code.
pub unsafe fn get_logger(&self) -> &'static PluginLogger {
(&**self.logger.get_or_init(|| Box::new(PluginLogger::new())) as *const PluginLogger)
.as_ref()
.unwrap()
}
pub fn try_get_logger(&self) -> Option<&PluginLogger> {
self.logger.get().map(|l| &**l)
}
}
/// Target information structure
#[repr(C)]
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(::serde::Serialize, ::serde::Deserialize))]
pub struct TargetInfo {
/// Name of the target
pub name: ReprCString,
}
pub type TargetCallback<'a> = OpaqueCallback<'a, TargetInfo>;
#[repr(C)]
pub struct PluginDescriptor<T: Loadable> {
/// The plugin api version for when the plugin was built.
/// This has to be set to `MEMFLOW_PLUGIN_VERSION` of memflow.
///
/// If the versions mismatch the inventory will refuse to load.
pub plugin_version: i32,
/// Does the plugin accept an input parameter?
pub accept_input: bool,
/// Layout of the input type.
pub input_layout: &'static TypeLayout,
/// Layout of the loaded type.
pub output_layout: &'static TypeLayout,
/// The name of the plugin.
/// This name will be used when loading a plugin from the inventory.
///
/// During plugin discovery, the export suffix has to match this name being capitalized
pub name: CSliceRef<'static, u8>,
/// The version of the connector.
/// If multiple connectors are installed the latest is picked.
pub version: CSliceRef<'static, u8>,
/// The description of the connector.
pub description: CSliceRef<'static, u8>,
/// Retrieves a help string from the plugin (lists all available commands)
pub help_callback: Option<extern "C" fn(callback: HelpCallback) -> ()>,
/// Retrieves a list of available targets for the plugin
pub target_list_callback: Option<extern "C" fn(callback: TargetCallback) -> i32>,
/// Create instance of the plugin
pub create: CreateFn<T>,
}
// This warning is misleading here. `Loadable::ArgsType` isn't constrained to be `#[repr(C)]` here
// but both `ConnectorArgs` and `OsArgs` that use it are marked as `#[repr(C)]`.
#[allow(improper_ctypes_definitions)]
pub type CreateFn<T> = extern "C" fn(
Option<&<T as Loadable>::ArgsType>,
<T as Loadable>::CInputArg,
lib: LibArc,
logger: Option<&'static PluginLogger>,
&mut MaybeUninit<<T as Loadable>::Instance>,
) -> i32;
/// Defines a common interface for loadable plugins
pub trait Loadable: Sized {
type Instance: StableAbi;
type InputArg;
type CInputArg: StableAbi;
type ArgsType;
/// Checks if plugin with the same `ident` already exists in input list
fn exists(&self, instances: &[LibInstance<Self>]) -> bool {
instances
.iter()
.filter_map(|i| i.state.as_option())
.any(|(_, l)| l.ident() == self.ident())
}
/// Identifier string of the plugin
fn ident(&self) -> &str;
fn plugin_type() -> &'static str;
/// Constant prefix for the plugin type
fn export_prefix() -> &'static str;
fn new(descriptor: PluginDescriptor<Self>) -> Self;
fn load(
path: impl AsRef<Path>,
library: &CArc<LibContext>,
export: &str,
) -> Result<LibInstance<Self>> {
// find os descriptor
let descriptor = unsafe {
library
.as_ref()
// TODO: support loading without arc
.ok_or(Error(ErrorOrigin::Inventory, ErrorKind::Uninitialized))?
.lib
.get::<*mut PluginDescriptor<Self>>(format!("{}\0", export).as_bytes())
.map_err(|_| Error(ErrorOrigin::Inventory, ErrorKind::MemflowExportsNotFound))?
.read()
};
// check version
if descriptor.plugin_version != MEMFLOW_PLUGIN_VERSION {
warn!(
"{} has a different version. version {} required, found {}.",
export, MEMFLOW_PLUGIN_VERSION, descriptor.plugin_version
);
Ok(LibInstance {
path: path.as_ref().to_path_buf(),
state: LibInstanceState::VersionMismatch,
})
} else if VerifyLayout::check::<Self::CInputArg>(Some(descriptor.input_layout))
.and(VerifyLayout::check::<Self::Instance>(Some(
descriptor.output_layout,
)))
.is_valid_strict()
{
Ok(LibInstance {
path: path.as_ref().to_path_buf(),
state: LibInstanceState::Loaded {
library: library.clone(),
loader: Self::new(descriptor),
},
})
} else {
warn!("{} has invalid ABI.", export);
Ok(LibInstance {
path: path.as_ref().to_path_buf(),
state: LibInstanceState::InvalidAbi,
})
}
}
/// Try to load a plugin library
///
/// This function will access `library` and try to find corresponding entry for the plugin. If
/// a valid plugins are found, `Ok(LibInstance<Self>)` is returned. Otherwise, `Err(Error)` is
/// returned, with appropriate error.
///
/// # Safety
///
/// Loading third party libraries is inherently unsafe and the compiler
/// cannot guarantee that the implementation of the library
/// matches the one specified here. This is especially true if
/// the loaded library implements the necessary interface manually.
///
/// It is adviced to use a provided proc macro to define a valid library.
fn load_all(path: impl AsRef<Path>) -> Result<Vec<LibInstance<Self>>> {
let exports = util::find_export_by_prefix(path.as_ref(), Self::export_prefix())?;
if exports.is_empty() {
return Err(Error(
ErrorOrigin::Inventory,
ErrorKind::MemflowExportsNotFound,
));
}
// load library
let library = unsafe { Library::new(path.as_ref()) }
.map_err(|err| {
debug!(
"found {:?} in library '{:?}' but could not load it: {}",
exports,
path.as_ref(),
err
);
Error(ErrorOrigin::Inventory, ErrorKind::UnableToLoadLibrary)
})
.map(LibContext::from)
.map(CArc::from)?;
Ok(exports
.into_iter()
.filter_map(|e| Self::load(path.as_ref(), &library, &e).ok())
.collect())
}
/// Helper function to load a plugin into a list of library instances
///
/// This function will try finding appropriate plugin entry, and add it into the list if there
/// isn't a duplicate entry.
///
/// # Safety
///
/// Loading third party libraries is inherently unsafe and the compiler
/// cannot guarantee that the implementation of the library matches the one
/// specified here.
fn load_append(path: impl AsRef<Path>, out: &mut Vec<LibInstance<Self>>) -> Result<()> {
// try to get the canonical path
let canonical_path =
std::fs::canonicalize(path.as_ref()).unwrap_or_else(|_| path.as_ref().to_owned());
let libs = Self::load_all(path.as_ref())?;
for lib in libs.into_iter() {
// check if the canonical path was already added
if !out.iter().any(|o| o.path == canonical_path) {
if let LibInstanceState::Loaded { library: _, loader } = &lib.state {
// check if the ident already exists
if !loader.exists(out) {
info!(
"adding plugin '{}/{}': {:?}",
Self::plugin_type(),
loader.ident(),
path.as_ref()
);
out.push(lib);
} else {
debug!(
"skipping library '{}' because it was added already: {:?}",
loader.ident(),
path.as_ref()
);
return Err(Error(ErrorOrigin::Inventory, ErrorKind::AlreadyExists));
}
} else {
out.push(lib);
}
} else {
debug!(
"skipping library at '{:?}' because it was added already",
path.as_ref()
);
return Err(Error(ErrorOrigin::Inventory, ErrorKind::AlreadyExists));
}
}
Ok(())
}
/// Retrieves the help text for this plugin
fn help(&self) -> Result<String>;
/// Retrieves the list of available targets for this plugin
fn target_list(&self) -> Result<Vec<TargetInfo>>;
/// Creates an `Instance` of the library
///
/// This function assumes that `load` performed necessary safety checks
/// for validity of the library.
fn instantiate(
&self,
library: CArc<LibContext>,
input: Self::InputArg,
args: Option<&Self::ArgsType>,
) -> Result<Self::Instance>;
}
/// The core of the plugin system
///
/// It scans system directories and collects valid memflow plugins. They can then be instantiated
/// easily. The reason the libraries are collected is to allow for reuse, and save performance
///
/// # Examples
///
/// Creating a OS instance, the recommended way:
///
/// ```no_run
/// use memflow::plugins::Inventory;
/// # use memflow::plugins::OsInstanceArcBox;
/// # use memflow::error::Result;
/// # fn test() -> Result<OsInstanceArcBox<'static>> {
/// let inventory = Inventory::scan();
/// inventory
/// .builder()
/// .connector("qemu")
/// .os("win32")
/// .build()
/// # }
/// # test().ok();
/// ```
///
/// Nesting connectors and os plugins:
/// ```no_run
/// use memflow::plugins::{Inventory, Args};
/// # use memflow::error::Result;
/// # fn test() -> Result<()> {
/// let inventory = Inventory::scan();
/// let os = inventory
/// .builder()
/// .connector("qemu")
/// .os("linux")
/// .connector("qemu")
/// .os("win32")
/// .build();
/// # Ok(())
/// # }
/// # test().ok();
/// ```
pub struct Inventory {
connectors: Vec<LibInstance<connector::LoadableConnector>>,
os_layers: Vec<LibInstance<os::LoadableOs>>,
}
impl Inventory {
/// Creates a new inventory of plugins from the provided path.
/// The path has to be a valid directory or the function will fail with an `Error::IO` error.
///
/// # Examples
///
/// Creating a inventory:
/// ```
/// use memflow::plugins::Inventory;
///
/// let inventory = Inventory::scan_path("./")
/// .unwrap();
/// ```
pub fn scan_path<P: AsRef<Path>>(path: P) -> Result<Self> {
let mut dir = PathBuf::default();
dir.push(path);
let mut ret = Self {
connectors: vec![],
os_layers: vec![],
};
ret.add_dir(dir)?;
Ok(ret)
}
/// Creates a new inventory of plugins by searching various paths.
///
/// It will query PATH, and an additional set of of directories (standard unix ones, if unix,
/// and "HOME/.local/lib" on all OSes) for "memflow" directory, and if there is one, then
/// search for libraries in there.
///
/// # Examples
///
/// Creating an inventory:
/// ```
/// use memflow::plugins::Inventory;
///
/// let inventory = Inventory::scan();
/// ```
pub fn scan() -> Self {
// add default paths
#[cfg(unix)]
let extra_paths: Vec<&str> = vec![
"/usr/lib", // deprecated
"/usr/local/lib",
];
#[cfg(not(unix))]
let extra_paths = if let Some(Some(programfiles)) =
std::env::var_os("PROGRAMFILES").map(|v| v.to_str().map(|s| s.to_owned()))
{
vec![programfiles]
} else {
vec![]
};
let path_iter = extra_paths.into_iter().map(PathBuf::from);
// add environment variable MEMFLOW_PLUGIN_PATH
let path_var = std::env::var_os("MEMFLOW_PLUGIN_PATH");
let path_iter = path_iter.chain(
path_var
.as_ref()
.map(std::env::split_paths)
.into_iter()
.flatten(),
);
// add user directory
#[cfg(unix)]
let path_iter = path_iter.chain(dirs::home_dir().map(|dir| dir.join(".local").join("lib")));
#[cfg(not(unix))]
let path_iter = path_iter.chain(dirs::document_dir());
let mut ret = Self {
connectors: vec![],
os_layers: vec![],
};
for mut path in path_iter {
path.push("memflow");
ret.add_dir(path).ok();
}
// add $MEMFLOW_PLUGIN_PATH at compile time
if let Some(extra_plugin_paths) = option_env!("MEMFLOW_PLUGIN_PATH") {
for p in std::env::split_paths(extra_plugin_paths) {
ret.add_dir(p).ok();
}
}
// add current working directory
if let Ok(pwd) = std::env::current_dir() {
ret.add_dir(pwd).ok();
}
ret
}
/// Adds a library directory to the inventory
///
/// This function applies additional filter to only scan potentially wanted files
///
/// # Safety
///
/// Same as previous functions - compiler can not guarantee the safety of
/// third party library implementations.
pub fn add_dir_filtered(&mut self, dir: PathBuf, filter: &str) -> Result<&mut Self> {
if !dir.is_dir() {
return Err(Error(ErrorOrigin::Inventory, ErrorKind::InvalidPath));
}
info!("scanning {:?} for libraries", dir,);
for entry in
read_dir(dir).map_err(|_| Error(ErrorOrigin::Inventory, ErrorKind::UnableToReadDir))?
{
let entry = entry
.map_err(|_| Error(ErrorOrigin::Inventory, ErrorKind::UnableToReadDirEntry))?;
if let Some(true) = entry.file_name().to_str().map(|n| n.contains(filter)) {
self.load(entry.path());
}
}
Ok(self)
}
/// Adds a library directory to the inventory
///
/// # Safety
///
/// Same as previous functions - compiler can not guarantee the safety of
/// third party library implementations.
pub fn add_dir(&mut self, dir: PathBuf) -> Result<&mut Self> {
self.add_dir_filtered(dir, "")
}
/// Adds cargo workspace to the inventory
///
/// This function is used behind the scenes by the documentation, however, is not particularly
/// useful for end users.
pub fn with_workspace(mut self) -> Result<Self> {
let paths = std::fs::read_dir("../target/").map_err(|_| ErrorKind::UnableToReadDir)?;
for path in paths {
match path.unwrap().file_name().to_str() {
Some("release") | Some("debug") | None => {}
Some(x) => {
self.add_dir_filtered(format!("../target/{}/release/deps", x).into(), "ffi")
.ok();
self.add_dir_filtered(format!("../target/{}/debug/deps", x).into(), "ffi")
.ok();
}
}
}
self.add_dir_filtered("../target/release/deps".into(), "ffi")
.ok();
self.add_dir_filtered("../target/debug/deps".into(), "ffi")
.ok();
Ok(self)
}
/// Adds a single library to the inventory
///
/// # Safety
///
/// Same as previous functions - compiler can not guarantee the safety of
/// third party library implementations.
pub fn load(&mut self, path: PathBuf) -> &mut Self {
Loadable::load_append(&path, &mut self.connectors).ok();
Loadable::load_append(&path, &mut self.os_layers).ok();
self
}
/// Returns the names of all currently available connectors that can be used.
pub fn available_connectors(&self) -> Vec<String> {
self.connectors
.iter()
.filter_map(|c| c.state.as_option())
.map(|s| s.1.ident().to_string())
.collect::<Vec<_>>()
}
/// Returns the names of all currently available os plugins that can be used.
pub fn available_os(&self) -> Vec<String> {
self.os_layers
.iter()
.filter_map(|c| c.state.as_option())
.map(|s| s.1.ident().to_string())
.collect::<Vec<_>>()
}
/// Returns the help string of the given Connector.
///
/// This function returns an error in case the Connector was not found or does not implement the help feature.
pub fn connector_help(&self, name: &str) -> Result<String> {
Self::help_internal(&self.connectors, name)
}
/// Returns the help string of the given Os Plugin.
///
/// This function returns an error in case the Os Plugin was not found or does not implement the help feature.
pub fn os_help(&self, name: &str) -> Result<String> {
Self::help_internal(&self.os_layers, name)
}
fn help_internal<T: Loadable>(libs: &[LibInstance<T>], name: &str) -> Result<String> {
let loader = libs
.iter()
.filter_map(|c| c.state.as_option().map(|s| s.1))
.find(|s| s.ident() == name)
.ok_or_else(|| {
error!("unable to find plugin with name '{}'.", name,);
error!(
"possible available `{}` plugins are: {}",
T::plugin_type(),
Self::plugin_list_available(libs),
);
error!(
"outdated/mismatched `{}` plugins where found at: {}",
T::plugin_type(),
Self::plugin_list_unavailable(libs),
);
Error(ErrorOrigin::Inventory, ErrorKind::PluginNotFound)
})?;
loader.help()
}
/// Returns a list of all available targets of the connector.
///
/// This function returns an error in case the connector does not implement this feature.
pub fn connector_target_list(&self, name: &str) -> Result<Vec<TargetInfo>> {
let loader = self
.connectors
.iter()
.filter_map(|c| c.state.as_option().map(|s| s.1))
.find(|s| s.ident() == name)
.ok_or_else(|| {
error!("unable to find plugin with name '{}'.", name,);
error!(
"possible available `{}` plugins are: {}",
LoadableConnector::plugin_type(),
Self::plugin_list_available(&self.connectors),
);
error!(
"outdated/mismatched `{}` plugins where found at: {}",
LoadableConnector::plugin_type(),
Self::plugin_list_unavailable(&self.connectors),
);
Error(ErrorOrigin::Inventory, ErrorKind::PluginNotFound)
})?;
loader.target_list()
}
/// Creates a new Connector / OS builder.
///
/// # Examples
///
/// Create a connector:
/// ```no_run
/// use memflow::plugins::Inventory;
///
/// let inventory = Inventory::scan();
/// let os = inventory
/// .builder()
/// .connector("qemu")
/// .build();
/// ```
///
/// Create a Connector with arguments:
/// ```no_run
/// use memflow::plugins::{Inventory, Args};
///
/// let inventory = Inventory::scan();
/// let os = inventory
/// .builder()
/// .connector("qemu")
/// .args(str::parse("vm-win10").unwrap())
/// .build();
/// ```
///
/// Create a Connector and OS with arguments:
/// ```no_run
/// use memflow::plugins::{Inventory, Args};
///
/// let inventory = Inventory::scan();
/// let os = inventory
/// .builder()
/// .connector("qemu")
/// .args(str::parse("vm-win10").unwrap())
/// .os("win10")
/// .build();
/// ```
///
/// Create a OS without a connector and arguments:
/// ```no_run
/// use memflow::plugins::Inventory;
///
/// let inventory = Inventory::scan();
/// let os = inventory
/// .builder()
/// .os("native")
/// .build();
/// ```
pub fn builder(&self) -> BuilderEmpty {
BuilderEmpty { inventory: self }
}
/// Tries to create a new instance for the library with the given name.
/// The instance will be initialized with the args provided to this call.
///
/// In case no library could be found this will throw an `Error::Library`.
///
/// # Safety
///
/// This function assumes all libraries were loaded with appropriate safety
/// checks in place. This function is safe, but can crash if previous checks
/// fail.
///
/// # Examples
///
/// Creating a connector instance:
/// ```no_run
/// use memflow::plugins::{Inventory, Args};
///
/// let inventory = Inventory::scan_path("./").unwrap();
/// let connector = inventory
/// .create_connector("coredump", None, None)
/// .unwrap();
/// ```
///
/// Defining a dynamically loaded connector:
/// ```
/// use memflow::error::Result;
/// use memflow::types::size;
/// use memflow::dummy::DummyMemory;
/// use memflow::plugins::ConnectorArgs;
/// use memflow::derive::connector;
/// use memflow::mem::phys_mem::*;
///
/// #[connector(name = "dummy_conn")]
/// pub fn create_connector(_args: &ConnectorArgs) -> Result<DummyMemory> {
/// Ok(DummyMemory::new(size::mb(16)))
/// }
/// ```
pub fn create_connector(
&self,
name: &str,
input: ConnectorInputArg,
args: Option<&ConnectorArgs>,
) -> Result<ConnectorInstanceArcBox<'static>> {
Self::create_internal(&self.connectors, name, input, args)
}
/// Create OS instance
///
/// This is the primary way of building a OS instance.
///
/// # Arguments
///
/// * `name` - name of the target OS
/// * `input` - connector to be passed to the OS
/// * `args` - arguments to be passed to the OS
///
/// # Examples
///
/// Creating a OS instance with custom arguments
/// ```
/// use memflow::plugins::{Inventory, ConnectorArgs};
///
/// # let inventory = Inventory::scan().with_workspace().unwrap();
/// let args = str::parse(":4m").unwrap();
/// let os = inventory.create_os("dummy", None, Some(&args))
/// .unwrap();
/// std::mem::drop(os);
/// ```
pub fn create_os(
&self,
name: &str,
input: OsInputArg,
args: Option<&OsArgs>,
) -> Result<OsInstanceArcBox<'static>> {
Self::create_internal(&self.os_layers, name, input, args)
}
fn create_internal<T: Loadable>(
libs: &[LibInstance<T>],
name: &str,
input: T::InputArg,
args: Option<&T::ArgsType>,
) -> Result<T::Instance> {
let lib = libs
.iter()
.filter(|l| l.state.is_loaded())
.find(|l| l.ident() == Some(name))
.ok_or_else(|| {
error!("unable to find plugin with name '{}'.", name,);
error!(
"possible available `{}` plugins are: {}",
T::plugin_type(),
Self::plugin_list_available(libs),
);
error!(
"outdated/mismatched `{}` plugins where found at: {}",
T::plugin_type(),
Self::plugin_list_unavailable(libs),
);
Error(ErrorOrigin::Inventory, ErrorKind::PluginNotFound)
})?;
if let LibInstanceState::Loaded { library, loader } = &lib.state {
info!(
"attempting to load `{}` type plugin `{}` from `{}`",
T::plugin_type(),
loader.ident(),
lib.path.to_string_lossy(),
);
loader.instantiate(library.clone(), input, args)
} else {
unreachable!()
}
}
/// Sets the maximum logging level in all plugins and updates the
/// internal [`PluginLogger`] in each plugin instance.
pub fn set_max_log_level(&self, level: LevelFilter) {
log::set_max_level(level);
self.update_max_log_level()
}
fn update_max_log_level(&self) {
let level = log::max_level();
self.connectors
.iter()
.filter_map(|c| c.state.as_option())
.map(|s| s.0)
.chain(
self.os_layers
.iter()
.filter_map(|o| o.state.as_option())
.map(|s| s.0),
)
.filter_map(|s| *s.as_ref())
.filter_map(LibContext::try_get_logger)
.for_each(|l| l.on_level_change(level));
}
/// Returns a comma-seperated list of plugin identifiers of all available plugins
fn plugin_list_available<T: Loadable>(libs: &[LibInstance<T>]) -> String {
libs.iter()
.filter_map(|c| c.state.as_option().map(|s| s.1.ident().to_string()))
.collect::<Vec<_>>()
.join(", ")
}
/// Returns a comma-seperated list of plugin paths of all un-available plugins that where found but could not be loaded. (e.g. because of ABI mismatch)
fn plugin_list_unavailable<T: Loadable>(libs: &[LibInstance<T>]) -> String {
libs.iter()
.filter(|c| !c.state.is_loaded())
.map(|c| c.path.to_string_lossy())
.collect::<Vec<_>>()
.join(", ")
}
}
pub enum BuildStep<'a> {
Connector {
name: &'a str,
args: Option<ConnectorArgs>,
},
Os {
name: &'a str,
args: Option<OsArgs>,
},
}
impl<'a> BuildStep<'a> {
/// Parse input string and construct steps for building a connector.
///
/// Name and arguments are separated by `:`, for example:
///
/// `kvm:5`, or `qemu:win10:memmap=map`.
pub fn new_connector(input: &'a str) -> Result<Self> {
let (name, args) = input.split_once(':').unwrap_or((input, ""));
Ok(Self::Connector {
name,
args: if args.is_empty() {
None
} else {
Some(str::parse(args)?)
},
})
}
/// Parse input string and construct steps for building an OS.
///
/// Name and arguments are separated by `:`, for example:
///
/// `win32`, or `win32::dtb=0xdeadbeef`.
pub fn new_os(input: &'a str) -> Result<Self> {
let (name, args) = input.split_once(':').unwrap_or((input, ""));
Ok(Self::Os {
name,
args: if args.is_empty() {
None
} else {
Some(str::parse(args)?)
},
})
}
/// Validate whether the next build step is compatible with the current one.
pub fn validate_next(&self, next: &Self) -> bool {
!matches!(
(self, next),
(BuildStep::Connector { .. }, BuildStep::Connector { .. })
| (BuildStep::Os { .. }, BuildStep::Os { .. })
)
}
}
fn builder_from_args<'a>(
connectors: impl Iterator<Item = (usize, &'a str)>,
os_layers: impl Iterator<Item = (usize, &'a str)>,
) -> Result<Vec<BuildStep<'a>>> {
let mut layers = connectors
.map(|(i, a)| BuildStep::new_connector(a).map(|a| (i, a)))
.chain(os_layers.map(|(i, a)| BuildStep::new_os(a).map(|a| (i, a))))
.collect::<Result<Vec<_>>>()?;
layers.sort_by(|(a, _), (b, _)| a.cmp(b));
if layers.windows(2).any(|w| !w[0].1.validate_next(&w[1].1)) {
return Err(
Error(ErrorOrigin::Other, ErrorKind::ArgValidation).log_error(
"invalid builder configuration, build steps cannot be used in the given order",
),
);
}
Ok(layers.into_iter().map(|(_, s)| s).collect())
}
/// Precompiled connector chain.
///
/// Use this with [`Inventory::builder`](Inventory::builder).
pub struct ConnectorChain<'a>(Vec<BuildStep<'a>>);
impl<'a> ConnectorChain<'a> {
/// Build a new connector chain.
///
/// Arguments are iterators of command line arguments with their position and value. The
/// position will be used to sort them and validate whether they are in correct order.
pub fn new(
connectors: impl Iterator<Item = (usize, &'a str)>,
os_layers: impl Iterator<Item = (usize, &'a str)>,
) -> Result<Self> {
let steps = builder_from_args(connectors, os_layers)?;
steps.try_into()
}
}
impl<'a> TryFrom<Vec<BuildStep<'a>>> for ConnectorChain<'a> {
type Error = Error;
fn try_from(steps: Vec<BuildStep<'a>>) -> Result<Self> {
if !matches!(steps.last(), Some(BuildStep::Connector { .. })) {
return Err(
Error(ErrorOrigin::Other, ErrorKind::ArgValidation).log_error(
"invalid builder configuration, last build step has to be a connector",
),
);
}
Ok(Self(steps))
}
}
/// Precompiled os chain.
///
/// Use this with [`Inventory::builder`](Inventory::builder).
pub struct OsChain<'a>(Vec<BuildStep<'a>>);
impl<'a> OsChain<'a> {
/// Build a new OS chain.
///
/// Arguments are iterators of command line arguments with their position and value. The
/// position will be used to sort them and validate whether they are in correct order.
pub fn new(
connectors: impl Iterator<Item = (usize, &'a str)>,
os_layers: impl Iterator<Item = (usize, &'a str)>,
) -> Result<Self> {
let steps = builder_from_args(connectors, os_layers)?;
steps.try_into()
}
}
impl<'a> TryFrom<Vec<BuildStep<'a>>> for OsChain<'a> {
type Error = Error;
fn try_from(steps: Vec<BuildStep<'a>>) -> Result<Self> {
if !matches!(steps.last(), Some(BuildStep::Os { .. })) {
return Err(Error(ErrorOrigin::Other, ErrorKind::ArgValidation)
.log_error("invalid builder configuration, last build step has to be a os"));
}
Ok(Self(steps))
}
}
/// BuilderEmpty is the starting builder that allows to either call `connector`, or `os`.
pub struct BuilderEmpty<'a> {
inventory: &'a Inventory,
}
impl<'a> BuilderEmpty<'a> {
/// Adds a Connector instance to the build chain
///
/// # Arguments
///
/// * `name` - name of the connector
pub fn connector(self, name: &'a str) -> OsBuilder<'a> {
OsBuilder {
inventory: self.inventory,
steps: vec![BuildStep::Connector { name, args: None }],
}
}
/// Adds an OS instance to the build chain
///
/// # Arguments
///
/// * `name` - name of the target OS
pub fn os(self, name: &'a str) -> ConnectorBuilder<'a> {
ConnectorBuilder {
inventory: self.inventory,
steps: vec![BuildStep::Os { name, args: None }],
}
}
/// Chains multiple pre-validated steps, resulting in an Os ready-to-build.
///
/// # Arguments
///
/// * `chain` - steps to initialize the builder with.
pub fn os_chain(self, chain: OsChain<'a>) -> ConnectorBuilder<'a> {
ConnectorBuilder {
inventory: self.inventory,
steps: chain.0,
}
}
/// Chains multiple pre-validated steps, resulting in a connector ready-to-build.
///
/// # Arguments
///
/// * `chain` - steps to initialize the builder with.
pub fn connector_chain(self, chain: ConnectorChain<'a>) -> OsBuilder<'a> {
OsBuilder {
inventory: self.inventory,
steps: chain.0,
}
}
}
/// ConnectorBuilder creates a new connector instance with the previous os step as an input.
pub struct ConnectorBuilder<'a> {
inventory: &'a Inventory,
steps: Vec<BuildStep<'a>>,
}
impl<'a> ConnectorBuilder<'a> {
/// Adds a Connector instance to the build chain
///
/// # Arguments
///
/// * `name` - name of the connector
pub fn connector(self, name: &'a str) -> OsBuilder<'a> {
let mut steps = self.steps;
steps.push(BuildStep::Connector { name, args: None });
OsBuilder {
inventory: self.inventory,
steps,
}
}
/// Appends arguments to the previously added OS.
///
/// # Arguments
///
/// * `os_args` - the arguments to be passed to the previously added OS
pub fn args(mut self, os_args: OsArgs) -> ConnectorBuilder<'a> {
if let Some(BuildStep::Os { name: _, args }) = self.steps.iter_mut().last() {
*args = Some(os_args);
}
self
}
/// Builds the final chain of Connectors and OS and returns the last OS.
///
/// Each created connector / os instance is fed into the next os / connector instance as an argument.
/// If any build step fails the function returns an error.
pub fn build(self) -> Result<OsInstanceArcBox<'static>> {
let mut connector: Option<ConnectorInstanceArcBox<'static>> = None;
let mut os: Option<OsInstanceArcBox<'static>> = None;
for step in self.steps.iter() {
match step {
BuildStep::Connector { name, args } => {
connector = Some(self.inventory.create_connector(name, os, args.as_ref())?);
os = None;
}
BuildStep::Os { name, args } => {
os = Some(self.inventory.create_os(name, connector, args.as_ref())?);
connector = None;
}
};
}
os.ok_or(Error(ErrorOrigin::Inventory, ErrorKind::Configuration))
}
}
/// OsBuilder creates a new os instance with the previous connector step as an input
pub struct OsBuilder<'a> {
inventory: &'a Inventory,
steps: Vec<BuildStep<'a>>,
}
impl<'a> OsBuilder<'a> {
/// Adds an OS instance to the build chain
///
/// # Arguments
///
/// * `name` - name of the target OS
pub fn os(self, name: &'a str) -> ConnectorBuilder<'a> {
let mut steps = self.steps;
steps.push(BuildStep::Os { name, args: None });
ConnectorBuilder {
inventory: self.inventory,
steps,
}
}
/// Appends arguments to the previously added Connector.
///
/// # Arguments
///
/// * `conn_args` - the arguments to be passed to the previously added Connector
pub fn args(mut self, conn_args: ConnectorArgs) -> OsBuilder<'a> {
if let Some(BuildStep::Connector { name: _, args }) = self.steps.iter_mut().last() {
*args = Some(conn_args);
}
self
}
/// Builds the final chain of Connectors and OS and returns the last Connector.
///
/// Each created connector / os instance is fed into the next os / connector instance as an argument.
/// If any build step fails the function returns an error.
pub fn build(self) -> Result<ConnectorInstanceArcBox<'static>> {
let mut connector: Option<ConnectorInstanceArcBox<'static>> = None;
let mut os: Option<OsInstanceArcBox<'static>> = None;
for step in self.steps.iter() {
match step {
BuildStep::Connector { name, args } => {
connector = Some(self.inventory.create_connector(name, os, args.as_ref())?);
os = None;
}
BuildStep::Os { name, args } => {
os = Some(self.inventory.create_os(name, connector, args.as_ref())?);
connector = None;
}
};
}
connector.ok_or(Error(ErrorOrigin::Inventory, ErrorKind::Configuration))
}
}
/// Reference counted library instance
///
/// This stores the necessary reference counted library instance, in order to prevent the library
/// from unloading unexpectedly. This is the required safety guarantee.
#[repr(C)]
#[derive(Clone)]
pub struct LibInstance<T> {
path: PathBuf,
state: LibInstanceState<T>,
}
impl<T: Loadable> LibInstance<T> {
pub fn ident(&self) -> Option<&str> {
self.state.as_option().map(|s| s.1.ident())
}
}
#[repr(C)]
#[derive(Clone)]
pub enum LibInstanceState<T> {
Loaded {
library: CArc<LibContext>,
loader: T,
},
VersionMismatch,
InvalidAbi,
}
impl<T> LibInstanceState<T> {
pub fn is_loaded(&self) -> bool {
matches!(
self,
LibInstanceState::Loaded {
library: _,
loader: _,
}
)
}
pub fn as_option(&self) -> Option<(&CArc<LibContext>, &T)> {
match self {
LibInstanceState::Loaded { library, loader } => Some((library, loader)),
_ => None,
}
}
}