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
use crate::alloc::boxed::Box;
use crate::error::SASLError;
use crate::mechanism::Authentication;
use crate::mechanisms::scram::{client, server};
use crate::mechname::Mechname;
use crate::registry::{Matches, Mechanism, Named, Selection, Selector};
use crate::session::Side;

const NONCE_LEN: usize = 24;

#[cfg(feature = "scram-sha-1")]
mod scram_sha1 {
    use super::{
        client, server, Authentication, Box, Matches, Mechanism, Mechname, Named, SASLError,
        Selection, Selector, Side, NONCE_LEN,
    };

    #[cfg(feature = "registry_static")]
    use crate::registry::{distributed_slice, MECHANISMS};
    #[cfg_attr(feature = "registry_static", distributed_slice(MECHANISMS))]
    #[cfg(feature = "scram-sha-1")]
    pub static SCRAM_SHA1: Mechanism = Mechanism {
        mechanism: Mechname::const_new(b"SCRAM-SHA-1"),
        priority: 400,
        client: Some(|| Ok(Box::new(client::ScramSha1Client::<NONCE_LEN>::new(true)))),
        server: Some(|sasl| {
            let can_cb = sasl
                .mech_list()
                .any(|m| m.mechanism.as_str() == "SCRAM-SHA-1-PLUS");
            Ok(Box::new(server::ScramSha1Server::<NONCE_LEN>::new(can_cb)))
        }),
        first: Side::Client,
        select: |cb| {
            Some(if cb {
                Selection::Nothing(Box::new(ScramSelector1::No))
            } else {
                Matches::<Select1>::name()
            })
        },
        offer: |_| true,
    };

    struct Select1;
    impl Named for Select1 {
        fn mech() -> &'static Mechanism {
            &SCRAM_SHA1
        }
    }

    #[derive(Copy, Clone, Debug)]
    enum ScramSelector1 {
        /// No SCRAM-SHA1 found yet
        No,
        /// Only SCRAM-SHA1 but not -PLUS found
        Bare,
        /// SCRAM-SHA1-PLUS found.
        Plus,
    }
    impl Selector for ScramSelector1 {
        fn select(&mut self, mechname: &Mechname) -> Option<&'static Mechanism> {
            if *mechname == *SCRAM_SHA1.mechanism {
                *self = match *self {
                    Self::No => Self::Bare,
                    x => x,
                }
            } else if *mechname == *SCRAM_SHA1_PLUS.mechanism {
                *self = Self::Plus;
            }
            None
        }

        fn done(&mut self) -> Option<&'static Mechanism> {
            match self {
                Self::No => None,
                _ => Some(&SCRAM_SHA1),
            }
        }

        fn finalize(&mut self) -> Result<Box<dyn Authentication>, SASLError> {
            Ok(Box::new(match self {
                Self::Bare => client::ScramSha1Client::<NONCE_LEN>::new(false),
                Self::Plus => client::ScramSha1Client::<NONCE_LEN>::new(true),
                Self::No => unreachable!(),
            }))
        }
    }

    pub static SCRAM_SHA1_PLUS: Mechanism = Mechanism {
        mechanism: Mechname::const_new(b"SCRAM-SHA-1-PLUS"),
        priority: 500,
        client: Some(|| Ok(Box::new(client::ScramSha1Client::<NONCE_LEN>::new_plus()))),
        server: Some(|_sasl| Ok(Box::new(server::ScramSha1Server::<NONCE_LEN>::new_plus()))),
        first: Side::Client,
        select: |cb| {
            if cb {
                Some(Matches::<Select1Plus>::name())
            } else {
                None
            }
        },
        offer: |_| true,
    };

    struct Select1Plus;
    impl Named for Select1Plus {
        fn mech() -> &'static Mechanism {
            &SCRAM_SHA1_PLUS
        }
    }
}
#[cfg(feature = "scram-sha-1")]
pub use scram_sha1::*;

#[cfg(feature = "scram-sha-2")]
mod scram_sha256 {
    use super::{
        client, server, Authentication, Box, Matches, Mechanism, Mechname, Named, SASLError,
        Selection, Selector, Side, NONCE_LEN,
    };

    #[cfg(feature = "registry_static")]
    use crate::registry::{distributed_slice, MECHANISMS};
    #[cfg_attr(feature = "registry_static", distributed_slice(MECHANISMS))]
    pub static SCRAM_SHA256: Mechanism = Mechanism {
        mechanism: Mechname::const_new(b"SCRAM-SHA-256"),
        priority: 600,
        client: Some(|| Ok(Box::new(client::ScramSha256Client::<NONCE_LEN>::new(true)))),
        server: Some(|sasl| {
            let can_cb = sasl
                .mech_list()
                .any(|m| m.mechanism.as_str() == "SCRAM-SHA-256-PLUS");
            Ok(Box::new(server::ScramSha256Server::<NONCE_LEN>::new(
                can_cb,
            )))
        }),
        first: Side::Client,
        select: |cb| {
            Some(if cb {
                Selection::Nothing(Box::new(ScramSelector256::No))
            } else {
                Matches::<Select256>::name()
            })
        },
        offer: |_| true,
    };

    struct Select256;
    impl Named for Select256 {
        fn mech() -> &'static Mechanism {
            &SCRAM_SHA256
        }
    }

    #[derive(Copy, Clone, Debug)]
    enum ScramSelector256 {
        /// No SCRAM-SHA256 found yet
        No,
        /// Only SCRAM-SHA256 but not -PLUS found
        Bare,
        /// SCRAM-SHA256-PLUS found.
        Plus,
    }
    impl Selector for ScramSelector256 {
        fn select(&mut self, mechname: &Mechname) -> Option<&'static Mechanism> {
            if *mechname == *SCRAM_SHA256.mechanism {
                *self = match *self {
                    Self::No => Self::Bare,
                    x => x,
                }
            } else if *mechname == *SCRAM_SHA256_PLUS.mechanism {
                *self = Self::Plus;
            }
            None
        }

        fn done(&mut self) -> Option<&'static Mechanism> {
            match self {
                Self::No => None,
                _ => Some(&SCRAM_SHA256),
            }
        }

        fn finalize(&mut self) -> Result<Box<dyn Authentication>, SASLError> {
            Ok(Box::new(match self {
                Self::Bare => client::ScramSha256Client::<NONCE_LEN>::new(false),
                Self::Plus => client::ScramSha256Client::<NONCE_LEN>::new(true),
                Self::No => unreachable!(),
            }))
        }
    }

    pub static SCRAM_SHA256_PLUS: Mechanism = Mechanism {
        mechanism: Mechname::const_new(b"SCRAM-SHA-256-PLUS"),
        priority: 700,
        client: Some(|| Ok(Box::new(client::ScramSha256Client::<NONCE_LEN>::new_plus()))),
        server: Some(|_sasl| Ok(Box::new(server::ScramSha256Server::<NONCE_LEN>::new_plus()))),
        first: Side::Client,
        select: |cb| {
            if cb {
                Some(Matches::<Select256Plus>::name())
            } else {
                None
            }
        },
        offer: |_| true,
    };

    struct Select256Plus;
    impl Named for Select256Plus {
        fn mech() -> &'static Mechanism {
            &SCRAM_SHA256_PLUS
        }
    }
}
#[cfg(feature = "scram-sha-2")]
pub use scram_sha256::*;

#[cfg(test)]
mod tests {
    use super::*;
    use crate::callback::SessionCallback;
    use crate::config::SASLConfig;
    use crate::registry::Registry;
    use crate::sasl::SASLClient;

    #[cfg(feature = "scram-sha-1")]
    #[test]
    /// Test if SCRAM will correctly set the CB support flag depending on the offered mechanisms.
    fn scram_sha1_plus_selection() {
        static SUPPORTED: &[Mechanism] = &[SCRAM_SHA1, SCRAM_SHA1_PLUS];

        client_start(
            SUPPORTED,
            &[
                Mechname::const_new(b"SCRAM-SHA-1-PLUS"),
                Mechname::const_new(b"SCRAM-SHA-1"),
            ],
            "SCRAM-SHA-1-PLUS",
        );

        // Test inverted too
        client_start(
            SUPPORTED,
            &[
                Mechname::const_new(b"SCRAM-SHA-1"),
                Mechname::const_new(b"SCRAM-SHA-1-PLUS"),
            ],
            "SCRAM-SHA-1-PLUS",
        );
    }

    #[cfg(feature = "scram-sha-2")]
    #[test]
    /// Test if SCRAM will correctly set the CB support flag depending on the offered mechanisms.
    fn scram_sha2_plus_selection() {
        static SUPPORTED: &[Mechanism] = &[SCRAM_SHA256, SCRAM_SHA256_PLUS];

        client_start(
            SUPPORTED,
            &[
                Mechname::const_new(b"SCRAM-SHA-256-PLUS"),
                Mechname::const_new(b"SCRAM-SHA-256"),
            ],
            "SCRAM-SHA-256-PLUS",
        );

        // Test inverted too
        client_start(
            SUPPORTED,
            &[
                Mechname::const_new(b"SCRAM-SHA-256"),
                Mechname::const_new(b"SCRAM-SHA-256-PLUS"),
            ],
            "SCRAM-SHA-256-PLUS",
        );
    }

    fn client_start(supported: &'static [Mechanism], offered: &[&Mechname], expected: &str) {
        struct ThisCB;
        impl SessionCallback for ThisCB {
            fn enable_channel_binding(&self) -> bool {
                true
            }
        }
        let cb = ThisCB;
        let config = SASLConfig::new(cb, Registry::with_mechanisms(supported))
            .expect("failed to construct sasl config");

        let client = SASLClient::new(config);
        let session = client
            .start_suggested(offered.iter())
            .expect("failed to start session");
        assert_eq!(
            session.get_mechname().as_str(),
            expected,
            "expected {} to get selected, instead {} was",
            expected,
            session.get_mechname()
        );
    }
}