specters 2.2.0

HTTP client with full TLS, HTTP/2, and HTTP/3 fingerprint control
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

use std::time::Duration;

use specter::{Client, CloseCode, CloseFrame};

#[path = "helpers/mock_ws_server.rs"]
mod mock_ws_server;

use mock_ws_server::{AcceptMode, MockWsServer, WsResponse};

#[tokio::test]
async fn invalid_accept_returns_handshake_error_without_close_frame() {
    let server = MockWsServer::new().await.unwrap();
    let url = server.ws_url("/invalid-accept");
    let handle = server.start_once(WsResponse {
        accept: AcceptMode::Wrong,
        ..WsResponse::default()
    });

    let err = Client::new()
        .unwrap()
        .websocket(url)
        .connect()
        .await
        .expect_err("invalid accept must fail");

    assert_error_mentions(&err, &["InvalidAccept", "Sec-WebSocket-Accept"]);
    assert!(
        handle.await.unwrap().client_frame.is_none(),
        "handshake failures must not send websocket close frames"
    );
}

#[tokio::test]
async fn extension_response_returns_unexpected_extension_without_close_frame() {
    let server = MockWsServer::new().await.unwrap();
    let url = server.ws_url("/unexpected-extension");
    let handle = server.start_once(WsResponse {
        headers: vec![(
            "Sec-WebSocket-Extensions".to_string(),
            "permessage-deflate".to_string(),
        )],
        ..WsResponse::default()
    });

    let err = Client::new()
        .unwrap()
        .websocket(url)
        .connect()
        .await
        .expect_err("unexpected extension must fail");

    assert_error_mentions(&err, &["UnexpectedExtension", "Sec-WebSocket-Extensions"]);
    assert!(
        handle.await.unwrap().client_frame.is_none(),
        "handshake failures must not send websocket close frames"
    );
}

#[tokio::test]
async fn unoffered_subprotocol_returns_unexpected_subprotocol_without_close_frame() {
    let server = MockWsServer::new().await.unwrap();
    let url = server.ws_url("/unexpected-subprotocol");
    let handle = server.start_once(WsResponse {
        headers: vec![(
            "Sec-WebSocket-Protocol".to_string(),
            "superchat".to_string(),
        )],
        ..WsResponse::default()
    });

    let err = Client::new()
        .unwrap()
        .websocket(url)
        .connect()
        .await
        .expect_err("unexpected subprotocol must fail");

    assert_error_mentions(&err, &["UnexpectedSubprotocol", "Sec-WebSocket-Protocol"]);
    assert!(
        handle.await.unwrap().client_frame.is_none(),
        "handshake failures must not send websocket close frames"
    );
}

#[tokio::test]
async fn invalid_outbound_close_codes_are_rejected_without_sending_frame() {
    for code in [
        CloseCode::Status,
        CloseCode::Abnormal,
        CloseCode::Tls,
        CloseCode::Library(1004),
        CloseCode::Library(1016),
        CloseCode::Library(2999),
    ] {
        let server = MockWsServer::new().await.unwrap();
        let url = server.ws_url("/invalid-close-code");
        let handle = server.start_once(WsResponse::default());

        let mut ws = Client::new()
            .unwrap()
            .websocket(url)
            .connect()
            .await
            .expect("websocket handshake should succeed");

        let err = ws
            .close(Some(CloseFrame {
                code,
                reason: String::new(),
            }))
            .await
            .expect_err("invalid close code must fail before sending");

        assert_error_mentions(&err, &["close code", "must not be sent"]);
        assert!(
            handle.await.unwrap().client_frame.is_none(),
            "invalid outbound close code must not write a close frame"
        );
    }
}

#[tokio::test]
async fn established_read_timeout_returns_timeout_error() {
    let server = MockWsServer::new().await.unwrap();
    let url = server.ws_url("/read-timeout");
    let handle = server.start_once(WsResponse::default());

    let mut ws = Client::new()
        .unwrap()
        .websocket(url)
        .read_timeout(Duration::from_millis(20))
        .connect()
        .await
        .expect("websocket handshake should succeed");

    let err = ws.next().await.expect_err("read timeout must fail");
    assert_error_mentions(&err, &["Timeout", "read"]);

    let _ = handle.await.unwrap();
}

fn assert_error_mentions<E: std::fmt::Debug + std::fmt::Display>(err: &E, needles: &[&str]) {
    let rendered = format!("{err:?}\n{err}");
    assert!(
        needles.iter().any(|needle| rendered.contains(needle)),
        "error did not mention any of {needles:?}: {rendered}"
    );
}