https://github.com/infinityloop-dev/security

:wrench: Security.txt generator component for Nette framework.
https://github.com/infinityloop-dev/security

component nette php security-txt

Last synced: 22 days ago
JSON representation

:wrench: Security.txt generator component for Nette framework.

• Host: GitHub
• URL: https://github.com/infinityloop-dev/security
• Owner: infinityloop-dev
• License: mit
• Created: 2018-10-08T14:57:20.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-12T20:46:18.000Z (over 4 years ago)
• Last Synced: 2024-10-01T14:18:52.050Z (about 1 month ago)
• Topics: component, nette, php, security-txt
• Language: PHP
• Homepage: https://www.infinityloop.dev
• Size: 13.7 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Security

:wrench: Security generator component

## Introduction

This component automaticaly generates security.txt from parameters in configuration.

## Dependencies

- [nette/application](https://github.com/nette/application)

## How to use

- Register `\Nepttune\Component\ISecurityFactory` as service in cofiguration file, inject it into presenter, write `createComponent` method and use macro `{control}` in template file.

  - Just as any other component.

  - You need to pass security configuration to factory service.

  - Content type is automaticaly set to `text/plain`.

- Modify parameters to accomplish your needs.

### Example configuration

```

services:

    securityFactory:

        implement: Nepttune\Component\ISecurityFactory

        arguments:

          - '%security%'

parameters:

    security:

        contact: '[email protected]'

        hiring: 'https://hiring.test.com'

        acknowledgements: 'https://hall-of-fame.test.com'

        permission: 'none'

```

### Example presenter

```

class ExamplePresenter implements IPresenter

{

    /** @var  \Nepttune\Component\ISecurityFactory */

    protected $iSecurityFactory;

    

    public function __construct(\Nepttune\Component\ISecurityFactory $ISecurityFactory)

    {

        $this->iSecurityFactory = $ISecurityFactory;

    }

    protected function createComponentSecurity() : \Nepttune\Component\Security

    {

        return $this->iSecurityFactory->create();

    }

}

```