diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 76bdb0fd..5f7df8ef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,7 @@ 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 Here are some tips for you: - - Please follow the PR contribution guidelines: https://github.com/scheb/2fa/blob/6.x/CONTRIBUTING.md#creating-a-pull-request + - Please follow the PR contribution guidelines: https://github.com/scheb/2fa/blob/7.x/CONTRIBUTING.md#creating-a-pull-request - Don't break backwards compatibility. If you have to, let's discuss! :) - Always add/update tests and ensure the build passes --> diff --git a/.github/workflows/split.yaml b/.github/workflows/split.yaml index 77e3d83d..5be1cd08 100644 --- a/.github/workflows/split.yaml +++ b/.github/workflows/split.yaml @@ -16,7 +16,7 @@ jobs: uses: actions/checkout@v3 with: fetch-depth: 0 # Fetch all history - ref: "6.x" # Force checkout the branch to split its commits as well + ref: "7.x" # Force checkout the branch to split its commits as well - name: "Gitsplit" diff --git a/README.md b/README.md index 48b0f282..b19b8ff1 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,8 @@ scheb/2fa This bundle provides **[two-factor authentication](https://en.wikipedia.org/wiki/Multi-factor_authentication) for your [Symfony](https://symfony.com/) application**. -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle/stats) @@ -46,12 +46,12 @@ Two-factor authentication methods: Installation ------------- -Follow the [installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Follow the [installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Detailed documentation of all features can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. Demo ---- diff --git a/UPGRADE.md b/UPGRADE.md index 786c8097..abb5be35 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -33,7 +33,7 @@ method `getProviderKey()` was removed, please implement `getFirewallName()` inst The internal interface `Scheb\TwoFactorBundle\Security\TwoFactor\Handler\AuthenticationHandlerInterface` was removed. If you used it nevertheless, please migrate to an implementation based on `Scheb\TwoFactorBundle\Security\TwoFactor\Condition\TwoFactorConditionInterface`. See more about -[custom conditions for two-factor authentication](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/custom_conditions.html). +[custom conditions for two-factor authentication](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/custom_conditions.html). The bundle has previously recommended the controller syntax with a single colon `_controller: "scheb_two_factor.form_controller:form"`. Under Symfony 6, you have to use the syntax with two colons @@ -128,7 +128,7 @@ public function invalidateBackupCode(object $user, string $code): void; Out-of-the-box support for `symfony/swiftmailer-bundle` was removed, respectively `Scheb\TwoFactorBundle\Mailer\SwiftAuthCodeMailer` was removed. Please migrate to `symfony/mailer` or use a -[custom mailer implementation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/providers/email.html#custom-mailer). +[custom mailer implementation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/providers/email.html#custom-mailer). Signature of `Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface::getEmailAuthCode()` has changed to be nullable, please update your implementation accordingly. @@ -172,7 +172,7 @@ The package `scheb/2fa-qr-code` was discontinued. Please migrate to get QR code `endroid/qr-code` package (or any alternative) to render an QR code image. An example how to render the QR code with `endroid/qr-code` version 4 can be found -[in the test application](https://github.com/scheb/2fa/blob/6.x/app/src/Controller/QrCodeController.php). +[in the test application](https://github.com/scheb/2fa/blob/7.x/app/src/Controller/QrCodeController.php). 4.x to 5.x ---------- diff --git a/doc/index.rst b/doc/index.rst index 720181f4..e266c164 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -63,13 +63,13 @@ is – just like roles – withheld until the two-factor authentication step has Contributing ------------ Want to contribute to this project? See -`CONTRIBUTING.md `_ in the repository. +`CONTRIBUTING.md `_ in the repository. Security -------- For information about the security policy and know security issues, see -`SECURITY.md `_ in the repository. +`SECURITY.md `_ in the repository. License ------- -**SchebTwoFactorBundle** is available under the `MIT license `_. +**SchebTwoFactorBundle** is available under the `MIT license `_. diff --git a/doc/installation.rst b/doc/installation.rst index df3dd59b..c605128b 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -4,8 +4,8 @@ Installation Prerequisites ------------- -You're currently looking at the documentation of **SchebTwoFactorBundle version 6**. This bundle version is -**compatible with Symfony 5.4 or Symfony 6.x**. +You're currently looking at the documentation of **SchebTwoFactorBundle version 7**. This bundle version is +**compatible with Symfony 6.4 or Symfony 7.x**. If you're using anything other than Doctrine ORM to manage the user entity you will have to implement a :doc:`persister service `. diff --git a/doc/providers/custom.rst b/doc/providers/custom.rst index 60994d30..72123390 100644 --- a/doc/providers/custom.rst +++ b/doc/providers/custom.rst @@ -7,9 +7,9 @@ Getting started A good starting point are the Google Authenticator, TOTP and email authentication implementations, which are available in the codebase. Have a look at the follow files: -* `src/google-authenticator/Security/TwoFactor/Provider/Google/GoogleAuthenticatorTwoFactorProvider.php `_ -* `src/totp/Security/TwoFactor/Provider/Totp/TotpAuthenticatorTwoFactorProvider.php `_ -* `src/email/Security/TwoFactor/Provider/Email/EmailTwoFactorProvider.php `_ +* `src/google-authenticator/Security/TwoFactor/Provider/Google/GoogleAuthenticatorTwoFactorProvider.php `_ +* `src/totp/Security/TwoFactor/Provider/Totp/TotpAuthenticatorTwoFactorProvider.php `_ +* `src/email/Security/TwoFactor/Provider/Email/EmailTwoFactorProvider.php `_ You will get the basic idea how to implement a custom two-factor method. diff --git a/doc/providers/google.rst b/doc/providers/google.rst index d8319875..266a6fb8 100644 --- a/doc/providers/google.rst +++ b/doc/providers/google.rst @@ -223,7 +223,7 @@ Authenticator service: Use the QR code rendering library of your choice to render a QR code image. An example how to render the QR code with ``endroid/qr-code`` version 4 can be found -`in the demo application `_. +`in the demo application `_. .. caution:: diff --git a/doc/providers/totp.rst b/doc/providers/totp.rst index 66276f16..3169d865 100644 --- a/doc/providers/totp.rst +++ b/doc/providers/totp.rst @@ -239,7 +239,7 @@ To generate a QR code that can be scanned by the authenticator app, retrieve the Use the QR code rendering library of your choice to render a QR code image. An example how to render the QR code with ``endroid/qr-code`` version 4 can be found -`in the demo application `_. +`in the demo application `_. .. caution:: diff --git a/doc/trusted_device.rst b/doc/trusted_device.rst index 93bf5963..3f79161a 100644 --- a/doc/trusted_device.rst +++ b/doc/trusted_device.rst @@ -101,7 +101,7 @@ To flag a device as "trusted", in the last step of the 2fa process, you have to two_factor: trusted_parameter_name: _trusted # Name of the parameter for the trusted device option -Please have a look at the `default authentication form template `_ +Please have a look at the `default authentication form template `_ how it's implemented. Clearing the trusted cookie diff --git a/src/backup-code/README.md b/src/backup-code/README.md index 974522e6..828368b7 100644 --- a/src/backup-code/README.md +++ b/src/backup-code/README.md @@ -1,8 +1,8 @@ scheb/2fa-backup-code ===================== -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-backup-code)](https://packagist.org/packages/scheb/2fa-backup-code) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-backup-code)](https://packagist.org/packages/scheb/2fa-backup-code/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-backup-code)](https://packagist.org/packages/scheb/2fa-backup-code/stats) @@ -18,12 +18,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License ------- diff --git a/src/bundle/README.md b/src/bundle/README.md index 6f8cfe36..f75712cb 100644 --- a/src/bundle/README.md +++ b/src/bundle/README.md @@ -1,8 +1,8 @@ scheb/2fa-bundle ================ -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-bundle)](https://packagist.org/packages/scheb/2fa-bundle/stats) @@ -18,12 +18,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License ------- diff --git a/src/email/README.md b/src/email/README.md index 176aa4a9..38700d48 100644 --- a/src/email/README.md +++ b/src/email/README.md @@ -1,8 +1,8 @@ scheb/2fa-email =============== -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-email)](https://packagist.org/packages/scheb/2fa-email) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-email)](https://packagist.org/packages/scheb/2fa-email/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-email)](https://packagist.org/packages/scheb/2fa-email/stats) @@ -18,12 +18,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License ------- diff --git a/src/google-authenticator/README.md b/src/google-authenticator/README.md index f5817ff5..b2e5eea0 100644 --- a/src/google-authenticator/README.md +++ b/src/google-authenticator/README.md @@ -1,8 +1,8 @@ scheb/2fa-google-authenticator ============================== -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-google-authenticator)](https://packagist.org/packages/scheb/2fa-google-authenticator) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-google-authenticator)](https://packagist.org/packages/scheb/2fa-google-authenticator/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-google-authenticator)](https://packagist.org/packages/scheb/2fa-google-authenticator/stats) @@ -19,12 +19,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License ------- diff --git a/src/totp/README.md b/src/totp/README.md index 2ff08acd..9362be08 100644 --- a/src/totp/README.md +++ b/src/totp/README.md @@ -1,8 +1,8 @@ scheb/2fa-totp ============== -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-totp)](https://packagist.org/packages/scheb/2fa-totp) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-totp)](https://packagist.org/packages/scheb/2fa-totp/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-totp)](https://packagist.org/packages/scheb/2fa-totp/stats) @@ -18,12 +18,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License ------- diff --git a/src/trusted-device/README.md b/src/trusted-device/README.md index 1abb3f2a..ce69ad23 100644 --- a/src/trusted-device/README.md +++ b/src/trusted-device/README.md @@ -1,8 +1,8 @@ scheb/2fa-trusted-device ======================== -[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=6.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A6.x) -[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/6.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/6.x) +[![Build Status](https://github.com/scheb/2fa/workflows/CI/badge.svg?branch=7.x)](https://github.com/scheb/2fa/actions?query=workflow%3ACI+branch%3A7.x) +[![Code Coverage](https://codecov.io/gh/scheb/2fa/branch/7.x/graph/badge.svg)](https://app.codecov.io/gh/scheb/2fa/branch/7.x) [![Latest Stable Version](https://img.shields.io/packagist/v/scheb/2fa-trusted-device)](https://packagist.org/packages/scheb/2fa-trusted-device) [![Monthly Downloads](https://img.shields.io/packagist/dm/scheb/2fa-trusted-device)](https://packagist.org/packages/scheb/2fa-trusted-device/stats) [![Total Downloads](https://img.shields.io/packagist/dt/scheb/2fa-trusted-device)](https://packagist.org/packages/scheb/2fa-trusted-device/stats) @@ -18,12 +18,12 @@ This repository is a sub-repository of [scheb/2fa](https://github.com/scheb/2fa) Installation ------------ -Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/installation.html). +Please follow the [bundle's installation instructions](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/installation.html). Documentation ------------- Documentation can be found on the -[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/6.x/index.html) website. +[Symfony Bundles Documentation](https://symfony.com/bundles/SchebTwoFactorBundle/7.x/index.html) website. License -------