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
use std::collections::HashSet;
use std::hash::Hash;
use std::time::Duration;
use crate::adapters::IntoAdapterVec;
use crate::conn::{LdapConnAsync, LdapConnSettings};
use crate::controls_impl::IntoRawControlVec;
use crate::exop::Exop;
use crate::ldap::{Ldap, Mod};
use crate::result::{CompareResult, ExopResult, LdapResult, Result, SearchResult};
use crate::search::{ResultEntry, Scope, SearchOptions, SearchStream};
use crate::RequestId;
use tokio::runtime::{self, Runtime};
use url::Url;
/// Synchronous connection to an LDAP server.
///
/// In this version of the interface, [`new()`](#method.new) will return
/// a struct encapsulating a runtime, the connection, and an operation handle. All
/// operations are performed through that struct, synchronously: the thread will
/// wait until the result is available or the operation times out.
///
/// The API is virtually identical to the asynchronous one. The chief difference is
/// that `LdapConn` is not cloneable: if you need another handle, you must open a
/// new connection.
#[cfg_attr(docsrs, doc(cfg(feature = "sync")))]
#[derive(Debug)]
pub struct LdapConn {
rt: Runtime,
ldap: Ldap,
}
impl LdapConn {
/// Open a connection to an LDAP server specified by `url`.
///
/// See [LdapConnAsync::new()](struct.LdapConnAsync.html#method.new) for the
/// details of the supported URL formats.
pub fn new(url: &str) -> Result<Self> {
Self::with_settings(LdapConnSettings::new(), url)
}
/// Open a connection to an LDAP server specified by `url`, using
/// `settings` to specify additional parameters.
pub fn with_settings(settings: LdapConnSettings, url: &str) -> Result<Self> {
let url = Url::parse(url)?;
Self::from_url_with_settings(settings, &url)
}
/// Open a connection to an LDAP server specified by an already parsed `Url`.
pub fn from_url(url: &Url) -> Result<Self> {
Self::from_url_with_settings(LdapConnSettings::new(), url)
}
/// Open a connection to an LDAP server specified by an already parsed `Url`, using
/// `settings` to specify additional parameters.
pub fn from_url_with_settings(settings: LdapConnSettings, url: &Url) -> Result<Self> {
let rt = runtime::Builder::new_current_thread()
.enable_all()
.build()?;
let ldap = rt.block_on(async move {
let (conn, ldap) = match LdapConnAsync::from_url_with_settings(settings, url).await {
Ok((conn, ldap)) => (conn, ldap),
Err(e) => return Err(e),
};
super::drive!(conn);
Ok(ldap)
})?;
Ok(LdapConn { ldap, rt })
}
/// See [`Ldap::with_search_options()`](struct.Ldap.html#method.with_search_options).
pub fn with_search_options(&mut self, opts: SearchOptions) -> &mut Self {
self.ldap.search_opts = Some(opts);
self
}
/// See [`Ldap::with_controls()`](struct.Ldap.html#method.with_controls).
pub fn with_controls<V: IntoRawControlVec>(&mut self, ctrls: V) -> &mut Self {
self.ldap.controls = Some(ctrls.into());
self
}
/// See [`Ldap::with_timeout()`](struct.Ldap.html#method.with_timeout).
pub fn with_timeout(&mut self, duration: Duration) -> &mut Self {
self.ldap.timeout = Some(duration);
self
}
/// See [`Ldap::simple_bind()`](struct.Ldap.html#method.simple_bind).
pub fn simple_bind(&mut self, bind_dn: &str, bind_pw: &str) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.simple_bind(bind_dn, bind_pw).await })
}
/// See [`Ldap::sasl_external_bind()`](struct.Ldap.html#method.sasl_external_bind).
pub fn sasl_external_bind(&mut self) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.sasl_external_bind().await })
}
#[cfg_attr(docsrs, doc(cfg(feature = "gssapi")))]
#[cfg(feature = "gssapi")]
/// See [`Ldap::sasl_gssapi_bind()`](struct.Ldap.html#method.sasl_gssapi_bind).
pub fn sasl_gssapi_bind(&mut self, server_fqdn: &str) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.sasl_gssapi_bind(server_fqdn).await })
}
/// See [`Ldap::search()`](struct.Ldap.html#method.search).
pub fn search<'a, S: AsRef<str> + Send + Sync + 'a, A: AsRef<[S]> + Send + Sync + 'a>(
&mut self,
base: &str,
scope: Scope,
filter: &str,
attrs: A,
) -> Result<SearchResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.search(base, scope, filter, attrs).await })
}
/// Perform a Search, but unlike `search()`, which returns all results at once, return a handle which
/// will be used for retrieving entries one by one. See [`EntryStream`](struct.EntryStream.html)
/// for the explanation of the protocol which must be adhered to in this case.
pub fn streaming_search<
'a,
'b,
S: AsRef<str> + Send + Sync + 'a,
A: AsRef<[S]> + Send + Sync + 'a,
>(
&'b mut self,
base: &str,
scope: Scope,
filter: &str,
attrs: A,
) -> Result<EntryStream<'a, 'b, S, A>> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
let stream =
rt.block_on(async move { ldap.streaming_search(base, scope, filter, attrs).await })?;
Ok(EntryStream { stream, conn: self })
}
/// Perform a streaming Search internally modified by a chain of [adapters](adapters/index.html).
/// See [`Ldap::streaming_search_with()`](struct.Ldap.html#method.streaming_search_with).
pub fn streaming_search_with<
'a,
'b,
V: IntoAdapterVec<'a, S, A>,
S: AsRef<str> + Send + Sync + 'a,
A: AsRef<[S]> + Send + Sync + 'a,
>(
&'b mut self,
adapters: V,
base: &str,
scope: Scope,
filter: &str,
attrs: A,
) -> Result<EntryStream<'a, 'b, S, A>> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
let stream = rt.block_on(async move {
ldap.streaming_search_with(adapters.into(), base, scope, filter, attrs)
.await
})?;
Ok(EntryStream { stream, conn: self })
}
/// See [`Ldap::add()`](struct.Ldap.html#method.add).
pub fn add<S: AsRef<[u8]> + Eq + Hash>(
&mut self,
dn: &str,
attrs: Vec<(S, HashSet<S>)>,
) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.add(dn, attrs).await })
}
/// See [`Ldap::compare()`](struct.Ldap.html#method.compare).
pub fn compare<B: AsRef<[u8]>>(
&mut self,
dn: &str,
attr: &str,
val: B,
) -> Result<CompareResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.compare(dn, attr, val).await })
}
/// See [`Ldap::delete()`](struct.Ldap.html#method.delete).
pub fn delete(&mut self, dn: &str) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.delete(dn).await })
}
/// See [`Ldap::modify()`](struct.Ldap.html#method.modify).
pub fn modify<S: AsRef<[u8]> + Eq + Hash>(
&mut self,
dn: &str,
mods: Vec<Mod<S>>,
) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.modify(dn, mods).await })
}
/// See [`Ldap::modifydn()`](struct.Ldap.html#method.modifydn).
pub fn modifydn(
&mut self,
dn: &str,
rdn: &str,
delete_old: bool,
new_sup: Option<&str>,
) -> Result<LdapResult> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.modifydn(dn, rdn, delete_old, new_sup).await })
}
/// See [`Ldap::unbind()`](struct.Ldap.html#method.unbind).
pub fn unbind(&mut self) -> Result<()> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.unbind().await })
}
/// See [`Ldap::extended()`](struct.Ldap.html#method.extended).
pub fn extended<E>(&mut self, exop: E) -> Result<ExopResult>
where
E: Into<Exop>,
{
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.extended(exop).await })
}
/// See [`Ldap::last_id()`](struct.Ldap.html#method.last_id).
pub fn last_id(&mut self) -> RequestId {
self.ldap.last_id()
}
/// See [`Ldap::abandon()`](struct.Ldap.html#method.abandon).
pub fn abandon(&mut self, msgid: RequestId) -> Result<()> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.abandon(msgid).await })
}
/// See [`Ldap::is_closed()`](struct.Ldap.html#method.is_closed).
pub fn is_closed(&mut self) -> bool {
self.ldap.tx.is_closed()
}
/// See [`Ldap::get_peer_certificate()`](struct.Ldap.html#method.get_peer_certificate).
pub fn get_peer_certificate(&mut self) -> Result<Option<Vec<u8>>> {
let rt = &mut self.rt;
let ldap = &mut self.ldap;
rt.block_on(async move { ldap.get_peer_certificate().await })
}
}
/// Handle for obtaining a stream of search results.
///
/// User code can't construct a stream directly, but only by using
/// [`streaming_search()`](struct.LdapConn.html#method.streaming_search) or
/// [`streaming_search_with()`](struct.LdapConn.html#method.streaming_search_with) on
/// an `LdapConn` handle.
///
/// For compatibility, this struct's name is different from the async version
/// which is [`SearchStream`](struct.SearchStream.html). The protocol and behavior
/// are the same, with one important difference: an `EntryStream` shares the
/// Tokio runtime with `LdapConn` from which it's obtained, but the two can't be
/// used in parallel, which is enforced by capturing the reference to `LdapConn`
/// during the lifetime of `EntryStream`.
#[cfg_attr(docsrs, doc(cfg(feature = "sync")))]
pub struct EntryStream<'a, 'b, S, A> {
stream: SearchStream<'a, S, A>,
conn: &'b mut LdapConn,
}
impl<'a, 'b, S, A> EntryStream<'a, 'b, S, A>
where
S: AsRef<str> + Send + Sync + 'a,
A: AsRef<[S]> + Send + Sync + 'a,
{
/// See [`SearchStream::next()`](struct.SearchStream.html#method.next).
#[allow(clippy::should_implement_trait)]
pub fn next(&mut self) -> Result<Option<ResultEntry>> {
let rt = &mut self.conn.rt;
let stream = &mut self.stream;
rt.block_on(async move { stream.next().await })
}
/// See [`SearchStream::finish()`](struct.SearchStream.html#method.finish).
///
/// The name `result()` was kept for backwards compatibility.
pub fn result(mut self) -> LdapResult {
let rt = &mut self.conn.rt;
let stream = &mut self.stream;
rt.block_on(async move { stream.finish().await })
}
/// Returns the Message ID of the initial Search.
///
/// This method calls [`Ldap::last_id()`](struct.Ldap.html#method.last_id)
/// on the `Ldap` handle encapsulated by the underlying stream.
pub fn last_id(&mut self) -> RequestId {
self.stream.ldap_handle().last_id()
}
}