Chirps is a Django-based Python web application that allows users to search and scan vector databases for sensitive data, and to perform vulnerability testing against Large Language Models (LLM). The application can connect to Mantium applications and to vector databases like Redis and Pinecone, as well as API endpoints where LLMs are hosted. Users can create and manage scanning policies, execute scans against an asset using a selected policy, and view the results of the scan, including any findings.
- Click the green “Code” button on your forked repository and choose “Open with Codespaces.”
- Click “New codespace” to create a new codespace for the project.
- Wait for the codespace to be created and the dependencies to be installed. Expect this first build to take at least 10 minutes. Codespace rebuilds should be much faster.
- Create a codespace using the instructions above
- Install the project dependencies by running the following command in the codepsace's terminal
pip install -r requirements.txt - Initialize the app by running the following command
./chirps/manage.py initialize_app- This runs database migrations and populates the database, starts services like Celery and RabbitMQ, and starts the web app
- In the codespace, click "Ports" on the lower toolbar and click the link under "Forwarded Ports" to access the application at port 8000.
- Create a user account in the UI.
Please familiarize yourself with the project by visiting our Getting Started page.
For any questions on the usage of Chirps please visit us on Discord. If you found a software issue, please create an issue on GitHub.
This project is maintained by Mantium
We appreciate any contributions you can make! Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at GitHub first.
Install required Python modules with pip install -r requirements.txt.
All of the functionality you need is handled with Django's manage.py interface. It's executable, and can be found in the chirps subdirectory. Always run manage.py from within the chirps subdirectory.
Initialize your database (sqlite) by executing ./manage.py migrate. This will create all of your tables. Generate new migrations by executing ./manage.py makemigrations. Running the migrate command again will apply the migration(s).
Pre-populate the database with some default data (plans) by executing ./manage.py loaddata <path/to/fixture>.json
The chirps application makes use of Celery and RabbitMQ for job processing. Executing a scan, the scan task will be offloaded to Celery for async processing. In order to start those two components execute the following commands:
./manage.py rabbitmq --start./manage.py celery --start
Both the rabbitmq and celery commands have --stop and --restart options as well.
If you make changes to a Celery task, it must be restarted in order for those changes to be picked up. Simply run
./manage.py celery --restart
./manage.py runserver
This will fire up the Django development server. Connect to the URL that it outputs in the console.
Once in a while, you might write a test (bravo!). Those can be executed by running ./manage.py test.
The /docs folder contains documentation which is built via Jekyll. In order to run the local development server, execute bundle exec jekyll serve.
At a high level, chirps performs security scans on vector databases and knowledge query systems. Users choose a Plan to Scan a Asset.
The Asset application allows users to interact with Mantium applications and vector databases like Redis and Pinecone for storing and searching document embeddings. Users can create, edit, and delete asset configurations, which include connection details and authentication credentials. Each asset model is derived from a BaseAsset model that implements the search() and test_connection() methods for seamless integration with different services/databases.
The Scan application manages scans and their results. Users can create, execute, and analyze scans using plans with defined rules. Users can also review scan findings.
The Plan application manages scanning plans and rules for the Scan application. A Plan consists of a set of rules that define the steps executed when scanning an asset. Users can create plans or use preloaded templates.
The authentication system in this Django-based Python web application manages user authentication and account features. Users can sign up, log in, and update their profiles, including an optional OpenAI API key, which is hashed before saving.
The Profile model extends Django's built-in User model with a one-to-one relationship and includes an openai_api_key field. Forms such as ProfileForm, LoginForm, and SignupForm handle user profile updates, logins, and registrations, with custom methods like clean_openai_key() for hashing the OpenAI API key.
This software is licensed under the GNU General Public LIcense v3.0. If you need a different license, please reach out to Mantium