Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
build/ | H | 03-May-2022 | - | 26,397 | 21,158 | |
contrib/ | H | 20-Apr-2021 | - | 85 | 68 | |
dev-tools/libexec/ | H | 20-Apr-2021 | - | 118 | 37 | |
doc/ | H | 20-Apr-2021 | - | 1,004 | 715 | |
etc/ | H | 20-Apr-2021 | - | 810 | 705 | |
lib/ | H | 20-Apr-2021 | - | 4,191 | 3,430 | |
src/ | H | 03-May-2022 | - | 15,361 | 7,121 | |
tests/ | H | 03-May-2022 | - | 14,162 | 10,203 | |
util/ | H | 20-Apr-2021 | - | 1,502 | 1,067 | |
COPYING | H A D | 20-Apr-2021 | 17.7 KiB | 340 | 281 | |
ChangeLog | H A D | 20-Apr-2021 | 24.9 KiB | 602 | 485 | |
Makefile.am | H A D | 20-Apr-2021 | 2.6 KiB | 142 | 67 | |
Makefile.in | H A D | 20-Apr-2021 | 31.9 KiB | 1,012 | 845 | |
README.md | H A D | 03-May-2022 | 11.2 KiB | 170 | 98 | |
aclocal.m4 | H A D | 20-Apr-2021 | 43 KiB | 1,201 | 1,092 | |
config.h.in | H A D | 20-Apr-2021 | 9.8 KiB | 373 | 250 | |
configure | H A D | 20-Apr-2021 | 690.2 KiB | 22,720 | 18,578 | |
configure.ac | H A D | 03-May-2022 | 37 KiB | 845 | 671 |
README.md
1# Snoopy Logger 2 3 4 5## Table of contents 6 7* [What is Snoopy?](#what-is-snoopy) 8* [News](#news) 9* [Latest version](#latest-version) 10* [Installation](#installation) 11* [Output](#output) 12* [Configuration](#configuration) 13* [FAQ - Frequently asked questions](#faq-frequently-asked-questions) 14* [Security disclaimer](#security-disclaimer) 15* [Contributing to Snoopy development](#contributing-to-snoopy-development) 16* [Getting support](#getting-support) 17* [License](#license) 18* [Online resources](#online-resources) 19* [Credits](#credits) 20 21 22 23## What is Snoopy? 24 25Snoopy is a small library that logs all program executions on your Linux/BSD system. 26 27[Developer documentation](doc/HACKING-INTERNALS.md) outlines how it actually does that (a fairly technical read). 28And don't miss the [security disclaimer](#security-disclaimer) about it. 29 30 31 32## News 33 34| Date | What? | Details | 35| ------------ | ------------------------ | --------- | 36| 2021-04-20 | Snoopy 2.4.14 released. | Bugfix release (long commands can cause segmentation fault, [#198](https://github.com/a2o/snoopy/issues/198)). | 37| 2021-04-14 | Snoopy 2.4.13 released. | Minor enhancement release (added custom datetime formatting support). | 38| 2021-02-09 | Snoopy 2.4.12 released. | Maintenance release - fairly important, see [#191](https://github.com/a2o/snoopy/issues/191) for details. | 39| 2021-02-02 | Snoopy 2.4.11 released. | Maintenance release. | 40| 2020-11-30 | Snoopy 2.4.10 released. | <br/> **IMPORTANT NOTICE:** This Snoopy version contains a bugfix for a condition ([#119](https://github.com/a2o/snoopy/issues/119)) that can make your systems unstable in specific situations. <br/> **All users are encouraged to upgrade to this version of Snoopy ASAP**. | 41| 2020-11-13 | Snoopy 2.4.9 released. | Maintenance release. On Friday 13th - let's hope for the best! :wink: | 42| 2020-10-04 | Snoopy 2.4.8 released. | Maintenance release. | 43 44Consult [ChangeLog](ChangeLog) for more information. 45 46 47 48## Latest version 49 50| Latest release | Version | Status | Download location | 51| -------------- | -------- | ------ | ----------------- | 52| Stable | 2.4.14 | [![Build QA - OS Matrix (Large) / stable](https://github.com/a2o/snoopy/workflows/Build%20QA%20-%20OS%20Matrix%20(Large)/badge.svg?branch=snoopy-2.4.14)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Build+QA+-+OS+Matrix%20(Large)%22+branch%3Asnoopy-%2A) <br/> [![Build QA - Config Matrix (Large) / stable](https://github.com/a2o/snoopy/workflows/Build%20QA%20-%20Config%20Matrix%20(Large)/badge.svg?branch=snoopy-2.4.14)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Build+QA+-+Config+Matrix+%28Large%29%22+branch%3Asnoopy-%2A) <br/> [![Code QA - Autoreconf / stable](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Autoreconf/badge.svg?branch=snoopy-2.4.14)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Autoreconf%22+branch%3Asnoopy-%2A) <br/> [![Code QA - Autoscan / stable](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Autoscan/badge.svg?branch=snoopy-2.4.14)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Autoscan%22+branch%3Asnoopy-%2A) <br/> [![Code QA - Valgrind / stable](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Valgrind/badge.svg?branch=snoopy-2.4.14)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Valgrind%22+branch%3Asnoopy-%2A) | All release packages can be found over there :point_right: in the [Releases](https://github.com/a2o/snoopy/releases) section. | 53| Development | `master` | [![Build QA - OS Matrix (Large) / master](https://github.com/a2o/snoopy/workflows/Build%20QA%20-%20OS%20Matrix%20(Large)/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Build+QA+-+OS+Matrix+%28Large%29%22+branch%3Amaster) <br/> [![Build QA - Config Matrix / master](https://github.com/a2o/snoopy/workflows/Build%20QA%20-%20Config%20Matrix%20(Large)/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Build+QA+-+Config+Matrix+%28Large%29%22+branch%3Amaster) <br/> [![Code QA - Autoreconf / master](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Autoreconf/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Autoreconf%22+branch%3Amaster) <br/> [![Code QA - Autoscan / master](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Autoscan/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Autoscan%22+branch%3Amaster) <br/> [![Code QA - Valgrind / master](https://github.com/a2o/snoopy/workflows/Code%20QA%20-%20Valgrind/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Code+QA+-+Valgrind%22+branch%3Amaster) <br/> [![Coverity Scan](https://scan.coverity.com/projects/4973/badge.svg?flat=1)](https://scan.coverity.com/projects/4973) <br/> SonarCloud: <br/> [![SonarCloud - Bugs](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=bugs)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Code Smells](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=code_smells)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Coverage](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=coverage)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=alert_status)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Security Rating](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=security_rating)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=sqale_index)](https://sonarcloud.io/dashboard?id=snoopy) <br/> [![SonarCloud - Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=snoopy&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=snoopy) | `git clone git:github.com:a2o/snoopy` | 54 55 56 57## Installation 58 59[![Install QA - README.md / master](https://github.com/a2o/snoopy/workflows/Install%20QA%20-%20README.md/badge.svg?branch=master)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Install+QA+-+README.md%22+branch%3Amaster) 60[![Install QA - install-snoopy.sh / install](https://github.com/a2o/snoopy/workflows/Install%20QA%20-%20install-snoopy.sh/badge.svg?branch=install)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Install+QA+-+install-snoopy.sh%22+branch%3Ainstall) 61[![Install QA - OS Matrix - Install from git](https://github.com/a2o/snoopy/workflows/Install%20QA%20-%20OS%20Matrix/badge.svg?branch=install)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Install+QA+-+OS+Matrix%22+branch%3Ainstall) 62[![Release QA - OS Matrix - Install from source](https://github.com/a2o/snoopy/workflows/Release%20QA%20-%20OS%20Matrix%20-%20Install%20from%20source/badge.svg)](https://github.com/a2o/snoopy/actions?query=workflow%3A%22Release+QA+-+OS+Matrix+-+Install+from+source%22) 63 64The simplest way to start using the latest Snoopy is to execute the following commands (as root): 65```shell 66wget -O install-snoopy.sh https://github.com/a2o/snoopy/raw/install/install/install-snoopy.sh && 67chmod 755 install-snoopy.sh && 68sudo ./install-snoopy.sh stable 69``` 70That's all. 71 72Other installation options (i.e. installing latest development version from this 73git repository) are described in the [doc/INSTALL.md](doc/INSTALL.md) document. 74 75 76 77## Output 78 79This is what typical Snoopy output looks like: 80 81 2015-02-11T19:05:10+00:00 labrat-1 snoopy[896]: [uid:0 sid:11679 tty:/dev/pts/2 cwd:/root filename:/usr/bin/cat]: cat /etc/fstab.BAK 82 2015-02-11T19:05:15+00:00 labrat-1 snoopy[896]: [uid:0 sid:11679 tty:/dev/pts/2 cwd:/root filename:/usr/bin/rm]: rm -f /etc/fstab.BAK 83 2015-02-11T19:05:19+00:00 labrat-1 snoopy[896]: [uid:0 sid:11679 tty:/dev/pts/2 cwd:/root filename:/usr/bin/tail]: tail -f /var/log/messages 84 85These are default output locations on various Linux distributions: 86 87| Distribution | Snoopy output location | Notes | 88| ------------ | ---------------------- |---------------------------------- | 89| CentOS | `/var/log/secure` | | 90| Debian | `/var/log/auth.log` | | 91| Ubuntu | `/var/log/auth.log` | | 92| (others) | `/var/log/messages` | (potentially, could be elsewhere) | 93 94For actual output format and destination, check your Snoopy and syslog configuration. 95 96 97 98## Configuration 99 100If the configuration file support is available in your Snoopy build (it probably is), 101Snoopy can be reconfigured on-the-fly. 102 103The configuration file is (most likely, but depending on the build) located at `/etc/snoopy.ini`. 104 105Supported configuration directives are explained in the [default configuration file](etc/snoopy.ini.in). 106 107 108 109## FAQ - Frequently asked questions 110 111Frequently asked questions and answers are collected in the [doc/FAQ.md](https://github.com/a2o/snoopy/blob/master/doc/FAQ.md) file in this repository. 112 113 114 115## Security disclaimer 116 117**WARNING: Snoopy is not a reliable auditing solution.** 118 119Rogue users can easily manipulate environment to avoid their actions being logged by Snoopy. 120Consult [this FAQ entry](https://github.com/a2o/snoopy/blob/master/doc/FAQ.md#5-i-see-no-snoopy-output-after-initial-user-login) for more information. 121 122 123 124## Contributing to Snoopy development 125 126Consult the following documents for information related to Snoopy development: 127 128- [CONTRIBUTING.md](.github/CONTRIBUTING.md) 129- [HACKING-OVERVIEW.md](doc/HACKING-OVERVIEW.md) 130- [HACKING-INTERNALS.md](doc/HACKING-INTERNALS.md) 131- [HACKING-QA.md](doc/HACKING-QA.md) (Autoscan, Travis-CI and Valgrind-related sections) 132 133 134 135## Getting support 136 137Information is available in a [dedicated document about getting support](https://github.com/a2o/snoopy/blob/master/doc/GETTING-SUPPORT.md). 138 139 140 141## License 142 143Snoopy is released under [GNU General Public License version 2](https://github.com/a2o/snoopy/blob/master/COPYING). 144 145 146 147## Online resources 148 149Snoopy development is located at the following URI: 150- https://github.com/a2o/snoopy/ 151 152Additional git repository mirrors (read-only) are available here: 153- https://gitlab.com/a2o/snoopy/ 154- https://bitbucket.org/snoopylogger/snoopy/ 155 156 157 158## Credits 159 160Snoopy Logger was originally created and maintained by: 161- Marius Aamodt Eriksen <marius@umich.edu> 162- Mike Baker <mbm@linux.com> 163 164Contribution acknowledgements are available at the following locations: 165- In the [ChangeLog](ChangeLog), 166- In [pull requests](https://github.com/a2o/snoopy/pulls), 167- In [git history](https://github.com/a2o/snoopy/commits/master). 168 169Snoopy is currently maintained by [Bostjan Skufca Jese](https://github.com/bostjan). 170