rustfs-signer 1.0.0

Digital signature generation and verification for RustFS, ensuring data integrity and authenticity.
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

// Copyright 2024 RustFS Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use http::request;

use s3s::Body;

#[derive(Debug, thiserror::Error)]
pub enum HostAddrError {
    #[error("invalid UTF-8 header value for `host`")]
    InvalidHostHeader,
    #[error("request uri has no host")]
    MissingUriHost,
}

pub fn try_get_host_addr(req: &request::Request<Body>) -> Result<String, HostAddrError> {
    let host = req.headers().get("host");
    let req_host = uri_host_addr(req).ok_or(HostAddrError::MissingUriHost)?;

    if let Some(host) = host {
        let host = host.to_str().map_err(|_| HostAddrError::InvalidHostHeader)?;
        if req_host != host {
            return Ok(host.to_string());
        }
    }

    Ok(req_host)
}

pub fn get_host_addr(req: &request::Request<Body>) -> String {
    match try_get_host_addr(req) {
        Ok(host) => host,
        Err(HostAddrError::MissingUriHost) => req
            .headers()
            .get("host")
            .and_then(|host| host.to_str().ok())
            .unwrap_or_default()
            .to_string(),
        Err(HostAddrError::InvalidHostHeader) => uri_host_addr(req).unwrap_or_default(),
    }
}

fn uri_host_addr(req: &request::Request<Body>) -> Option<String> {
    let uri = req.uri();
    let uri_host = uri.host()?;

    if let Some(port) = uri.port() {
        Some(format!("{uri_host}:{port}"))
    } else {
        Some(uri_host.to_string())
    }
}

pub fn sign_v4_trim_all(input: &str) -> String {
    let ss = input.split_whitespace().collect::<Vec<_>>();
    ss.join(" ")
}

pub fn stable_sort_by_first<T>(v: &mut [(T, T)])
where
    T: Ord,
{
    v.sort_by(|lhs, rhs| lhs.0.cmp(&rhs.0));
}

#[cfg(test)]
mod tests {
    use super::{HostAddrError, get_host_addr, try_get_host_addr};
    use http::HeaderValue;
    use http::request;
    use s3s::Body;

    #[test]
    fn try_get_host_addr_prefers_explicit_host_header_when_it_differs_from_uri() {
        let mut req = request::Request::builder()
            .method(http::Method::GET)
            .uri("https://bucket.example.com/object")
            .body(Body::empty())
            .expect("request should build");
        req.headers_mut()
            .insert("host", HeaderValue::from_static("proxy.internal:9443"));

        let host = try_get_host_addr(&req).expect("host lookup should succeed");

        assert_eq!(host, "proxy.internal:9443");
    }

    #[test]
    fn get_host_addr_preserves_legacy_string_api() {
        let req = request::Request::builder()
            .method(http::Method::GET)
            .uri("https://bucket.example.com:9443/object")
            .body(Body::empty())
            .expect("request should build");

        assert_eq!(get_host_addr(&req), "bucket.example.com:9443");
    }

    #[test]
    fn get_host_addr_uses_host_header_for_relative_uri() {
        let mut req = request::Request::builder()
            .method(http::Method::GET)
            .uri("/object")
            .body(Body::empty())
            .expect("request should build");
        req.headers_mut()
            .insert("host", HeaderValue::from_static("bucket.example.com"));

        assert_eq!(get_host_addr(&req), "bucket.example.com");
    }

    #[test]
    fn try_get_host_addr_rejects_non_utf8_host_header_value() {
        let mut req = request::Request::builder()
            .method(http::Method::GET)
            .uri("https://bucket.example.com/object")
            .body(Body::empty())
            .expect("request should build");
        req.headers_mut().insert(
            "host",
            HeaderValue::from_bytes(&[0xFF]).expect("invalid utf8 bytes should be accepted by HeaderValue"),
        );

        let err = try_get_host_addr(&req).expect_err("invalid host header should fail");

        assert!(matches!(err, HostAddrError::InvalidHostHeader));
    }

    #[test]
    fn get_host_addr_uses_uri_host_when_host_header_is_non_utf8() {
        let mut req = request::Request::builder()
            .method(http::Method::GET)
            .uri("https://bucket.example.com:9443/object")
            .body(Body::empty())
            .expect("request should build");
        req.headers_mut().insert(
            "host",
            HeaderValue::from_bytes(&[0xFF]).expect("invalid utf8 bytes should be accepted by HeaderValue"),
        );

        assert_eq!(get_host_addr(&req), "bucket.example.com:9443");
    }

    #[test]
    fn try_get_host_addr_rejects_relative_uri_without_host() {
        let req = request::Request::builder()
            .method(http::Method::GET)
            .uri("/object")
            .body(Body::empty())
            .expect("request should build");

        let err = try_get_host_addr(&req).expect_err("relative uri should fail");

        assert!(matches!(err, HostAddrError::MissingUriHost));
    }
}