├── .github └── workflows │ └── CI.yml ├── .gitignore ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── examples └── client.rs └── src ├── client.rs ├── lib.rs └── stream.rs /.github/workflows/CI.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | pull_request: 4 | push: 5 | branches: 6 | - master 7 | 8 | env: 9 | RUST_BACKTRACE: 1 10 | 11 | jobs: 12 | ci-pass: 13 | name: CI is green 14 | runs-on: ubuntu-latest 15 | needs: 16 | - style 17 | - test 18 | - msrv 19 | - miri 20 | - features 21 | - doc 22 | steps: 23 | - run: exit 0 24 | 25 | style: 26 | name: Check Style 27 | runs-on: ubuntu-latest 28 | steps: 29 | - uses: actions/checkout@v4 30 | 31 | - uses: dtolnay/rust-toolchain@stable 32 | with: 33 | components: rustfmt 34 | 35 | - run: cargo fmt --all --check 36 | 37 | test: 38 | name: Test ${{ matrix.rust }} on ${{ matrix.os }} 39 | needs: [style] 40 | strategy: 41 | matrix: 42 | rust: 43 | - stable 44 | - beta 45 | - nightly 46 | 47 | os: 48 | - ubuntu-latest 49 | - windows-latest 50 | - macOS-latest 51 | 52 | runs-on: ${{ matrix.os }} 53 | 54 | steps: 55 | - uses: actions/checkout@v4 56 | 57 | - name: Install Rust (${{ matrix.rust }}) 58 | uses: dtolnay/rust-toolchain@master 59 | with: 60 | toolchain: ${{ matrix.rust }} 61 | 62 | - run: cargo test 63 | 64 | msrv: 65 | name: Check MSRV 66 | needs: [style] 67 | strategy: 68 | matrix: 69 | os: 70 | - ubuntu-latest 71 | 72 | runs-on: ${{ matrix.os }} 73 | 74 | steps: 75 | - uses: actions/checkout@v4 76 | 77 | - uses: dtolnay/rust-toolchain@stable 78 | 79 | - name: Resolve MSRV aware dependencies 80 | run: cargo update 81 | env: 82 | CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS: fallback 83 | 84 | - name: Get MSRV from package metadata 85 | id: msrv 86 | run: echo "version=$(yq '.package.rust-version' Cargo.toml)" >> $GITHUB_OUTPUT 87 | 88 | - name: Install Rust (${{ steps.msrv.outputs.version }}) 89 | uses: dtolnay/rust-toolchain@master 90 | with: 91 | toolchain: ${{ steps.msrv.outputs.version }} 92 | 93 | - run: cargo check --features vendored 94 | 95 | miri: 96 | name: Test with Miri 97 | needs: [style] 98 | runs-on: ubuntu-latest 99 | 100 | steps: 101 | - uses: actions/checkout@v4 102 | 103 | - uses: dtolnay/rust-toolchain@nightly 104 | with: 105 | components: miri 106 | 107 | - name: Test 108 | env: 109 | # Can't enable tcp feature since Miri does not support the tokio runtime 110 | MIRIFLAGS: "-Zmiri-disable-isolation" 111 | run: cargo miri test 112 | 113 | features: 114 | name: features 115 | needs: [style] 116 | runs-on: ubuntu-latest 117 | steps: 118 | - uses: actions/checkout@v4 119 | 120 | - uses: dtolnay/rust-toolchain@stable 121 | 122 | - uses: taiki-e/install-action@cargo-hack 123 | 124 | - run: cargo hack --no-dev-deps check --feature-powerset --depth 2 125 | 126 | doc: 127 | name: Build docs 128 | needs: [style, test] 129 | runs-on: ubuntu-latest 130 | steps: 131 | - uses: actions/checkout@v4 132 | 133 | - uses: dtolnay/rust-toolchain@nightly 134 | 135 | - run: cargo rustdoc -- --cfg docsrs -D rustdoc::broken-intra-doc-links 136 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "hyper-tls" 3 | version = "0.6.0" # don't forget html_root_url in lib.rs 4 | description = "Default TLS implementation for use with hyper" 5 | authors = ["Sean McArthur "] 6 | license = "MIT/Apache-2.0" 7 | keywords = ["hyper", "tls", "http", "https", "ssl"] 8 | homepage = "https://hyper.rs" 9 | repository = "https://github.com/hyperium/hyper-tls" 10 | documentation = "https://docs.rs/hyper-tls" 11 | edition = "2018" 12 | rust-version = "1.63" 13 | 14 | [features] 15 | alpn = ["native-tls/alpn"] 16 | vendored = ["native-tls/vendored"] 17 | 18 | [dependencies] 19 | bytes = "1" 20 | hyper = "1" 21 | hyper-util = { version = "0.1.0", features = ["client-legacy", "tokio"] } 22 | native-tls = "0.2.1" 23 | tokio = "1" 24 | tokio-native-tls = "0.3" 25 | tower-service = "0.3" 26 | 27 | [dev-dependencies] 28 | http-body-util = "0.1.0" 29 | hyper-util = { version = "0.1.0", features = ["http1"] } 30 | tokio = { version = "1.0.0", features = ["io-std", "macros", "io-util"] } 31 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) 2017 Sean McArthur 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 | THE SOFTWARE. 20 | 21 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # hyper-tls 2 | 3 | Provides an HTTPS connector for use with [hyper](https://hyper.rs). 4 | 5 | [Documentation](https://docs.rs/hyper-tls) 6 | 7 | ## License 8 | 9 | Licensed under either of 10 | 11 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://apache.org/licenses/LICENSE-2.0) 12 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 13 | 14 | ### Contribution 15 | 16 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. 17 | -------------------------------------------------------------------------------- /examples/client.rs: -------------------------------------------------------------------------------- 1 | use bytes::Bytes; 2 | use http_body_util::BodyExt; 3 | 4 | use http_body_util::Empty; 5 | use hyper_tls::HttpsConnector; 6 | use hyper_util::{client::legacy::Client, rt::TokioExecutor}; 7 | use tokio::io::{self, AsyncWriteExt as _}; 8 | 9 | #[tokio::main(flavor = "current_thread")] 10 | async fn main() -> Result<(), Box> { 11 | let https = HttpsConnector::new(); 12 | 13 | let client = Client::builder(TokioExecutor::new()).build::<_, Empty>(https); 14 | 15 | let mut res = client.get("https://hyper.rs".parse()?).await?; 16 | 17 | println!("Status: {}", res.status()); 18 | println!("Headers:\n{:#?}", res.headers()); 19 | 20 | while let Some(frame) = res.body_mut().frame().await { 21 | let frame = frame?; 22 | 23 | if let Some(d) = frame.data_ref() { 24 | io::stdout().write_all(d).await?; 25 | } 26 | } 27 | 28 | Ok(()) 29 | } 30 | -------------------------------------------------------------------------------- /src/client.rs: -------------------------------------------------------------------------------- 1 | use hyper::{ 2 | rt::{Read, Write}, 3 | Uri, 4 | }; 5 | use hyper_util::{client::legacy::connect::HttpConnector, rt::TokioIo}; 6 | use std::fmt; 7 | use std::future::Future; 8 | use std::pin::Pin; 9 | use std::task::{Context, Poll}; 10 | use tokio_native_tls::TlsConnector; 11 | use tower_service::Service; 12 | 13 | use crate::stream::MaybeHttpsStream; 14 | 15 | type BoxError = Box; 16 | 17 | /// A Connector for the `https` scheme. 18 | #[derive(Clone)] 19 | pub struct HttpsConnector { 20 | force_https: bool, 21 | http: T, 22 | tls: TlsConnector, 23 | } 24 | 25 | impl HttpsConnector { 26 | /// Construct a new `HttpsConnector`. 27 | /// 28 | /// This uses hyper's default `HttpConnector`, and default `TlsConnector`. 29 | /// If you wish to use something besides the defaults, use `From::from`. 30 | /// 31 | /// # Note 32 | /// 33 | /// By default this connector will use plain HTTP if the URL provided uses 34 | /// the HTTP scheme (eg: ). 35 | /// 36 | /// If you would like to force the use of HTTPS then call `https_only(true)` 37 | /// on the returned connector. 38 | /// 39 | /// # Panics 40 | /// 41 | /// This will panic if the underlying TLS context could not be created. 42 | /// 43 | /// To handle that error yourself, you can use the `HttpsConnector::from` 44 | /// constructor after trying to make a `TlsConnector`. 45 | #[must_use] 46 | pub fn new() -> Self { 47 | native_tls::TlsConnector::new().map_or_else( 48 | |e| panic!("HttpsConnector::new() failure: {}", e), 49 | |tls| HttpsConnector::new_(tls.into()), 50 | ) 51 | } 52 | 53 | fn new_(tls: TlsConnector) -> Self { 54 | let mut http = HttpConnector::new(); 55 | http.enforce_http(false); 56 | HttpsConnector::from((http, tls)) 57 | } 58 | } 59 | 60 | impl Default for HttpsConnector { 61 | fn default() -> Self { 62 | Self::new_with_connector(Default::default()) 63 | } 64 | } 65 | 66 | impl HttpsConnector { 67 | /// Force the use of HTTPS when connecting. 68 | /// 69 | /// If a URL is not `https` when connecting, an error is returned. 70 | pub fn https_only(&mut self, enable: bool) { 71 | self.force_https = enable; 72 | } 73 | 74 | /// With connector constructor 75 | /// 76 | /// # Panics 77 | /// 78 | /// This will panic if the underlying TLS context could not be created. 79 | /// 80 | /// To handle that error yourself, you can use the `HttpsConnector::from` 81 | /// constructor after trying to make a `TlsConnector`. 82 | pub fn new_with_connector(http: T) -> Self { 83 | native_tls::TlsConnector::new().map_or_else( 84 | |e| { 85 | panic!( 86 | "HttpsConnector::new_with_connector() failure: {}", 87 | e 88 | ) 89 | }, 90 | |tls| HttpsConnector::from((http, tls.into())), 91 | ) 92 | } 93 | } 94 | 95 | impl From<(T, TlsConnector)> for HttpsConnector { 96 | fn from(args: (T, TlsConnector)) -> HttpsConnector { 97 | HttpsConnector { 98 | force_https: false, 99 | http: args.0, 100 | tls: args.1, 101 | } 102 | } 103 | } 104 | 105 | impl fmt::Debug for HttpsConnector { 106 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 107 | f.debug_struct("HttpsConnector") 108 | .field("force_https", &self.force_https) 109 | .field("http", &self.http) 110 | .finish_non_exhaustive() 111 | } 112 | } 113 | 114 | impl Service for HttpsConnector 115 | where 116 | T: Service, 117 | T::Response: Read + Write + Send + Unpin, 118 | T::Future: Send + 'static, 119 | T::Error: Into, 120 | { 121 | type Response = MaybeHttpsStream; 122 | type Error = BoxError; 123 | type Future = HttpsConnecting; 124 | 125 | fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll> { 126 | match self.http.poll_ready(cx) { 127 | Poll::Ready(Ok(())) => Poll::Ready(Ok(())), 128 | Poll::Ready(Err(e)) => Poll::Ready(Err(e.into())), 129 | Poll::Pending => Poll::Pending, 130 | } 131 | } 132 | 133 | fn call(&mut self, dst: Uri) -> Self::Future { 134 | let is_https = dst.scheme_str() == Some("https"); 135 | // Early abort if HTTPS is forced but can't be used 136 | if !is_https && self.force_https { 137 | return err(ForceHttpsButUriNotHttps.into()); 138 | } 139 | 140 | let host = dst 141 | .host() 142 | .unwrap_or("") 143 | .trim_matches(|c| c == '[' || c == ']') 144 | .to_owned(); 145 | let connecting = self.http.call(dst); 146 | 147 | let tls_connector = self.tls.clone(); 148 | 149 | let fut = async move { 150 | let tcp = connecting.await.map_err(Into::into)?; 151 | 152 | let maybe = if is_https { 153 | let stream = TokioIo::new(tcp); 154 | 155 | let tls = TokioIo::new(tls_connector.connect(&host, stream).await?); 156 | MaybeHttpsStream::Https(tls) 157 | } else { 158 | MaybeHttpsStream::Http(tcp) 159 | }; 160 | Ok(maybe) 161 | }; 162 | HttpsConnecting(Box::pin(fut)) 163 | } 164 | } 165 | 166 | fn err(e: BoxError) -> HttpsConnecting { 167 | HttpsConnecting(Box::pin(async { Err(e) })) 168 | } 169 | 170 | type BoxedFut = Pin, BoxError>> + Send>>; 171 | 172 | /// A Future representing work to connect to a URL, and a TLS handshake. 173 | pub struct HttpsConnecting(BoxedFut); 174 | 175 | impl Future for HttpsConnecting { 176 | type Output = Result, BoxError>; 177 | 178 | fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll { 179 | Pin::new(&mut self.0).poll(cx) 180 | } 181 | } 182 | 183 | impl fmt::Debug for HttpsConnecting { 184 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 185 | f.pad("HttpsConnecting") 186 | } 187 | } 188 | 189 | // ===== Custom Errors ===== 190 | 191 | #[derive(Debug)] 192 | struct ForceHttpsButUriNotHttps; 193 | 194 | impl fmt::Display for ForceHttpsButUriNotHttps { 195 | fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 196 | f.write_str("https required but URI was not https") 197 | } 198 | } 199 | 200 | impl std::error::Error for ForceHttpsButUriNotHttps {} 201 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! # hyper-tls 2 | //! 3 | //! An HTTPS connector to be used with [hyper][]. 4 | //! 5 | //! [hyper]: https://hyper.rs 6 | //! 7 | //! ## Example 8 | //! 9 | //! ```no_run 10 | //! use bytes::Bytes; 11 | //! use http_body_util::Empty; 12 | //! use hyper_tls::HttpsConnector; 13 | //! use hyper_util::{client::legacy::Client, rt::TokioExecutor}; 14 | //! 15 | //! #[tokio::main(flavor = "current_thread")] 16 | //! async fn main() -> Result<(), Box>{ 17 | //! let https = HttpsConnector::new(); 18 | //! let client = Client::builder(TokioExecutor::new()).build::<_, Empty>(https); 19 | //! 20 | //! let res = client.get("https://hyper.rs".parse()?).await?; 21 | //! assert_eq!(res.status(), 200); 22 | //! Ok(()) 23 | //! } 24 | //! ``` 25 | //! 26 | //! ## Crate Features 27 | //! 28 | //! - `alpn`: Enables `native-tls/alpn`, and if `h2` is negotiated, tells hyper. 29 | //! - `vendored`: Enables `native-tls/vendored`, removing dependency on OpenSSL. 30 | #![doc(html_root_url = "https://docs.rs/hyper-tls/0.6.0")] 31 | #![cfg_attr(test, deny(warnings))] 32 | #![deny(missing_docs)] 33 | #![deny(missing_debug_implementations)] 34 | 35 | #[doc(hidden)] 36 | pub extern crate native_tls; 37 | 38 | pub use client::{HttpsConnecting, HttpsConnector}; 39 | pub use stream::{MaybeHttpsStream, TlsStream}; 40 | 41 | mod client; 42 | mod stream; 43 | -------------------------------------------------------------------------------- /src/stream.rs: -------------------------------------------------------------------------------- 1 | use std::fmt; 2 | use std::io; 3 | use std::io::IoSlice; 4 | use std::pin::Pin; 5 | use std::task::{Context, Poll}; 6 | 7 | use hyper::rt::{Read, ReadBufCursor, Write}; 8 | 9 | use hyper_util::{ 10 | client::legacy::connect::{Connected, Connection}, 11 | rt::TokioIo, 12 | }; 13 | pub use tokio_native_tls::TlsStream; 14 | 15 | /// A stream that might be protected with TLS. 16 | pub enum MaybeHttpsStream { 17 | /// A stream over plain text. 18 | Http(T), 19 | /// A stream protected with TLS. 20 | Https(TokioIo>>), 21 | } 22 | 23 | // ===== impl MaybeHttpsStream ===== 24 | 25 | impl fmt::Debug for MaybeHttpsStream { 26 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 27 | match self { 28 | MaybeHttpsStream::Http(s) => f.debug_tuple("Http").field(s).finish(), 29 | MaybeHttpsStream::Https(s) => f.debug_tuple("Https").field(s).finish(), 30 | } 31 | } 32 | } 33 | 34 | impl From for MaybeHttpsStream { 35 | fn from(inner: T) -> Self { 36 | MaybeHttpsStream::Http(inner) 37 | } 38 | } 39 | 40 | impl From>> for MaybeHttpsStream { 41 | fn from(inner: TlsStream>) -> Self { 42 | MaybeHttpsStream::Https(TokioIo::new(inner)) 43 | } 44 | } 45 | 46 | impl From>>> for MaybeHttpsStream { 47 | fn from(inner: TokioIo>>) -> Self { 48 | MaybeHttpsStream::Https(inner) 49 | } 50 | } 51 | 52 | impl Read for MaybeHttpsStream { 53 | #[inline] 54 | fn poll_read( 55 | self: Pin<&mut Self>, 56 | cx: &mut Context, 57 | buf: ReadBufCursor<'_>, 58 | ) -> Poll> { 59 | match Pin::get_mut(self) { 60 | MaybeHttpsStream::Http(s) => Pin::new(s).poll_read(cx, buf), 61 | MaybeHttpsStream::Https(s) => Pin::new(s).poll_read(cx, buf), 62 | } 63 | } 64 | } 65 | 66 | impl Write for MaybeHttpsStream { 67 | #[inline] 68 | fn poll_write( 69 | self: Pin<&mut Self>, 70 | cx: &mut Context<'_>, 71 | buf: &[u8], 72 | ) -> Poll> { 73 | match Pin::get_mut(self) { 74 | MaybeHttpsStream::Http(s) => Pin::new(s).poll_write(cx, buf), 75 | MaybeHttpsStream::Https(s) => Pin::new(s).poll_write(cx, buf), 76 | } 77 | } 78 | 79 | fn poll_write_vectored( 80 | self: Pin<&mut Self>, 81 | cx: &mut Context<'_>, 82 | bufs: &[IoSlice<'_>], 83 | ) -> Poll> { 84 | match Pin::get_mut(self) { 85 | MaybeHttpsStream::Http(s) => Pin::new(s).poll_write_vectored(cx, bufs), 86 | MaybeHttpsStream::Https(s) => Pin::new(s).poll_write_vectored(cx, bufs), 87 | } 88 | } 89 | 90 | fn is_write_vectored(&self) -> bool { 91 | match self { 92 | MaybeHttpsStream::Http(s) => s.is_write_vectored(), 93 | MaybeHttpsStream::Https(s) => s.is_write_vectored(), 94 | } 95 | } 96 | 97 | #[inline] 98 | fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 99 | match Pin::get_mut(self) { 100 | MaybeHttpsStream::Http(s) => Pin::new(s).poll_flush(cx), 101 | MaybeHttpsStream::Https(s) => Pin::new(s).poll_flush(cx), 102 | } 103 | } 104 | 105 | #[inline] 106 | fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { 107 | match Pin::get_mut(self) { 108 | MaybeHttpsStream::Http(s) => Pin::new(s).poll_shutdown(cx), 109 | MaybeHttpsStream::Https(s) => Pin::new(s).poll_shutdown(cx), 110 | } 111 | } 112 | } 113 | 114 | impl Connection for MaybeHttpsStream { 115 | fn connected(&self) -> Connected { 116 | match self { 117 | MaybeHttpsStream::Http(s) => s.connected(), 118 | MaybeHttpsStream::Https(s) => { 119 | let c = s.inner().get_ref().get_ref().get_ref().inner().connected(); 120 | #[cfg(feature = "alpn")] 121 | { 122 | if negotiated_h2(s.inner().get_ref()) { 123 | return c.negotiated_h2(); 124 | } 125 | } 126 | c 127 | } 128 | } 129 | } 130 | } 131 | 132 | #[cfg(feature = "alpn")] 133 | fn negotiated_h2(s: &native_tls::TlsStream) -> bool { 134 | s.negotiated_alpn() 135 | .unwrap_or(None) 136 | .map(|list| list == &b"h2"[..]) 137 | .unwrap_or(false) 138 | } 139 | --------------------------------------------------------------------------------