nepttune/security

Security generator component

v2.0.1 2019-04-26 12:36 UTC

This package is auto-updated.

Last update: 2024-11-13 06:17:01 UTC


README

🔧 Security generator component

Introduction

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

Dependencies

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: 'contact@test.com'
        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();
    }
}