simple-hyper-server-tls 0.3.2

Simplify TLS configuration for Hyper server
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

// lib.rs - main library
//
// simple-hyper-server-tls - Library to simplify initialization TLS for hyper server
// Copyright (C) 2022  Mateusz Szpakowski
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

#![cfg_attr(docsrs, feature(doc_cfg))]
//! The library to simplify TLS configuration for Hyper server including ALPN
//! (Application-Layer Protocol Negotiation) setup.
//! This library setup TLS configuration suitable for clients.
//! The configuration includes the HTTP protocol choice setup (ALPN mechanism setup)
//! thanks to the almost clients can choose for example HTTP/2 protocol.
//!
//! The usage of this library requires choose suitable the TLS implementation, by choosing
//! feature that one of:
//! * `tls-rustls` - RusTLS - native for Rust TLS implementation based on tokio-rustls,
//! * `tls-openssl` - OpenSSL - TLS implementation based native OpenSSL library and openssl.
//!
//! The `tls-openssl` is recommended for systems which can not handle rustls
//! due to some problems, like lacks of some CPU instructions needed by `ring` crate.
//! For other systems, `tls-rustls` should be preferred.
//!
//! By default three versions of HTTP protocol are enabled (HTTP/1.0, HTTP/1.1, HTTP/2).
//! It is possible to choose only one version by disabling default features and choose
//! one of features:
//! * `hyper-h1` - for HTTP/1.0 or HTTP/1.1,
//! * `hyper-h2` - for HTTP/2.
//!
//! ## List of other features
//! * `hyper-full-server` - enables all features for hyper server.
//!
//! ## Examples
//! The simplest usage is:
//!
//! ```no_run
//! use std::{convert::Infallible, net::SocketAddr};
//! use simple_hyper_server_tls::*;
//! use hyper::{Body, Request, Response, Server};
//! use hyper::service::{make_service_fn, service_fn};
//!
//! async fn handle(_: Request<Body>) -> Result<Response<Body>, Infallible> {
//!     Ok(Response::new("Hello, World!".into()))
//! }
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
//!
//!     let make_svc = make_service_fn(|_conn| async {
//!         Ok::<_, Infallible>(service_fn(handle))
//!     });
//!     let mut server = hyper_from_pem_files("cert.pem", "key.pem", Protocols::ALL, &addr)?
//!             .serve(make_svc);
//!     while let Err(e) = (&mut server).await {
//!         eprintln!("server error: {}", e);
//!     }
//!     Ok(())
//! }
//! ```
//!
//! Additional functions can be used for customization of the TLS configuration.

use hyper::server::conn::AddrIncoming;
use hyper::server::{Builder, Server};
#[cfg(feature = "tls-openssl")]
use openssl::pkey::PKey;
#[cfg(feature = "tls-openssl")]
use openssl::ssl::{SslContext, SslContextBuilder, SslFiletype, SslMethod, SslRef};
#[cfg(feature = "tls-openssl")]
use openssl::x509::X509;
#[cfg(feature = "tls-rustls")]
use rustls::ServerConfig;
#[cfg(feature = "tls-rustls")]
use rustls_pemfile;
use std::net::SocketAddr;
use std::path::Path;
#[cfg(any(feature = "tls-rustls", feature = "tls-openssl"))]
use tls_listener::hyper::WrappedAccept;
#[cfg(feature = "tls-rustls")]
use tokio_rustls::rustls::{Certificate, PrivateKey};
#[cfg(feature = "tls-rustls")]
use tokio_rustls::TlsAcceptor;

pub use hyper;
#[cfg(feature = "tls-openssl")]
pub use openssl;
#[cfg(feature = "tls-rustls")]
pub use rustls;
#[cfg(any(feature = "tls-rustls", feature = "tls-openssl"))]
pub use tls_listener;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// Defines protocols that will be used in TLS configuration.
pub enum Protocols {
    /// All protocols enabled by features (HTTP/1.0, HTTP/1.1, HTTP/2).
    ALL,
    #[cfg(feature = "hyper-h1")]
    #[cfg_attr(docsrs, doc(cfg(feature = "hyper-h1")))]
    /// Only HTTP/1.0 or HTTP/1.1 if enabled by hyper-h1.
    HTTP1,
    #[cfg(feature = "hyper-h2")]
    #[cfg_attr(docsrs, doc(cfg(feature = "hyper-h2")))]
    /// Only HTTP/2 if enabled by hyper-h2.
    HTTP2,
}

/// Boxed error type.
pub type Error = Box<dyn std::error::Error>;

#[cfg(feature = "tls-rustls")]
fn rustls_server_config_from_readers<R: std::io::Read>(
    cert: R,
    key: R,
    protocols: Protocols,
) -> Result<ServerConfig, Error> {
    use std::io::{self, BufReader};
    // load certificates and keys from Read
    let certs = rustls_pemfile::certs(&mut BufReader::new(cert))
        .map(|mut certs| certs.drain(..).map(Certificate).collect())?;
    let mut keys: Vec<PrivateKey> = rustls_pemfile::pkcs8_private_keys(&mut BufReader::new(key))
        .map(|mut keys| keys.drain(..).map(PrivateKey).collect())?;
    let mut config = ServerConfig::builder()
        .with_safe_defaults()
        .with_no_client_auth()
        .with_single_cert(certs, keys.remove(0))
        .map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?;

    // set up ALPN protocols based on Protocols
    config.alpn_protocols = match protocols {
        #[cfg(all(feature = "hyper-h1", feature = "hyper-h2"))]
        Protocols::ALL => vec![b"h2".to_vec(), b"http/1.1".to_vec(), b"http/1.0".to_vec()],

        #[cfg(all(feature = "hyper-h1", not(feature = "hyper-h2")))]
        Protocols::ALL => vec![b"http/1.1".to_vec(), b"http/1.0".to_vec()],

        #[cfg(all(not(feature = "hyper-h1"), feature = "hyper-h2"))]
        Protocols::ALL => vec![b"h2".to_vec()],

        #[cfg(feature = "hyper-h1")]
        Protocols::HTTP1 => vec![b"http/1.1".to_vec(), b"http/1.0".to_vec()],
        #[cfg(feature = "hyper-h2")]
        Protocols::HTTP2 => vec![b"h2".to_vec()],
    };
    Ok(config)
}

#[cfg(feature = "tls-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls-rustls")))]
/// The low-level function to retrieve configuration to further customization.
///
/// Creates the RusTLS server configuration. Certificates and key will be obtained from files.
/// Protocols determines list of protocols that will be supported.
pub fn rustls_server_config_from_pem_files<P: AsRef<Path>, Q: AsRef<Path>>(
    cert_file: P,
    key_file: Q,
    protocols: Protocols,
) -> Result<ServerConfig, Error> {
    use std::fs::File;
    rustls_server_config_from_readers(File::open(cert_file)?, File::open(key_file)?, protocols)
}

#[cfg(feature = "tls-rustls")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls-rustls")))]
/// The low-level function to retrieve configuration to further customization.
///
/// Creates the RusTLS server configuration. Certificates and key will be obtained from data.
/// Protocols determines list of protocols that will be supported.
pub fn rustls_server_config_from_pem_data<'a>(
    cert: &'a [u8],
    key: &'a [u8],
    protocols: Protocols,
) -> Result<ServerConfig, Error> {
    rustls_server_config_from_readers(cert, key, protocols)
}

#[cfg(feature = "tls-openssl")]
fn ssl_context_set_alpns(
    builder: &mut SslContextBuilder,
    protocols: Protocols,
) -> Result<(), Error> {
    // set up ALPN protocols based on Protocols
    let protos = match protocols {
        #[cfg(all(feature = "hyper-h1", feature = "hyper-h2"))]
        Protocols::ALL => &b"\x02h2\x08http/1.1\x08http/1.0"[..],

        #[cfg(all(feature = "hyper-h1", not(feature = "hyper-h2")))]
        Protocols::ALL => &b"\x08http/1.1\x08http/1.0"[..],

        #[cfg(all(not(feature = "hyper-h1"), feature = "hyper-h2"))]
        Protocols::ALL => &b"\x02h2"[..],

        #[cfg(feature = "hyper-h1")]
        Protocols::HTTP1 => &b"\x08http/1.1\x08http/1.0"[..],
        #[cfg(feature = "hyper-h2")]
        Protocols::HTTP2 => &b"\x02h2"[..],
    };
    builder.set_alpn_protos(protos)?;
    // set uo ALPN selection routine - as select_next_proto
    builder.set_alpn_select_callback(move |_: &mut SslRef, list: &[u8]| {
        openssl::ssl::select_next_proto(protos, list).ok_or(openssl::ssl::AlpnError::NOACK)
    });
    Ok(())
}

#[cfg(feature = "tls-openssl")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls-openssl")))]
/// The low-level function to retrieve configuration to further customization.
///
/// Creates the SSL context builder. Certificates and key will be obtained from files.
/// Protocols determines list of protocols that will be supported.
pub fn ssl_context_builder_from_pem_files<P: AsRef<Path>, Q: AsRef<Path>>(
    cert_file: P,
    key_file: Q,
    protocols: Protocols,
) -> Result<SslContextBuilder, Error> {
    let mut builder = SslContext::builder(SslMethod::tls_server()).unwrap();
    builder.set_certificate_chain_file(cert_file)?;
    builder.set_private_key_file(key_file, SslFiletype::PEM)?;
    ssl_context_set_alpns(&mut builder, protocols)?;
    Ok(builder)
}

#[cfg(feature = "tls-openssl")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls-openssl")))]
/// The low-level function to retrieve configuration to further customization.
///
/// Creates the SSL context builder. Certificates and key will be obtained from data.
/// Protocols determines list of protocols that will be supported.
pub fn ssl_context_builder_from_pem_data<'a>(
    cert: &'a [u8],
    key: &'a [u8],
    protocols: Protocols,
) -> Result<SslContextBuilder, Error> {
    let mut builder = SslContext::builder(SslMethod::tls_server()).unwrap();
    let mut certs = X509::stack_from_pem(cert)?;
    let mut certs = certs.drain(..);
    builder.set_certificate(certs.next().ok_or("no leaf certificate")?.as_ref())?;
    certs.try_for_each(|cert| builder.add_extra_chain_cert(cert))?;
    builder.set_private_key(PKey::private_key_from_pem(key)?.as_ref())?;
    ssl_context_set_alpns(&mut builder, protocols)?;
    Ok(builder)
}

#[cfg(feature = "tls-rustls")]
/// TlsListener for hyper server.
pub type TlsListener = tls_listener::TlsListener<WrappedAccept<AddrIncoming>, TlsAcceptor>;
#[cfg(all(not(docsrs), feature = "tls-openssl"))]
/// TlsListener for hyper server.
pub type TlsListener = tls_listener::TlsListener<WrappedAccept<AddrIncoming>, SslContext>;

/// The higher level function. Creates the TLS listener for Hyper server.
///
/// Certificates and key will be obtained from files.
/// Protocols determines list of protocols that will be supported.
/// Typical usage is:
/// ```no run
/// let listener = listener_from_pem_files("cert.pem", "key.pem", Protocols::ALL, &addr)?;
/// let server = Server::builder(listener).serve(make_svc);
/// ```
pub fn listener_from_pem_files<P: AsRef<Path>, Q: AsRef<Path>>(
    cert_file: P,
    key_file: Q,
    protocols: Protocols,
    addr: &SocketAddr,
) -> Result<TlsListener, Error> {
    #[cfg(feature = "tls-rustls")]
    let acceptor = {
        use std::sync::Arc;
        let config = rustls_server_config_from_pem_files(cert_file, key_file, protocols)?;
        TlsAcceptor::from(Arc::new(config))
    };
    #[cfg(feature = "tls-openssl")]
    let acceptor = {
        let builder = ssl_context_builder_from_pem_files(cert_file, key_file, protocols)?;
        builder.build()
    };
    Ok(TlsListener::new_hyper(acceptor, AddrIncoming::bind(addr)?))
}

/// The higher level function. Creates the TLS listener for Hyper server.
///
/// Certificates and key will be obtained from data.
/// Protocols determines list of protocols that will be supported.
/// Typical usage is:
/// ```no run
/// let listener = listener_from_pem_data(cert_data, key_data, Protocols::ALL, &addr)?;
/// let server = Server::builder(listener).serve(make_svc);
/// ```
pub fn listener_from_pem_data<'a>(
    cert: &'a [u8],
    key: &'a [u8],
    protocols: Protocols,
    addr: &SocketAddr,
) -> Result<TlsListener, Error> {
    #[cfg(feature = "tls-rustls")]
    let acceptor = {
        use std::sync::Arc;
        let config = rustls_server_config_from_pem_data(cert, key, protocols)?;
        TlsAcceptor::from(Arc::new(config))
    };
    #[cfg(feature = "tls-openssl")]
    let acceptor = {
        let builder = ssl_context_builder_from_pem_data(cert, key, protocols)?;
        builder.build()
    };
    Ok(TlsListener::new_hyper(acceptor, AddrIncoming::bind(&addr)?))
}

/// The highest level function. Creates the Hyper server builder.
///
/// Certificates and key will be obtained from files.
/// Protocols determines list of protocols that will be supported.
/// Typical usage is:
/// ```no run
/// let server = hyper_from_pem_files("cert.pem", "key.pem", Protocols::ALL, &addr)?
///             .serve(make_svc);
/// ```
pub fn hyper_from_pem_files<P: AsRef<Path>, Q: AsRef<Path>>(
    cert_file: P,
    key_file: Q,
    protocols: Protocols,
    addr: &SocketAddr,
) -> Result<Builder<TlsListener>, Error> {
    let listener = listener_from_pem_files(cert_file, key_file, protocols, addr)?;
    let builder = Server::builder(listener);
    Ok(match protocols {
        Protocols::ALL => builder,
        #[cfg(feature = "hyper-h1")]
        Protocols::HTTP1 => builder.http1_only(true),
        #[cfg(feature = "hyper-h2")]
        Protocols::HTTP2 => builder.http2_only(true),
    })
}

/// The highest level function. Creates the Hyper server builder.
///
/// Certificates and key will be obtained from data.
/// Protocols determines list of protocols that will be supported.
/// Typical usage is:
/// ```no run
/// let server = hyper_from_pem_data(cert_data, key_data, Protocols::ALL, &addr)?
///             .serve(make_svc);
/// ```
pub fn hyper_from_pem_data<'a>(
    cert: &'a [u8],
    key: &'a [u8],
    protocols: Protocols,
    addr: &SocketAddr,
) -> Result<Builder<TlsListener>, Error> {
    let listener = listener_from_pem_data(cert, key, protocols, addr)?;
    let builder = Server::builder(listener);
    Ok(match protocols {
        Protocols::ALL => builder,
        #[cfg(feature = "hyper-h1")]
        Protocols::HTTP1 => builder.http1_only(true),
        #[cfg(feature = "hyper-h2")]
        Protocols::HTTP2 => builder.http2_only(true),
    })
}

#[cfg(test)]
mod tests {
    #[test]
    #[cfg(feature = "tls-rustls")]
    fn test_rustls_server_config_from_readers() {
        use super::*;
        const CERT: &[u8] = include_bytes!("../data/cert.pem");
        const KEY: &[u8] = include_bytes!("../data/key.pem");
        let config = rustls_server_config_from_readers(CERT, KEY, Protocols::ALL).unwrap();
        #[cfg(all(feature = "hyper-h1", feature = "hyper-h2"))]
        assert_eq!(
            config.alpn_protocols,
            vec![b"h2".to_vec(), b"http/1.1".to_vec(), b"http/1.0".to_vec()]
        );
        #[cfg(all(not(feature = "hyper-h1"), feature = "hyper-h2"))]
        assert_eq!(config.alpn_protocols, vec![b"h2".to_vec()]);
        #[cfg(all(feature = "hyper-h1", not(feature = "hyper-h2")))]
        assert_eq!(
            config.alpn_protocols,
            vec![b"http/1.1".to_vec(), b"http/1.0".to_vec()]
        );

        #[cfg(feature = "hyper-h1")]
        {
            let config = rustls_server_config_from_readers(CERT, KEY, Protocols::HTTP1).unwrap();
            assert_eq!(
                config.alpn_protocols,
                vec![b"http/1.1".to_vec(), b"http/1.0".to_vec()]
            );
        }
        #[cfg(feature = "hyper-h2")]
        {
            let config = rustls_server_config_from_readers(CERT, KEY, Protocols::HTTP2).unwrap();
            assert_eq!(config.alpn_protocols, vec![b"h2".to_vec()]);
        }
    }
}