Skip to content

Fix docs: Construct new TwoFactorAuth-class #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willpower232 merged 7 commits into from
Jul 29, 2023
Merged

Fix docs: Construct new TwoFactorAuth-class #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
241dfec
fix: fixed docs
modelrailroader Jun 5, 2023
dd0ecae
Fix: Changes for > PHP 8
modelrailroader Jun 8, 2023
8361159
fix: fixed documentation
modelrailroader Jun 11, 2023
6416e79
fix: fixed typing
modelrailroader Jun 11, 2023
a6f7735
fix: docs for new PHP Version
modelrailroader Jun 23, 2023
d5aa22a
fix: hyperlinks for new file extensions
modelrailroader Jun 23, 2023
0565d63
fix: better understanding for QrCodeProvider class
modelrailroader Jun 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/optional-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ title: Optional Configuration

The instance (`new TwoFactorAuth()`) can only be configured by the constructor with the following optional arguments

Argument | Default value | Use
------------------|---------------|-----
`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret
`$digits` | `6` | The number of digits the resulting codes will be
`$period` | `30` | The number of seconds a code will be valid
`$algorithm` | `'sha1'` | The algorithm used (one of `sha1`, `sha256`, `sha512`, `md5`)
`$qrcodeprovider` | `null` | QR-code provider
`$rngprovider` | `null` | Random Number Generator provider
`$timeprovider` | `null` | Time provider
Argument | Default value | Use
------------------|-------------------|-----
`$issuer` | `null` | Will be displayed in the users app as the default issuer name when using QR code to import the secret
`$digits` | `6` | The number of digits the resulting codes will be
`$period` | `30` | The number of seconds a code will be valid
`$algorithm` | `Algorithm::Sha1` | The algorithm used (one of `Algorithm::Sha1`, `Algorithm::Sha256`, `Algorithm::Sha512`, `Algorithm::Md5`)
`$qrcodeprovider` | `null` | QR-code provider
`$rngprovider` | `null` | Random Number Generator provider
`$timeprovider` | `null` | Time provider

**Note:** the default values for `$digits`, `$period`, and `$algorithm` provide the widest variety of support amongst common authenticator apps such as Google Authenticator. If you choose to use different values for these arguments you will likely have to instruct your users to use a specific app which supports your chosen configuration.

Expand Down
17 changes: 7 additions & 10 deletions docs/qr-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ You can also specify a size as a third argument which is 200 by default.

## Online Providers

[QRServerProvider](qr-codes/qr-server.html) (default)
[QRServerProvider](qr-codes/qr-server.md) (default)

**Warning:** Whilst it is the default, this provider is not suggested for applications where absolute security is needed, because it uses an external service for the QR code generation. You can make use of the included offline providers listed below which generate locally.

[ImageChartsQRCodeProvider](qr-codes/image-charts.html)
[ImageChartsQRCodeProvider](qr-codes/image-charts.md)

[QRicketProvider](qr-codes/qrickit.html)
[QRicketProvider](qr-codes/qrickit.md)

## Offline Providers

[EndroidQrCodeProvider](qr-codes/endroid.html) and EndroidQrCodeWithLogoProvider
[EndroidQrCodeProvider](qr-codes/endroid.md) and EndroidQrCodeWithLogoProvider

[BaconQRCodeProvider](qr-codes/bacon.html)
[BaconQRCodeProvider](qr-codes/bacon.md)

**Note:** offline providers may have additional PHP requirements in order to function, you should study what is required before trying to make use of them.

Expand All @@ -52,11 +52,8 @@ use RobThree\Auth\TwoFactorAuth;
$qrCodeProvider = new YourChosenProvider();

$tfa = new TwoFactorAuth(
null,
6,
30,
'sha1',
$qrCodeProvider
issuer: "Your Company Or App Name",
qrcodeprovider: $qrCodeProvider
);
```

Expand Down