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
use std::{collections::HashMap, convert::TryFrom, io::BufRead, result::Result};
use enumflags2::BitFlags;
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use static_assertions::assert_impl_all;
use zbus::{dbus_proxy, fdo};
use zvariant::{derive::Type, OwnedValue, Value};
use crate::Error;
/// Flags used in the CheckAuthorization() method.
#[repr(u32)]
#[derive(Type, BitFlags, Debug, PartialEq, Copy, Clone, Serialize, Deserialize)]
pub enum CheckAuthorizationFlags {
/// If the Subject can obtain the authorization through authentication, and an authentication
/// agent is available, then attempt to do so. Note, this means that the CheckAuthorization()
/// method will block while the user is being asked to authenticate.
AllowUserInteraction = 0x01,
}
assert_impl_all!(CheckAuthorizationFlags: Send, Sync, Unpin);
/// An enumeration for granting implicit authorizations.
#[repr(u32)]
#[derive(Deserialize_repr, Serialize_repr, Type, Debug, PartialEq)]
pub enum ImplicitAuthorization {
/// The Subject is not authorized.
NotAuthorized = 0,
/// Authentication is required.
AuthenticationRequired = 1,
/// Authentication as an administrator is required.
AdministratorAuthenticationRequired = 2,
/// Authentication is required. If the authorization is obtained, it is retained.
AuthenticationRequiredRetained = 3,
/// Authentication as an administrator is required. If the authorization is obtained, it is retained.
AdministratorAuthenticationRequiredRetained = 4,
/// The subject is authorized.
Authorized = 5,
}
assert_impl_all!(ImplicitAuthorization: Send, Sync, Unpin);
/// Flags describing features supported by the Authority implementation.
#[repr(u32)]
#[derive(Type, BitFlags, Debug, PartialEq, Copy, Clone, Serialize, Deserialize)]
pub enum AuthorityFeatures {
/// The authority supports temporary authorizations that can be obtained through authentication.
TemporaryAuthorization = 0x01,
}
assert_impl_all!(AuthorityFeatures: Send, Sync, Unpin);
impl TryFrom<OwnedValue> for AuthorityFeatures {
type Error = <u32 as TryFrom<OwnedValue>>::Error;
fn try_from(v: OwnedValue) -> Result<Self, Self::Error> {
// safe because AuthorityFeatures has repr u32
Ok(unsafe { std::mem::transmute(<u32>::try_from(v)?) })
}
}
/// Details of a temporary authorization as provided by the /org/freedesktop/PolicyKit1/Authority object in the system bus.
#[derive(Debug, Type, Deserialize)]
pub struct TemporaryAuthorization {
/// An opaque identifier for the temporary authorization.
pub id: String,
/// The action the temporary authorization is for.
pub action_id: String,
/// The subject the temporary authorization is for.
pub subject: Subject,
/// When the temporary authorization was obtained, in seconds since the Epoch Jan 1, 1970 0:00
/// UTC. Note that the PolicyKit daemon is using monotonic time internally so the returned value
/// may change if system time changes.
pub time_obtained: u64,
/// When the temporary authorization is set to expire, in seconds since the Epoch Jan 1, 1970
/// 0:00 UTC. Note that the PolicyKit daemon is using monotonic time internally so the returned
/// value may change if system time changes.
pub time_expires: u64,
}
assert_impl_all!(TemporaryAuthorization: Send, Sync, Unpin);
/// This struct describes identities such as UNIX users and UNIX groups. It is typically used to
/// check if a given process is authorized for an action.
///
/// The following kinds of identities are known:
///
/// * Unix User. `identity_kind` should be set to `unix-user` with key uid (of type uint32).
///
/// * Unix Group. `identity_kind` should be set to `unix-group` with key gid (of type uint32).
#[derive(Debug, Type, Serialize)]
pub struct Identity<'a> {
pub identity_kind: &'a str,
pub identity_details: &'a HashMap<&'a str, Value<'a>>,
}
assert_impl_all!(Identity<'_>: Send, Sync, Unpin);
fn pid_start_time(pid: u32) -> Result<u64, Error> {
let fname = format!("/proc/{}/stat", pid);
let content = std::fs::read_to_string(fname)?;
if let Some(i) = content.rfind(')') {
if let Some(start_time) = content[i..].split(' ').nth(20) {
return Ok(start_time.parse()?);
}
}
Err(std::io::Error::from(std::io::ErrorKind::NotFound).into())
}
// Return the "current" UID. Note that this is inherently racy, and the value may already be
// obsolete by the time this function returns; this function only guarantees that the UID was valid
// at some point during its execution.
fn pid_uid_racy(pid: u32) -> Result<u32, Error> {
let fname = format!("/proc/{}/status", pid);
let file = std::fs::File::open(fname)?;
let lines = std::io::BufReader::new(file).lines();
for line in lines.flatten() {
if line.starts_with("Uid:") {
if let Some(uid) = line.split('\t').nth(1) {
return Ok(uid.parse()?);
}
}
}
Err(std::io::Error::from(std::io::ErrorKind::NotFound).into())
}
/// This struct describes subjects such as UNIX processes. It is typically used to check if a given
/// process is authorized for an action.
///
/// The following kinds of subjects are known:
///
/// * Unix Process. `subject_kind` should be set to `unix-process` with keys `pid` (of type
/// `uint32`) and `start-time` (of type `uint64`).
///
/// * Unix Session. `subject_kind` should be set to `unix-session` with the key `session-id` (of
/// type `string`).
///
/// * System Bus Name. `subject_kind` should be set to `system-bus-name` with the key `name` (of
/// type `string`).
#[derive(Debug, Type, Serialize, Deserialize)]
pub struct Subject {
/// The type of the subject.
pub subject_kind: String,
/// Details about the subject. Depending of the value of `subject_kind`, a set of well-defined
/// key/value pairs are guaranteed to be available.
pub subject_details: HashMap<String, OwnedValue>,
}
assert_impl_all!(Subject: Send, Sync, Unpin);
impl Subject {
/// Create a `Subject` for `pid`, `start_time` & `uid`.
///
/// # Arguments
///
/// * `pid` - The process ID
///
/// * `start_time` - The start time for `pid` or `None` to look it up in e.g. `/proc`
///
/// * `uid` - The (real, not effective) uid of the owner of `pid` or `None` to look it up in
/// e.g. `/proc`
pub fn new_for_owner(
pid: u32,
start_time: Option<u64>,
uid: Option<u32>,
) -> Result<Self, Error> {
let start_time = match start_time {
Some(s) => s,
None => pid_start_time(pid)?,
};
let uid = match uid {
Some(u) => u,
None => pid_uid_racy(pid)?,
};
let mut hashmap = HashMap::new();
hashmap.insert("pid".to_string(), Value::from(pid).into());
hashmap.insert("start-time".to_string(), Value::from(start_time).into());
hashmap.insert("uid".to_string(), Value::from(uid).into());
Ok(Self {
subject_kind: "unix-process".into(),
subject_details: hashmap,
})
}
/// Create a `Subject` for a message for querying if the sender of a Message is permitted to
/// execute an action.
///
/// # Arguments
///
/// * `message_header` - The header of the message which caused an authentication to be necessary.
pub fn new_for_message_header(message_header: &zbus::MessageHeader<'_>) -> Result<Self, Error> {
let mut subject_details = HashMap::new();
match message_header.sender() {
Ok(Some(sender)) => {
subject_details.insert("name".to_string(), Value::from(sender.clone()).into());
}
Ok(None) => {
return Err(Error::MissingSender);
}
Err(e) => {
return Err(Error::BadSender(e));
}
}
Ok(Self {
subject_kind: "system-bus-name".to_string(),
subject_details,
})
}
}
/// This struct describes actions registered with the PolicyKit daemon.
#[derive(Debug, Type, Serialize, Deserialize)]
pub struct ActionDescription {
/// Action Identifier.
pub action_id: String,
/// Localized description of the action.
pub description: String,
/// Localized message to be displayed when making the user authenticate for an action.
pub message: String,
/// Name of the provider of the action or the empty string.
pub vendor_name: String,
/// A URL pointing to a place with more information about the action or the empty string.
pub vendor_url: String,
/// The themed icon describing the action or the empty string if no icon is set.
pub icon_name: String,
/// A value from the ImplicitAuthorization. enumeration for implicit authorizations that apply
/// to any Subject.
pub implicit_any: ImplicitAuthorization,
/// A value from the ImplicitAuthorization. enumeration for implicit authorizations that apply
/// any Subject in an inactive user session on the local console.
pub implicit_inactive: ImplicitAuthorization,
/// A value from the ImplicitAuthorization. enumeration for implicit authorizations that apply
/// any Subject in an active user session on the local console.
pub implicit_active: ImplicitAuthorization,
/// Annotations for the action.
pub annotations: HashMap<String, String>,
}
assert_impl_all!(ActionDescription: Send, Sync, Unpin);
/// Describes the result of calling `CheckAuthorization()`
#[derive(Debug, Type, Serialize, Deserialize)]
pub struct AuthorizationResult {
/// TRUE if the given `Subject` is authorized for the given action.
pub is_authorized: bool,
/// TRUE if the given `Subject` could be authorized if more information was provided, and
/// `CheckAuthorizationFlags::AllowUserInteraction` wasn't passed or no suitable authentication
/// agent was available.
pub is_challenge: bool,
/// Details for the result. Known key/value-pairs include `polkit.temporary_authorization_id`
/// (if the authorization is temporary, this is set to the opaque temporary authorization id),
/// `polkit.retains_authorization_after_challenge` (Set to a non-empty string if the
/// authorization will be retained after authentication (if is_challenge is TRUE)),
/// `polkit.dismissed` (Set to a non-empty string if the authentication dialog was dismissed by
/// the user).
pub details: std::collections::HashMap<String, String>,
}
assert_impl_all!(AuthorizationResult: Send, Sync, Unpin);
/// This D-Bus interface is implemented by the /org/freedesktop/PolicyKit1/Authority object on the
/// well-known name org.freedesktop.PolicyKit1 on the system message bus.
#[dbus_proxy(
interface = "org.freedesktop.PolicyKit1.Authority",
default_service = "org.freedesktop.PolicyKit1",
default_path = "/org/freedesktop/PolicyKit1/Authority"
)]
trait Authority {
/// Method for authentication agents to invoke on successful authentication, intended only for
/// use by a privileged helper process internal to polkit. This method will fail unless a
/// sufficiently privileged +caller invokes it. Deprecated in favor of
/// `AuthenticationAgentResponse2()`.
fn authentication_agent_response(
&self,
cookie: &str,
identity: &Identity<'_>,
) -> zbus::Result<()>;
/// Method for authentication agents to invoke on successful authentication, intended only for
/// use by a privileged helper process internal to polkit. This method will fail unless a
/// sufficiently privileged caller invokes it. Note this method was introduced in 0.114 and
/// should be preferred over `AuthenticationAgentResponse()` as it fixes a security issue.
fn authentication_agent_response2(
&self,
uid: u32,
cookie: &str,
identity: &Identity<'_>,
) -> zbus::Result<()>;
/// Cancels an authorization check.
///
/// # Arguments
///
/// * `cancellation_id` - The cancellation_id passed to `CheckAuthorization()`.
fn cancel_check_authorization(&self, cancellation_id: &str) -> zbus::Result<()>;
/// Checks if subject is authorized to perform the action with identifier `action_id`
///
/// If `cancellation_id` is non-empty and already in use for the caller, the
/// `org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique` error is returned.
///
/// Note that `CheckAuthorizationFlags::AllowUserInteraction` SHOULD be passed ONLY if the event
/// that triggered the authorization check is stemming from an user action, e.g. the user
/// pressing a button or attaching a device.
///
/// # Arguments
///
/// * `subject` - A Subject struct.
///
/// * `action_id` - Identifier for the action that subject is attempting to do.
///
/// * `details` - Details describing the action. Keys starting with `polkit.` can only be set
/// if defined in this document.
///
/// Known keys include `polkit.message` and `polkit.gettext_domain` that can be used to override
/// the message shown to the user. This latter is needed because the user could be running an
/// authentication agent in another locale than the calling process.
///
/// The (translated version of) `polkit.message` may include references to other keys that are
/// expanded with their respective values. For example if the key `device_file` has the value
/// `/dev/sda` then the message "Authenticate to format $(device_file)" is expanded to
/// "Authenticate to format /dev/sda".
///
/// The key `polkit.icon_name` is used to override the icon shown in the authentication dialog.
///
/// If non-empty, then the request will fail with `org.freedesktop.PolicyKit1.Error.Failed`
/// unless the process doing the check itself is sufficiently authorized (e.g. running as uid 0).
///
/// * `flags` - A set of `CheckAuthorizationFlags`.
///
/// * `cancellation_id` - A unique id used to cancel the the authentication check via
/// `CancelCheckAuthorization()` or the empty string if cancellation is not needed.
///
/// Returns: An `AuthorizationResult` structure.
fn check_authorization(
&self,
subject: &Subject,
action_id: &str,
details: &std::collections::HashMap<&str, &str>,
flags: BitFlags<CheckAuthorizationFlags>,
cancellation_id: &str,
) -> zbus::Result<AuthorizationResult>;
/// Enumerates all registered PolicyKit actions.
///
/// # Arguments:
///
/// * `locale` - The locale to get descriptions in or the blank string to use the system locale.
fn enumerate_actions(&self, locale: &str) -> zbus::Result<Vec<ActionDescription>>;
/// Retrieves all temporary authorizations that applies to subject.
fn enumerate_temporary_authorizations(
&self,
subject: &Subject,
) -> zbus::Result<Vec<TemporaryAuthorization>>;
/// Register an authentication agent.
///
/// Note that this should be called by same effective UID which will be passed to
/// `AuthenticationAgentResponse2()`.
///
/// # Arguments
///
/// * `subject` - The subject to register the authentication agent for, typically a session
/// subject.
///
/// * `locale` - The locale of the authentication agent.
///
/// * `object_path` - The object path of authentication agent object on the unique name of the
/// caller.
fn register_authentication_agent(
&self,
subject: &Subject,
locale: &str,
object_path: &str,
) -> zbus::Result<()>;
/// Like `RegisterAuthenticationAgent` but takes additional options. If the option fallback (of
/// type Boolean) is TRUE, then the authentcation agent will only be used as a fallback, e.g. if
/// another agent (without the fallback option set TRUE) is available, it will be used instead.
fn register_authentication_agent_with_options(
&self,
subject: &Subject,
locale: &str,
object_path: &str,
options: &std::collections::HashMap<&str, zvariant::Value<'_>>,
) -> zbus::Result<()>;
/// Revokes all temporary authorizations that applies to `id`.
fn revoke_temporary_authorization_by_id(&self, id: &str) -> zbus::Result<()>;
/// Revokes all temporary authorizations that applies to `subject`.
fn revoke_temporary_authorizations(&self, subject: &Subject) -> zbus::Result<()>;
/// Unregister an authentication agent.
///
/// # Arguments
///
/// * `subject` - The subject passed to `RegisterAuthenticationAgent()`.
///
/// * `object_path` - The object_path passed to `RegisterAuthenticationAgent()`.
fn unregister_authentication_agent(
&self,
subject: &Subject,
object_path: &str,
) -> zbus::Result<()>;
/// This signal is emitted when actions and/or authorizations change
#[dbus_proxy(signal)]
fn changed(&self) -> fdo::Result<()>;
/// The features supported by the currently used Authority backend.
#[dbus_proxy(property)]
fn backend_features(&self) -> fdo::Result<AuthorityFeatures>;
/// The name of the currently used Authority backend.
#[dbus_proxy(property)]
fn backend_name(&self) -> fdo::Result<String>;
/// The version of the currently used Authority backend.
#[dbus_proxy(property)]
fn backend_version(&self) -> fdo::Result<String>;
}
assert_impl_all!(AuthorityProxy<'_>: Send, Sync, Unpin);
assert_impl_all!(AuthorityProxyBlocking<'_>: Send, Sync, Unpin);