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
use std::future::Future;
use std::marker::{PhantomData, Send};

use crate::async_tungstenite::WebSocketStream;
use crate::tungstenite::protocol::Role;
use crate::WebSocketConnection;

use async_dup::Arc;
use async_std::task;
use sha1::{Digest, Sha1};

use tide::http::format_err;
use tide::http::headers::{HeaderName, CONNECTION, UPGRADE};
use tide::{Middleware, Request, Response, Result, StatusCode};

const WEBSOCKET_GUID: &str = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

/// # endpoint/middleware handler for websockets in tide
///
/// This can either be used as a middleware or as an
/// endpoint. Regardless of which approach is taken, the handler
/// function provided to [`WebSocket::new`] is only called if the
/// request correctly negotiates an upgrade to the websocket protocol.
///
/// ## As a middleware
///
/// If used as a middleware, the endpoint will be executed if the
/// request is not a websocket upgrade.
///
/// ### Example
///
/// ```rust
/// use async_std::prelude::*;
/// use tide_websockets::{Message, WebSocket};
///
/// #[async_std::main]
/// async fn main() -> Result<(), std::io::Error> {
///     let mut app = tide::new();
///
///     app.at("/ws")
///         .with(WebSocket::new(|_request, mut stream| async move {
///             while let Some(Ok(Message::Text(input))) = stream.next().await {
///                 let output: String = input.chars().rev().collect();
///
///                 stream
///                     .send_string(format!("{} | {}", &input, &output))
///                     .await?;
///             }
///
///             Ok(())
///         }))
///        .get(|_| async move { Ok("this was not a websocket request") });
///
/// # if false {
///     app.listen("127.0.0.1:8080").await?;
/// # }
///     Ok(())
/// }
/// ```
///
/// ## As an endpoint
///
/// If used as an endpoint but the request is
/// not a websocket request, tide will reply with a `426 Upgrade
/// Required` status code.
///
/// ### example
///
/// ```rust
/// use async_std::prelude::*;
/// use tide_websockets::{Message, WebSocket};
///
/// #[async_std::main]
/// async fn main() -> Result<(), std::io::Error> {
///     let mut app = tide::new();
///
///     app.at("/ws")
///         .get(WebSocket::new(|_request, mut stream| async move {
///             while let Some(Ok(Message::Text(input))) = stream.next().await {
///                 let output: String = input.chars().rev().collect();
///
///                 stream
///                     .send_string(format!("{} | {}", &input, &output))
///                     .await?;
///             }
///
///             Ok(())
///         }));
///
/// # if false {
///     app.listen("127.0.0.1:8080").await?;
/// # }
///     Ok(())
/// }
/// ```
///
#[derive(Debug)]
pub struct WebSocket<S, H> {
    handler: Arc<H>,
    ghostly_apparition: PhantomData<S>,
}

enum UpgradeStatus<S> {
    Upgraded(Result<Response>),
    NotUpgraded(Request<S>),
}
use UpgradeStatus::{NotUpgraded, Upgraded};

fn header_eq_ignore_case<T>(req: &Request<T>, header_name: HeaderName, value: &str) -> bool {
    req.header(header_name)
        .map(|h| h.as_str().eq_ignore_ascii_case(value))
        .unwrap_or(false)
}

impl<S, H, Fut> WebSocket<S, H>
where
    S: Send + Sync + Clone + 'static,
    H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static,
    Fut: Future<Output = Result<()>> + Send + 'static,
{
    /// Build a new WebSocket with a handler function that
    pub fn new(handler: H) -> Self {
        Self {
            handler: Arc::new(handler),
            ghostly_apparition: PhantomData,
        }
    }

    async fn handle_upgrade(&self, req: Request<S>) -> UpgradeStatus<S> {
        let connection_upgrade = header_eq_ignore_case(&req, CONNECTION, "upgrade");
        let upgrade_to_websocket = header_eq_ignore_case(&req, UPGRADE, "websocket");
        let upgrade_requested = connection_upgrade && upgrade_to_websocket;

        if !upgrade_requested {
            return NotUpgraded(req);
        }

        let header = match req.header("Sec-Websocket-Key") {
            Some(h) => h.as_str(),
            None => return Upgraded(Err(format_err!("expected sec-websocket-key"))),
        };

        let mut response = Response::new(StatusCode::SwitchingProtocols);

        response.insert_header(UPGRADE, "websocket");
        response.insert_header(CONNECTION, "Upgrade");
        let hash = Sha1::new().chain(header).chain(WEBSOCKET_GUID).finalize();
        response.insert_header("Sec-Websocket-Accept", base64::encode(&hash[..]));
        response.insert_header("Sec-Websocket-Version", "13");

        let http_res: &mut tide::http::Response = response.as_mut();
        let upgrade_receiver = http_res.recv_upgrade().await;
        let handler = self.handler.clone();

        task::spawn(async move {
            if let Some(stream) = upgrade_receiver.await {
                let stream = WebSocketStream::from_raw_socket(stream, Role::Server, None).await;
                handler(req, stream.into()).await
            } else {
                Err(format_err!("never received an upgrade!"))
            }
        });

        Upgraded(Ok(response))
    }
}

#[tide::utils::async_trait]
impl<H, S, Fut> tide::Endpoint<S> for WebSocket<S, H>
where
    H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static,
    Fut: Future<Output = Result<()>> + Send + 'static,
    S: Send + Sync + Clone + 'static,
{
    async fn call(&self, req: Request<S>) -> Result {
        match self.handle_upgrade(req).await {
            Upgraded(result) => result,
            NotUpgraded(_) => Ok(Response::new(StatusCode::UpgradeRequired)),
        }
    }
}

#[tide::utils::async_trait]
impl<H, S, Fut> Middleware<S> for WebSocket<S, H>
where
    H: Fn(Request<S>, WebSocketConnection) -> Fut + Sync + Send + 'static,
    Fut: Future<Output = Result<()>> + Send + 'static,
    S: Send + Sync + Clone + 'static,
{
    async fn handle(&self, req: Request<S>, next: tide::Next<'_, S>) -> Result {
        match self.handle_upgrade(req).await {
            Upgraded(result) => result,
            NotUpgraded(req) => Ok(next.run(req).await),
        }
    }
}