bitexpert/sulu-securitytxt-bundle

Sulu bundle for managing security.txt configuration

v0.6.0 2024-07-07 12:22 UTC

Requires

• php: ^8.2 | ^8.3
• sulu/sulu: ^2.6
• symfony/dependency-injection: ^6.0
• symfony/framework-bundle: ^6.0
• symfony/http-foundation: ^6.0
• symfony/http-kernel: ^6.0
• symfony/routing: ^6.0

Requires (Dev)

• jackalope/jackalope: ^1.4
• jackalope/jackalope-doctrine-dbal: ^1.8
• madewithlove/license-checker: ^1.4
• phly/keep-a-changelog: ^2.12
• phpstan/extension-installer: ^1.2
• phpstan/phpstan: ^1.9
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.4
• phpunit/phpunit: ^11.2
• roave/security-advisories: dev-latest
• squizlabs/php_codesniffer: ^3.7

MIT

• Stephan Hochdörfer

README

This is a Sulu Bundle to manage security.txt files for your Sulu webspaces.

According to securitytxt.org the main purpose of security.txt is to help make things easier for companies and security researchers when trying to secure platforms. Thanks to security.txt, security researchers can easily get in touch with companies about security issues.

Installation

composer require bitexpert/sulu-securitytxt-bundle

1. Register the bundle in the file config/bundles.php

BitExpert\Sulu\SecuritytxtBundle\BitExpertSuluSecuritytxtBundle::class => ['all' => true],

1. Configure the routing as follows:

Create file config/routes/securitytxt_admin.yaml:

securitytxt_api:
    resource: "@BitExpertSuluSecuritytxtBundle/Resources/config/routing_api.yaml"
    type: rest
    prefix:   /admin/api

Create file config/routes/securitytxt_website.yaml:

securitytxt_website:
  resource: "@BitExpertSuluSecuritytxtBundle/Resources/config/routing_website.yaml"

1. Run Doctrine Schema Update

./bin/adminconsole doctrine:schema:update -f

Usage

Once installed, this bundle adds a tab called "Security.txt" to the webspaces configuration which allows you to create new security.txt entries for the different webspaces. For each webspace only one security.txt configuration can be saved.

Since 0.5.0: Only users with the Securitytxt permissions can view, add, edit or delete the security.txt entries.

Contribute

Please feel free to fork and extend existing or add new features and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and adapt the documentation.

Want To Contribute?

If you feel that you have something to share, then we’d love to have you. Check out the contributing guide to find out how, as well as what we expect from you.

License

Sulu Security.txt Bundle is released under the MIT License.