ruma-common 0.18.0

Common types for other ruma crates.
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
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

use assert_matches2::assert_matches;
use http::header;
use ruma_common::api::auth_scheme::{
    AccessToken, AccessTokenOptional, AppserviceToken, AppserviceTokenOptional, AuthScheme,
    NoAccessToken, NoAuthentication, SendAccessToken,
};

const TOKEN: &str = "token";
const HEADER_VALUE: http::HeaderValue = http::HeaderValue::from_static("Bearer token");

fn http_request() -> http::Request<Vec<u8>> {
    http::Request::builder()
        .method(http::Method::GET)
        .uri("http://localhost/_matrix/client/versions")
        .body(vec![])
        .unwrap()
}

#[test]
fn send_access_token_none() {
    let input = SendAccessToken::None;
    let mut request = http_request();

    NoAuthentication::add_authentication(&mut request, ()).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    NoAccessToken::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    AccessToken::add_authentication(&mut request, input).unwrap_err();

    AccessTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    AppserviceToken::add_authentication(&mut request, input).unwrap_err();

    AppserviceTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);
}

#[test]
fn send_access_token_if_required() {
    let input = SendAccessToken::IfRequired(TOKEN);
    let mut request = http_request();

    NoAuthentication::add_authentication(&mut request, ()).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    NoAccessToken::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    AccessToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AccessTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AppserviceToken::add_authentication(&mut request, input).unwrap_err();

    AppserviceTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);
}

#[test]
fn send_access_token_always() {
    let input = SendAccessToken::Always(TOKEN);
    let mut request = http_request();

    NoAuthentication::add_authentication(&mut request, ()).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    NoAccessToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AccessToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AccessTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AppserviceToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AppserviceTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);
}

#[test]
fn send_access_token_appservice() {
    let input = SendAccessToken::Appservice(TOKEN);
    let mut request = http_request();

    NoAuthentication::add_authentication(&mut request, ()).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    NoAccessToken::add_authentication(&mut request, input).unwrap();
    assert_eq!(request.headers_mut().remove(header::AUTHORIZATION), None);

    AccessToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AccessTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AppserviceToken::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);

    AppserviceTokenOptional::add_authentication(&mut request, input).unwrap();
    assert_matches!(request.headers_mut().remove(header::AUTHORIZATION), Some(value));
    assert_eq!(value, HEADER_VALUE);
}

#[test]
fn extract_authentication_bearer() {
    let request_without_token = http_request();
    let mut request_with_valid_header = http_request();
    request_with_valid_header.headers_mut().insert(header::AUTHORIZATION, HEADER_VALUE);
    let mut request_with_invalid_scheme = http_request();
    request_with_invalid_scheme
        .headers_mut()
        .insert(header::AUTHORIZATION, http::HeaderValue::from_static("Basic dGVzdDoxMjPCow=="));
    let mut request_with_query = http_request();
    *request_with_query.uri_mut() = http::Uri::from_static(
        "http://localhost/_matrix/client/versions?foo=bar&access_token=token",
    );

    NoAuthentication::extract_authentication(&request_without_token).unwrap();
    NoAuthentication::extract_authentication(&request_with_valid_header).unwrap();
    NoAuthentication::extract_authentication(&request_with_invalid_scheme).unwrap();
    NoAuthentication::extract_authentication(&request_with_query).unwrap();

    NoAccessToken::extract_authentication(&request_without_token).unwrap();
    NoAccessToken::extract_authentication(&request_with_valid_header).unwrap();
    NoAccessToken::extract_authentication(&request_with_invalid_scheme).unwrap();
    NoAccessToken::extract_authentication(&request_with_query).unwrap();

    AccessToken::extract_authentication(&request_without_token).unwrap_err();
    let token = AccessToken::extract_authentication(&request_with_valid_header).unwrap();
    assert_eq!(token, TOKEN);
    AccessToken::extract_authentication(&request_with_invalid_scheme).unwrap_err();
    let token = AccessToken::extract_authentication(&request_with_query).unwrap();
    assert_eq!(token, TOKEN);

    let token = AccessTokenOptional::extract_authentication(&request_without_token).unwrap();
    assert_eq!(token, None);
    let token = AccessTokenOptional::extract_authentication(&request_with_valid_header).unwrap();
    assert_eq!(token.as_deref(), Some(TOKEN));
    AccessTokenOptional::extract_authentication(&request_with_invalid_scheme).unwrap_err();
    let token = AccessTokenOptional::extract_authentication(&request_with_query).unwrap();
    assert_eq!(token.as_deref(), Some(TOKEN));

    AppserviceToken::extract_authentication(&request_without_token).unwrap_err();
    let token = AppserviceToken::extract_authentication(&request_with_valid_header).unwrap();
    assert_eq!(token, TOKEN);
    AppserviceToken::extract_authentication(&request_with_invalid_scheme).unwrap_err();
    let token = AppserviceToken::extract_authentication(&request_with_query).unwrap();
    assert_eq!(token, TOKEN);

    let token = AppserviceTokenOptional::extract_authentication(&request_without_token).unwrap();
    assert_eq!(token, None);
    let token =
        AppserviceTokenOptional::extract_authentication(&request_with_valid_header).unwrap();
    assert_eq!(token.as_deref(), Some(TOKEN));
    AppserviceTokenOptional::extract_authentication(&request_with_invalid_scheme).unwrap_err();
    let token = AppserviceTokenOptional::extract_authentication(&request_with_query).unwrap();
    assert_eq!(token.as_deref(), Some(TOKEN));
}