nswdpc/silverstripe-security-recipe

Recipe for adding MFA, Password check, Breached account check, Security report to a Silverstripe application

v0.3.2 2023-08-29 04:52 UTC

Requires

• nswdpc/silverstripe-authentication-boilerplate: <1.0
• nswdpc/silverstripe-csp: <1
• nswdpc/silverstripe-recaptcha-v3: <1
• silverstripe/dynamodb: ^4.1
• silverstripe/login-forms: ^4.9.0
• silverstripe/mimevalidator: ^2.4
• silverstripe/recipe-plugin: ^1.7

BSD-3-Clause

• James Ellis

• security
• password
• totp
• silverstripe
• 2fa
• haveibeenpwned
• MFA
• hibp
• pwnedpasswords

README

A recipe for adding various security-focused modules to a Silverstripe website.

In this recipe

Authentication boilerplate

• The nswdpc/silverstripe-authentication-boilerplate, providing:
  • Multi-factor Authentication (MFA) for the administration area via the Silverstripe TOTP Authenticator
  • Pwned Password checks via the pwnedpasswords API provided by Have I Been Pwned
  • Breached account checks via the haveibeenpwned API provided by Have I Been Pwned
  • The Silverstripe security extensions module
  • The Silverstripe security report module

Content Security Policy

• The NSWDPC CSP module

Captcha

• The NSWDPC reCAPTCHA v3 base module

Useful extras

• silverstripe/login-forms
• silverstripe/mimevalidator

Sessions

• DynamoDB sessions

Configuration

There is no configuration provided in this recipe. Its aim is to bring together a set of Silverstripe security modules to be used together in a standardised way. Default configuration settings can be found in the recipe's modules and can be overridden on a per-project basis.

The authentication boilerplate module provides a standard set of rules for defining access to websites. You can modify these rules using the Silverstripe configuration API.

Installation

The only supported way of installing this recipe is via composer

composer require-recipe nswdpc/silverstripe-security-recipe

About recipes

See the recipe plugin page for information on how recipes work.

LICENSE

BSD-3-Clause

Maintainers

• dpcdigital@NSWDPC:~$

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.