s3s 0.15.0-alpha.1

S3 Service Adapter
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373

//! Custom route support
//!
//! This module provides the [`S3Route`] trait for implementing custom routes that can
//! intercept requests before they reach the standard S3 operation handlers.
//!
//! # Overview
//!
//! Custom routes allow you to:
//!
//! - Handle non-S3 endpoints (e.g., health checks, metrics)
//! - Implement custom authentication flows (e.g., STS `AssumeRole`)
//! - Add middleware-like functionality
//! - Route specific requests to custom handlers
//!
//! # Example
//!
//! ```
//! use s3s::route::S3Route;
//! use s3s::{Body, S3Request, S3Response, S3Result};
//! use hyper::{HeaderMap, Method, Uri};
//! use hyper::http::Extensions;
//!
//! // Custom route for health checks
//! #[derive(Clone)]
//! struct HealthCheckRoute;
//!
//! #[async_trait::async_trait]
//! impl S3Route for HealthCheckRoute {
//!     fn is_match(&self, method: &Method, uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool {
//!         method == Method::GET && uri.path() == "/health"
//!     }
//!
//!     // Override to allow unauthenticated health checks
//!     async fn check_access(&self, _req: &mut S3Request<Body>) -> S3Result<()> {
//!         Ok(())
//!     }
//!
//!     async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
//!         Ok(S3Response::new(Body::from("OK".to_string())))
//!     }
//! }
//! ```
//!
//! # Integration with `S3Service`
//!
//! ```
//! use s3s::service::S3ServiceBuilder;
//! use s3s::route::S3Route;
//! use s3s::{S3, S3Request, S3Response, S3Result, Body};
//! use s3s::dto::{GetObjectInput, GetObjectOutput};
//! use hyper::{HeaderMap, Method, Uri};
//! use hyper::http::Extensions;
//!
//! #[derive(Clone)]
//! struct MyS3;
//!
//! #[async_trait::async_trait]
//! impl S3 for MyS3 {
//! #   async fn get_object(&self, _req: S3Request<GetObjectInput>) -> S3Result<S3Response<GetObjectOutput>> {
//! #       Err(s3s::s3_error!(NotImplemented))
//! #   }
//!     // Implement S3 operations
//! }
//!
//! #[derive(Clone)]
//! struct MyRoute;
//!
//! #[async_trait::async_trait]
//! impl S3Route for MyRoute {
//!     fn is_match(&self, _method: &Method, _uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool {
//!         false
//!     }
//!
//!     async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
//!         Err(s3s::s3_error!(NotImplemented))
//!     }
//! }
//!
//! let mut builder = S3ServiceBuilder::new(MyS3);
//! builder.set_route(MyRoute);
//! let service = builder.build();
//! ```

use crate::Body;
use crate::S3Request;
use crate::S3Response;
use crate::S3Result;

use hyper::HeaderMap;
use hyper::Method;
use hyper::Uri;
use hyper::http::Extensions;

/// Custom route handler for S3 requests.
///
/// This trait allows you to intercept and handle specific requests before they reach
/// the standard S3 operation handlers. Routes are checked before S3 operations are
/// invoked, allowing you to implement custom endpoints or middleware.
///
/// # Example
///
/// ```
/// use s3s::route::S3Route;
/// use s3s::{Body, S3Request, S3Response, S3Result};
/// use hyper::{HeaderMap, Method, Uri};
/// use hyper::http::Extensions;
///
/// // Custom route for STS AssumeRole
/// #[derive(Clone)]
/// struct AssumeRoleRoute;
///
/// #[async_trait::async_trait]
/// impl S3Route for AssumeRoleRoute {
///     fn is_match(&self, method: &Method, uri: &Uri, headers: &HeaderMap, _extensions: &mut Extensions) -> bool {
///         method == Method::POST
///             && uri.path() == "/"
///             && headers.get("content-type")
///                 .and_then(|v| v.to_str().ok())
///                 == Some("application/x-www-form-urlencoded")
///     }
///
///     async fn call(&self, req: S3Request<Body>) -> S3Result<S3Response<Body>> {
///         // Handle AssumeRole request
///         // Parse form data, generate temporary credentials, etc.
/// #       Err(s3s::s3_error!(NotImplemented))
///     }
/// }
/// ```
#[async_trait::async_trait]
pub trait S3Route: Send + Sync + 'static {
    /// Determines if this route should handle the request.
    ///
    /// This method is called before S3 operations are invoked. If it returns `true`,
    /// the [`call`](Self::call) method will be invoked instead of the standard S3 handler.
    ///
    /// # Arguments
    ///
    /// * `method` - The HTTP method (GET, POST, etc.)
    /// * `uri` - The request URI
    /// * `headers` - The HTTP headers
    /// * `extensions` - HTTP extensions (can be used to store custom data)
    ///
    /// # Returns
    ///
    /// `true` if this route should handle the request, `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use s3s::route::S3Route;
    /// use s3s::{Body, S3Request, S3Response, S3Result};
    /// use hyper::{HeaderMap, Method, Uri};
    /// use hyper::http::Extensions;
    ///
    /// struct MetricsRoute;
    ///
    /// #[async_trait::async_trait]
    /// impl S3Route for MetricsRoute {
    ///     fn is_match(&self, method: &Method, uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool {
    ///         // Match GET /metrics
    ///         method == Method::GET && uri.path() == "/metrics"
    ///     }
    /// #   async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
    /// #       Err(s3s::s3_error!(NotImplemented))
    /// #   }
    /// }
    /// ```
    fn is_match(&self, method: &Method, uri: &Uri, headers: &HeaderMap, extensions: &mut Extensions) -> bool;

    /// Checks access permissions for the request.
    ///
    /// This method is called after [`is_match`](Self::is_match) returns true and before [`call`](Self::call) is invoked.
    /// The default implementation requires valid credentials (returns error if credentials are None).
    ///
    /// Override this method to implement custom access control for your route.
    ///
    /// # Arguments
    ///
    /// * `req` - The S3 request (mutable to allow modifications)
    ///
    /// # Returns
    ///
    /// `Ok(())` if access is granted, `Err(S3Error)` otherwise.
    ///
    /// # Default Behavior
    ///
    /// The default implementation denies requests without credentials:
    ///
    /// ```
    /// # use s3s::route::S3Route;
    /// # use s3s::{Body, S3Request, S3Response, S3Result};
    /// # use hyper::{HeaderMap, Method, Uri};
    /// # use hyper::http::Extensions;
    /// # struct MyRoute;
    /// # #[async_trait::async_trait]
    /// # impl S3Route for MyRoute {
    /// #   fn is_match(&self, _method: &Method, _uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool { false }
    /// async fn check_access(&self, req: &mut S3Request<Body>) -> S3Result<()> {
    ///     match req.credentials {
    ///         Some(_) => Ok(()),
    ///         None => Err(s3s::s3_error!(AccessDenied, "Signature is required")),
    ///     }
    /// }
    /// #   async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
    /// #       Err(s3s::s3_error!(NotImplemented))
    /// #   }
    /// # }
    /// ```
    ///
    /// # Example
    ///
    /// ```
    /// use s3s::route::S3Route;
    /// use s3s::{Body, S3Request, S3Response, S3Result};
    /// use hyper::{HeaderMap, Method, Uri};
    /// use hyper::http::Extensions;
    ///
    /// struct PublicRoute;
    ///
    /// #[async_trait::async_trait]
    /// impl S3Route for PublicRoute {
    /// #   fn is_match(&self, _method: &Method, _uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool { false }
    ///     // Allow access without credentials
    ///     async fn check_access(&self, _req: &mut S3Request<Body>) -> S3Result<()> {
    ///         Ok(())
    ///     }
    /// #   async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
    /// #       Err(s3s::s3_error!(NotImplemented))
    /// #   }
    /// }
    /// ```
    async fn check_access(&self, req: &mut S3Request<Body>) -> S3Result<()> {
        match req.credentials {
            Some(_) => Ok(()),
            None => Err(s3_error!(AccessDenied, "Signature is required")),
        }
    }

    /// Handles the request for this route.
    ///
    /// This method is called if `is_match` returns true and `check_access` succeeds.
    /// Implement your custom request handling logic here.
    ///
    /// # Arguments
    ///
    /// * `req` - The S3 request to handle
    ///
    /// # Returns
    ///
    /// A successful response or an S3 error.
    ///
    /// # Example
    ///
    /// ```
    /// use s3s::route::S3Route;
    /// use s3s::{Body, S3Request, S3Response, S3Result};
    /// use hyper::{HeaderMap, Method, Uri};
    /// use hyper::http::Extensions;
    ///
    /// struct HealthCheckRoute;
    ///
    /// #[async_trait::async_trait]
    /// impl S3Route for HealthCheckRoute {
    /// #   fn is_match(&self, _method: &Method, _uri: &Uri, _headers: &HeaderMap, _extensions: &mut Extensions) -> bool { true }
    ///     async fn call(&self, _req: S3Request<Body>) -> S3Result<S3Response<Body>> {
    ///         // Return a simple OK response
    ///         let response = S3Response::new(Body::from("OK".to_string()));
    ///         Ok(response)
    ///     }
    /// }
    /// ```
    async fn call(&self, req: S3Request<Body>) -> S3Result<S3Response<Body>>;
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::auth::{Credentials, SecretKey};
    use crate::header;

    use hyper::header::HeaderValue;

    #[allow(dead_code)]
    pub struct AssumeRole {}

    #[async_trait::async_trait]
    impl S3Route for AssumeRole {
        fn is_match(&self, method: &Method, uri: &Uri, headers: &HeaderMap, _: &mut Extensions) -> bool {
            if method == Method::POST
                && uri.path() == "/"
                && let Some(val) = headers.get(header::CONTENT_TYPE)
                && val.as_bytes() == b"application/x-www-form-urlencoded"
            {
                return true;
            }
            false
        }

        async fn call(&self, _: S3Request<Body>) -> S3Result<S3Response<Body>> {
            tracing::debug!("call AssumeRole");
            return Err(s3_error!(NotImplemented));
        }
    }

    fn make_request(credentials: Option<Credentials>) -> S3Request<Body> {
        S3Request {
            input: Body::empty(),
            method: Method::POST,
            uri: Uri::from_static("http://example.com/"),
            headers: HeaderMap::new(),
            extensions: Extensions::new(),
            credentials,
            region: None,
            service: None,
            trailing_headers: None,
        }
    }

    #[test]
    fn assume_role_matches_urlencoded_post_root() {
        let route = AssumeRole {};
        let method = Method::POST;
        let uri = Uri::from_static("/");
        let mut headers = HeaderMap::new();
        headers.insert(header::CONTENT_TYPE, HeaderValue::from_static("application/x-www-form-urlencoded"));
        let mut extensions = Extensions::new();

        assert!(route.is_match(&method, &uri, &headers, &mut extensions));
    }

    #[test]
    fn assume_role_rejects_non_matching_requests() {
        let route = AssumeRole {};
        let uri = Uri::from_static("/");
        let mut headers = HeaderMap::new();
        headers.insert(header::CONTENT_TYPE, HeaderValue::from_static("application/json"));
        let mut extensions = Extensions::new();

        assert!(!route.is_match(&Method::GET, &uri, &headers, &mut extensions));
        assert!(!route.is_match(&Method::POST, &uri, &headers, &mut extensions));
    }

    #[tokio::test]
    async fn default_check_access_rejects_anonymous_request() {
        let route = AssumeRole {};
        let mut req = make_request(None);

        let err = route.check_access(&mut req).await.unwrap_err();

        assert_eq!(*err.code(), crate::S3ErrorCode::AccessDenied);
    }

    #[tokio::test]
    async fn default_check_access_allows_signed_request() {
        let route = AssumeRole {};
        let credentials = Credentials {
            access_key: "AKIAIOSFODNN7EXAMPLE".to_owned(),
            secret_key: SecretKey::from("secret"),
        };
        let mut req = make_request(Some(credentials));

        route.check_access(&mut req).await.unwrap();
    }

    #[tokio::test]
    async fn assume_role_call_returns_not_implemented() {
        let route = AssumeRole {};
        let err = route.call(make_request(None)).await.unwrap_err();

        assert_eq!(*err.code(), crate::S3ErrorCode::NotImplemented);
    }
}