From 03b174d6b5904b5ea4d7b8aa0d97b6a0120c7053 Mon Sep 17 00:00:00 2001 From: LoneRifle Date: Thu, 7 Mar 2024 15:36:11 +0800 Subject: [PATCH] docs(readme): add workflow seq diagram --- README.md | 2 + docs/workflow-sequence.svg | 116 +++++++++++++++++++++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 docs/workflow-sequence.svg diff --git a/README.md b/README.md index 44c4534..88b33af 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ This codebase is derived from services built for ## Workflow +![Workflow Sequence Diagram](./docs/workflow-sequence.svg) + Files are placed in an S3 bucket for quarantining incoming files. Both this bucket, as well as the S3 bucket for holding files that have been scanned and deemed clean, *must* have versioning enabled. Versioning ensures that the file diff --git a/docs/workflow-sequence.svg b/docs/workflow-sequence.svg new file mode 100644 index 0000000..50c7ee2 --- /dev/null +++ b/docs/workflow-sequence.svg @@ -0,0 +1,116 @@ + + + + + + S3 Clean + + + + + + Lambda + + + + + + S3 Quarantine + + + + + + User + + + + + + + + S3 Clean + + + + + + + + + Lambda + + + + + + + + + S3 Quarantine + + + + + + + + + User + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Upload file + + Trigger scan S3 quarantine bucket with key k1 + + Retrieve quarantine file with key k1 + from S3 quarantine bucket and scan + + After scan complete, dump scanned file stream + into S3 clean bucket and randomised key k2 + + Return key k2 of clean file + + Download clean file with clean key k2 + + Return clean file with clean key k2 + +