Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 5.08 KB

README.md

File metadata and controls

71 lines (52 loc) · 5.08 KB

Join the chat at https://gitter.im/Patrowl/Support Known Vulnerabilities SonarCloud Build Status Codacy Badge Rawsec's CyberSecurity Inventory

PatrOwl

PatrOwl is a scalable, free and open-source solution for orchestrating Security Operations.
PatrowlManager is the Front-end application for managing the assets, reviewing risks on real-time, orchestrating the operations (scans, searches, API calls, ...), aggregating the results, relaying alerts on third parties (ex: Incident Response platform like TheHive, Splunk, ...) and providing the reports and dashboards. Operations are performed by the PatrowlEngines instances. Don't forget to install and deploy them ;)

Project pitch desk

PatrOwl Pitch Desk

Try it now!

To try PatrOwl, install it by reading the Installation Guide and the User Guide.

Architecture

Fully-Developed in Python, PatrOwl is composed of a Front-end application PatrowlManager (Django) communicating with one or multiple PatrowlEngines micro-applications (Flask) which perform the scans, analyze the results and format them in a normalized way. It remains incredibly easy to customize all components. Asynchronous tasks and engine scalability are supported by RabbitMQ and Celery. Architecture
The PatrowlManager application is reachable using the embedded WEB interface or using the JSON-API. PatrowlEngines are only available through generic JSON-API calls (see Documentation).

License

PatrOwl is an open source and free software released under the AGPL (Affero General Public License). We are committed to ensure that PatrOwl will remain a free and open source project on the long-run.

Updates

Information, news and updates are regularly posted on Patrowl.io Twitter account and on the blog.

Contributing

Please see our Code of conduct. We welcome your contributions. Please feel free to fork the code, play with it, make some patches and send us pull requests via issues.

Roadmap

  • API Documentation
  • Python 3 migration
  • Transform all API calls to async tasks (limit Nginx 504 timeouts)
  • Beautify scan creation and edition forms
  • Enhance finding states management
  • Enhance user management
  • Support scan campaigns (multiple scan definition)
  • Support django-health-check
  • Support cache
  • Optimize global performances
  • Refactor static files (remove unused ?)
  • Continuous Docker image deployment (DockerHub)

Follow our roadmap on Trello here

Support

Please open an issue on GitHub if you'd like to report a bug or request a feature. We are also available on Gitter to help you out.

If you need to contact the project team, send an email to getsupport@patrowl.io.

Commercial Services

Looking for advanced support, training, integration, custom developments, dual-licensing ? Contact us at getsupport@patrowl.io

Security contact

Please disclose any security-related issues or vulnerabilities by emailing security@patrowl.io, instead of using the public issue tracker.

Copyright

Copyright (C) 2018-2019 Nicolas MATTIOCCO (@MaKyOtOx - nicolas@greenlock.fr)

Travis build status

Branch Status
master Build Status
develop Build Status