From 7992cd0d51c3b858f36e74abd76ceef986b51df8 Mon Sep 17 00:00:00 2001
From: jvoisin
Date: Sun, 1 Apr 2018 15:36:45 +0200
Subject: Add some documentation

---
 doc/implementation_notes.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 doc/implementation_notes.md

(limited to 'doc/implementation_notes.md')

diff --git a/doc/implementation_notes.md b/doc/implementation_notes.md
new file mode 100644
index 0000000..bc83671
--- /dev/null
+++ b/doc/implementation_notes.md
@@ -0,0 +1,33 @@
+Implementation notes
+====================
+
+Symlink attacks
+---------------
+
+MAT2 output predictable filenames (like yourfile.jpg.cleaned).
+This may lead to symlink attack. Please check if you OS prevent
+against them
+
+Archives handling
+-----------------
+
+MAT2 doesn't support archives yet, because we haven't found an usable way to ask the user
+what to do when a non-supported files are encountered.
+
+PDF handling
+------------
+
+MAT was doing some kind of rendering for PDF files, on a cairo surface, then
+printed it to a file. This kept the text selectable, but unfortunately, it
+didn't remove any *deep metadata*, like the ones in embedded pictures. This was
+on of the reason MAT was abandoned: the absence of satisfying solution to
+handle PDF. But apparently, people are ok with [pdf redact
+tools](https://github.com/firstlookmedia/pdf-redact-tools), that simply
+transform the PDF into images. So this is what's MAT2 is doing too.
+
+Images handling
+---------------
+
+When possible, images are handled like PDF: rendered on a surface, then saved
+to the filesystem. This ensures that every metadata is removed.
+
-- 
cgit v1.3