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

クラス VaultTransitTemplate

java.lang.ObjectSE
org.springframework.vault.core.VaultTransitTemplate
実装されているすべてのインターフェース:
VaultTransitOperations
public class VaultTransitTemplate extends ObjectSE implements VaultTransitOperations
VaultTransitOperations のデフォルト実装。
作成者:
Mark Paluch, Sven Sch ü rmann, Praveendra Singh, Luander Ribeiro, Mikko Koli, My-Lan Aragon, Nanne Baars

  • コンストラクターの詳細

    • VaultTransitTemplate

      public VaultTransitTemplate(VaultOperations vaultOperations, StringSE path)
      VaultOperations とマウント path を指定して、新しい VaultTransitTemplate を作成します。
      パラメーター:
      vaultOperations - null であってはなりません。
      path - 空または null であってはなりません。

  • メソッドの詳細

    • createKey

      public void createKey(StringSE keyName)
      インターフェースからコピーされた説明: VaultTransitOperations
      name を指定して、新しい名前付き暗号鍵を作成します。
      次で指定:
      インターフェース VaultTransitOperations の createKey 
      パラメーター:
      keyName - 空または null であってはなりません。

    • createKey

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

    • getKeys

      public ListSE<StringSE> getKeys()
      インターフェースからコピーされた説明: VaultTransitOperations
      中継キー名の ListSE を取得します。
      次で指定:
      インターフェース VaultTransitOperations の getKeys 
      戻り値:
      中継キー名の ListSE。

    • configureKey

      public void configureKey(StringSE keyName, VaultTransitKeyConfiguration keyConfiguration)
      インターフェースからコピーされた説明: VaultTransitOperations
      name を指定して、新しい名前付き暗号鍵を作成します。
      次で指定:
      インターフェース VaultTransitOperations の configureKey 
      パラメーター:
      keyName - 空または null であってはなりません。
      keyConfiguration - null であってはなりません。

    • exportKey

      public @Nullable RawTransitKey exportKey(StringSE keyName, TransitKeyType type)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定された暗号化キーの値を返します。キーの型によって、異なる情報が返される場合があります。この操作をサポートするには、キーがエクスポート可能である必要があります。
      次で指定:
      インターフェース VaultTransitOperations の exportKey 
      パラメーター:
      keyName - 空または null であってはなりません。
      type - null であってはなりません。
      戻り値:
      RawTransitKey

    • getKey

      public @Nullable VaultTransitKey getKey(StringSE keyName)
      インターフェースからコピーされた説明: VaultTransitOperations
      名前付き暗号鍵に関する情報を返します。
      次で指定:
      インターフェース VaultTransitOperations の getKey 
      パラメーター:
      keyName - 空または null であってはなりません。
      戻り値:
      VaultTransitKey

    • deleteKey

      public void deleteKey(StringSE keyName)
      インターフェースからコピーされた説明: VaultTransitOperations
      名前付き暗号鍵を削除します。指定されたキーで暗号化されたデータを復号化することはできなくなります。
      次で指定:
      インターフェース VaultTransitOperations の deleteKey 
      パラメーター:
      keyName - 空または null であってはなりません。

    • rotate

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

    • encrypt

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

    • encrypt

      public Ciphertext encrypt(StringSE keyName, Plaintext plaintext)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定されたキーを使用して、指定された plaintext を暗号化します。
      次で指定:
      インターフェース VaultTransitOperations の encrypt 
      パラメーター:
      keyName - 空または null であってはなりません。
      plaintext - null であってはなりません。
      戻り値:
      暗号文。

    • encrypt

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

    • encrypt

      public ListSE<VaultEncryptionResult> encrypt(StringSE keyName, ListSE<Plaintext> batchRequest)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定されたキーとコンテキストを使用して、指定された plaintext のバッチを暗号化します。暗号化は、トランジットバックエンドのバッチ操作を使用して行われます。
      次で指定:
      インターフェース VaultTransitOperations の encrypt 
      パラメーター:
      keyName - 空または null であってはなりません。
      batchRequest - プレーンテキストとオプションのコンテキストを含む Plaintext のリスト。
      戻り値:
      batchRequest 平文の順序で暗号化された結果。

    • decrypt

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

    • decrypt

      public Plaintext decrypt(StringSE keyName, Ciphertext ciphertext)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定されたキーを使用して、指定された暗号テキストを復号化します。
      次で指定:
      インターフェース VaultTransitOperations の decrypt 
      パラメーター:
      keyName - 空または null であってはなりません。
      ciphertext - null であってはなりません。
      戻り値:
      プレーンテキスト。

    • decrypt

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

    • decrypt

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

    • rewrap

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

    • rewrap

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

    • rewrap

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

    • getHmac

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

    • getHmac

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

    • sign

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

    • sign

      public Signature sign(StringSE keyName, VaultSignRequest signRequest)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定された VaultSignRequest の keyName と指定されたハッシュアルゴリズムを使用して、暗号署名を作成します。キーは、署名をサポートする型である必要があります。
      次で指定:
      インターフェース VaultTransitOperations の sign 
      パラメーター:
      keyName - 空または null であってはなりません。
      signRequest - VaultSignRequest を空または null にすることはできません。
      戻り値:
      VaultSignRequest の署名。

    • verify

      public boolean verify(StringSE keyName, Plaintext plainText, Signature signature)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定された Plaintext および Signature の keyName を使用して暗号署名を検証します。
      次で指定:
      インターフェース VaultTransitOperations の verify 
      パラメーター:
      keyName - 空または null であってはなりません。
      plainText - null であってはなりません。
      signature - 検証する署名は null であってはなりません。
      戻り値:
      署名が有効な場合は true、そうでない場合は false。

    • verify

      public SignatureValidation verify(StringSE keyName, VaultSignatureVerificationRequest verificationRequest)
      インターフェースからコピーされた説明: VaultTransitOperations
      指定された VaultSignRequest の keyName を使用して暗号署名を検証します。
      次で指定:
      インターフェース VaultTransitOperations の verify 
      パラメーター:
      keyName - 空または null であってはなりません。
      verificationRequest - VaultSignatureVerificationRequest は null であってはなりません。
      戻り値:
      結果の SignatureValidation。

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString