クラス JwsHeader
- java.lang.Object
-
- org.springframework.security.oauth2.jwt.JwsHeader
public final class JwsHeader extends java.lang.Object
JSON Web 署名(JWS)ヘッダーは、JSON Web トークンのヘッダーパラメーターを表す JSON オブジェクトであり、JWS 保護ヘッダーと JWS ペイロードのコンテンツの MAC にデジタル署名または作成するために使用される暗号化操作を記述します。- 導入:
- 5.6
- 関連事項:
- JWSJOSE ヘッダー
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
JwsHeader.Builder
JwsHeader
のビルダー。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 static JwsHeader.Builder
from(JwsHeader headers)
提供されたheaders
で初期化された新しいJwsHeader.Builder
を返します。JwsAlgorithm
getAlgorithm()
JWS のデジタル署名または JWE の暗号化に使用されるJWA algorithm
を返します。java.lang.String
getContentType()
保護されたコンテンツのメディア型(ペイロード)を宣言するコンテンツ型ヘッダーを返します。java.util.Set<java.lang.String>
getCritical()
理解および処理する必要のある、JWS/JWE/JWA 仕様のどの拡張機能が使用されているかを示す重要なヘッダーを返します。<T> T
getHeader(java.lang.String name)
ヘッダー値を返します。java.util.Map<java.lang.String,java.lang.Object>
getHeaders()
ヘッダーを返します。java.util.Map<java.lang.String,java.lang.Object>
getJwk()
JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する公開鍵である JSON Web キーを返します。java.net.URL
getJwkSetUrl()
JSON でエンコードされた公開鍵のセットのリソースを参照する JWK セット URL を返します。そのうちの 1 つは、JWS のデジタル署名または JWE の暗号化に使用される鍵に対応します。java.lang.String
getKeyId()
JWS または JWE を保護するために使用されたキーを示すヒントであるキー ID を返します。java.lang.String
getType()
JWS/JWE のメディア型を宣言する型ヘッダーを返します。java.util.List<java.lang.String>
getX509CertificateChain()
X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンを含む X.509 証明書チェーンを返します。java.lang.String
getX509SHA1Thumbprint()
base64url でエンコードされた SHA-1 拇印である X.509 証明書 SHA-1 拇印を返します(別名java.lang.String
getX509SHA256Thumbprint()
base64url でエンコードされた SHA-256 拇印である X.509 証明書 SHA-256 拇印を返します(別名java.net.URL
getX509Url()
X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンのリソースを参照する X.509URL を返します。static JwsHeader.Builder
with(JwsAlgorithm jwsAlgorithm)
指定されたJwsAlgorithm
で初期化された新しいJwsHeader.Builder
を返します。
メソッドの詳細
getAlgorithm
public JwsAlgorithm getAlgorithm()
JWS のデジタル署名または JWE の暗号化に使用されるJWA algorithm
を返します。- 戻り値:
JwaAlgorithm
with
public static JwsHeader.Builder with(JwsAlgorithm jwsAlgorithm)
指定されたJwsAlgorithm
で初期化された新しいJwsHeader.Builder
を返します。- パラメーター:
jwsAlgorithm
-JwsAlgorithm
- 戻り値:
JwsHeader.Builder
from
public static JwsHeader.Builder from(JwsHeader headers)
提供されたheaders
で初期化された新しいJwsHeader.Builder
を返します。- パラメーター:
headers
- ヘッダー- 戻り値:
JwsHeader.Builder
getJwkSetUrl
public java.net.URL getJwkSetUrl()
JSON でエンコードされた公開鍵のセットのリソースを参照する JWK セット URL を返します。そのうちの 1 つは、JWS のデジタル署名または JWE の暗号化に使用される鍵に対応します。- 戻り値:
- JWK セットの URL
getJwk
public java.util.Map<java.lang.String,java.lang.Object> getJwk()
JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する公開鍵である JSON Web キーを返します。- 戻り値:
- JSON Web キー
getKeyId
public java.lang.String getKeyId()
JWS または JWE を保護するために使用されたキーを示すヒントであるキー ID を返します。- 戻り値:
- キー ID
getX509Url
public java.net.URL getX509Url()
X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンのリソースを参照する X.509URL を返します。- 戻り値:
- X.509URL
getX509CertificateChain
public java.util.List<java.lang.String> getX509CertificateChain()
X.509 公開鍵証明書または JWS のデジタル署名または JWE の暗号化に使用される鍵に対応する証明書チェーンを含む X.509 証明書チェーンを返します。証明書または証明書チェーンは、証明書値String
のList
として表されます。List
の各String
は、Base64 でエンコードされた DERPKIX 証明書の値です。- 戻り値:
- X.509 証明書チェーン
getX509SHA1Thumbprint
public java.lang.String getX509SHA1Thumbprint()
JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 証明書の DER エンコードの base64url エンコード SHA-1 拇印(別名ダイジェスト)である X.509 証明書 SHA-1 拇印を返します。- 戻り値:
- X.509 証明書 SHA-1 拇印
getX509SHA256Thumbprint
public java.lang.String getX509SHA256Thumbprint()
JWS のデジタル署名または JWE の暗号化に使用されるキーに対応する X.509 証明書の DER エンコードの base64url エンコード SHA-256 拇印(別名ダイジェスト)である X.509 証明書 SHA-256 拇印を返します。- 戻り値:
- X.509 証明書 SHA-256 拇印
getType
public java.lang.String getType()
JWS/JWE のメディア型を宣言する型ヘッダーを返します。- 戻り値:
- 型ヘッダー
getContentType
public java.lang.String getContentType()
保護されたコンテンツのメディア型(ペイロード)を宣言するコンテンツ型ヘッダーを返します。- 戻り値:
- コンテンツ型ヘッダー
getCritical
public java.util.Set<java.lang.String> getCritical()
理解および処理する必要のある、JWS/JWE/JWA 仕様のどの拡張機能が使用されているかを示す重要なヘッダーを返します。- 戻り値:
- 重要なヘッダー
getHeaders
public java.util.Map<java.lang.String,java.lang.Object> getHeaders()
ヘッダーを返します。- 戻り値:
- ヘッダー
getHeader
public <T> T getHeader(java.lang.String name)
ヘッダー値を返します。- 型パラメーター:
T
- ヘッダー値の型- パラメーター:
name
- ヘッダー名- 戻り値:
- ヘッダー値