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
use std::ffi::{OsStr, OsString};
use std::os::windows::ffi::OsStringExt;
use std::{io, ptr};
use widestring::WideCString;
use windows_sys::Win32::System::Services;
use crate::sc_handle::ScHandle;
use crate::service::{to_wide, RawServiceInfo, Service, ServiceAccess, ServiceInfo};
use crate::{Error, Result};
bitflags::bitflags! {
/// Flags describing access permissions for [`ServiceManager`].
pub struct ServiceManagerAccess: u32 {
/// Can connect to service control manager.
const CONNECT = Services::SC_MANAGER_CONNECT;
/// Can create services.
const CREATE_SERVICE = Services::SC_MANAGER_CREATE_SERVICE;
/// Can enumerate services or receive notifications.
const ENUMERATE_SERVICE = Services::SC_MANAGER_ENUMERATE_SERVICE;
}
}
/// Service manager.
pub struct ServiceManager {
manager_handle: ScHandle,
}
impl ServiceManager {
/// Private initializer.
///
/// # Arguments
///
/// * `machine` - The name of machine. Pass `None` to connect to local machine.
/// * `database` - The name of database to connect to. Pass `None` to connect to active
/// database.
fn new(
machine: Option<impl AsRef<OsStr>>,
database: Option<impl AsRef<OsStr>>,
request_access: ServiceManagerAccess,
) -> Result<Self> {
let machine_name =
to_wide(machine).map_err(|_| Error::ArgumentHasNulByte("machine name"))?;
let database_name =
to_wide(database).map_err(|_| Error::ArgumentHasNulByte("database name"))?;
let handle = unsafe {
Services::OpenSCManagerW(
machine_name.map_or(ptr::null(), |s| s.as_ptr()),
database_name.map_or(ptr::null(), |s| s.as_ptr()),
request_access.bits(),
)
};
if handle == 0 {
Err(Error::Winapi(io::Error::last_os_error()))
} else {
Ok(ServiceManager {
manager_handle: unsafe { ScHandle::new(handle) },
})
}
}
/// Connect to local services database.
///
/// # Arguments
///
/// * `database` - The name of database to connect to. Pass `None` to connect to active
/// database.
/// * `request_access` - Desired access permissions.
pub fn local_computer(
database: Option<impl AsRef<OsStr>>,
request_access: ServiceManagerAccess,
) -> Result<Self> {
ServiceManager::new(None::<&OsStr>, database, request_access)
}
/// Connect to remote services database.
///
/// # Arguments
///
/// * `machine` - The name of remote machine.
/// * `database` - The name of database to connect to. Pass `None` to connect to active
/// database.
/// * `request_access` - desired access permissions.
pub fn remote_computer(
machine: impl AsRef<OsStr>,
database: Option<impl AsRef<OsStr>>,
request_access: ServiceManagerAccess,
) -> Result<Self> {
ServiceManager::new(Some(machine), database, request_access)
}
/// Create a service.
///
/// # Arguments
///
/// * `service_info` - The service information that will be saved to the system services
/// registry.
/// * `service_access` - Desired access permissions for the returned [`Service`] instance.
///
/// # Example
///
/// ```rust,no_run
/// use std::ffi::OsString;
/// use std::path::PathBuf;
/// use windows_service::service::{
/// ServiceAccess, ServiceErrorControl, ServiceInfo, ServiceStartType, ServiceType,
/// };
/// use windows_service::service_manager::{ServiceManager, ServiceManagerAccess};
///
/// fn main() -> windows_service::Result<()> {
/// let manager =
/// ServiceManager::local_computer(None::<&str>, ServiceManagerAccess::CREATE_SERVICE)?;
///
/// let my_service_info = ServiceInfo {
/// name: OsString::from("my_service"),
/// display_name: OsString::from("My service"),
/// service_type: ServiceType::OWN_PROCESS,
/// start_type: ServiceStartType::OnDemand,
/// error_control: ServiceErrorControl::Normal,
/// executable_path: PathBuf::from(r"C:\path\to\my\service.exe"),
/// launch_arguments: vec![],
/// dependencies: vec![],
/// account_name: None, // run as System
/// account_password: None,
/// };
///
/// let my_service = manager.create_service(&my_service_info, ServiceAccess::QUERY_STATUS)?;
/// Ok(())
/// }
/// ```
pub fn create_service(
&self,
service_info: &ServiceInfo,
service_access: ServiceAccess,
) -> Result<Service> {
let raw_info = RawServiceInfo::new(service_info)?;
let service_handle = unsafe {
Services::CreateServiceW(
self.manager_handle.raw_handle(),
raw_info.name.as_ptr(),
raw_info.display_name.as_ptr(),
service_access.bits(),
raw_info.service_type,
raw_info.start_type,
raw_info.error_control,
raw_info.launch_command.as_ptr(),
ptr::null(), // load ordering group
ptr::null_mut(), // tag id within the load ordering group
raw_info
.dependencies
.as_ref()
.map_or(ptr::null(), |s| s.as_ptr()),
raw_info
.account_name
.as_ref()
.map_or(ptr::null(), |s| s.as_ptr()),
raw_info
.account_password
.as_ref()
.map_or(ptr::null(), |s| s.as_ptr()),
)
};
if service_handle == 0 {
Err(Error::Winapi(io::Error::last_os_error()))
} else {
Ok(Service::new(unsafe { ScHandle::new(service_handle) }))
}
}
/// Open an existing service.
///
/// # Arguments
///
/// * `name` - The service name.
/// * `request_access` - Desired permissions for the returned [`Service`] instance.
///
/// # Example
///
/// ```rust,no_run
/// use windows_service::service::ServiceAccess;
/// use windows_service::service_manager::{ServiceManager, ServiceManagerAccess};
///
/// # fn main() -> windows_service::Result<()> {
/// let manager = ServiceManager::local_computer(None::<&str>, ServiceManagerAccess::CONNECT)?;
/// let my_service = manager.open_service("my_service", ServiceAccess::QUERY_STATUS)?;
/// # Ok(())
/// # }
/// ```
pub fn open_service(
&self,
name: impl AsRef<OsStr>,
request_access: ServiceAccess,
) -> Result<Service> {
let service_name = WideCString::from_os_str(name)
.map_err(|_| Error::ArgumentHasNulByte("service name"))?;
let service_handle = unsafe {
Services::OpenServiceW(
self.manager_handle.raw_handle(),
service_name.as_ptr(),
request_access.bits(),
)
};
if service_handle == 0 {
Err(Error::Winapi(io::Error::last_os_error()))
} else {
Ok(Service::new(unsafe { ScHandle::new(service_handle) }))
}
}
/// Return the service name given a service display name.
///
/// # Arguments
///
/// * `name` - A service display name.
///
/// # Example
///
/// ```rust,no_run
/// use windows_service::service_manager::{ServiceManager, ServiceManagerAccess};
///
/// # fn main() -> windows_service::Result<()> {
/// let manager = ServiceManager::local_computer(None::<&str>, ServiceManagerAccess::CONNECT)?;
/// let my_service_name = manager.service_name_from_display_name("My Service Display Name")?;
/// # Ok(())
/// # }
/// ```
pub fn service_name_from_display_name(
&self,
display_name: impl AsRef<OsStr>,
) -> Result<OsString> {
let service_display_name = WideCString::from_os_str(display_name)
.map_err(|_| Error::ArgumentHasNulByte("display name"))?;
// As per docs, the maximum size of data buffer used by GetServiceKeyNameW is 4k bytes,
// which is 2k wchars
let mut buffer = [0u16; 2 * 1024];
let mut buffer_len = u32::try_from(buffer.len()).expect("size must fit in u32");
let result = unsafe {
Services::GetServiceKeyNameW(
self.manager_handle.raw_handle(),
service_display_name.as_ptr(),
buffer.as_mut_ptr(),
&mut buffer_len,
)
};
if result == 0 {
Err(Error::Winapi(io::Error::last_os_error()))
} else {
Ok(OsString::from_wide(
&buffer[..usize::try_from(buffer_len).unwrap()],
))
}
}
}