security.txt icon
Module Id
securitytxt
Group Id
org.jahia.modules
Updated
Requires Jahia
7.2.2.0
Author
Florent BOURASSE
Category
Tools and Utilities
Status
COMMUNITY

security.txt group_work

security

The purpose of this module is to ease the generation of the file security.txt inside Digital Experience Manager. For more information about security.txt, please refer to this URL: https://securitytxt.org/

Dependencies & Dependants

Dependencies
  • NONE
Dependants
  • NONE

How To Install

Installation

  • In DX, go to "Administration --> Server settings --> System components --> Modules"
  • Upload the JAR securitytxt-X.X.X.jar
  • Check that the module is started

Use

Administration

  • Go to "Administration -> Server settings -> Web Projects"
  • Edit the site with which you want to use this module and add it to the list of the deployed modules

Edit mode

  • Go to "Edit mode -> Site settings -> Security.txt manager"
  • You can now define:
    • The security address: it will be used by people to communicate with you if they find a security issue
    • The PGP Key: a GPG/PGP public key that will be used to securely communicate with you. To generate it, please refer to this section
    • The security acknowledgements page: a page where you can thank the people having found a security issue
    • The security policy and/or disclosure policy page: a page where you explain the policy rules you're following, how the security issues have to be communicated, the perimeter of the bug bounty, etc
    • The external signature file: a GPG/PGP signature of the text file available at the address DX_URL/.well-known/security.txt. To generate it, please refer to this section

GPG/PGP

Key creation

  • Generate a key:
gpg --full-generate-key
  • Export your public key:
gpg --armor --export <EMAIL> > <EMAIL>.pub

Signature

  • Download the file security.txt on your computer thanks to the URL DX_URL/.well-known/security.txt
  • Execute the following command to generate an external signature:
gpg --output security.txt.sig --detach-sig security.txt

Check a signed document

  • Execute the following command to check the validity of the signed document
gpg --output security.txt --decrypt security.txt.sig

License

MIT License

Copyright (c) 2018 - present Florent BOURASSÉ

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.