django-security-txt

Dependencies

Maintainers

Alerts

File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

django-security-txt

Handle security.txt

0.4.1

PyPI

Maintainers: 1

Readme

.. django-security-txt .. README.rst

A django-security-txt documentation

|GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-django-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_

*django-security-txt is a Django reusable application to handle security.txt (http://securitytxt.org/)*

.. contents::

Installation

Obtain your copy of source code from the git repository: $ git clone https://github.com/vint21h/django-security-txt.git. Or download the latest release from https://github.com/vint21h/django-security-txt/tags/.
Run $ python ./setup.py install from the repository source tree or the unpacked archive. Or use pip: $ pip install django-security-txt.

Configuration

Add "security_txt" to settings.INSTALLED_APPS:

.. code-block:: python

# settings.py

INSTALLED_APPS += [
    "phonenumber_field",
    "security_txt",
]

Add "security_txt" to your URLs definitions:

.. code-block:: python

# urls.py

from django.urls import re_path


urlpatterns += [
    re_path(r"^.well-known/security\.txt", include("security_txt.urls")),
]

Settings

SECURITY_TXT_EXPIRES Indicates the date and time after which the data contained in the "security.txt" file is considered stale and should not be used. Defaults to None. SECURITY_TXT_PREFERRED_LANGUAGES Used to indicate a set of natural languages that are preferred when submitting security reports. Defaults to None. SECURITY_TXT_SIGN Sign "security.txt" using PGP. Defaults to False. SECURITY_TXT_SIGNING_KEY Path to PGP key. Defaults to "".

Advanced features

If you want to sign your "security.txt":

Install django-security-txt with additional dependencies: $ pip install django-security-txt[pgp].
Configure:

.. code-block:: python

# settings.py

SECURITY_TXT_SIGN: bool = True
SECURITY_TXT_SIGNING_KEY: str = "/path/to/key.asc"

Contributing

Fork it <https://github.com/vint21h/django-security-txt/>_
Install GNU Make <https://www.gnu.org/software/make/>_
Install and configure pyenv <https://github.com/pyenv/pyenv/>_ and pyenv-virtualenv plugin <https://github.com/pyenv/pyenv-virtualenv/>_
Install and configure direnv <https://github.com/direnv/direnv/>_
Create environment config from example

.. code-block:: bash

cp .env.example .env

6. Install development dependencies:

.. code-block:: bash

make install

7. Create your fix/feature branch:

.. code-block:: bash

git checkout -b my-new-fix-or-feature

8. Check code style and moreover:

.. code-block:: bash

make check

9. Run tests:

.. code-block:: bash

make test

10. Push to the branch:

.. code-block:: bash

git push origin my-new-fix-or-feature

11. Create a new Pull Request <https://github.com/vint21h/django-security-txt/compare/>_

Licensing

django-security-txt is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (a t your option) any later version. For complete license text see COPYING file.

Contacts

Project Website: https://github.com/vint21h/django-security-txt/

Author: Alexei Andrushievich vint21h@vint21h.pp.ua

For other authors list see AUTHORS file.

Keywords

FAQs

What is django-security-txt?

Is django-security-txt well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install