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
//! Bluetooth authorization agent.
use dbus::nonblock::Proxy;
use dbus_crossroads::{Crossroads, IfaceBuilder, IfaceToken};
use futures::{pin_mut, Future};
use std::{fmt, pin::Pin, sync::Arc};
use strum::IntoStaticStr;
use tokio::{
select,
sync::{oneshot, Mutex},
};
use uuid::Uuid;
use crate::{method_call, Address, Device, Result, SessionInner, ERR_PREFIX, SERVICE_NAME, TIMEOUT};
pub(crate) const INTERFACE: &str = "org.bluez.Agent1";
pub(crate) const MANAGER_INTERFACE: &str = "org.bluez.AgentManager1";
pub(crate) const MANAGER_PATH: &str = "/org/bluez";
pub(crate) const AGENT_PREFIX: &str = publish_path!("agent/");
/// Error response from us to a Bluetooth agent request.
#[derive(Clone, Copy, Debug, displaydoc::Display, Eq, PartialEq, Ord, PartialOrd, Hash, IntoStaticStr)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[non_exhaustive]
pub enum ReqError {
/// Request was rejected.
Rejected,
/// Request was canceled.
Canceled,
}
impl std::error::Error for ReqError {}
impl Default for ReqError {
fn default() -> Self {
Self::Canceled
}
}
impl From<ReqError> for dbus::MethodErr {
fn from(err: ReqError) -> Self {
let name: &'static str = err.into();
Self::from((ERR_PREFIX.to_string() + name, &err.to_string()))
}
}
/// Result of a Bluetooth agent request to us.
pub type ReqResult<T> = std::result::Result<T, ReqError>;
/// Arguments for a pin code request.
#[derive(Debug)]
#[non_exhaustive]
pub struct RequestPinCode {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
}
/// Function handling a pin code request.
pub type RequestPinCodeFn =
Box<dyn (Fn(RequestPinCode) -> Pin<Box<dyn Future<Output = ReqResult<String>> + Send>>) + Send + Sync>;
/// Arguments for a display pin code request.
#[derive(custom_debug::Debug)]
#[non_exhaustive]
pub struct DisplayPinCode {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
/// Pin code.
pub pincode: String,
/// Resolves once the pin code should not be displayed anymore.
#[debug(skip)]
pub cancel: oneshot::Receiver<()>,
}
/// Function handling a display pin code request.
pub type DisplayPinCodeFn =
Box<dyn (Fn(DisplayPinCode) -> Pin<Box<dyn Future<Output = ReqResult<()>> + Send>>) + Send + Sync>;
/// Argument for a passkey request.
#[derive(Debug)]
#[non_exhaustive]
pub struct RequestPasskey {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
}
/// Function handling a passkey request.
pub type RequestPasskeyFn =
Box<dyn (Fn(RequestPasskey) -> Pin<Box<dyn Future<Output = ReqResult<u32>> + Send>>) + Send + Sync>;
/// Arguments for a display passkey request.
#[derive(custom_debug::Debug)]
#[non_exhaustive]
pub struct DisplayPasskey {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
/// Passkey.
pub passkey: u32,
/// Digits entered so far.
pub entered: u16,
/// Resolves once the passkey should not be displayed anymore.
#[debug(skip)]
pub cancel: oneshot::Receiver<()>,
}
/// Function handling a display passkey request.
pub type DisplayPasskeyFn =
Box<dyn (Fn(DisplayPasskey) -> Pin<Box<dyn Future<Output = ReqResult<()>> + Send>>) + Send + Sync>;
/// Arguments for a confirmation request.
#[derive(Debug)]
#[non_exhaustive]
pub struct RequestConfirmation {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
/// Passkey.
pub passkey: u32,
}
/// Function handling a confirmation request.
pub type RequestConfirmationFn =
Box<dyn (Fn(RequestConfirmation) -> Pin<Box<dyn Future<Output = ReqResult<()>> + Send>>) + Send + Sync>;
/// Arguments for an authorization request.
#[derive(Debug)]
#[non_exhaustive]
pub struct RequestAuthorization {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
}
/// Function handling an authorization request.
pub type RequestAuthorizationFn =
Box<dyn (Fn(RequestAuthorization) -> Pin<Box<dyn Future<Output = ReqResult<()>> + Send>>) + Send + Sync>;
/// Arguments for an authorize service request.
#[derive(Debug)]
#[non_exhaustive]
pub struct AuthorizeService {
/// Adapter making the request.
pub adapter: String,
/// Address of device making the request.
pub device: Address,
/// Service UUID.
pub service: Uuid,
}
/// Function handling an authorize service request.
pub type AuthorizeServiceFn =
Box<dyn (Fn(AuthorizeService) -> Pin<Box<dyn Future<Output = ReqResult<()>> + Send>>) + Send + Sync>;
/// Bluetooth authorization agent handler.
///
/// Each handler that is set to [None] will reject the request.
/// The capabilities of the agent are published accordingly.
/// Setting all handlers to [None] (the default) will result in a `NoInputNoOutput` handler
/// that accepts all requests.
///
/// The future of a particular request is dropped when BlueZ cancels that request.
///
/// Use [Session::register_agent](crate::session::Session::register_agent) to register the handler.
#[derive(Default)]
pub struct Agent {
/// This requests is to make the application agent
/// the default agent.
///
/// Special permission might be required to become
/// the default agent.
pub request_default: bool,
/// This method gets called when the service daemon
/// needs to get the passkey for an authentication.
///
/// The return value should be a string of 1-16 characters
/// length. The string can be alphanumeric.
pub request_pin_code: Option<RequestPinCodeFn>,
/// This method gets called when the service daemon
/// needs to display a pin code for an authentication.
///
/// An empty reply should be returned. When the pin code
/// needs no longer to be displayed, the Cancel method
/// of the agent will be called.
///
/// This is used during the pairing process of keyboards
/// that don't support Bluetooth 2.1 Secure Simple Pairing,
/// in contrast to DisplayPasskey which is used for those
/// that do.
///
/// This method will only ever be called once since
/// older keyboards do not support typing notification.
///
/// Note that the PIN will always be a 6-digit number,
/// zero-padded to 6 digits. This is for harmony with
/// the later specification.
pub display_pin_code: Option<DisplayPinCodeFn>,
/// This method gets called when the service daemon
/// needs to get the passkey for an authentication.
///
/// The return value should be a numeric value
/// between 0-999999.
pub request_passkey: Option<RequestPasskeyFn>,
/// This method gets called when the service daemon
/// needs to display a passkey for an authentication.
///
/// The entered parameter indicates the number of already
/// typed keys on the remote side.
///
/// An empty reply should be returned. When the passkey
/// needs no longer to be displayed, the Cancel method
/// of the agent will be called.
///
/// During the pairing process this method might be
/// called multiple times to update the entered value.
///
/// Note that the passkey will always be a 6-digit number,
/// so the display should be zero-padded at the start if
/// the value contains less than 6 digits.
pub display_passkey: Option<DisplayPasskeyFn>,
/// This method gets called when the service daemon
/// needs to confirm a passkey for an authentication.
///
/// To confirm the value it should return an empty reply
/// or an error in case the passkey is invalid.
///
/// Note that the passkey will always be a 6-digit number,
/// so the display should be zero-padded at the start if
/// the value contains less than 6 digits.
pub request_confirmation: Option<RequestConfirmationFn>,
/// This method gets called to request the user to
/// authorize an incoming pairing attempt which
/// would in other circumstances trigger the just-works
/// model, or when the user plugged in a device that
/// implements cable pairing.
///
/// In the latter case, the
/// device would not be connected to the adapter via
/// Bluetooth yet.
pub request_authorization: Option<RequestAuthorizationFn>,
/// This method gets called when the service daemon
/// needs to authorize a connection/service request.
pub authorize_service: Option<AuthorizeServiceFn>,
#[doc(hidden)]
pub _non_exhaustive: (),
}
impl Agent {
/// BlueZ capability parameter.
pub(crate) fn capability(&self) -> &'static str {
let keyboard = self.request_passkey.is_some() || self.request_pin_code.is_some();
let display_only = self.display_passkey.is_some() || self.display_pin_code.is_some();
let yes_no = self.request_confirmation.is_some()
|| self.request_authorization.is_some()
|| self.authorize_service.is_some();
match (keyboard, display_only, yes_no) {
(true, false, false) => "KeyboardOnly",
(false, true, false) => "DisplayOnly",
(false, _, true) => "DisplayYesNo",
(true, true, _) | (true, _, true) => "KeyboardDisplay",
(false, false, false) => "NoInputNoOutput",
}
}
}
pub(crate) struct RegisteredAgent {
a: Agent,
cancel: Mutex<Option<oneshot::Sender<()>>>,
}
impl RegisteredAgent {
pub(crate) fn new(agent: Agent) -> Self {
Self { a: agent, cancel: Mutex::new(None) }
}
async fn get_cancel(&self) -> oneshot::Receiver<()> {
let (cancel_tx, cancel_rx) = oneshot::channel();
*self.cancel.lock().await = Some(cancel_tx);
cancel_rx
}
async fn call<A, F, R>(&self, f: &Option<impl Fn(A) -> F>, arg: A) -> ReqResult<R>
where
F: Future<Output = ReqResult<R>> + Send + 'static,
{
match f {
Some(f) => f(arg).await,
None => Err(ReqError::Rejected),
}
}
async fn call_with_cancel<A, F, R>(&self, f: &Option<impl Fn(A) -> F>, arg: A) -> ReqResult<R>
where
F: Future<Output = ReqResult<R>> + Send + 'static,
{
let cancel_rx = self.get_cancel().await;
match f {
Some(f) => {
let fut = f(arg);
pin_mut!(fut);
select! {
result = fut => result,
_ = cancel_rx => Err(ReqError::Canceled)
}
}
None => Err(ReqError::Rejected),
}
}
fn parse_device_path(device: &dbus::Path<'static>) -> ReqResult<(String, Address)> {
match Device::parse_dbus_path(device) {
Some((adapter, addr)) => Ok((adapter.to_string(), addr)),
None => {
log::error!("Cannot parse device path {}", &device);
Err(ReqError::Rejected)
}
}
}
pub(crate) fn register_interface(cr: &mut Crossroads) -> IfaceToken<Arc<Self>> {
cr.register(INTERFACE, |ib: &mut IfaceBuilder<Arc<Self>>| {
ib.method_with_cr_async("Cancel", (), (), |ctx, cr, ()| {
method_call(ctx, cr, move |reg: Arc<Self>| async move {
if let Some(cancel_tx) = reg.cancel.lock().await.take() {
let _ = cancel_tx.send(());
}
Ok(())
})
});
ib.method_with_cr_async(
"RequestPinCode",
("device",),
("value",),
|ctx, cr, (device,): (dbus::Path<'static>,)| {
method_call(ctx, cr, |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
Ok((reg
.call_with_cancel(®.a.request_pin_code, RequestPinCode { adapter, device })
.await?,))
})
},
);
ib.method_with_cr_async(
"DisplayPinCode",
("device", "pincode"),
(),
|ctx, cr, (device, pincode): (dbus::Path<'static>, String)| {
method_call(ctx, cr, |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
reg.call(
®.a.display_pin_code,
DisplayPinCode { adapter, device, pincode, cancel: reg.get_cancel().await },
)
.await?;
Ok(())
})
},
);
ib.method_with_cr_async(
"RequestPasskey",
("device",),
("value",),
|ctx, cr, (device,): (dbus::Path<'static>,)| {
method_call(ctx, cr, |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
Ok((reg
.call_with_cancel(®.a.request_passkey, RequestPasskey { adapter, device })
.await?,))
})
},
);
ib.method_with_cr_async(
"DisplayPasskey",
("device", "passkey", "entered"),
(),
|ctx, cr, (device, passkey, entered): (dbus::Path<'static>, u32, u16)| {
method_call(ctx, cr, move |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
reg.call(
®.a.display_passkey,
DisplayPasskey { adapter, device, passkey, entered, cancel: reg.get_cancel().await },
)
.await?;
Ok(())
})
},
);
ib.method_with_cr_async(
"RequestConfirmation",
("device", "passkey"),
(),
|ctx, cr, (device, passkey): (dbus::Path<'static>, u32)| {
method_call(ctx, cr, move |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
reg.call_with_cancel(
®.a.request_confirmation,
RequestConfirmation { adapter, device, passkey },
)
.await?;
Ok(())
})
},
);
ib.method_with_cr_async(
"RequestAuthorization",
("device",),
(),
|ctx, cr, (device,): (dbus::Path<'static>,)| {
method_call(ctx, cr, move |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
reg.call_with_cancel(
®.a.request_authorization,
RequestAuthorization { adapter, device },
)
.await?;
Ok(())
})
},
);
ib.method_with_cr_async(
"AuthorizeService",
("device", "uuid"),
(),
|ctx, cr, (device, uuid): (dbus::Path<'static>, String)| {
method_call(ctx, cr, move |reg: Arc<Self>| async move {
let (adapter, device) = Self::parse_device_path(&device)?;
let service: Uuid = match uuid.parse() {
Ok(service) => service,
Err(_) => {
log::error!("Invalid UUID: {}", &uuid);
return Err(ReqError::Rejected.into());
}
};
reg.call_with_cancel(
®.a.authorize_service,
AuthorizeService { adapter, device, service },
)
.await?;
Ok(())
})
},
);
})
}
pub(crate) async fn register(self, inner: Arc<SessionInner>) -> Result<AgentHandle> {
let name = dbus::Path::new(format!("{}{}", AGENT_PREFIX, Uuid::new_v4().as_simple())).unwrap();
let capability = self.a.capability();
let request_default = self.a.request_default;
log::trace!("Publishing agent at {} with capability {}", &name, &capability);
{
let mut cr = inner.crossroads.lock().await;
cr.insert(name.clone(), &[inner.agent_token], Arc::new(self));
}
log::trace!("Registering agent at {}", &name);
let proxy = Proxy::new(SERVICE_NAME, MANAGER_PATH, TIMEOUT, inner.connection.clone());
proxy.method_call(MANAGER_INTERFACE, "RegisterAgent", (name.clone(), capability)).await?;
let connection = inner.connection.clone();
let (drop_tx, drop_rx) = oneshot::channel();
let unreg_name = name.clone();
tokio::spawn(async move {
let _ = drop_rx.await;
log::trace!("Unregistering agent at {}", &unreg_name);
let _: std::result::Result<(), dbus::Error> =
proxy.method_call(MANAGER_INTERFACE, "UnregisterAgent", (unreg_name.clone(),)).await;
log::trace!("Unpublishing agent at {}", &unreg_name);
let mut cr = inner.crossroads.lock().await;
let _: Option<Self> = cr.remove(&unreg_name);
});
if request_default {
log::trace!("Requesting default agent for {}", &name);
let proxy = Proxy::new(SERVICE_NAME, MANAGER_PATH, TIMEOUT, connection);
proxy.method_call(MANAGER_INTERFACE, "RequestDefaultAgent", (name.clone(),)).await?;
}
Ok(AgentHandle { name, _drop_tx: drop_tx })
}
}
/// Handle to registered agent.
///
/// Drop to unregister agent.
pub struct AgentHandle {
name: dbus::Path<'static>,
_drop_tx: oneshot::Sender<()>,
}
impl Drop for AgentHandle {
fn drop(&mut self) {
// required for drop order
}
}
impl fmt::Debug for AgentHandle {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "AgentHandle {{ {} }}", &self.name)
}
}