gateryx 0.1.6

Secure HTTP gateway for IoT and Industrial applications
Documentation
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
use crate::{
    Error, Result,
    authenticator::RandomSleeper,
    util::{GDuration, synth_sleep},
};
use std::{
    path::{Path, PathBuf},
    sync::Arc,
    time::Duration,
};

use super::{AuthResult, Authenticator};
use ldap3::{LdapConnAsync, SearchEntry};
use native_tls::{Certificate, TlsConnector};
use serde::Deserialize;
use simple_pool::ResourcePool;
use tokio::{
    sync::{Mutex, Semaphore},
    task::JoinHandle,
};
use tracing::{debug, error, info};
use zeroize::{Zeroize, ZeroizeOnDrop};

pub struct LdapAuthenticator {
    pool: LdapPool,
}

impl LdapAuthenticator {
    pub async fn create(config: &Config) -> Result<Self> {
        let cert = if let Some(ca) = &config.ca {
            Some(read_tls_certificate(ca).await?)
        } else {
            None
        };
        let pool = LdapPool::init(config, cert.as_ref());
        Ok(Self { pool })
    }
}

#[async_trait::async_trait]
impl Authenticator for LdapAuthenticator {
    async fn present(&self, login: &str) -> bool {
        let random_sleeper = RandomSleeper::new(100..300);
        match self.pool.user_present(login).await {
            Ok(present) => {
                random_sleeper.sleep().await;
                present
            }
            Err(e) => {
                random_sleeper.sleep().await;
                synth_sleep().await;
                error!(%e, "error checking user presence");
                false
            }
        }
    }
    async fn spawn_secure_workers(&self) -> Result<()> {
        self.pool.start_connector().await;
        Ok(())
    }
    async fn verify(&self, login: &str, password: &str, _otp: Option<&str>) -> AuthResult {
        let random_sleeper = RandomSleeper::new(100..300);
        match self.pool.verify_password(login, password).await {
            Ok(()) => {
                random_sleeper.sleep().await;
                let groups = match self.pool.user_groups(login).await {
                    Ok(g) => g,
                    Err(e) => {
                        error!(%e, "error fetching user groups");
                        return AuthResult::Error;
                    }
                };
                AuthResult::Success { groups }
            }
            Err(e) => {
                if matches!(e, crate::Error::AccessDenied(_)) {
                    random_sleeper.sleep().await;
                    synth_sleep().await;
                    AuthResult::Failure
                } else {
                    error!(%e, "error verifying password");
                    AuthResult::Error
                }
            }
        }
    }
    async fn user_groups(&self, login: &str) -> Result<Vec<String>> {
        self.pool.user_groups(login).await
    }
}

#[derive(Deserialize, Default, Clone, Zeroize, ZeroizeOnDrop)]
#[serde(rename_all = "lowercase")]
enum Provider {
    #[default]
    Generic,
    Msad,
    Authentik,
}

fn default_pool_size() -> usize {
    1
}

fn default_auth_pool_size() -> usize {
    1
}

#[derive(Deserialize, Clone, Zeroize, ZeroizeOnDrop)]
pub struct Config {
    path: String,
    service_user: String,
    service_password: String,
    url: String,
    #[serde(default)]
    starttls: bool,
    #[zeroize(skip)]
    pub(crate) ca: Option<PathBuf>,
    #[serde(default)]
    no_tls_verify: bool,
    #[serde(default)]
    provider: Provider,
    #[serde(default = "crate::util::default_timeout")]
    #[zeroize(skip)]
    timeout: GDuration,
    #[serde(default = "default_pool_size")]
    pool_size: usize,
    #[serde(default = "default_auth_pool_size")]
    auth_pool_size: usize,
}

pub async fn read_tls_certificate(ca: &Path) -> Result<Certificate> {
    let data = tokio::fs::read(ca).await?;

    let cert = if Path::new(ca)
        .extension()
        .is_some_and(|ext| ext.eq_ignore_ascii_case("der"))
    {
        native_tls::Certificate::from_der(&data).map_err(Error::crypto)?
    } else {
        native_tls::Certificate::from_pem(&data).map_err(Error::crypto)?
    };
    Ok(cert)
}

struct LdapPool {
    pool: Arc<Mutex<Option<Arc<ResourcePool<Ldap>>>>>,
    auth_perms: Semaphore,
    connector: Arc<Mutex<Option<JoinHandle<()>>>>,
    timeout: Duration,
    config: Config,
    cert: Option<Certificate>,
}

async fn try_init_pool(config: &Config, cert: Option<&Certificate>) -> Result<ResourcePool<Ldap>> {
    let pool = ResourcePool::new();
    for _ in 0..config.pool_size {
        let ldap = Ldap::connect(config, cert, None).await?;
        pool.append(ldap);
    }
    Ok(pool)
}

impl LdapPool {
    fn init(config: &Config, cert: Option<&Certificate>) -> Self {
        let timeout = config.timeout.into();
        let ldap_pool: Arc<Mutex<Option<Arc<ResourcePool<Ldap>>>>> = <_>::default();
        Self {
            pool: ldap_pool,
            auth_perms: Semaphore::new(config.auth_pool_size),
            connector: <_>::default(),
            timeout,
            cert: cert.cloned(),
            config: config.clone(),
        }
    }
    async fn ldap_user(&self, user: &str, ldap: &mut Ldap) -> Result<String> {
        Ok(if user.contains('@') {
            format!(
                "cn={},{}",
                ldap.get_user_by_email(user).await?,
                self.config.path
            )
        } else {
            format!("cn={},{}", user, self.config.path)
        })
    }
    async fn start_connector(&self) {
        let connector = tokio::spawn({
            let ldap_pool = self.pool.clone();
            let config = self.config.clone();
            let cert = self.cert.clone();
            async move {
                loop {
                    match try_init_pool(&config, cert.as_ref()).await {
                        Ok(pool) => {
                            ldap_pool.lock().await.replace(pool.into());
                            info!("LDAP pool initialized");
                            break;
                        }
                        Err(e) => {
                            error!(error = %e, "Failed to initialize LDAP pool");
                        }
                    }
                    tokio::time::sleep(Duration::from_secs(10)).await;
                }
            }
        });
        self.connector.lock().await.replace(connector);
    }
    pub async fn get_user_by_email(&self, email: &str) -> Result<String> {
        let res = tokio::time::timeout(self.timeout, self.get_user_by_email_impl(email)).await??;
        Ok(res)
    }
    async fn get_user_by_email_impl(&self, email: &str) -> Result<String> {
        let pool = self.get_pool().await?;
        let mut ldap = pool.get().await;
        ldap.get_user_by_email(email).await
    }
    async fn get_pool(&self) -> Result<Arc<ResourcePool<Ldap>>> {
        let Some(pool) = self.pool.lock().await.as_ref().cloned() else {
            return Err(Error::failed("LDAP pool not initialized"));
        };
        Ok(pool)
    }
    async fn user_groups(&self, user: &str) -> Result<Vec<String>> {
        let res = tokio::time::timeout(self.timeout, self.user_groups_impl(user)).await??;
        Ok(res)
    }
    async fn user_groups_impl(&self, user: &str) -> Result<Vec<String>> {
        let pool = self.get_pool().await?;
        let mut ldap = pool.get().await;
        let attrs = vec!["memberOf"];
        let ldap_user = self.ldap_user(user, &mut ldap).await?;
        let (rs, _) = ldap
            .inner
            .search(&ldap_user, ldap3::Scope::Base, "(objectClass=*)", attrs)
            .await
            .map_err(Error::failed)?
            .success()
            .map_err(Error::failed)?;
        if rs.is_empty() {
            return Ok(vec![]);
        }
        let se = SearchEntry::construct(
            rs.into_iter()
                .next()
                .ok_or_else(|| Error::failed("No search entry found"))?,
        );
        let member_of = se.attrs.get("memberOf").cloned().unwrap_or_default();
        let groups = member_of
            .into_iter()
            .filter_map(|dn| {
                dn.split(',')
                    .next()
                    .and_then(|cn_part| {
                        let (key, value) = cn_part.split_once('=')?;
                        if key.eq_ignore_ascii_case("cn") {
                            Some(value)
                        } else {
                            None
                        }
                    })
                    .map(ToString::to_string)
            })
            .collect();
        Ok(groups)
    }
    async fn user_present(&self, user: &str) -> Result<bool> {
        let res = tokio::time::timeout(self.timeout, self.user_present_impl(user)).await??;
        Ok(res)
    }
    async fn user_present_impl(&self, user: &str) -> Result<bool> {
        let pool = self.get_pool().await?;
        let mut ldap = pool.get().await;
        let mut attrs = vec!["cn"];
        match self.config.provider {
            Provider::Generic => {}
            Provider::Msad => attrs.push("userAccountControl"),
            Provider::Authentik => {
                attrs.push("ak-active");
            }
        }
        let ldap_user = self.ldap_user(user, &mut ldap).await?;
        let (rs, _) = ldap
            .inner
            .search(&ldap_user, ldap3::Scope::Base, "(objectClass=*)", attrs)
            .await
            .map_err(Error::failed)?
            .success()
            .map_err(Error::failed)?;
        if rs.is_empty() {
            return Ok(false);
        }
        let se = SearchEntry::construct(
            rs.into_iter()
                .next()
                .ok_or_else(|| Error::failed("No search entry found"))?,
        );
        let active = match self.config.provider {
            Provider::Generic => true,
            Provider::Msad => {
                let uac = se
                    .attrs
                    .get("userAccountControl")
                    .ok_or_else(|| Error::failed("No userAccountControl attribute found"))?
                    .first()
                    .ok_or_else(|| Error::failed("No userAccountControl value found"))?
                    .parse::<u32>()
                    .map_err(|e| {
                        Error::failed(format!("Failed to parse userAccountControl: {}", e))
                    })?;
                (uac & 0x2) == 0
            }
            Provider::Authentik => se
                .attrs
                .get("ak-active")
                .and_then(|v| v.first())
                .is_some_and(|s| s == "TRUE"),
        };
        if !active {
            debug!(user = %user, "LDAP user is inactive");
        }
        Ok(active)
    }
    async fn verify_password(&self, user: &str, password: &str) -> Result<()> {
        tokio::time::timeout(self.timeout, self.verify_password_impl(user, password)).await??;
        Ok(())
    }
    async fn verify_password_impl(&self, user: &str, password: &str) -> Result<()> {
        let _perm = self.auth_perms.acquire().await.map_err(Error::failed)?;
        let ldap_user = if user.contains('@') {
            self.get_user_by_email(user).await?
        } else {
            user.to_string()
        };
        let creds = Creds {
            user: ldap_user,
            password,
        };
        let mut user_ldap = Ldap::connect(&self.config, None, Some(creds)).await?;
        user_ldap.test().await?;
        Ok(())
    }
}

impl Drop for LdapPool {
    fn drop(&mut self) {
        let connector = self.connector.clone();
        tokio::spawn(async move {
            if let Some(f) = connector.lock().await.take() {
                f.abort();
            }
        });
    }
}

#[derive(Clone)]
struct Ldap {
    inner: ldap3::Ldap,
    bind_login: String,
}

struct Creds<'a> {
    user: String,
    password: &'a str,
}

impl Ldap {
    async fn connect(
        config: &Config,
        cert: Option<&Certificate>,
        creds: Option<Creds<'_>>,
    ) -> Result<Self> {
        let (bind_login, password) = if let Some(ref creds) = creds {
            (format!("cn={},{}", creds.user, config.path), creds.password)
        } else {
            (
                format!("cn={},{}", config.service_user, config.path),
                config.service_password.as_str(),
            )
        };
        let timeout = config.timeout.into();
        let mut settings = ldap3::LdapConnSettings::new()
            .set_no_tls_verify(config.no_tls_verify)
            .set_starttls(config.starttls)
            .set_conn_timeout(timeout);
        if let Some(cert) = cert {
            let mut builder = TlsConnector::builder();
            if config.no_tls_verify {
                builder.danger_accept_invalid_certs(true);
            }
            builder.add_root_certificate(cert.clone());

            let connector = builder.build().map_err(Error::crypto)?;
            settings = settings.set_connector(connector);
        }
        let (conn, mut ldap) = LdapConnAsync::with_settings(settings, &config.url)
            .await
            .map_err(Error::io)?;
        ldap3::drive!(conn);
        debug!(login = %bind_login, "Binding LDAP user");
        ldap.simple_bind(&bind_login, password)
            .await
            .map_err(Error::access)?
            .success()
            .map_err(Error::access)?;
        Ok(Self {
            inner: ldap,
            bind_login,
        })
    }
    async fn test(&mut self) -> Result<()> {
        self.inner
            .search(
                &self.bind_login,
                ldap3::Scope::Subtree,
                "(objectClass=*)",
                vec!["cn"],
            )
            .await
            .map_err(Error::failed)?
            .success()
            .map_err(Error::failed)?;
        Ok(())
    }
    async fn get_user_by_email(&mut self, email: &str) -> Result<String> {
        let (rs, _res) = self
            .inner
            .search(
                "ou=users,dc=lab,dc=bma,dc=ai",
                ldap3::Scope::Subtree,
                &format!("(mail={})", email),
                vec!["cn"],
            )
            .await
            .map_err(Error::failed)?
            .success()
            .map_err(Error::failed)?;
        if rs.is_empty() {
            return Err(Error::failed("No user found"));
        }
        if rs.len() > 1 {
            return Err(Error::failed("Multiple users found"));
        }
        let se = SearchEntry::construct(
            rs.into_iter()
                .next()
                .ok_or_else(|| Error::failed("No search entry found"))?,
        );
        let cn = se
            .attrs
            .get("cn")
            .ok_or_else(|| Error::failed("No cn attribute found"))?
            .first()
            .ok_or_else(|| Error::failed("No cn attribute found"))?
            .clone();
        Ok(cn)
    }
}