Skip to main content

Handle security.txt

Project description

GitHub Coveralls License Version Supported Python version Supported Django version Package format Python wheel support Package status

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

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:

# settings.py

INSTALLED_APPS += [
    "phonenumber_field",
    "security_txt",
]
  • Add "security_txt" to your URLs definitions:

# 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:

# settings.py

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

Contributing

  1. Fork it

  2. Install GNU Make

  3. Install and configure pyenv and pyenv-virtualenv plugin

  4. Install and configure direnv

  5. Create environment config from example

cp .env.example .env
  1. Install development dependencies:

make install
  1. Create your fix/feature branch:

git checkout -b my-new-fix-or-feature
  1. Check code style and moreover:

make check
  1. Run tests:

make test
  1. Push to the branch:

git push origin my-new-fix-or-feature
  1. Create a new Pull Request

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-security-txt-0.4.1.zip (55.2 kB view details)

Uploaded Source

Built Distribution

django_security_txt-0.4.1-py3-none-any.whl (42.8 kB view details)

Uploaded Python 3

File details

Details for the file django-security-txt-0.4.1.zip.

File metadata

  • Download URL: django-security-txt-0.4.1.zip
  • Upload date:
  • Size: 55.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for django-security-txt-0.4.1.zip
Algorithm Hash digest
SHA256 8da95ab33c140116a299ca3ad6635f6ceb16c1fb9f603c416a6350eb17452cdd
MD5 3192110a8f64c850f1ad131883be321b
BLAKE2b-256 9ae6885bfe3fc11648afa0580823d1fc19779527cf09aee928a95335abaa45a6

See more details on using hashes here.

File details

Details for the file django_security_txt-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: django_security_txt-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 42.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.0 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for django_security_txt-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1260b9bb1eeb63d973e6e0ad9b7f11eed8849246d9bc1e5ce64628ecc4dc302
MD5 4888154e0fd0060a4a8af99970ee8495
BLAKE2b-256 0c0ffe582b1af6b1aa66ff61616c009e24dc1e61dd206429e0c17c34b088805c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page