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
use std::marker;
use crate::connector_box::TlsConnectorBox;
use crate::connector_box::TlsConnectorTypeImpl;
use crate::socket::AsyncSocket;
use crate::stream::TlsStream;
use crate::BoxFuture;
use crate::ImplInfo;
use crate::TlsConnectorType;
use crate::TlsStreamDyn;
use crate::TlsStreamWithSocket;
/// A builder for `TlsConnector`s.
pub trait TlsConnectorBuilder: Sized + Sync + Send + 'static {
/// Result of connector to be build.
type Connector: TlsConnector;
/// Type of the underlying builder.
///
/// In the world of HKT this would be:
///
/// ```ignore
/// type TlsStream<S: TlsStreamDyn> : TlsStreamWithSocketDyn<S>;
/// ```
///
/// Note each implementation has `accept_impl` function
/// which returns more specific type, providing both access to implementation details
/// and the underlying socket.
type Underlying;
/// Get the underlying builder.
///
/// API intentionally exposes the underlying acceptor builder to allow fine tuning
/// not possible in common API.
fn underlying_mut(&mut self) -> &mut Self::Underlying;
/// Set ALPN-protocols to negotiate.
///
/// This operations fails is not [`TlsConnector::SUPPORTS_ALPN`].
fn set_alpn_protocols(&mut self, protocols: &[&[u8]]) -> anyhow::Result<()>;
/// Should hostname verification be performed?
/// Use carefully, it opens the door to MITM attacks.
fn set_verify_hostname(&mut self, verify: bool) -> anyhow::Result<()>;
/// Add trusted root certificate. By default connector supports only
/// global trusted root.
///
/// Param is DER-encoded X.509 certificate.
fn add_root_certificate(&mut self, cert: &[u8]) -> anyhow::Result<()>;
/// Finish the acceptor construction.
fn build(self) -> anyhow::Result<Self::Connector>;
}
/// A builder for client-side TLS connections.
pub trait TlsConnector: Sized + Sync + Send + 'static {
/// Type of the builder for this connector.
type Builder: TlsConnectorBuilder<Connector = Self>;
/// Type of the underlying connector.
type Underlying;
/// `crate::TlsStream<tls_api::AsyncSocketBox>`.
///
/// In the world of HKT this would be:
///
/// ```ignore
/// type TlsStream<S: TlsStreamDyn> : TlsStreamWithSocketDyn<S>;
/// ```
type TlsStream: TlsStreamDyn;
/// Get the underlying builder.
///
/// API intentionally exposes the underlying acceptor builder to allow fine tuning
/// not possible in common API.
fn underlying_mut(&mut self) -> &mut Self::Underlying;
/// Is it implemented? When `false` all operations return an error.
///
/// At the moment of writing, there are two crates which return `false` here:
/// * `tls-api-stub`, dummy implementation is not meant to be instantiated
/// * `tls-api-security-framework`, `true` only on macOS and iOS, `false` elsewhere
const IMPLEMENTED: bool;
/// Whether this implementation supports ALPN negotiation.
const SUPPORTS_ALPN: bool;
/// Implementation info.
fn info() -> ImplInfo;
/// New builder for the acceptor.
fn builder() -> anyhow::Result<Self::Builder>;
/// Dynamic (without type parameter) version of the connector.
///
/// This function returns a connector type, which can be used to constructor connectors.
const TYPE_DYN: &'static dyn TlsConnectorType =
&TlsConnectorTypeImpl::<Self>(marker::PhantomData);
/// Dynamic (without type parameter) version of the connector.
fn into_dyn(self) -> TlsConnectorBox {
TlsConnectorBox::new(self)
}
/// Connect using default settings.
///
/// Shortcut.
fn connect_default<S>(domain: &str, stream: S) -> BoxFuture<'_, anyhow::Result<TlsStream>>
where
S: AsyncSocket,
{
BoxFuture::new(async move {
let connector = Self::builder()?.build()?;
connector.connect(domain, stream).await
})
}
/// Connect.
///
/// Returned future is resolved when the TLS-negotiation completes,
/// and the stream is ready to send and receive.
///
/// This is like the function you want to use.
fn connect<'a, S>(
&'a self,
domain: &'a str,
stream: S,
) -> BoxFuture<'a, anyhow::Result<TlsStream>>
where
S: AsyncSocket,
{
BoxFuture::new(async move {
self.connect_with_socket(domain, stream)
.await
.map(TlsStream::new)
})
}
/// Connect.
///
/// Returned future is resolved when the TLS-negotiation completes,
/// and the stream is ready to send and receive.
///
/// This function returns a stream which provides access to the underlying socket.
///
/// Practically, [`connect`](Self::connect) is usually needed.
fn connect_with_socket<'a, S>(
&'a self,
domain: &'a str,
stream: S,
) -> BoxFuture<'a, anyhow::Result<TlsStreamWithSocket<S>>>
where
S: AsyncSocket;
/// Connect.
///
/// Returned future is resolved when the TLS-negotiation completes,
/// and the stream is ready to send and receive.
///
/// This version returns a stream of type of the underlying implementation,
/// which may provide access to the implementation details.
///
/// Practically, [`connect`](Self::connect) is usually needed.
fn connect_impl_tls_stream<'a, S>(
&'a self,
domain: &'a str,
stream: S,
) -> BoxFuture<'a, anyhow::Result<Self::TlsStream>>
where
S: AsyncSocket;
}
/// Common part of all connectors. Poor man replacement for HKT.
#[macro_export]
macro_rules! spi_connector_common {
($stream: ty) => {
fn connect_with_socket<'a, S>(
&'a self,
domain: &'a str,
stream: S,
) -> $crate::BoxFuture<'a, anyhow::Result<$crate::TlsStreamWithSocket<S>>>
where
S: $crate::AsyncSocket,
{
$crate::BoxFuture::new(async move {
let crate_tls_stream: $stream = self.connect_impl(domain, stream).await?;
Ok($crate::TlsStreamWithSocket::new(crate_tls_stream))
})
}
fn connect_impl_tls_stream<'a, S>(
&'a self,
domain: &'a str,
stream: S,
) -> tls_api::BoxFuture<'a, anyhow::Result<Self::TlsStream>>
where
S: AsyncSocket,
{
tls_api::BoxFuture::new(self.connect_impl(domain, tls_api::AsyncSocketBox::new(stream)))
}
};
}