パッケージ org.springframework.vault.core

インターフェース VaultTransitOperations

すべての既知の実装クラス:
VaultTransitTemplate
public interface VaultTransitOperations
transit シークレットエンジンを使用して操作を指定するインターフェース。
作成者:
Mark Paluch, Sven Sch ü rmann, Praveendra Singh, Luander Ribeiro, Nanne Baars
関連事項:

  • メソッドの詳細

    • createKey

      void createKey(StringSE keyName)
      name を指定して、新しい名前付き暗号鍵を作成します。
      パラメーター:
      keyName - 空または null であってはなりません。

    • createKey

      void createKey(StringSE keyName, VaultTransitKeyCreationRequest createKeyRequest)
      name および VaultTransitKeyCreationRequest を指定して、新しい名前付き暗号鍵を作成します。ここで設定したキーオプションは、キーの作成後に変更することはできません。
      パラメーター:
      keyName - 空または null であってはなりません。
      createKeyRequest - null であってはなりません。

    • getKeys

      ListSE<StringSE> getKeys()
      中継キー名の ListSE を取得します。
      戻り値:
      中継キー名の ListSE。

    • configureKey

      void configureKey(StringSE keyName, VaultTransitKeyConfiguration keyConfiguration)
      name を指定して、新しい名前付き暗号鍵を作成します。
      パラメーター:
      keyName - 空または null であってはなりません。
      keyConfiguration - null であってはなりません。

    • exportKey

      @Nullable RawTransitKey exportKey(StringSE keyName, TransitKeyType type)
      指定された暗号化キーの値を返します。キーの種類に応じて、返される情報は異なる場合があります。この操作をサポートするには、キーがエクスポート可能である必要があります。
      パラメーター:
      keyName - 空または null であってはなりません。
      type - null であってはなりません。
      戻り値:
      RawTransitKey

    • getKey

      @Nullable VaultTransitKey getKey(StringSE keyName)
      名前付き暗号鍵に関する情報を返します。
      パラメーター:
      keyName - 空または null であってはなりません。
      戻り値:
      VaultTransitKey

    • deleteKey

      void deleteKey(StringSE keyName)
      名前付き暗号鍵を削除します。指定されたキーで暗号化されたデータを復号化することはできなくなります。
      パラメーター:
      keyName - 空または null であってはなりません。

    • rotate

      void rotate(StringSE keyName)
      名前付きキーのバージョンをローテーションします。ローテーション後、新しいプレーンテキストリクエストは新しいバージョンのキーで暗号化されます。最新バージョンのキーで暗号化されるように暗号文をアップグレードするには、rewrap(String, String) を使用します。
      パラメーター:
      keyName - 空または null であってはなりません。
      関連事項:

    • encrypt

      StringSE encrypt(StringSE keyName, StringSE plaintext)
      指定されたキーを使用して、指定されたプレーンテキストを暗号化します。指定された plaintext は、default charset を使用してバイトにエンコードされます。CharsetSE の不一致を避けるために、encrypt(String, org.springframework.vault.support.Plaintext) を使用してバイトから Plaintext オブジェクトを構築します。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - 空または null であってはなりません。
      戻り値:
      暗号文。

    • encrypt

      Ciphertext encrypt(StringSE keyName, Plaintext plaintext)
      指定されたキーを使用して、指定された plaintext を暗号化します。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - null であってはなりません。
      戻り値:
      暗号文。
      導入:
      1.1

    • encrypt

      StringSE encrypt(StringSE keyName, byte[] plaintext, VaultTransitContext transitRequest)
      指定されたキーを使用して、指定された plaintext を暗号化します。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - 空または null であってはなりません。
      transitRequest - null であってはなりません。リクエストオプションが指定されていない場合は、VaultTransitContext.empty() を使用します。
      戻り値:
      暗号文。

    • encrypt

      ListSE<VaultEncryptionResult> encrypt(StringSE keyName, ListSE<Plaintext> batchRequest)
      指定されたキーとコンテキストを使用して、提供された plaintext のバッチを暗号化します。暗号化はトランジットエンジンのバッチ処理を使用して行われます。
      パラメーター:
      keyName - 空または null であってはなりません。
      batchRequest - プレーンテキストとオプションのコンテキストを含む Plaintext のリスト。
      戻り値:
      batchRequest 平文の順序で暗号化された結果。
      導入:
      1.1

    • decrypt

      StringSE decrypt(StringSE keyName, StringSE ciphertext)
      指定されたキーを使用して、指定されたプレーンテキストを復号化します。デコードされた plaintext は StringSE および default charset にデコードされます。decrypt(String, org.springframework.vault.support.Ciphertext) を使用して、後で使用するために CharsetSE を制御できる Ciphertext オブジェクトを取得します。
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - 空または null であってはなりません。
      戻り値:
      プレーンテキスト。

    • decrypt

      Plaintext decrypt(StringSE keyName, Ciphertext ciphertext)
      指定されたキーを使用して、指定された暗号テキストを復号化します。
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - null であってはなりません。
      戻り値:
      プレーンテキスト。
      導入:
      1.1

    • decrypt

      byte[] decrypt(StringSE keyName, StringSE ciphertext, VaultTransitContext transitContext)
      指定されたキーを使用して、指定された ciphertext を復号化します。
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - 空または null であってはなりません。
      transitContext - null であってはなりません。リクエストオプションが指定されていない場合は、VaultTransitContext.empty() を使用します。
      戻り値:
      暗号文。

    • decrypt

      ListSE<VaultDecryptionResult> decrypt(StringSE keyName, ListSE<Ciphertext> batchRequest)
      指定されたキーとコンテキストを使用して、提供された暗号文のバッチを復号します。* 復号はトランジットエンジンのバッチ操作を使用して実行されます。
      パラメーター:
      keyName - 空または null であってはなりません。
      batchRequest - プレーンテキストとオプションのコンテキストを含む Ciphertext のリスト。
      戻り値:
      batchRequest 暗号文の順序で復号化された結果。
      導入:
      1.1

    • rewrap

      StringSE rewrap(StringSE keyName, StringSE ciphertext)
      指定されたキーの最新バージョンを使用して、提供された暗号テキストを再ラップします。これはプレーンテキストを決して返さないため、この機能を信頼できないユーザーまたはスクリプトに委譲する可能性があります。
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - 空または null であってはなりません。
      戻り値:
      暗号文。
      関連事項:

    • rewrap

      StringSE rewrap(StringSE keyName, StringSE ciphertext, VaultTransitContext transitContext)
      指定されたキーの最新バージョンを使用して、提供された暗号テキストを再ラップします。これはプレーンテキストを決して返さないため、この機能を信頼できないユーザーまたはスクリプトに委譲する可能性があります。
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - 空または null であってはなりません。
      transitContext - null であってはなりません。リクエストオプションが指定されていない場合は、VaultTransitContext.empty() を使用します。
      戻り値:
      暗号文。
      関連事項:

    • rewrap

      ListSE<VaultEncryptionResult> rewrap(StringSE keyName, ListSE<Ciphertext> batchRequest)
      指定されたキーの最新バージョンを使用して、提供された暗号テキストのバッチを再ラップします。
      パラメーター:
      batchRequest - 暗号文とコンテキストを含む Ciphertext のリスト
      戻り値:
      batchRequest 暗号文の順序で再ラップされた結果。
      導入:
      3.1
      関連事項:

    • getHmac

      Hmac getHmac(StringSE keyName, Plaintext plaintext)
      デフォルトのハッシュアルゴリズムを使用して、指定された Plaintext の keyName を使用して HMAC を作成します。キーは、トランジットでサポートされている任意の型にすることができます。生のキーは、HMAC 関数に使用されるバイトにマーシャリングされます。キーがローテーションをサポートする型の場合、最新 (現在) のバージョンが使用されます。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - null であってはなりません。
      戻り値:
      指定されたデータのダイジェスト、デフォルトのハッシュアルゴリズム、および名前付きキー。
      導入:
      2.0

    • getHmac

      Hmac getHmac(StringSE keyName, VaultHmacRequest request)
      デフォルトのハッシュアルゴリズムを使用して、指定された VaultHmacRequest の keyName を使用して HMAC を作成します。キーは、トランジットでサポートされている任意の型にすることができます。生のキーは、HMAC 関数に使用されるバイトにマーシャリングされます。キーがローテーションをサポートする型の場合、構成された VaultHmacRequest.getKeyVersion() が使用されます。
      パラメーター:
      keyName - 空または null であってはなりません。
      request - VaultHmacRequest は null であってはなりません。
      戻り値:
      指定されたデータのダイジェスト、デフォルトのハッシュアルゴリズム、および名前付きキー。
      導入:
      2.0

    • sign

      Signature sign(StringSE keyName, Plaintext plaintext)
      指定された Plaintext の keyName とデフォルトのハッシュアルゴリズムを使用して暗号署名を作成します。キーは、署名をサポートする型である必要があります。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - 空または null であってはなりません。
      戻り値:
      Plaintext の署名。
      導入:
      2.0

    • sign

      Signature sign(StringSE keyName, VaultSignRequest request)
      指定された VaultSignRequest の keyName と指定されたハッシュアルゴリズムを使用して、暗号署名を作成します。キーは、署名をサポートする型である必要があります。
      パラメーター:
      keyName - 空または null であってはなりません。
      request - VaultSignRequest を空または null にすることはできません。
      戻り値:
      VaultSignRequest の署名。
      導入:
      2.0

    • verify

      boolean verify(StringSE keyName, Plaintext plaintext, Signature signature)
      指定された Plaintext および Signature の keyName を使用して暗号署名を検証します。
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - null であってはなりません。
      signature - 検証する署名は null であってはなりません。
      戻り値:
      署名が有効な場合は true、そうでない場合は false。
      導入:
      2.0

    • verify

      SignatureValidation verify(StringSE keyName, VaultSignatureVerificationRequest request)
      指定された VaultSignRequest の keyName を使用して暗号署名を検証します。
      パラメーター:
      keyName - 空または null であってはなりません。
      request - VaultSignatureVerificationRequest は null であってはなりません。
      戻り値:
      結果の SignatureValidation。
      導入:
      2.0