baserCMS クラスリファレンス

OAuth2Service
in package

OAuth2 Service (moved under OAuth2\Service)

Table of Contents

Properties

$authorizationServer  : AuthorizationServer|null
Authorization Server インスタンス
$resourceServer  : ResourceServer|null
Resource Server インスタンス

Methods

__construct()  : mixed
コンストラクタ
getAuthorizationServer()  : AuthorizationServer
Get Authorization Server
getResourceServer()  : ResourceServer
Get Resource Server
storeAuthorizationCode()  : void
Store Authorization Code
validateAccessToken()  : array<string|int, mixed>|null
Validate Access Token
assertEncryptionKey()  : void
暗号化キーが設定されている事を確認する
createAuthorizationServer()  : AuthorizationServer
Create Authorization Server
createResourceServer()  : ResourceServer
Create Resource Server
generateKeyPair()  : void
Generate RSA Key Pair
getEncryptionKey()  : string
Get Encryption Key
getPrivateKey()  : CryptKey
Get Private Key
getPublicKey()  : CryptKey
Get Public Key
restrictPrivateKeyPermissions()  : void
秘密鍵ファイルの権限を所有者のみ読み書き可（0600）に制限する

Properties

$authorizationServer

Authorization Server インスタンス

private AuthorizationServer|null $authorizationServer = null

$resourceServer

Resource Server インスタンス

private ResourceServer|null $resourceServer = null

Methods

__construct()

コンストラクタ

public __construct() : mixed

暗号化キーが未設定のまま動かすと、認可コードとリフレッシュトークンの 機密性が失われるため、この時点で停止させる。

getAuthorizationServer()

Get Authorization Server

public getAuthorizationServer() : AuthorizationServer
Return values
AuthorizationServer

getResourceServer()

Get Resource Server

public getResourceServer() : ResourceServer
Return values
ResourceServer

storeAuthorizationCode()

Store Authorization Code

public storeAuthorizationCode(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

validateAccessToken()

Validate Access Token

public validateAccessToken(string $token) : array<string|int, mixed>|null
Parameters
$token : string
Return values
array<string|int, mixed>|null

assertEncryptionKey()

暗号化キーが設定されている事を確認する

private assertEncryptionKey() : void

形式や長さは検証しない。install 時に base64_encode(random_bytes(32)) が 書かれる前提であり、形式チェックは誤検知の害のほうが大きい。

Tags
throws
OAuth2ConfigurationException

createAuthorizationServer()

Create Authorization Server

private createAuthorizationServer() : AuthorizationServer
Tags
throws
Exception
Return values
AuthorizationServer

createResourceServer()

Create Resource Server

private createResourceServer() : ResourceServer
Tags
throws
Exception
Return values
ResourceServer

generateKeyPair()

Generate RSA Key Pair

private generateKeyPair() : void
Tags
throws
Exception

getEncryptionKey()

Get Encryption Key

private getEncryptionKey() : string
Return values
string

getPrivateKey()

Get Private Key

private getPrivateKey() : CryptKey
Return values
CryptKey

getPublicKey()

Get Public Key

private getPublicKey() : CryptKey
Return values
CryptKey

restrictPrivateKeyPermissions()

秘密鍵ファイルの権限を所有者のみ読み書き可（0600）に制限する

private restrictPrivateKeyPermissions(string $privateKeyPath) : void
Parameters
$privateKeyPath : string
On this page

Search results