php oath server suite

php oath server suite

ชุดของคลาสที่ให้การรับรองความถูกต้องของปัจจัยที่สอง เช่น Yubico OTP (Yubikey), Oath (TOTP, HOTP, GoogleAuthenticator) ฝั่งเซิร์ฟเวอร์

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับคำสาบาน โปรดดูที่ https://openauthentication.org/

ข้อมูลเพิ่มเติมเกี่ยวกับ TOTP (อัลกอริทึมรหัสผ่านครั้งเดียวตามเวลา) สามารถพบได้ที่ Wikipedia

ข้อมูลเพิ่มเติมเกี่ยวกับ HOTP (อัลกอริทึมรหัสผ่านครั้งเดียวที่ใช้ HMAC) สามารถพบได้ที่ Wikipedia

หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับกลไกการตรวจสอบสิทธิ์ Yubico OTP โปรดอ่านบทความ "YubiKey OTP คืออะไร" ที่ https://developers.yubico.com/OTP/

การติดตั้ง

 {
   	"require": {
        "chroma-x/oath-server-suite": "~4.0"
    }
}

การใช้งาน

การโหลดอัตโนมัติและเนมสเปซ

 require_once('path/to/vendor/autoload.php');

---

ยูบิโกะ OTP (YubiCloud)

หากต้องการใช้ Yubico OTP คุณต้องมีสิทธิ์เข้าถึง YubiCloud คุณสามารถรับข้อมูลรับรอง API ได้ฟรีจาก https://upgrade.yubico.com/getapikey/

กำลังตรวจสอบรหัสผ่าน Yubico แบบครั้งเดียว

 use ChromaXCommonExceptionNetworkExceptionBaseNetworkException;

$otp = $_POST['otp'];
$userPublicId = 'fetchedFromDatabaseOrSimilar';

$validator = new OathServerSuiteValidationYubicoOtpValidator('yubiCloudClientId', 'yubiCloudSecretKey');
try {
	$validator->validate($otp, $userPublicId);
	if ($validator->isValid()) {
		// Validation was successful
	} else {
		// Validation failed
	}
} catch (NetworkException $exception) {
	// Accessing the YubiCloud webservice failed.
}

---

คำสาบาน – สไตล์ Google Authenticator

แบ่งปันชื่อคีย์และความลับ

เพื่ออนุญาตการตรวจสอบสิทธิ์ไคลเอนต์และเซิร์ฟเวอร์จะต้องแบ่งปันความลับ โดยปกติแล้วเซิร์ฟเวอร์จะเปิดเผยความลับและแสดงข้อมูลทั้งหมดพร้อมกับชื่อคีย์และกลไกการตรวจสอบสิทธิ์เป็นโค้ด QR

Google Authenticator และแอปพลิเคชันและฮาร์ดแวร์อื่นๆ เช่น Yubikey ไม่ปฏิบัติตามมาตรฐานโดยคาดหวังว่าความลับจะไม่เป็นเลขฐานสิบหก แต่เป็นข้อมูลที่เข้ารหัส Base32

TOTP (อัลกอริธึมรหัสผ่านครั้งเดียวตามเวลา)

 use ChromaXOathServerSuiteSecretSharingSharedSecretQrCodeProviderSharedSecretQrCodeProvider;
use ChromaXOathServerSuiteSecretSharingSharedSecretUrlEncoderTotpBase32SharedSecretUrlEncoder;
use ChromaXQrCodeSuiteQrEncodeQrEncoder;

// Initialize Oath URL encoder for TOTP (Time-based One-time Password Algorithm)
$contentEncoder = new TotpBase32SharedSecretUrlEncoder();

// Setting the key name
$keyName = 'My Username';

// Setting the issuer name
$issuerName = 'Awesome Application';

// Setting a secret
// Attention: This is just an example value
// Use a random value of a proper length stored with your user credentials
$sharedSecret = openssl_random_pseudo_bytes(30);

// Getting the shared secret URL for usage wihtout QR code provision
$sharedSecretUrl = $contentEncoder->encode($keyName, $sharedSecret);

// Start QR code provision
// Initialize the QR code provider with Oath URL encoder for TOTP
$sharedSecretQrProvider = new SharedSecretQrCodeProvider(new TotpBase32SharedSecretUrlEncoder(), $keyName, $sharedSecret, $issuerName);

// Configure the QR code renderer for your needs
$sharedSecretQrProvider->getQrEncoder()
	->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
	->setTempDir('/path/to/a/writable/temp-dir');

// Persist the QR code PNG to the filesystem
$sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');

HOTP (อัลกอริธึมรหัสผ่านครั้งเดียวที่ใช้ HMAC)

 use ChromaXOathServerSuiteSecretSharingSharedSecretQrCodeProviderSharedSecretQrCodeProvider;
use ChromaXOathServerSuiteSecretSharingSharedSecretUrlEncoderHotpBase32SharedSecretUrlEncoder;
use ChromaXQrCodeSuiteQrEncodeQrEncoder;

// Initialize Oath URL encoder for HOTP (HMAC-based One-time Password Algorithm)
$contentEncoder = new HotpBase32SharedSecretUrlEncoder();

// Setting the key name
$keyName = 'My Username';

// Setting the issuer name
$issuerName = 'Awesome Application';

// Setting a secret
// Attention: This is just an example value
// Use a random value of a proper length stored with your user credentials
$sharedSecret = openssl_random_pseudo_bytes(30);

// Getting the shared secret URL for usage wihtout QR code provision
$sharedSecretUrl = $contentEncoder->encode($keyName, $sharedSecret);

// Start QR code provision
// Initialize the QR code provider with Oath URL encoder for HOTP
$sharedSecretQrProvider = new SharedSecretQrCodeProvider(new HotpBase32SharedSecretUrlEncoder(), $keyName, $sharedSecret, $issuerName);

// Configure the QR code renderer for your needs
$sharedSecretQrProvider->getQrEncoder()
	->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
	->setTempDir('/path/to/a/writable/temp-dir');

// Persist the QR code PNG to the filesystem
$sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');

ตรวจสอบรหัสผ่านคำสาบานเพียงครั้งเดียว

TOTP (อัลกอริธึมรหัสผ่านครั้งเดียวตามเวลา)

 $totp = $_POST['totp'];
$sharedSecret = 'fetchedFromDatabaseOrSimilar';

$validator = new OathServerSuiteValidationOathTotpValidator();
$validator->validate($totp, $sharedSecret);
if ($validator->isValid()) {
	// Validation was successful
} else {
	// Validation failed
}

HOTP (อัลกอริธึมรหัสผ่านครั้งเดียวที่ใช้ HMAC)

 $hotp = $_POST['hotp'];
$sharedSecret = 'fetchedFromDatabaseOrSimilar';
$counter = (int)'fetchedFromDatabaseOrSimilar';

$validator = new OathServerSuiteValidationOathHotpValidator();
$validator->validate($hotp, $sharedSecret, $counter);
if ($validator->isValid()) {
	// Validation was successful
} else {
	// Validation failed
}

---

คำสาบาน – ปฏิบัติตามมาตรฐาน

แบ่งปันชื่อคีย์และความลับ

TOTP (อัลกอริธึมรหัสผ่านครั้งเดียวตามเวลา)

 use ChromaXOathServerSuiteSecretSharingSharedSecretQrCodeProviderSharedSecretQrCodeProvider;
use ChromaXOathServerSuiteSecretSharingSharedSecretUrlEncoderTotpSharedSecretUrlEncoder;
use ChromaXQrCodeSuiteQrEncodeQrEncoder;

// Initialize Oath URL encoder for TOTP (Time-based One-time Password Algorithm)
$contentEncoder = new TotpSharedSecretUrlEncoder();

// Setting the key name
$keyName = 'My Username';

// Setting the issuer name
$issuerName = 'Awesome Application';

// Setting a secret
// Attention: This is just an example value
// Use a random value of a proper length stored with your user credentials
$sharedSecret = openssl_random_pseudo_bytes(30);

// Getting the shared secret URL for usage wihtout QR code provision
$sharedSecretUrl = $contentEncoder->encode($keyName, $sharedSecret);

// Start QR code provision
// Initialize the QR code provider with Oath URL encoder for TOTP
$sharedSecretQrProvider = new SharedSecretQrCodeProvider(new TotpSharedSecretUrlEncoder(), $keyName, $sharedSecret, $issuerName);

// Configure the QR code renderer for your needs
$sharedSecretQrProvider->getQrEncoder()
	->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
	->setTempDir('/path/to/a/writable/temp-dir');

// Persist the QR code PNG to the filesystem
$sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');

HOTP (อัลกอริธึมรหัสผ่านครั้งเดียวที่ใช้ HMAC)

 use ChromaXOathServerSuiteSecretSharingSharedSecretQrCodeProviderSharedSecretQrCodeProvider;
use ChromaXOathServerSuiteSecretSharingSharedSecretUrlEncoderHotpSharedSecretUrlEncoder;
use ChromaXQrCodeSuiteQrEncodeQrEncoder;

// Initialize Oath URL encoder for HOTP (HMAC-based One-time Password Algorithm)
$contentEncoder = new HotpSharedSecretUrlEncoder();

// Setting the key name
$keyName = 'My Username';

// Setting the issuer name
$issuerName = 'Awesome Application';

// Setting a secret
// Attention: This is just an example value
// Use a random value of a proper length stored with your user credentials
$sharedSecret = openssl_random_pseudo_bytes(30);

// Getting the shared secret URL for usage wihtout QR code provision
$sharedSecretUrl = $contentEncoder->encode($keyName, $sharedSecret);

// Start QR code provision
// Initialize the QR code provider with Oath URL encoder for HOTP
$sharedSecretQrProvider = new SharedSecretQrCodeProvider(new HotpSharedSecretUrlEncoder(), $keyName, $sharedSecret, $issuerName);

// Configure the QR code renderer for your needs
$sharedSecretQrProvider->getQrEncoder()
	->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
	->setTempDir('/path/to/a/writable/temp-dir');

// Persist the QR code PNG to the filesystem
$sharedSecretQrProvider->provideQrCode('/path/to/the/qrcode.png');

ตรวจสอบรหัสผ่านคำสาบานเพียงครั้งเดียว

TOTP (อัลกอริธึมรหัสผ่านครั้งเดียวตามเวลา)

 $totp = $_POST['totp'];
$sharedSecret = 'fetchedFromDatabaseOrSimilar';

$validator = new OathServerSuiteValidationOathTotpValidator();
$validator->validate($totp, $sharedSecret);
if ($validator->isValid()) {
	// Validation was successful
} else {
	// Validation failed
}

HOTP (อัลกอริธึมรหัสผ่านครั้งเดียวที่ใช้ HMAC)

 $hotp = $_POST['hotp'];
$sharedSecret = 'fetchedFromDatabaseOrSimilar';
$counter = (int)'fetchedFromDatabaseOrSimilar';

$validator = new OathServerSuiteValidationOathHotpValidator();
$validator->validate($hotp, $sharedSecret, $counter);
if ($validator->isValid()) {
	// Validation was successful
} else {
	// Validation failed
}

---

การจัดการข้อยกเว้น

php oath server suite มีข้อยกเว้นที่แตกต่างกัน – บางส่วนจัดทำโดยโครงการ PHP Common Exceptions – เพื่อการจัดการที่เหมาะสม
คุณสามารถค้นหาข้อมูลเพิ่มเติมเกี่ยวกับ PHP Common Exceptions ได้ที่ Github

---

ผลงาน

การมีส่วนร่วมในโครงการของเราได้รับการชื่นชมอย่างมากเสมอ
แต่: โปรดปฏิบัติตามหลักเกณฑ์การบริจาคที่เขียนไว้ในเอกสาร CONTRIBUTING.md

ใบอนุญาต

php oath server suite อยู่ภายใต้ใบอนุญาต MIT