From a8e7a2c52ad29c6f75193f5653987ac52495feff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bendeg=C3=BAz=20Gy=C3=B6nki?= Date: Sat, 28 Nov 2020 19:17:44 +0100 Subject: [PATCH] Start writing developer documentation --- Developer-documentation.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/Developer-documentation.md b/Developer-documentation.md index 29c8ab0..85c5a60 100644 --- a/Developer-documentation.md +++ b/Developer-documentation.md @@ -1 +1,21 @@ -TODO: write documentation \ No newline at end of file +# Overview of the task + +The task was to implement a security-critical webshop that can be used to sell and buy animated images stored in a custom format. The webshop has to support CAFF (_CrySyS Animated File Format_). The system consists of a web service and a mobile or web client. + +# Overview of the implementation + +During the design phase, we decided to implement a web client. + +Our implementation consists of the following modules: + +- **CAFF previewer** / [caff-previewer](https://github.com/UnstableVortexSecurity/caff-previewer): A program written in C that is used to extract a preview (a single frame) from a CAFF file. The extracted preview is saved in .tga (TARGA) format, which is a simple bitmap image format. +- **CAFF previewer wrapper** / [caff-previewer-wrapper](https://github.com/UnstableVortexSecurity/caff-previewer-wrapper): A wrapper written in Python/Flask that provides a simple HTTP interface between CAFF previewer and the web client. The wrapper also converts the extracted preview to PNG using ImageMagick. +- **Web client** / [webshop](https://github.com/UnstableVortexSecurity/webshop): A web client written in Python/Flask. This client implements the user functions. + +Note: each module is hosted in its own repository. + +# CAFF previewer + +# CAFF previewer wrapper + +# Web client \ No newline at end of file