【PHP8.x】PRAGMA定数の使い方

Copy
1<?php
2
3// Composerのオートロードファイルを読み込み、必要なライブラリが利用できるようにします。
4// このサンプルコードを実行する前に、プロジェクトのルートディレクトリで以下のコマンドを実行してください。
5// composer require pragmarx/google2fa-qrcode
6require_once 'vendor/autoload.php';
7
8use PragmaRX\Google2FAQRCode\Google2FA;
9
10/**
11 * Google Authenticatorを使用した二段階認証（2FA）のためのQRコードを生成します。
12 *
13 * この関数は、指定された組織名とユーザー名に基づいて、
14 * Google Authenticatorアプリでスキャンするための秘密鍵を生成し、
15 * その秘密鍵を含むQRコードのSVG（Scalable Vector Graphics）表現を標準出力に出力します。
16 * 生成されたSVGコードをHTMLファイルとして保存し、ウェブブラウザで開くことで、
17 * QRコードを目視確認し、Google Authenticatorアプリでスキャンできます。
18 * このコードは、ウェブサーバーなしでCLI (コマンドラインインターフェース) 環境で直接実行可能です。
19 *
20 * @param string $companyName 二段階認証を設定する組織またはアプリケーションの名前。
21 *                            Google Authenticatorアプリに表示されます。
22 *                            例: 'MyCompanyApp'
23 * @param string $userName 二段階認証を設定するユーザーの識別子。
24 *                         Google Authenticatorアプリに表示されます。
25 *                         例: 'user@example.com'
26 * @return void
27 */
28function generateTwoFactorAuthQrCode(string $companyName, string $userName): void
29{
30    // PragmaRX\Google2FAQRCode\Google2FA クラスのインスタンスを作成します。
31    // このライブラリは、秘密鍵の生成とQRコードSVGの生成を容易にします。
32    $google2fa = new Google2FA();
33    
34    // Google Authenticator用の秘密鍵を生成します。
35    // この鍵は、ユーザーごとに一意に生成され、安全に保管される必要があります。
36    $secretKey = $google2fa->generateSecretKey();
37
38    echo "生成された秘密鍵: " . $secretKey . PHP_EOL;
39
40    // Google AuthenticatorアプリがスキャンできるQRコードのSVG表現を生成します。
41    // このSVGには、組織名、ユーザー名、そして生成された秘密鍵がエンコードされています。
42    $qrCodeSvg = $google2fa->getQRCodeInline(
43        $companyName,
44        $userName,
45        $secretKey
46    );
47
48    echo PHP_EOL;
49    echo "--- Google Authenticator QR コード (SVG) ---" . PHP_EOL;
50    echo "以下のSVGコードは、QRコードリーダーでスキャン可能です。" . PHP_EOL;
51    echo "HTMLファイルとして保存し、ブラウザで開いてQRコードを表示してください。" . PHP_EOL;
52    echo "例: echo \$qrCodeSvg > qrcode.html && open qrcode.html" . PHP_EOL;
53    echo $qrCodeSvg . PHP_EOL;
54    echo "------------------------------------------" . PHP_EOL;
55    echo "この秘密鍵とQRコードをGoogle Authenticatorアプリに登録して、二段階認証を設定してください。" . PHP_EOL;
56}
57
58// サンプルとして、'MyAwesomeApp' という組織名と 'newuser@example.com' というユーザー名で
59// 二段階認証のQRコード生成関数を実行します。
60// 実際のシステムでは、これらの値はデータベースやユーザー入力から動的に取得されます。
61generateTwoFactorAuthQrCode('MyAwesomeApp', 'newuser@example.com');

このPHPサンプルコードは、PragmaRX/Google2FAQRCodeライブラリを活用し、Google Authenticatorのようなアプリで利用する二段階認証（2FA）用のQRコードを生成する手順を示しています。

generateTwoFactorAuthQrCode関数は、二段階認証を設定する組織名とユーザー名を引数として受け取ります。$companyName引数にはGoogle Authenticatorアプリに表示される組織の名前を、$userName引数には同じくアプリに表示されるユーザーの識別子を指定します。この関数は内部で、ユーザーごとに一意の秘密鍵を生成し、その秘密鍵、組織名、ユーザー名をエンコードしたQRコードのSVG（Scalable Vector Graphics）データを生成します。

関数には戻り値がなく（void）、生成された秘密鍵とQRコードのSVG表現を標準出力に出力します。出力されたSVGコードは、HTMLファイルとして保存し、ウェブブラウザで開くことでQRコードを視覚的に確認できます。これにより、Google AuthenticatorアプリでQRコードをスキャンし、二段階認証を簡単に設定することが可能になります。このコードは、ウェブサーバーを必要とせず、コマンドラインインターフェース（CLI）環境で直接実行できるため、開発やテストの際に手軽に利用できます。