Rfc9068JwtBuilder
in package
RFC 9068 準拠の JWT ビルダー
JSON Web Token (JWT) Profile for OAuth 2.0 Access Tokens (RFC 9068) に準拠した JWTを構築するためのビルダークラス
Table of Contents
Properties
- $builder : Builder
- $configuration : Configuration
Methods
- __construct() : mixed
- コンストラクタ
- canOnlyBeUsedAfter() : self
- nbf (not before) クレームを設定 RFC 9068では推奨
- expiresAt() : self
- exp (expires at) クレームを設定 RFC 9068では必須
- getToken() : Token
- JWTトークンを生成 RFC 9068に準拠したトークンを作成
- identifiedBy() : self
- jti (JWT ID) クレームを設定 RFC 9068では必須（ユニークなトークン識別子）
- issuedAt() : self
- iat (issued at) クレームを設定 RFC 9068では必須
- issuedBy() : self
- iss (issuer) クレームを設定 RFC 9068では必須
- permittedFor() : self
- aud (audience) クレームを設定 RFC 9068では必須（クライアントID）
- relatedTo() : self
- sub (subject) クレームを設定 RFC 9068では推奨（ユーザー識別子）
- withClaim() : self
- カスタムクレームを設定 RFC 9068では、アプリケーション固有のクレームを追加可能
- withHeader() : self
- JWTヘッダーにkid (Key ID) を設定
Properties
$builder
private
Builder
$builder
$configuration
private
Configuration
$configuration
Methods
__construct()
コンストラクタ
public
__construct(Configuration $configuration) : mixed
Parameters
- $configuration : Configuration
-
JWT設定
canOnlyBeUsedAfter()
nbf (not before) クレームを設定 RFC 9068では推奨
public
canOnlyBeUsedAfter(DateTimeImmutable $notBefore) : self
Parameters
- $notBefore : DateTimeImmutable
-
有効開始日時
Return values
selfexpiresAt()
exp (expires at) クレームを設定 RFC 9068では必須
public
expiresAt(DateTimeImmutable $expiration) : self
Parameters
- $expiration : DateTimeImmutable
-
有効期限
Return values
selfgetToken()
JWTトークンを生成 RFC 9068に準拠したトークンを作成
public
getToken(Signer $signer, Key $key) : Token
Parameters
- $signer : Signer
-
署名アルゴリズム
- $key : Key
-
署名キー
Return values
TokenidentifiedBy()
jti (JWT ID) クレームを設定 RFC 9068では必須（ユニークなトークン識別子）
public
identifiedBy(string $id) : self
Parameters
- $id : string
-
JWT ID
Return values
selfissuedAt()
iat (issued at) クレームを設定 RFC 9068では必須
public
issuedAt(DateTimeImmutable $issuedAt) : self
Parameters
- $issuedAt : DateTimeImmutable
-
発行日時
Return values
selfissuedBy()
iss (issuer) クレームを設定 RFC 9068では必須
public
issuedBy(string $issuer) : self
Parameters
- $issuer : string
-
発行者のURL
Return values
selfpermittedFor()
aud (audience) クレームを設定 RFC 9068では必須（クライアントID）
public
permittedFor(string $audience) : self
Parameters
- $audience : string
-
対象者
Return values
selfrelatedTo()
sub (subject) クレームを設定 RFC 9068では推奨（ユーザー識別子）
public
relatedTo(string $subject) : self
Parameters
- $subject : string
-
サブジェクト
Return values
selfwithClaim()
カスタムクレームを設定 RFC 9068では、アプリケーション固有のクレームを追加可能
public
withClaim(string $name, mixed $value) : self
Parameters
- $name : string
-
クレーム名
- $value : mixed
-
クレーム値
Return values
selfwithHeader()
JWTヘッダーにkid (Key ID) を設定
public
withHeader(string $name, string $value) : self
Parameters
- $name : string
- $value : string