vsmtp-rule-engine 2.2.1

Next-gen MTA. Secured, Faster and Greener
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

/*
 * vSMTP mail transfer agent
 * Copyright (C) 2022 viridIT SAS
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see https://www.gnu.org/licenses/.
 *
*/

use crate::api::SharedObject;
use rhai::plugin::{
    Dynamic, FnAccess, FnNamespace, Module, NativeCallContext, PluginFunction, RhaiResult, TypeId,
};

pub use net::*;

/// Predefined network ip ranges.
#[rhai::plugin::export_module]
mod net {
    use vsmtp_plugin_vsl::objects::constructors::rg4;

    /// Return an ip range over "192.168.0.0/16".
    ///
    /// # Example
    ///
    /// ```ignore
    /// #{
    ///     rcpt: [
    ///         rule "anti relay" || { if ctx::client_ip() in net::rg_192() { state::next() } else { state::deny() } }
    ///     ]
    /// }
    /// ```
    ///
    /// # rhai-autodocs:index:1
    #[must_use]
    #[rhai_fn(name = "rg_192")]
    pub fn rg_192() -> SharedObject {
        rg4("192.168.0.0/16").expect("valid range")
    }

    /// Return an ip range over "172.16.0.0/12".
    ///
    /// # Example
    ///
    /// ```ignore
    /// #{
    ///     rcpt: [
    ///         rule "anti relay" || { if ctx::client_ip() in net::rg_172() { state::next() } else { state::deny() } }
    ///     ]
    /// }
    /// ```
    ///
    /// # rhai-autodocs:index:2
    #[must_use]
    #[rhai_fn(name = "rg_172")]
    pub fn rg_172() -> SharedObject {
        rg4("172.16.0.0/12").expect("valid range")
    }

    /// Return an ip range over "10.0.0.0/8".
    ///
    /// # Example
    ///
    /// ```ignore
    /// #{
    ///     rcpt: [
    ///         rule "anti relay" || { if ctx::client_ip() in net::rg_10() { state::next() } else { state::deny() } }
    ///     ]
    /// }
    /// ```
    ///
    /// # rhai-autodocs:index:3
    #[must_use]
    #[rhai_fn(name = "rg_10")]
    pub fn rg_10() -> SharedObject {
        rg4("10.0.0.0/8").expect("valid range")
    }

    /// Return a list of non routable networks (net_192, net_172, and net_10).
    ///
    /// # rhai-autodocs:index:4
    #[must_use]
    #[rhai_fn(name = "non_routable")]
    pub fn non_routable() -> rhai::Array {
        rhai::Array::from_iter([
            rhai::Dynamic::from(rg_192()),
            rhai::Dynamic::from(rg_172()),
            rhai::Dynamic::from(rg_10()),
        ])
    }
}