s3-endpoint 0.1.1

S3-compatible endpoint for upload and object-access workflows.
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
use std::{path::PathBuf, sync::Arc};

use futures_util::future::BoxFuture;
use thiserror::Error;
use tokio::fs::File;

mod checksum;
mod complete_checksum;
mod fs_util;
mod model;
mod multipart;
mod object;
mod temp;

use crate::error::S3Error;
use crate::{
    body::checksum::ChecksumRequest,
    config::{AccessKeyId, IoTuning, UploadLimits},
    s3::types::{BucketName, ObjectKey, PartNumber},
};

pub use crate::s3::types::UploadId;
pub use checksum::{ChecksumAlgorithm, ChecksumType};
pub use model::{
    CommittedPart, CompletedPart, ObjectMetadata, PartMetadata, UploadMetadata, UploadProcessing,
    UploadSession, UploadState,
};
pub use multipart::FileMultipartStore;
pub use object::FileObjectStore;
pub use temp::{StagedObject, TempObjectWriter, TempPartWriter};

/// Shared object store implementation.
pub type SharedObjectStore = Arc<dyn ObjectStore>;
/// Shared multipart store implementation.
pub type SharedMultipartStore = Arc<dyn MultipartStore>;

/// Object storage boundary used by request handlers.
///
/// The default implementation is [`FileObjectStore`]. Custom implementations
/// can wrap the filesystem store or provide alternate persistence while
/// preserving the same S3-visible behavior.
pub trait ObjectStore: Send + Sync + 'static {
    /// Creates a temporary object writer for a bucket/key.
    fn create_temp_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<TempObjectWriter, StoreError>>;

    /// Atomically publishes a staged object and metadata.
    fn commit_staged_object<'a>(
        &'a self,
        staged: StagedObject,
        metadata: ObjectMetadata,
    ) -> BoxFuture<'a, Result<(), StoreError>>;

    /// Reads committed object metadata.
    fn head_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<Option<ObjectMetadata>, StoreError>>;

    /// Opens a committed object for streaming.
    fn open_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<Option<(ObjectMetadata, File)>, StoreError>>;

    /// Deletes object metadata and bytes.
    fn delete_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<(), StoreError>>;
}

impl ObjectStore for FileObjectStore {
    fn create_temp_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<TempObjectWriter, StoreError>> {
        Box::pin(FileObjectStore::create_temp_object(self, bucket, key))
    }

    fn commit_staged_object<'a>(
        &'a self,
        staged: StagedObject,
        metadata: ObjectMetadata,
    ) -> BoxFuture<'a, Result<(), StoreError>> {
        Box::pin(FileObjectStore::commit_staged_object(
            self, staged, metadata,
        ))
    }

    fn head_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<Option<ObjectMetadata>, StoreError>> {
        Box::pin(FileObjectStore::head_object(self, bucket, key))
    }

    fn open_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<Option<(ObjectMetadata, File)>, StoreError>> {
        Box::pin(FileObjectStore::open_object(self, bucket, key))
    }

    fn delete_object<'a>(
        &'a self,
        bucket: &'a BucketName,
        key: &'a ObjectKey,
    ) -> BoxFuture<'a, Result<(), StoreError>> {
        Box::pin(FileObjectStore::delete_object(self, bucket, key))
    }
}

/// Inputs for completing a multipart upload.
pub struct CompleteUploadRequest<'a> {
    /// Object store that receives the completed object.
    pub object_store: &'a dyn ObjectStore,
    /// Multipart upload ID.
    pub upload_id: &'a UploadId,
    /// Client-requested parts in completion order.
    pub requested_parts: &'a [CompletedPart],
    /// Requested checksum validation.
    pub checksum_request: &'a ChecksumRequest,
    /// Upload size limits.
    pub upload_limits: &'a UploadLimits,
    /// I/O buffer tuning.
    pub io_tuning: &'a IoTuning,
    /// Upload processing context.
    pub processing: UploadProcessing<'a>,
}

/// Multipart storage boundary used by request handlers.
pub trait MultipartStore: Send + Sync + 'static {
    /// Creates and persists a new multipart upload session.
    fn create_upload<'a>(
        &'a self,
        bucket: BucketName,
        key: ObjectKey,
        owner_access_key_id: Option<AccessKeyId>,
        metadata: UploadMetadata,
    ) -> BoxFuture<'a, Result<UploadSession, StoreError>>;

    /// Returns a snapshot of an upload session.
    fn get_upload(&self, upload_id: &UploadId) -> Option<UploadSession>;

    /// Creates a temporary part writer for an open upload.
    fn create_temp_part<'a>(
        &'a self,
        upload_id: &'a UploadId,
        part_number: PartNumber,
    ) -> BoxFuture<'a, Result<TempPartWriter, StoreError>>;

    /// Atomically publishes a temporary part.
    fn commit_part<'a>(
        &'a self,
        upload_id: &'a UploadId,
        part_number: PartNumber,
        temp: TempPartWriter,
        part: CommittedPart,
    ) -> BoxFuture<'a, Result<PartMetadata, StoreError>>;

    /// Aborts an open upload and deletes its temporary storage.
    fn abort_upload<'a>(&'a self, upload_id: &'a UploadId)
    -> BoxFuture<'a, Result<(), StoreError>>;

    /// Completes an open multipart upload into a committed object.
    fn complete_upload<'a>(
        &'a self,
        request: CompleteUploadRequest<'a>,
    ) -> BoxFuture<'a, Result<ObjectMetadata, StoreError>>;
}

impl MultipartStore for FileMultipartStore {
    fn create_upload<'a>(
        &'a self,
        bucket: BucketName,
        key: ObjectKey,
        owner_access_key_id: Option<AccessKeyId>,
        metadata: UploadMetadata,
    ) -> BoxFuture<'a, Result<UploadSession, StoreError>> {
        Box::pin(FileMultipartStore::create_upload(
            self,
            bucket,
            key,
            owner_access_key_id,
            metadata,
        ))
    }

    fn get_upload(&self, upload_id: &UploadId) -> Option<UploadSession> {
        FileMultipartStore::get_upload(self, upload_id)
    }

    fn create_temp_part<'a>(
        &'a self,
        upload_id: &'a UploadId,
        part_number: PartNumber,
    ) -> BoxFuture<'a, Result<TempPartWriter, StoreError>> {
        Box::pin(FileMultipartStore::create_temp_part(
            self,
            upload_id,
            part_number,
        ))
    }

    fn commit_part<'a>(
        &'a self,
        upload_id: &'a UploadId,
        part_number: PartNumber,
        temp: TempPartWriter,
        part: CommittedPart,
    ) -> BoxFuture<'a, Result<PartMetadata, StoreError>> {
        Box::pin(FileMultipartStore::commit_part(
            self,
            upload_id,
            part_number,
            temp,
            part,
        ))
    }

    fn abort_upload<'a>(
        &'a self,
        upload_id: &'a UploadId,
    ) -> BoxFuture<'a, Result<(), StoreError>> {
        Box::pin(FileMultipartStore::abort_upload(self, upload_id))
    }

    fn complete_upload<'a>(
        &'a self,
        request: CompleteUploadRequest<'a>,
    ) -> BoxFuture<'a, Result<ObjectMetadata, StoreError>> {
        Box::pin(FileMultipartStore::complete_upload(self, request))
    }
}

#[derive(Debug, Error)]
/// Errors returned by filesystem object and multipart stores.
pub enum StoreError {
    /// Filesystem I/O failed.
    #[error("storage I/O failed")]
    Io(#[from] std::io::Error),

    /// Persisted JSON metadata could not be encoded or decoded.
    #[error("failed to encode or decode storage metadata")]
    Json(#[from] serde_json::Error),

    /// A persisted file path did not match the expected storage layout.
    #[error("invalid storage path: {0}")]
    InvalidPath(PathBuf),

    /// An upload ID was not a canonical UUID path segment.
    #[error("invalid upload ID")]
    InvalidUploadId,

    /// The requested multipart upload does not exist or is no longer open.
    #[error("multipart upload does not exist")]
    NoSuchUpload,

    /// The requested multipart part is missing, duplicated, or inconsistent.
    #[error("multipart upload part is invalid")]
    InvalidPart,

    /// A non-final multipart part is below the configured minimum size.
    #[error("multipart upload part is smaller than the minimum allowed size")]
    EntityTooSmall,

    /// An object, part, or completed multipart object exceeds configured limits.
    #[error("entity is larger than the maximum allowed size")]
    EntityTooLarge,

    /// Final object checksum validation failed.
    #[error("checksum validation failed")]
    Checksum(S3Error),

    /// Upload middleware rejected or failed a staged object.
    #[error("upload processor failed")]
    Processor(S3Error),
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        body::checksum::ChecksumRequest,
        config::UploadLimits,
        s3::types::{BucketName, ETag, ObjectKey, PartNumber, RequestId},
        storage::complete_checksum::MultipartCompleteChecksumState,
    };
    use axum::http::{HeaderMap, HeaderValue};
    use base64::{Engine, engine::general_purpose::STANDARD as BASE64};
    use chrono::{TimeZone, Utc};
    use std::{collections::BTreeMap, sync::Arc, time::Duration};

    #[test]
    fn upload_session_deserialization_defaults_missing_state_to_open() {
        let upload_id = UploadId::new();
        let upload_id_value = upload_id.as_str();
        let json = format!(
            r#"{{
              "upload_id": "{upload_id_value}",
              "bucket": "test-bucket",
              "key": "key.txt",
              "initiated": "2026-06-16T00:00:00Z",
              "metadata": {{}},
              "parts": {{}}
            }}"#
        );

        let session = serde_json::from_str::<UploadSession>(&json).expect("session");

        assert_eq!(session.state, UploadState::Open);
        assert!(session.owner_access_key_id.is_none());
        assert!(session.is_open());
    }

    #[test]
    fn upload_metadata_serializes_checksum_enums_as_s3_values() {
        let metadata = UploadMetadata {
            checksum_algorithm: Some(ChecksumAlgorithm::Crc32c),
            checksum_type: Some(ChecksumType::FullObject),
            ..UploadMetadata::default()
        };

        let json = serde_json::to_value(&metadata).expect("serialize metadata");

        assert_eq!(json["checksum_algorithm"], "CRC32C");
        assert_eq!(json["checksum_type"], "FULL_OBJECT");
        assert_eq!(
            serde_json::from_value::<UploadMetadata>(json)
                .expect("deserialize metadata")
                .checksum_algorithm,
            Some(ChecksumAlgorithm::Crc32c)
        );
    }

    #[tokio::test]
    async fn multipart_store_rejects_part_creation_for_non_open_upload() {
        let temp_dir = tempfile::tempdir().expect("create temp dir");
        let store = FileMultipartStore::new(temp_dir.path().to_path_buf())
            .await
            .expect("store");
        let upload_id = UploadId::new();
        let session = UploadSession {
            upload_id: upload_id.clone(),
            bucket: BucketName::parse("test-bucket").expect("bucket"),
            key: ObjectKey::parse("key.txt").expect("key"),
            initiated: Utc::now(),
            state: UploadState::Completing,
            owner_access_key_id: None,
            metadata: UploadMetadata::default(),
            parts: BTreeMap::new(),
        };
        store.sessions.insert(upload_id.clone(), session);

        let result = store
            .create_temp_part(&upload_id, PartNumber::parse(1).expect("part number"))
            .await;

        assert!(matches!(result, Err(StoreError::NoSuchUpload)));
    }

    #[tokio::test]
    async fn multipart_completion_failure_restores_upload_to_open() {
        let temp_dir = tempfile::tempdir().expect("create temp dir");
        let object_store = FileObjectStore::new(temp_dir.path().to_path_buf())
            .await
            .expect("object store");
        let multipart_store = FileMultipartStore::new(temp_dir.path().to_path_buf())
            .await
            .expect("multipart store");
        let upload = multipart_store
            .create_upload(
                BucketName::parse("test-bucket").expect("bucket"),
                ObjectKey::parse("key.txt").expect("key"),
                None,
                UploadMetadata::default(),
            )
            .await
            .expect("create upload");
        let checksum_request =
            ChecksumRequest::from_headers(&HeaderMap::new()).expect("empty checksum request");

        let result = multipart_store
            .complete_upload(CompleteUploadRequest {
                object_store: &object_store,
                upload_id: &upload.upload_id,
                requested_parts: &[CompletedPart {
                    part_number: PartNumber::parse(1).expect("part number"),
                    etag: ETag::parse("\"missing\"").expect("etag"),
                }],
                checksum_request: &checksum_request,
                upload_limits: &UploadLimits::default(),
                io_tuning: &crate::config::IoTuning::default(),
                processing: UploadProcessing {
                    request_id: &RequestId::new(),
                    upload_processors: &[],
                },
            })
            .await;

        assert!(matches!(result, Err(StoreError::InvalidPart)));
        let upload = multipart_store
            .get_upload(&upload.upload_id)
            .expect("upload remains");
        assert_eq!(upload.state, UploadState::Open);
        multipart_store
            .create_temp_part(
                &upload.upload_id,
                PartNumber::parse(1).expect("part number"),
            )
            .await
            .expect("part creation after failed completion");
    }

    #[tokio::test]
    async fn multipart_store_startup_removes_terminal_upload_sessions() {
        let temp_dir = tempfile::tempdir().expect("create temp dir");
        let open_upload_id = UploadId::new();
        let completed_upload_id = UploadId::new();
        let aborted_upload_id = UploadId::new();

        for (upload_id, state) in [
            (open_upload_id.clone(), UploadState::Open),
            (completed_upload_id.clone(), UploadState::Completed),
            (aborted_upload_id.clone(), UploadState::Aborted),
        ] {
            let upload_dir = temp_dir.path().join("multipart").join(upload_id.as_str());
            std::fs::create_dir_all(upload_dir.join("parts")).expect("create upload dir");
            let session = UploadSession {
                upload_id,
                bucket: BucketName::parse("test-bucket").expect("bucket"),
                key: ObjectKey::parse("key.txt").expect("key"),
                initiated: Utc::now(),
                state,
                owner_access_key_id: None,
                metadata: UploadMetadata::default(),
                parts: BTreeMap::new(),
            };
            std::fs::write(
                upload_dir.join("session.json"),
                serde_json::to_vec_pretty(&session).expect("session json"),
            )
            .expect("write session");
        }

        let store = FileMultipartStore::new(temp_dir.path().to_path_buf())
            .await
            .expect("store");

        assert!(store.get_upload(&open_upload_id).is_some());
        assert!(store.get_upload(&completed_upload_id).is_none());
        assert!(store.get_upload(&aborted_upload_id).is_none());
        assert!(
            temp_dir
                .path()
                .join("multipart")
                .join(open_upload_id.as_str())
                .exists()
        );
        assert!(
            !temp_dir
                .path()
                .join("multipart")
                .join(completed_upload_id.as_str())
                .exists()
        );
        assert!(
            !temp_dir
                .path()
                .join("multipart")
                .join(aborted_upload_id.as_str())
                .exists()
        );
    }

    #[tokio::test]
    async fn multipart_store_startup_removes_expired_open_upload_sessions() {
        let temp_dir = tempfile::tempdir().expect("create temp dir");
        let upload_id = UploadId::new();
        let upload_dir = temp_dir.path().join("multipart").join(upload_id.as_str());
        std::fs::create_dir_all(upload_dir.join("parts")).expect("create upload dir");
        let now = Utc
            .with_ymd_and_hms(2026, 6, 17, 12, 0, 0)
            .single()
            .expect("current time");
        let session = UploadSession {
            upload_id: upload_id.clone(),
            bucket: BucketName::parse("test-bucket").expect("bucket"),
            key: ObjectKey::parse("key.txt").expect("key"),
            initiated: now - chrono::Duration::hours(2),
            state: UploadState::Open,
            owner_access_key_id: None,
            metadata: UploadMetadata::default(),
            parts: BTreeMap::new(),
        };
        std::fs::write(
            upload_dir.join("session.json"),
            serde_json::to_vec_pretty(&session).expect("session json"),
        )
        .expect("write session");

        let store = FileMultipartStore::new_with_options(
            temp_dir.path().to_path_buf(),
            crate::config::MultipartLifecycle::builder()
                .abort_incomplete_after(Duration::from_secs(60 * 60))
                .build(),
            Arc::new(move || now),
        )
        .await
        .expect("store");

        assert!(store.get_upload(&upload_id).is_none());
        assert!(!upload_dir.exists());
    }

    #[test]
    fn multipart_complete_checksum_state_is_empty_without_requested_checksums() {
        let headers = HeaderMap::new();
        let request = ChecksumRequest::from_headers(&headers).expect("checksum request");

        let state = MultipartCompleteChecksumState::new(&request);
        let enabled = state.enabled_digests();

        assert!(!enabled.md5);
        assert!(!enabled.sha1);
        assert!(!enabled.sha256);
        assert!(!enabled.sha512);
        assert!(!enabled.crc32);
        assert!(!enabled.crc32c);
    }

    #[test]
    fn multipart_complete_checksum_state_enables_requested_digests() {
        let mut headers = HeaderMap::new();
        headers.insert(
            "content-md5",
            HeaderValue::from_static("AAAAAAAAAAAAAAAAAAAAAA=="),
        );
        headers.insert(
            "x-amz-checksum-crc32c",
            HeaderValue::from_static("AAAAAA=="),
        );
        headers.insert(
            "x-amz-checksum-sha1",
            HeaderValue::from_str(&BASE64.encode([0_u8; 20])).expect("header"),
        );
        let request = ChecksumRequest::from_headers(&headers).expect("checksum request");

        let state = MultipartCompleteChecksumState::new(&request);
        let enabled = state.enabled_digests();

        assert!(enabled.md5);
        assert!(enabled.sha1);
        assert!(!enabled.sha256);
        assert!(!enabled.sha512);
        assert!(!enabled.crc32);
        assert!(enabled.crc32c);
    }
}