Skip to content

🐙 octoconf - tool dedicated to the realization of configuration audits of various assets

License

Notifications You must be signed in to change notification settings

nillyr/octoconf

Repository files navigation

octoconf



Tool dedicated to the realization of configuration audits.

        ,'""`.       octoconf 2.4.0-beta
       / _  _ \
       |(@)(@)|      Tool dedicated to the realization
       )  __  (      of configuration audits.
      /,'))((`.\
     (( ((  )) ))    /** @nillyr **/
   hh `\ `)(' /'


positional arguments:
  {analyze,baseline,report,config}
                        Available Commands
    analyze             performs an analysis on an archive based on a security baseline
    baseline            performs the interaction with the security baselines
    util                performs the interaction with the utility scripts
    report              performs the recompilation of the report in PDF format from an adoc file
    template            performs the interaction with your custom report templates
    config              performs octoconf configuration management

options:
  -h, --help            show this help message and exit
  --version             print version and exit
  --loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        set the log level (default: INFO)

Table of contents

Disclaimer

  • This is not a turn key tool, read the documentation for more information;
  • This tool does not offer any guarantee;
  • The authors of this tool cannot be held responsible for the effects caused by the executed commands;
  • It is highly recommended to risk assess your commands in a test environment before using them in production;
  • It is highly recommended that the risk of service degradation be graded before any use on a system in production.

Standard usage

  1. Use a built-in baseline or create your own
  2. Generate a collection script from the selected baseline
  3. Run the collection script on the target host
  4. Analyze the results and generate the reports with or without your own report template
  5. When required, edit the report and recompile it in PDF format

Documentation

Contributing

See CONTRIBUTING.

Copyright and license

Copyright (c) 2021 Nicolas GRELLETY

This software is licensed under GNU GPLv3 license. See LICENSE file in the root folder of the project.

The information used in the "report information" configuration file come from the movie "L'Aile ou la Cuisse".

Icons made by Freepik from www.flaticon.com

About

🐙 octoconf - tool dedicated to the realization of configuration audits of various assets

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Languages