Metadata-Version: 2.1
Name: integrityguard
Version: 0.3.1
Summary: Multiplatform agent for file integrity monitoring. Monitors, generate logs, and notify.
Home-page: https://github.com/bruno-canada/integrityguard
Author: Bruno Bueno
Author-email: integrityguard@fastmail.com
License: MIT license
Keywords: integrityguard
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst

==============
IntegrityGuard
==============

.. image:: https://img.shields.io/pypi/v/integrityguard.svg
        :target: https://pypi.python.org/pypi/integrityguard

.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
     :target: code_of_conduct.md
     :alt: Contributor Covenant

Multiplatform agent for file integrity monitoring (FIM).

The main motivation for this project is to offer all the minimum features required for a reliable FIM that is independent of any other big monitoring platform.

**IMPORTANT**: This project is currently an ALPHA release. Not suitable for production environment, it is still a work in progress.

Features highlight
--------------------

* Simple and centralized configuration YAML file (``config.yml``)
* Generate logs of any changes in real-time for future auditing
* Push notifications to an API endpoint
* Send email alerts
* Supported hashing methods: "md5", "sha1", "sha224", "sha256", "sha384", "sha512"

How to use it
----------------------

1. To install, run ``pip install integrityguard``
2. Edit the configuration file that will be presented after the installation. (``integrityguard.conf``)
3. Generate the reference hashes, run ``integrityguard --task generate_hashes``
4. Start the monitoring, run ``integrityguard --task monitor``

For more information, run ``integrityguard --help``

Call for contributors
----------------------

This project is just at the begining of its development. We're currently looking for engaged and energized people to colaborate and make it awesome.




=======
History
=======

0.3.1 (2022-01-01)
------------------

* Fixed copy config to user issue #11

0.3.0 (2022-01-01)
------------------

* Replaced setuptools data_files feature with copy_config() method #7
* Added new feature to CLI to show paths for the system #8
* Adjusted versioning to 0.3.0 #10

0.2.1 (2021-12-29)
------------------

* Fix version and release history

0.2.0 (2021-12-29)
------------------

* Added support for conf file and multiplataform paths #3
* Adjusted project basic directory structure #4
* Added CLI support #5

0.1.1 (2021-12-28)
------------------

* Adjusted README file.

0.1.0 (2021-12-28)
------------------

* Alpha release on PyPI.


