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
use std::collections::HashSet; use std::hash::Hash; use std::sync::{Arc, Mutex}; use std::time::Duration; use crate::adapters::{EntriesOnly, IntoAdapterVec}; use crate::controls_impl::IntoRawControlVec; use crate::exop::Exop; use crate::exop_impl::construct_exop; use crate::protocol::{LdapOp, MaybeControls, ResultSender}; use crate::result::{ CompareResult, ExopResult, LdapError, LdapResult, LdapResultExt, Result, SearchResult, }; use crate::search::{Scope, SearchOptions, SearchStream}; use crate::RequestId; use lber::common::TagClass; use lber::structures::{Boolean, Enumerated, Integer, Null, OctetString, Sequence, Set, Tag}; use maplit::hashset; use tokio::sync::{mpsc, oneshot}; use tokio::time; /// Possible sub-operations for the Modify operation. #[derive(Clone, Debug, PartialEq)] pub enum Mod<S: AsRef<[u8]> + Eq + Hash> { /// Add an attribute, with at least one value. Add(S, HashSet<S>), /// Delete the entire attribute, or the given values of an attribute. Delete(S, HashSet<S>), /// Replace an existing attribute, setting its values to those in the set, or delete it if no values are given. Replace(S, HashSet<S>), /// Increment the attribute by the given value. Increment(S, S), } /// Asynchronous handle for LDAP operations. __*__ /// /// All LDAP operations allow attaching a series of request controls, which augment or modify /// the operation. Controls are attached by calling [`with_controls()`](#method.with_controls) /// on the handle, and using the result to call another modifier or the operation itself. /// A timeout can be imposed on an operation by calling [`with_timeout()`](#method.with_timeout) /// on the handle before invoking the operation. /// /// The Search operation has many parameters, most of which are infrequently used. Those /// parameters can be specified by constructing a [`SearchOptions`](struct.SearchOptions.html) /// structure and passing it to [`with_search_options()`](#method.with_search_options) /// called on the handle. This method can be combined with `with_controls()` and `with_timeout()`, /// described above. /// /// There are two ways to invoke a search. The first, using [`search()`](#method.search), /// returns all result entries in a single vector, which works best if it's known that the /// result set will be limited. The other way uses [`streaming_search()`](#method.streaming_search), /// which accepts the same parameters, but returns a handle which must be used to obtain /// result entries one by one. /// /// As a rule, operations return [`LdapResult`](result/struct.LdapResult.html), /// a structure of result components. The most important element of `LdapResult` /// is the result code, a numeric value indicating the outcome of the operation. /// This structure also contains the possibly empty vector of response controls, /// which are not directly usable, but must be additionally parsed by the driver- or /// user-supplied code. /// /// The handle can be freely cloned. Each clone will multiplex the invoked LDAP operations on /// the same underlying connection. Dropping the last handle will automatically close the /// connection. #[derive(Debug)] pub struct Ldap { pub(crate) msgmap: Arc<Mutex<(RequestId, HashSet<RequestId>)>>, pub(crate) tx: mpsc::UnboundedSender<(RequestId, LdapOp, Tag, MaybeControls, ResultSender)>, pub(crate) id_scrub_tx: mpsc::UnboundedSender<RequestId>, pub(crate) last_id: RequestId, pub timeout: Option<Duration>, pub controls: MaybeControls, pub search_opts: Option<SearchOptions>, } impl Clone for Ldap { fn clone(&self) -> Self { Ldap { msgmap: self.msgmap.clone(), tx: self.tx.clone(), id_scrub_tx: self.id_scrub_tx.clone(), last_id: 0, timeout: None, controls: None, search_opts: None, } } } impl Ldap { fn next_msgid(&mut self) -> i32 { let mut msgmap = self.msgmap.lock().expect("msgmap mutex (inc id)"); let last_ldap_id = msgmap.0; let mut next_ldap_id = last_ldap_id; loop { if next_ldap_id == std::i32::MAX { next_ldap_id = 1; } else { next_ldap_id += 1; } if !msgmap.1.contains(&next_ldap_id) { break; } assert_ne!( next_ldap_id, last_ldap_id, "LDAP message id wraparound with no free slots" ); } msgmap.0 = next_ldap_id; msgmap.1.insert(next_ldap_id); next_ldap_id } pub(crate) async fn op_call(&mut self, op: LdapOp, req: Tag) -> Result<(LdapResult, Exop)> { let id = self.next_msgid(); self.last_id = id; let (tx, rx) = oneshot::channel(); self.tx.send((id, op, req, self.controls.take(), tx))?; let response = if let Some(timeout) = self.timeout.take() { let res = time::timeout(timeout, rx).await; if res.is_err() { self.id_scrub_tx.send(self.last_id)?; } res? } else { rx.await }?; let (ldap_ext, controls) = (LdapResultExt::from(response.0), response.1); let (mut result, exop) = (ldap_ext.0, ldap_ext.1); result.ctrls = controls; Ok((result, exop)) } /// Use the provided `SearchOptions` with the next Search operation, which can /// be invoked directly on the result of this method. If this method is used in /// combination with a non-Search operation, the provided options will be silently /// discarded when the operation is invoked. /// /// The Search operation can be invoked on the result of this method. pub fn with_search_options(&mut self, opts: SearchOptions) -> &mut Self { self.search_opts = Some(opts); self } /// Pass the provided request control(s) to the next LDAP operation. /// Controls can be constructed by instantiating structs in the /// [`controls`](controls/index.html) module, and converted to the form needed /// by this method by calling `into()` on the instances. Alternatively, a control /// struct may offer a constructor which will produce a `RawControl` instance /// itself. See the module-level documentation for the list of directly supported /// controls and procedures for defining custom controls. /// /// This method accepts either a single `RawControl` or a `Vec` of them, in /// order to make the call site less noisy, since it's expected that passing /// a single control will comprise the majority of uses. /// /// The desired operation can be invoked on the result of this method. pub fn with_controls<V: IntoRawControlVec>(&mut self, ctrls: V) -> &mut Self { self.controls = Some(ctrls.into()); self } /// Perform the next operation with the timeout specified in `duration`. /// The LDAP Search operation consists of an indeterminate number of Entry/Referral /// replies; the timer is reset for each reply. /// /// If the timeout occurs, the operation will return an error. The connection remains /// usable for subsequent operations. /// /// The desired operation can be invoked on the result of this method. pub fn with_timeout(&mut self, duration: Duration) -> &mut Self { self.timeout = Some(duration); self } /// Do a simple Bind with the provided DN (`bind_dn`) and password (`bind_pw`). pub async fn simple_bind(&mut self, bind_dn: &str, bind_pw: &str) -> Result<LdapResult> { let req = Tag::Sequence(Sequence { id: 0, class: TagClass::Application, inner: vec![ Tag::Integer(Integer { inner: 3, ..Default::default() }), Tag::OctetString(OctetString { inner: Vec::from(bind_dn), ..Default::default() }), Tag::OctetString(OctetString { id: 0, class: TagClass::Context, inner: Vec::from(bind_pw), }), ], }); Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Do a SASL EXTERNAL bind on the connection. The identity of the client /// must have already been established by connection-specific methods, as /// is the case for Unix domain sockets or TLS client certificates. The bind /// is made with the hardcoded empty authzId value. pub async fn sasl_external_bind(&mut self) -> Result<LdapResult> { let req = Tag::Sequence(Sequence { id: 0, class: TagClass::Application, inner: vec![ Tag::Integer(Integer { inner: 3, ..Default::default() }), Tag::OctetString(OctetString { inner: Vec::new(), ..Default::default() }), Tag::Sequence(Sequence { id: 3, class: TagClass::Context, inner: vec![ Tag::OctetString(OctetString { inner: Vec::from("EXTERNAL"), ..Default::default() }), Tag::OctetString(OctetString { inner: Vec::new(), ..Default::default() }), ], }), ], }); Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Perform a Search with the given base DN (`base`), scope, filter, and /// the list of attributes to be returned (`attrs`). If `attrs` is empty, /// or if it contains a special name `*` (asterisk), return all (user) attributes. /// Requesting a special name `+` (plus sign) will return all operational /// attributes. Include both `*` and `+` in order to return all attributes /// of an entry. /// /// The returned structure wraps the vector of result entries and the overall /// result of the operation. Entries are not directly usable, and must be parsed by /// [`SearchEntry::construct()`](struct.SearchEntry.html#method.construct). All /// referrals in the result stream will be collected in the `refs` vector of the /// operation result. Any intermediate messages will be discarded. /// /// This method should be used if it's known that the result set won't be /// large. For other situations, one can use [`streaming_search()`](#method.streaming_search). pub async fn search<'a, S: AsRef<str> + Send + Sync + 'a>( &mut self, base: &str, scope: Scope, filter: &str, attrs: Vec<S>, ) -> Result<SearchResult> { let mut stream = self .streaming_search_with(EntriesOnly::new(), base, scope, filter, attrs) .await?; let mut re_vec = vec![]; while let Some(entry) = stream.next().await? { re_vec.push(entry); } let res = stream.finish().await; Ok(SearchResult(re_vec, res)) } /// Perform a Search, but unlike [`search()`](#method.search) (q.v., also for /// the parameters), which returns all results at once, return a handle which /// will be used for retrieving entries one by one. See [`SearchStream`](struct.SearchStream.html) /// for the explanation of the protocol which must be adhered to in this case. pub async fn streaming_search<'a, S: AsRef<str> + Send + Sync + 'a>( &mut self, base: &str, scope: Scope, filter: &str, attrs: Vec<S>, ) -> Result<SearchStream<'a, S>> { self.streaming_search_with(vec![], base, scope, filter, attrs) .await } /// Perform a streaming Search internally modified by a chain of [adapters](adapters/index.html). /// The first argument can either be a struct implementing `Adapter`, if a single adapter is needed, /// or a vector of boxed `Adapter` trait objects. pub async fn streaming_search_with< 'a, V: IntoAdapterVec<'a, S>, S: AsRef<str> + Send + Sync + 'a, >( &mut self, adapters: V, base: &str, scope: Scope, filter: &str, attrs: Vec<S>, ) -> Result<SearchStream<'a, S>> { let mut ldap = self.clone(); ldap.controls = self.controls.take(); ldap.timeout = self.timeout.take(); ldap.search_opts = self.search_opts.take(); let mut stream = SearchStream::new(ldap, adapters.into()); stream.start(base, scope, filter, attrs).await?; Ok(stream) } /// Add an entry named by `dn`, with the list of attributes and their values /// given in `attrs`. None of the `HashSet`s of values for an attribute may /// be empty. pub async fn add<S: AsRef<[u8]> + Eq + Hash>( &mut self, dn: &str, attrs: Vec<(S, HashSet<S>)>, ) -> Result<LdapResult> { let mut any_empty = false; let req = Tag::Sequence(Sequence { id: 8, class: TagClass::Application, inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(dn.as_bytes()), ..Default::default() }), Tag::Sequence(Sequence { inner: attrs .into_iter() .map(|(name, vals)| { if vals.is_empty() { any_empty = true; } Tag::Sequence(Sequence { inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(name.as_ref()), ..Default::default() }), Tag::Set(Set { inner: vals .into_iter() .map(|v| { Tag::OctetString(OctetString { inner: Vec::from(v.as_ref()), ..Default::default() }) }) .collect(), ..Default::default() }), ], ..Default::default() }) }) .collect(), ..Default::default() }), ], }); if any_empty { return Err(LdapError::AddNoValues); } Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Compare the value(s) of the attribute `attr` within an entry named by `dn` with the /// value `val`. If any of the values is identical to the provided one, return result code 5 /// (`compareTrue`), otherwise return result code 6 (`compareFalse`). If access control /// rules on the server disallow comparison, another result code will be used to indicate /// an error. pub async fn compare<B: AsRef<[u8]>>( &mut self, dn: &str, attr: &str, val: B, ) -> Result<CompareResult> { let req = Tag::Sequence(Sequence { id: 14, class: TagClass::Application, inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(dn.as_bytes()), ..Default::default() }), Tag::Sequence(Sequence { inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(attr.as_bytes()), ..Default::default() }), Tag::OctetString(OctetString { inner: Vec::from(val.as_ref()), ..Default::default() }), ], ..Default::default() }), ], }); Ok(CompareResult(self.op_call(LdapOp::Single, req).await?.0)) } /// Delete an entry named by `dn`. pub async fn delete(&mut self, dn: &str) -> Result<LdapResult> { let req = Tag::OctetString(OctetString { id: 10, class: TagClass::Application, inner: Vec::from(dn.as_bytes()), }); Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Modify an entry named by `dn` by sequentially applying the modifications given by `mods`. /// See the [`Mod`](enum.Mod.html) documentation for the description of possible values. pub async fn modify<S: AsRef<[u8]> + Eq + Hash>( &mut self, dn: &str, mods: Vec<Mod<S>>, ) -> Result<LdapResult> { let mut any_add_empty = false; let req = Tag::Sequence(Sequence { id: 6, class: TagClass::Application, inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(dn.as_bytes()), ..Default::default() }), Tag::Sequence(Sequence { inner: mods .into_iter() .map(|m| { let mut is_add = false; let (num, attr, set) = match m { Mod::Add(attr, set) => { is_add = true; (0, attr, set) } Mod::Delete(attr, set) => (1, attr, set), Mod::Replace(attr, set) => (2, attr, set), Mod::Increment(attr, val) => (3, attr, hashset! { val }), }; if set.is_empty() && is_add { any_add_empty = true; } let op = Tag::Enumerated(Enumerated { inner: num, ..Default::default() }); let part_attr = Tag::Sequence(Sequence { inner: vec![ Tag::OctetString(OctetString { inner: Vec::from(attr.as_ref()), ..Default::default() }), Tag::Set(Set { inner: set .into_iter() .map(|val| { Tag::OctetString(OctetString { inner: Vec::from(val.as_ref()), ..Default::default() }) }) .collect(), ..Default::default() }), ], ..Default::default() }); Tag::Sequence(Sequence { inner: vec![op, part_attr], ..Default::default() }) }) .collect(), ..Default::default() }), ], }); if any_add_empty { return Err(LdapError::AddNoValues); } Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Rename and/or move an entry named by `dn`. The new name is given by `rdn`. If /// `delete_old` is `true`, delete the previous value of the naming attribute from /// the entry. If the entry is to be moved elsewhere in the DIT, `new_sup` gives /// the new superior entry where the moved entry will be anchored. pub async fn modifydn( &mut self, dn: &str, rdn: &str, delete_old: bool, new_sup: Option<&str>, ) -> Result<LdapResult> { let mut params = vec![ Tag::OctetString(OctetString { inner: Vec::from(dn.as_bytes()), ..Default::default() }), Tag::OctetString(OctetString { inner: Vec::from(rdn.as_bytes()), ..Default::default() }), Tag::Boolean(Boolean { inner: delete_old, ..Default::default() }), ]; if let Some(new_sup) = new_sup { params.push(Tag::OctetString(OctetString { id: 0, class: TagClass::Context, inner: Vec::from(new_sup.as_bytes()), })); } let req = Tag::Sequence(Sequence { id: 12, class: TagClass::Application, inner: params, }); Ok(self.op_call(LdapOp::Single, req).await?.0) } /// Perform an Extended operation given by `exop`. Extended operations are defined in the /// [`exop`](exop/index.html) module. See the module-level documentation for the list of extended /// operations supported by this library and procedures for defining custom exops. pub async fn extended<E>(&mut self, exop: E) -> Result<ExopResult> where E: Into<Exop>, { let req = Tag::Sequence(Sequence { id: 23, class: TagClass::Application, inner: construct_exop(exop.into()), }); self.op_call(LdapOp::Single, req) .await .map(|et| ExopResult(et.1, et.0)) } /// Terminate the connection to the server. pub async fn unbind(&mut self) -> Result<()> { let req = Tag::Null(Null { id: 2, class: TagClass::Application, inner: (), }); Ok(self.op_call(LdapOp::Unbind, req).await.map(|_| ())?) } /// Return the message ID of the last active operation. When the handle is initialized, this /// value is set to zero. The intended use is to obtain the ID of a timed out operation for /// passing it to an Abandon or Cancel operation. /// /// Using this method in the `start()` adapter chain of a streaming Search will return zero, /// since the Message ID is obtained in the inner `start()` method. pub fn last_id(&mut self) -> RequestId { self.last_id } /// Ask the server to abandon an operation identified by `msgid`. pub async fn abandon(&mut self, msgid: RequestId) -> Result<()> { let req = Tag::Integer(Integer { id: 16, class: TagClass::Application, inner: msgid as i64, }); Ok(self .op_call(LdapOp::Abandon(msgid), req) .await .map(|_| ())?) } }