-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
145 lines (93 loc) · 4.76 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
================================================================================
Lynis - README
================================================================================
Author: Michael Boelen (michael@rootkit.nl)
Description: Security and system auditing tool
Web site: http://www.rootkit.nl/projects/lynis.html
Development start: May 2007
Support policy: See section 'Support'
Documentation: See web site, README, FAQ and CHANGELOG file
================================================================================
== Web site contains up-to-date documentation ==
See http://www.rootkit.nl/files/lynis-documentation.html
[+] Introduction
-------------------------------
Lynis is an auditing tool which tests and gathers (security) information from
Unix based systems. The audience for this tool are security and system
auditors, network specialists and system maintainers.
Some of the (future) features and usage options:
- System and security audit checks
- File Integrity Assessment
- System and file forensics
- Usage of templates/baselines (reporting and monitoring)
- Extended debugging features
The name Lynis is fictive and does not have a special meaning. Everyone is free
to use Lynis under the conditions of the GPL v3 license (see LICENSE file).
========================
Quick facts
========================
- Name: Lynis
- Type: audit, security, forensics tool
- License: GPL v3
- Language: Shell script
- Author: Michael Boelen
- Web site: http://www.rootkit.nl
- Required permissions: root or equivalent
- Other requirements: write access to /var/log and /tmp
[+] Installation
-------------------------------
Lynis doesn't have to be installed, so it can be used directly from a
(removable) disk. If you want the program to be installed, use one of the
following methods:
- Create a custom directory (ie. /usr/local/lynis) and unpack the tarball
(tar xfvz lynis-version.tar.gz) into this directory.
- Create a RPM package by using the lynis.spec file (see web site)
run 'rpmbuild -ta lynis-version.tar.gz' (= build RPM package)
run 'rpm -ivh <filename>' (= install RPM package)
========================
Upgrade tip:
========================
If you want to upgrade easily, make a shell script which removes an old
installation, then unpacks and installs the new version. However, don't
forget to migrate your dynamic files (like report / profile files).
Or better: split these files up and make sure that you always use the right ones
(especially with automated scanning).
[+] Supported systems
-------------------------------
Since the complexity of auditing different systems and platforms, Lynis is
developed on BSD and Linux.
This tool is tested or confirmed to work with:
AIX, Linux, FreeBSD, OpenBSD, Mac OS X, Solaris
[+] Usage
-------------------------------
See online documentation for more information about using Lynis.
[+] Development
-------------------------------
If you have input to improve Lynis, let me know via the contact form. Although
no additional developers are needed at this moment, you are free to send patches or
input for consideration.
[+] Support
-------------------------------
Lynis is tested on the most common operating systems. The documentation (README,
FAQ) and the debugging information in the log file should cover most questions and
problems. Bugs can be reported by filling in the contact form at the web site.
NOTE: User related questions should not be asked via the contact form. Read the
documentation, the website resources and the log file for answers to common problems.
Commercial support is available under strict conditions and depends on the request.
For more information fill in the contact form and describe what kind of service is
requested.
[+] Project donations
-------------------------------
Individuals and companies which use this software for more than 10 systems, should
consider the value of this tool. To improve my tools, I rely on internet sources,
lots of books and a huge amount of time (spare time) investment. Book donations
are highly appreciated and stimulate development.
[+] Thanks
-------------------------------
Thanks to the community for using and supporting open source software and my tools
in particular. Many comments, bugs/patches and questions are the key to success
and motivation in developing tools like this.
A special thanks to anyone who donated a book or valuable suggestions in the past!
================================================================================
Lynis - Copyright 2007-2012, Michael Boelen - The Netherlands
http://www.rootkit.nl