rustls/server/
handy.rs

1use alloc::vec::Vec;
2use core::fmt::Debug;
3
4use crate::server::ClientHello;
5use crate::sync::Arc;
6use crate::{server, sign};
7
8/// Something which never stores sessions.
9#[derive(Debug)]
10pub struct NoServerSessionStorage {}
11
12impl server::StoresServerSessions for NoServerSessionStorage {
13    fn put(&self, _id: Vec<u8>, _sec: Vec<u8>) -> bool {
14        false
15    }
16    fn get(&self, _id: &[u8]) -> Option<Vec<u8>> {
17        None
18    }
19    fn take(&self, _id: &[u8]) -> Option<Vec<u8>> {
20        None
21    }
22    fn can_cache(&self) -> bool {
23        false
24    }
25}
26
27#[cfg(any(feature = "std", feature = "hashbrown"))]
28mod cache {
29    use alloc::vec::Vec;
30    use core::fmt::{Debug, Formatter};
31
32    use crate::lock::Mutex;
33    use crate::sync::Arc;
34    use crate::{limited_cache, server};
35
36    /// An implementer of `StoresServerSessions` that stores everything
37    /// in memory.  If enforces a limit on the number of stored sessions
38    /// to bound memory usage.
39    pub struct ServerSessionMemoryCache {
40        cache: Mutex<limited_cache::LimitedCache<Vec<u8>, Vec<u8>>>,
41    }
42
43    impl ServerSessionMemoryCache {
44        /// Make a new ServerSessionMemoryCache.  `size` is the maximum
45        /// number of stored sessions, and may be rounded-up for
46        /// efficiency.
47        #[cfg(feature = "std")]
48        pub fn new(size: usize) -> Arc<Self> {
49            Arc::new(Self {
50                cache: Mutex::new(limited_cache::LimitedCache::new(size)),
51            })
52        }
53
54        /// Make a new ServerSessionMemoryCache.  `size` is the maximum
55        /// number of stored sessions, and may be rounded-up for
56        /// efficiency.
57        #[cfg(not(feature = "std"))]
58        pub fn new<M: crate::lock::MakeMutex>(size: usize) -> Arc<Self> {
59            Arc::new(Self {
60                cache: Mutex::new::<M>(limited_cache::LimitedCache::new(size)),
61            })
62        }
63    }
64
65    impl server::StoresServerSessions for ServerSessionMemoryCache {
66        fn put(&self, key: Vec<u8>, value: Vec<u8>) -> bool {
67            self.cache
68                .lock()
69                .unwrap()
70                .insert(key, value);
71            true
72        }
73
74        fn get(&self, key: &[u8]) -> Option<Vec<u8>> {
75            self.cache
76                .lock()
77                .unwrap()
78                .get(key)
79                .cloned()
80        }
81
82        fn take(&self, key: &[u8]) -> Option<Vec<u8>> {
83            self.cache.lock().unwrap().remove(key)
84        }
85
86        fn can_cache(&self) -> bool {
87            true
88        }
89    }
90
91    impl Debug for ServerSessionMemoryCache {
92        fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
93            f.debug_struct("ServerSessionMemoryCache")
94                .finish()
95        }
96    }
97
98    #[cfg(test)]
99    mod tests {
100        use std::vec;
101
102        use super::*;
103        use crate::server::StoresServerSessions;
104
105        #[test]
106        fn test_serversessionmemorycache_accepts_put() {
107            let c = ServerSessionMemoryCache::new(4);
108            assert!(c.put(vec![0x01], vec![0x02]));
109        }
110
111        #[test]
112        fn test_serversessionmemorycache_persists_put() {
113            let c = ServerSessionMemoryCache::new(4);
114            assert!(c.put(vec![0x01], vec![0x02]));
115            assert_eq!(c.get(&[0x01]), Some(vec![0x02]));
116            assert_eq!(c.get(&[0x01]), Some(vec![0x02]));
117        }
118
119        #[test]
120        fn test_serversessionmemorycache_overwrites_put() {
121            let c = ServerSessionMemoryCache::new(4);
122            assert!(c.put(vec![0x01], vec![0x02]));
123            assert!(c.put(vec![0x01], vec![0x04]));
124            assert_eq!(c.get(&[0x01]), Some(vec![0x04]));
125        }
126
127        #[test]
128        fn test_serversessionmemorycache_drops_to_maintain_size_invariant() {
129            let c = ServerSessionMemoryCache::new(2);
130            assert!(c.put(vec![0x01], vec![0x02]));
131            assert!(c.put(vec![0x03], vec![0x04]));
132            assert!(c.put(vec![0x05], vec![0x06]));
133            assert!(c.put(vec![0x07], vec![0x08]));
134            assert!(c.put(vec![0x09], vec![0x0a]));
135
136            let count = c.get(&[0x01]).iter().count()
137                + c.get(&[0x03]).iter().count()
138                + c.get(&[0x05]).iter().count()
139                + c.get(&[0x07]).iter().count()
140                + c.get(&[0x09]).iter().count();
141
142            assert!(count < 5);
143        }
144    }
145}
146
147#[cfg(any(feature = "std", feature = "hashbrown"))]
148pub use cache::ServerSessionMemoryCache;
149
150/// Something which never produces tickets.
151#[derive(Debug)]
152pub(super) struct NeverProducesTickets {}
153
154impl server::ProducesTickets for NeverProducesTickets {
155    fn enabled(&self) -> bool {
156        false
157    }
158    fn lifetime(&self) -> u32 {
159        0
160    }
161    fn encrypt(&self, _bytes: &[u8]) -> Option<Vec<u8>> {
162        None
163    }
164    fn decrypt(&self, _bytes: &[u8]) -> Option<Vec<u8>> {
165        None
166    }
167}
168
169/// An exemplar `ResolvesServerCert` implementation that always resolves to a single
170/// [RFC 7250] raw public key.
171///
172/// [RFC 7250]: https://tools.ietf.org/html/rfc7250
173#[derive(Clone, Debug)]
174pub struct AlwaysResolvesServerRawPublicKeys(Arc<sign::CertifiedKey>);
175
176impl AlwaysResolvesServerRawPublicKeys {
177    /// Create a new `AlwaysResolvesServerRawPublicKeys` instance.
178    pub fn new(certified_key: Arc<sign::CertifiedKey>) -> Self {
179        Self(certified_key)
180    }
181}
182
183impl server::ResolvesServerCert for AlwaysResolvesServerRawPublicKeys {
184    fn resolve(&self, _client_hello: &ClientHello<'_>) -> Option<Arc<sign::CertifiedKey>> {
185        Some(self.0.clone())
186    }
187
188    fn only_raw_public_keys(&self) -> bool {
189        true
190    }
191}
192
193#[cfg(any(feature = "std", feature = "hashbrown"))]
194mod sni_resolver {
195    use core::fmt::Debug;
196
197    use pki_types::{DnsName, ServerName};
198
199    use crate::error::Error;
200    use crate::hash_map::HashMap;
201    use crate::server::ClientHello;
202    use crate::sync::Arc;
203    use crate::webpki::{ParsedCertificate, verify_server_name};
204    use crate::{server, sign};
205
206    /// Something that resolves do different cert chains/keys based
207    /// on client-supplied server name (via SNI).
208    #[derive(Debug)]
209    pub struct ResolvesServerCertUsingSni {
210        by_name: HashMap<DnsName<'static>, Arc<sign::CertifiedKey>>,
211    }
212
213    impl ResolvesServerCertUsingSni {
214        /// Create a new and empty (i.e., knows no certificates) resolver.
215        pub fn new() -> Self {
216            Self {
217                by_name: HashMap::new(),
218            }
219        }
220
221        /// Add a new `sign::CertifiedKey` to be used for the given SNI `name`.
222        ///
223        /// This function fails if the `name` is not valid for the supplied certificate, or if
224        /// the certificate chain is syntactically faulty.
225        pub fn add(&mut self, name: DnsName<'static>, ck: sign::CertifiedKey) -> Result<(), Error> {
226            // Check the certificate chain for validity:
227            // - it should be non-empty list
228            // - the first certificate should be parsable as a x509v3,
229            // - the first certificate should quote the given server name
230            //   (if provided)
231            //
232            // These checks are not security-sensitive.  They are the
233            // *server* attempting to detect accidental misconfiguration.
234
235            let wrapped = ServerName::DnsName(name);
236            ck.end_entity_cert()
237                .and_then(ParsedCertificate::try_from)
238                .and_then(|cert| verify_server_name(&cert, &wrapped))?;
239
240            let ServerName::DnsName(name) = wrapped else {
241                unreachable!()
242            };
243
244            self.by_name.insert(name, Arc::new(ck));
245            Ok(())
246        }
247    }
248
249    impl server::ResolvesServerCert for ResolvesServerCertUsingSni {
250        fn resolve(&self, client_hello: &ClientHello<'_>) -> Option<Arc<sign::CertifiedKey>> {
251            if let Some(name) = client_hello.server_name() {
252                self.by_name.get(name).cloned()
253            } else {
254                // This kind of resolver requires SNI
255                None
256            }
257        }
258    }
259
260    #[cfg(test)]
261    mod tests {
262        use super::*;
263        use crate::server::ResolvesServerCert;
264
265        #[test]
266        fn test_resolvesservercertusingsni_requires_sni() {
267            let rscsni = ResolvesServerCertUsingSni::new();
268            assert!(
269                rscsni
270                    .resolve(&ClientHello {
271                        server_name: &None,
272                        signature_schemes: &[],
273                        alpn: None,
274                        server_cert_types: None,
275                        client_cert_types: None,
276                        cipher_suites: &[],
277                        certificate_authorities: None,
278                        named_groups: None,
279                    })
280                    .is_none()
281            );
282        }
283
284        #[test]
285        fn test_resolvesservercertusingsni_handles_unknown_name() {
286            let rscsni = ResolvesServerCertUsingSni::new();
287            let name = DnsName::try_from("hello.com")
288                .unwrap()
289                .to_owned();
290            assert!(
291                rscsni
292                    .resolve(&ClientHello {
293                        server_name: &Some(name),
294                        signature_schemes: &[],
295                        alpn: None,
296                        server_cert_types: None,
297                        client_cert_types: None,
298                        cipher_suites: &[],
299                        certificate_authorities: None,
300                        named_groups: None,
301                    })
302                    .is_none()
303            );
304        }
305    }
306}
307
308#[cfg(any(feature = "std", feature = "hashbrown"))]
309pub use sni_resolver::ResolvesServerCertUsingSni;
310
311#[cfg(test)]
312mod tests {
313    use std::vec;
314
315    use super::*;
316    use crate::server::{ProducesTickets, StoresServerSessions};
317
318    #[test]
319    fn test_noserversessionstorage_drops_put() {
320        let c = NoServerSessionStorage {};
321        assert!(!c.put(vec![0x01], vec![0x02]));
322    }
323
324    #[test]
325    fn test_noserversessionstorage_denies_gets() {
326        let c = NoServerSessionStorage {};
327        c.put(vec![0x01], vec![0x02]);
328        assert_eq!(c.get(&[]), None);
329        assert_eq!(c.get(&[0x01]), None);
330        assert_eq!(c.get(&[0x02]), None);
331    }
332
333    #[test]
334    fn test_noserversessionstorage_denies_takes() {
335        let c = NoServerSessionStorage {};
336        assert_eq!(c.take(&[]), None);
337        assert_eq!(c.take(&[0x01]), None);
338        assert_eq!(c.take(&[0x02]), None);
339    }
340
341    #[test]
342    fn test_neverproducestickets_does_nothing() {
343        let npt = NeverProducesTickets {};
344        assert!(!npt.enabled());
345        assert_eq!(0, npt.lifetime());
346        assert_eq!(None, npt.encrypt(&[]));
347        assert_eq!(None, npt.decrypt(&[]));
348    }
349}
rustls/server/handy.rs

rustls/server/
handy.rs
