-
Notifications
You must be signed in to change notification settings - Fork 4
/
README
130 lines (76 loc) · 2.21 KB
/
README
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
fxor
====
fxor - a tool to encrypt/decrypt a file using XOR operation to do one-time pad
Syntax
======
fxor IN_FILE KEY_FILE
fxor IN_FILE KEY_FILE OUT_FILE [OPTION]
Display usage information:
fxor --help
Display version and copyright information:
fxor --version
Description
===========
fxor is a tool that you can use to encrypt/decrypt IN_FILE content
with KEY_FILE content using XOR operation, and output to:
* The file OUT_FILE.
* STDOUT if OUT_FILE not defined.
fxor can be used as OTP (One-Time Pad) tool.
IN_FILE: Input file name, Witch will processed.
KEY_FILE: Key file name, Usually random bytes file.
OUT_FILE: Output file name.
Options
=======
-r Overwrite (destroy contents) OUT_FILE then output
-s Start output from OUT_FILE beginning and replace bytes,
Perfect to encrypt/decrypt IN_FILE and output to IN_FILE!
Examples
========
Output to OUT_FILE (overwrite if exist):
fxor IN_FILE KEY_FILE OUT_FILE -r
Output to OUT_FILE and replace byte by byte from beginning:
fxor IN_FILE KEY_FILE OUT_FILE -s
Output to STDOUT:
fxor IN_FILE KEY_FILE
Versioning
==========
fxor follows the [semantic versioning](http://semver.org) scheme.
fxor releases
=============
* fxor releases: https://github.com/abderraouf-adjal/fxor/releases
fxor on GitHub
==============
<https://github.com/abderraouf-adjal/fxor>
fxor FAQ
========
See the file 'FAQ' for details.
Requirements
============
C99 GCC-compatible compiler, e.g.: gcc, clang.
unix-like OS, e.g.: GNU/Linux, *BSD.
Installation
============
After you unpack the distribution tarball and change into the source directory:
Compile:
--------
% make
Install:
--------
% make install
You can install/copy files in a different destination:
% make PREFIX="/directory/directory" install
Uninstall:
----------
% make uninstall
Or:
% make PREFIX="/directory/directory" uninstall
Reporting bugs
==============
Report fxor bugs to: <abderraouf.adjal@gmail.com>
Or create an issue on GitHub:
<https://github.com/abderraouf-adjal/fxor/issues>
Copyright
=========
Copyright (c) 2014-2015 Abderraouf Adjal. All rights reserved.
License: BSD 2-Clause License (Simplified BSD License). There is NO WARRANTY.
See the file 'COPYING' for details.