Mercurial > projects > sencrypt

annotate README @ 7:112d55c825b4 version-2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Release version 2
author Guido Berhoerster <guido+sencrypt@berhoerster.name>
date Tue, 17 Mar 2015 23:02:56 +0100
parents fcaa8b650cdd
children b7309b030e8d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
1 sencrypt
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
2 ========
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
3
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
4 Description
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
5 -----------
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
6
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
7 sencrypt and sdecrypt are utilities for encrypting and decrypting data with the
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
8 AES, DES, 3DES, and RC4 algorithms. It can read keys from files or ask for a
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
9 passphrase and use that together with a salt to derive a key using the PBKDF2
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
10 key derivation function.
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
11
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
12 sencrypt and sdecrypt are portable and compatible reimplementations of the
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
13 encrypt and decrypt utilities in Solaris/Illumos-based operating systems.
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
14
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
15 Build Instructions
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
16 ------------------
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
17
6
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
18 sencrypt requires a POSIX:2004 compatible operating system, it has been tested
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
19 to work on Linux distributions, FreeBSD, Solaris and Illumos-derived
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
20 distributions, UnixWare, and OpenServer. The following tools and shared
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
21 libraries are required to build sencrypt:
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
22
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
23 - GNU make >= 3.81
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
24 - GNU or BSD install
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
25 - OpenSSL
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
26
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
27 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
28
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
29 Before building sencrypt check the commented macros in the Makefile for any
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
30 macros you may need to override depending on the used toolchain and operating
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
31 system.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
32
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
33 By default, all files will be installed under the "/usr/local" directory, a
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
34 different installation path prefix can be set via the `prefix` macro. In
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
35 addition, a second path prefix can be specified via the `DESTDIR` macro which
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
36 will be prepended to any path, incuding the `prefix` macro path prefix. In
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
37 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
38 prepended to paths during installation and not be used for constructing
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
39 internal paths.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
40
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
41 The following instructions assume that `make` is GNU make, on some platforms
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
42 it may be installed under a different name or a non-default path. In order to
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
43 start the build process run `make all`. After a successful build, run `make
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
44 install` to install the program, any associated data files and the
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
45 documentation.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
46
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
47 Previously built binaries, object files, generated data files and
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
48 documentation can be removed by running `make clean`, any additional,
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
49 generated files which are not removed by the `clean` target can be removed by
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
50 running `make clobber`.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
51
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
52 Contact
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
53 -------
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
54
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
55 Please send any feedback, translations or bug reports via email to
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
56 <guido+sencrypt@berhoerster.name>.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
57
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
58 Bug Reports
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
59 -----------
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
60
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
61 When sending bug reports, please always mention the exact version of sencrypt
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
62 with which the issue occurs as well as the version of the operating system you
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
63 are using and make sure that you provide sufficient information to reproduce
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
64 the issue and include any input, output, any error messages.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
65
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
66 In case of build issues, please also specify the implementations and versions
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
67 of the tools and shared libraries used to build the program, in particular the
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
68 compiler.
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
69
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
70 In case of crashes, please generate a stack trace with a suitable debugger
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
71 such as gdb, lldb, dbx, or debug after a crash has occurred either by
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
72 examining the resulting core file or by running the program from the debugger
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
73 and attach it to the bug report. In order to generate a meaningful stack
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
74 trace the program as well as any dynamically linked libraries need to be built
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
75 with debugging information, see the documentation of the used compiler for the
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
76 required compiler flags. If any of the dynamically linked shared libraries do
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
77 not contain debugging information, please either install debugging information
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
78 for these libraries using mechanisms provided by your operating system or
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
79 rebuild the libraries accordingly. Please refer to the documentation of the
fcaa8b650cdd Improve README file
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents: 1
diff changeset
80 debugger for detailed instructions on generating backtraces.
0
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
81
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
82 License
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
83 -------
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
84
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
85 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
86 distributed under the following license terms:
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
87
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
88 Copyright (C) 2014 Guido Berhoerster <guido+sencrypt@berhoerster.name>
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
89
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
90 Permission is hereby granted, free of charge, to any person obtaining
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
91 a copy of this software and associated documentation files (the
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
92 "Software"), to deal in the Software without restriction, including
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
93 without limitation the rights to use, copy, modify, merge, publish,
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
94 distribute, sublicense, and/or sell copies of the Software, and to
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
95 permit persons to whom the Software is furnished to do so, subject to
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
96 the following conditions:
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
97
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
98 The above copyright notice and this permission notice shall be included
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
99 in all copies or substantial portions of the Software.
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
100
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
101 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
102 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
103 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
104 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
105 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
106 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
73af139d1a94 Initial revision
Guido Berhoerster <guido+sencrypt@berhoerster.name>
parents:
diff changeset
107 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.