From 91fede5e1868567dfdfb3e9a96b3b157377c4209 Mon Sep 17 00:00:00 2001 From: Yevgeny Tomenko Date: Fri, 9 Feb 2024 19:45:43 +0300 Subject: [PATCH] add documentation. update changelog. --- .editorconfig | 18 ++++++++++++++++++ CHANGELOG.md | 5 ++++- Docs/Documentation/TwoFactor.md | 17 +++++++++++++++++ Docs/Home.md | 1 + 4 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 .editorconfig create mode 100644 Docs/Documentation/TwoFactor.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7061901 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.bat] +end_of_line = crlf + +[*.yml] +indent_style = space +indent_size = 2 diff --git a/CHANGELOG.md b/CHANGELOG.md index c6e8a79..8de07b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,8 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [9.0.0] - 2024-02-09 +- Two factor processors introduced. Prvided way to add new two factor processors on client level. + ## [7.0.0] - 2021-10-30 -- upgrade to cakephp 4.3.0 +- upgrade to cakephp 4.3.0 - upgrade to phpunit 9.5 ## [6.1.0] - 2021-05-14 diff --git a/Docs/Documentation/TwoFactor.md b/Docs/Documentation/TwoFactor.md new file mode 100644 index 0000000..97fa518 --- /dev/null +++ b/Docs/Documentation/TwoFactor.md @@ -0,0 +1,17 @@ +Two Factor (2FA) +================ + +Two-factor authentication (2FA) is an identity and access management security method that requires two forms of identification to access resources and data. 2FA gives businesses the ability to monitor and help safeguard their most vulnerable information and networks. + +Configuration +------------- + +Processors defined as Configure storage with key `TwoFactorProcessors` + + +Processors +------------- + +* `U2FProcessor` - *deprecated*. Universal 2nd Factor (U2F) is an open standard that strengthens and simplifies two-factor authentication (2FA) using specialized Universal Serial Bus (USB) or near-field communication (NFC) devices based on similar security technology found in smart cards. +* `OneTimePassword` - Authenticator is an authenticator app used as part of a two-factor/multi-factor authentication (2FA/MFA) scheme. It acts as an example of a “something you have” factor by generating one-time passwords (OTPs) on a smartphone or other mobile device. +* `Webauthn2fa` - WebAuthn is a browser-based API that allows for web applications to simplify and secure user authentication by using registered devices (phones, laptops, etc) as factors. It uses public key cryptography to protect users from advanced phishing attacks. diff --git a/Docs/Home.md b/Docs/Home.md index 9782d32..2aeb858 100644 --- a/Docs/Home.md +++ b/Docs/Home.md @@ -1,6 +1,7 @@ Home ==== * [Authentication](Documentation/Authentication.md) + * [Two Factor](Documentation/TwoFactor.md) * [Authorization](Documentation/Authorization.md) * [Social](Documentation/Social.md) * [SimpleRbacAuthorize](Documentation/SimpleRbacAuthorize.md) RBAC Authorize based on configuration