クラスHKDFParameterSpec.Builder

java.lang.Object
javax.crypto.spec.HKDFParameterSpec.Builder
含まれているインタフェース:
HKDFParameterSpec
public static final class HKDFParameterSpec.Builder extends Object
このBuilderは、ExtractおよびExtractThenExpandオブジェクトをビルドします。

Builderは、HKDFParameterSpecのofExtractメソッドを介して初期化されます。 クラスの説明に示されているように、addIKMまたはaddSalt(あるいはその両方)を必要に応じてコールできます。 最後に、ExtractおよびExtractThenExpandのユースケースに対してextractOnlyまたはthenExpandをそれぞれコールすることで、オブジェクトは"built"です。 Builderはスレッド・セーフではないことに注意してください。

導入されたバージョン:
25

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    HKDFParameterSpec.Builder
    addIKM(byte[] ikm)
    入力キーイング・マテリアル(IKM)をビルダーに追加します。
    HKDFParameterSpec.Builder
    addIKM(SecretKey ikm)
    入力キーイング・マテリアル(IKM)をビルダーに追加します。
    HKDFParameterSpec.Builder
    addSalt(byte[] salt)
    ビルダーに塩を加えます。
    HKDFParameterSpec.Builder
    addSalt(SecretKey salt)
    ビルダーに塩を加えます。
    HKDFParameterSpec.Extract
    extractOnly()
    Builderの現在の状態からExtractオブジェクトを作成します。
    HKDFParameterSpec.ExtractThenExpand
    thenExpand(byte[] info, int length)
    Builderの現在の状態からExtractThenExpandオブジェクトを作成します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • メソッドの詳細

    • extractOnly

      public HKDFParameterSpec.Extract extractOnly()
      Builderの現在の状態からExtractオブジェクトを作成します。
      戻り値:
      不変のExtractオブジェクト

    • thenExpand

      public HKDFParameterSpec.ExtractThenExpand thenExpand(byte[] info, int length)
      Builderの現在の状態からExtractThenExpandオブジェクトを作成します。
      実装上のノート:
      HKDFの実装では、長さが255 * HMACの長さを超えないようにします。 HKDF実装では、 {code null} 情報値が長さ0バイト配列として扱われることも強制されます。
      パラメータ:
      info - オプションのコンテキストおよびアプリケーション固有の情報(null)。バイト配列は、後続の変更を防ぐためにクローニングされます
      length - 出力キーイング材料の長さ (0より大きくする必要があります)
      戻り値:
      不変のExtractThenExpandオブジェクト
      スロー:
      IllegalArgumentException - lengthが0より大きくない場合

    • addIKM

      public HKDFParameterSpec.Builder addIKM(SecretKey ikm)
      入力キーイング・マテリアル(IKM)をビルダーに追加します。

      ユーザーは、入力キーイング・マテリアル値をピース・ミールで組み立てる場合、またはIKMの一部をハードウェア暗号化デバイスによって提供する場合に、addIKMを複数回コールできます。 ExtractオブジェクトまたはExtractThenExpandオブジェクトのikms()メソッドは、組み立てられた入力キーイング・マテリアルをSecretKeyオブジェクトのリストとして返します。

      パラメータ:
      ikm - 入力キーイング・マテリアル(IKM)値
      戻り値:
      このビルダー
      スロー:
      NullPointerException - ikm引数がnullの場合

    • addIKM

      public HKDFParameterSpec.Builder addIKM(byte[] ikm)
      入力キーイング・マテリアル(IKM)をビルダーに追加します。 長さ0のikmバイト配列は破棄されることに注意してください。

      ユーザーは、入力キーイング・マテリアル値をピース・ミールで組み立てる場合、またはIKMの一部をハードウェア暗号化デバイスによって提供する場合に、addIKMを複数回コールできます。 ExtractオブジェクトまたはExtractThenExpandオブジェクトのikms()メソッドは、組み立てられた入力キーイング・マテリアルをSecretKeyオブジェクトのリストとして返します。

      パラメータ:
      ikm - 入力キーイング・マテリアルの(IKM)値。ikmバイト配列はSecretKeySpecに変換されます。これは、バイト配列がSecretKeySpecコンストラクタ内でクローニングされることを意味
      戻り値:
      このビルダー
      スロー:
      NullPointerException - ikm引数がnullの場合

    • addSalt

      public HKDFParameterSpec.Builder addSalt(SecretKey salt)
      ビルダーに塩を加えます。

      ユーザーがaddSaltを複数回コールできるのは、salt値をピース・ミールにアセンブルする場合、またはsaltの一部をハードウェア暗号化デバイスから提供する場合です。 後で構築されるExtractまたはExtractThenExpandオブジェクトのsalts()メソッドは、アセンブルされたsaltをSecretKeyオブジェクトのリストとして返します。

      パラメータ:
      salt - 塩の値
      戻り値:
      このビルダー
      スロー:
      NullPointerException - saltがnullの場合

    • addSalt

      public HKDFParameterSpec.Builder addSalt(byte[] salt)
      ビルダーに塩を加えます。 長さ0のsaltバイト配列は破棄されることに注意してください。

      ユーザーがaddSaltを複数回コールできるのは、salt値をピース・ミールにアセンブルする場合、またはsaltの一部をハードウェア暗号化デバイスから提供する場合です。 後で構築されるExtractまたはExtractThenExpandオブジェクトのsalts()メソッドは、アセンブルされたsaltをSecretKeyオブジェクトのリストとして返します。

      パラメータ:
      salt - salt値。saltバイト配列はSecretKeySpecに変換されます。これは、バイト配列がSecretKeySpecコンストラクタ内でクローニングされることを意味
      戻り値:
      このビルダー
      スロー:
      NullPointerException - saltがnullの場合