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
use std::{borrow::Cow, future::Future};
use hyper::upgrade::{OnUpgrade, Upgraded};
use tokio_tungstenite::tungstenite::protocol::Role;
use crate::{
async_trait,
header::{SEC_WEBSOCKET_PROTOCOL, UPGRADE},
headers::{
Connection, HeaderMapExt, HeaderValue, SecWebsocketAccept, SecWebsocketKey,
SecWebsocketVersion, Upgrade,
},
FromRequest, IntoResponse, OutgoingBody, Request, Response, Result, StatusCode,
};
mod error;
pub use error::WebSocketError;
pub use tokio_tungstenite::tungstenite::protocol::{Message, WebSocketConfig};
pub type WebSocketStream<T = Upgraded> = tokio_tungstenite::WebSocketStream<T>;
#[derive(Debug)]
pub struct WebSocket {
key: SecWebsocketKey,
on_upgrade: Option<OnUpgrade>,
protocols: Option<Box<[Cow<'static, str>]>>,
sec_websocket_protocol: Option<HeaderValue>,
}
impl WebSocket {
const NAME: &'static [u8] = b"websocket";
pub fn protocols<I>(mut self, protocols: I) -> Self
where
I: IntoIterator,
I::Item: Into<Cow<'static, str>>,
{
self.protocols = Some(
protocols
.into_iter()
.map(Into::into)
.collect::<Vec<_>>()
.into(),
);
self
}
#[must_use]
pub fn on_upgrade_with_config<F, Fut>(
mut self,
callback: F,
config: Option<WebSocketConfig>,
) -> Response
where
F: FnOnce(WebSocketStream) -> Fut + Send + 'static,
Fut: Future<Output = ()> + Send + 'static,
{
let on_upgrade = self.on_upgrade.take().unwrap();
tokio::task::spawn(async move {
let upgraded = match on_upgrade.await {
Ok(upgraded) => upgraded,
Err(_) => return,
};
let socket = WebSocketStream::from_raw_socket(upgraded, Role::Server, config).await;
(callback)(socket).await
});
self.into_response()
}
pub fn on_upgrade<F, Fut>(self, callback: F) -> Response
where
F: FnOnce(WebSocketStream) -> Fut + Send + 'static,
Fut: Future<Output = ()> + Send + 'static,
{
self.on_upgrade_with_config(callback, None)
}
}
#[async_trait]
impl FromRequest for WebSocket {
type Error = WebSocketError;
async fn extract(req: &mut Request) -> Result<Self, Self::Error> {
req.headers()
.typed_get::<Connection>()
.ok_or(WebSocketError::MissingConnectUpgrade)
.and_then(|h| {
if h.contains(UPGRADE) {
Ok(())
} else {
Err(WebSocketError::InvalidConnectUpgrade)
}
})?;
req.headers()
.get(UPGRADE)
.ok_or(WebSocketError::MissingUpgrade)
.and_then(|h| {
if h.as_bytes().eq_ignore_ascii_case(WebSocket::NAME) {
Ok(())
} else {
Err(WebSocketError::InvalidUpgrade)
}
})?;
req.headers()
.typed_get::<SecWebsocketVersion>()
.ok_or(WebSocketError::MissingWebSocketVersion)
.and_then(|h| {
if h == SecWebsocketVersion::V13 {
Ok(())
} else {
Err(WebSocketError::InvalidWebSocketVersion)
}
})?;
let key = req
.headers()
.typed_get::<SecWebsocketKey>()
.ok_or(WebSocketError::MissingWebSocketKey)?;
let on_upgrade = req.extensions_mut().remove::<OnUpgrade>();
if on_upgrade.is_none() {
Err(WebSocketError::ConnectionNotUpgradable)?;
}
let sec_websocket_protocol = req.headers().get(SEC_WEBSOCKET_PROTOCOL).cloned();
Ok(Self {
key,
on_upgrade,
protocols: None,
sec_websocket_protocol,
})
}
}
impl IntoResponse for WebSocket {
fn into_response(self) -> Response {
let protocol = self
.sec_websocket_protocol
.as_ref()
.and_then(|req_protocols| {
let req_protocols = req_protocols.to_str().ok()?;
let protocols = self.protocols.as_ref()?;
req_protocols
.split(',')
.map(|req_p| req_p.trim())
.find(|req_p| protocols.iter().any(|p| p == req_p))
.and_then(|v| HeaderValue::from_str(v).ok())
});
let mut res = Response::new(OutgoingBody::Empty);
*res.status_mut() = StatusCode::SWITCHING_PROTOCOLS;
res.headers_mut().typed_insert(Connection::upgrade());
res.headers_mut().typed_insert(Upgrade::websocket());
res.headers_mut()
.typed_insert(SecWebsocketAccept::from(self.key));
if let Some(protocol) = protocol {
res.headers_mut().insert(SEC_WEBSOCKET_PROTOCOL, protocol);
}
res
}
}