summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md17
-rw-r--r--README.md23
-rw-r--r--doc/mat2.112
-rwxr-xr-xmat22
-rw-r--r--setup.py2
5 files changed, 43 insertions, 13 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index dfd81c4..ee65463 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,20 @@
1# 0.4.0 - 2018-10-03
2
3- There is now a policy, for advanced users, to deal with unknown embedded fileformats
4- Improve the documentation
5- Various minor refactoring
6- Improve how corrupted PNG are handled
7- Dangerous/advanced cli's options no longer have short versions
8- Significant improvements to office files anonymisation
9 - Archive members are sorted lexicographically
10 - XML attributes are sorted lexicographically too
11 - RSID are now stripped
12 - Dangling references in [Content_types].xml are now removed
13- Significant improvements to office files support
14- Anonimysed office files can now be opened by MS Office without warnings
15- The CLI isn't threaded anymore, for it was causing issues
16- Various misc typo fix
17
1# 0.3.1 - 2018-09-01 18# 0.3.1 - 2018-09-01
2 19
3- Document how to install MAT2 for various distributions 20- Document how to install MAT2 for various distributions
diff --git a/README.md b/README.md
index 5d25b71..f125d45 100644
--- a/README.md
+++ b/README.md
@@ -44,20 +44,27 @@ $ python3 -m unittest discover -v
44# How to use MAT2 44# How to use MAT2
45 45
46```bash 46```bash
47usage: mat2 [-h] [-v] [-l] [-s | -L] [files [files ...]] 47usage: mat2 [-h] [-v] [-l] [--check-dependencies] [-V]
48 [--unknown-members policy] [-s | -L]
49 [files [files ...]]
48 50
49Metadata anonymisation toolkit 2 51Metadata anonymisation toolkit 2
50 52
51positional arguments: 53positional arguments:
52 files 54 files the files to process
53 55
54optional arguments: 56optional arguments:
55 -h, --help show this help message and exit 57 -h, --help show this help message and exit
56 -v, --version show program's version number and exit 58 -v, --version show program's version number and exit
57 -l, --list list all supported fileformats 59 -l, --list list all supported fileformats
58 -s, --show list all the harmful metadata of a file without removing 60 --check-dependencies check if MAT2 has all the dependencies it needs
59 them 61 -V, --verbose show more verbose status information
60 -L, --lightweight remove SOME metadata 62 --unknown-members policy
63 how to handle unknown members of archive-style files
64 (policy should be one of: abort, omit, keep)
65 -s, --show list harmful metadata detectable by MAT2 without
66 removing them
67 -L, --lightweight remove SOME metadata
61``` 68```
62 69
63Note that MAT2 **will not** clean files in-place, but will produce, for 70Note that MAT2 **will not** clean files in-place, but will produce, for
diff --git a/doc/mat2.1 b/doc/mat2.1
index 26d9e03..3d7d57d 100644
--- a/doc/mat2.1
+++ b/doc/mat2.1
@@ -1,10 +1,10 @@
1.TH MAT2 "1" "September 2018" "MAT2 0.3.1" "User Commands" 1.TH MAT2 "1" "October 2018" "MAT2 0.4.0" "User Commands"
2 2
3.SH NAME 3.SH NAME
4mat2 \- the metadata anonymisation toolkit 2 4mat2 \- the metadata anonymisation toolkit 2
5 5
6.SH SYNOPSIS 6.SH SYNOPSIS
7mat2 [\-h] [\-v] [\-l] [\-c] [\-s | \-L]\fR [files [files ...]] 7\fBmat2\fR [\-h] [\-v] [\-l] [\-V] [-s | -L] [\fIfiles\fR [\fIfiles ...\fR]]
8 8
9.SH DESCRIPTION 9.SH DESCRIPTION
10.B mat2 10.B mat2
@@ -31,9 +31,15 @@ show program's version number and exit
31\fB\-l\fR, \fB\-\-list\fR 31\fB\-l\fR, \fB\-\-list\fR
32list all supported fileformats 32list all supported fileformats
33.TP 33.TP
34fB\-c\fR, \fB\-\-check\-dependencies\fR 34\fB\-\-check\-dependencies\fR
35check if MAT2 has all the dependencies it needs 35check if MAT2 has all the dependencies it needs
36.TP 36.TP
37\fB\-V\fR, \fB\-\-verbose\fR
38show more verbose status information
39.TP
40\fB\-\-unknown-members\fR \fIpolicy\fR
41how to handle unknown members of archive-style files (policy should be one of: abort, omit, keep)
42.TP
37\fB\-s\fR, \fB\-\-show\fR 43\fB\-s\fR, \fB\-\-show\fR
38list harmful metadata detectable by MAT2 without 44list harmful metadata detectable by MAT2 without
39removing them 45removing them
diff --git a/mat2 b/mat2
index 2619728..272cd8f 100755
--- a/mat2
+++ b/mat2
@@ -14,7 +14,7 @@ except ValueError as e:
14 print(e) 14 print(e)
15 sys.exit(1) 15 sys.exit(1)
16 16
17__version__ = '0.3.1' 17__version__ = '0.4.0'
18 18
19def __check_file(filename: str, mode: int=os.R_OK) -> bool: 19def __check_file(filename: str, mode: int=os.R_OK) -> bool:
20 if not os.path.exists(filename): 20 if not os.path.exists(filename):
diff --git a/setup.py b/setup.py
index 246c4df..e893bad 100644
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
5 5
6setuptools.setup( 6setuptools.setup(
7 name="mat2", 7 name="mat2",
8 version='0.3.1', 8 version='0.4.0',
9 author="Julien (jvoisin) Voisin", 9 author="Julien (jvoisin) Voisin",
10 author_email="julien.voisin+mat2@dustri.org", 10 author_email="julien.voisin+mat2@dustri.org",
11 description="A handy tool to trash your metadata", 11 description="A handy tool to trash your metadata",