
================================================================================

  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:
  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, feel free to drop a note. However, for the
  time being no project group will be formed. Patches will be considered.



[+] 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: The contact form is NOT a place for user questions. Questions (or the answer
  to it) which can be found in the docs, the web site or log file will be discarded and
  bounced with a small line referring to the source which can help you. This is to
  avoid answering the same questions over and over, encouraging the user to read the
  documentation and to make programming time more efficient.

  Commercial support is available under strict conditions and depends on the request.
  For more information fill in the contact form, regarding this.



[+] 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 input in the past!




================================================================================
 Lynis - Copyright 2007-2008, Michael Boelen - The Netherlands
 http://www.rootkit.nl
