CryptographyClient class

パッケージ:: @azure/keyvault-keys

Azure Key Vault キーまたはローカル <xref:JsonWebKey>に対して暗号化操作を実行するために使用されるクライアント。

コンストラクター

指定されたキーの暗号化クライアントの新しいインスタンスをローカルモードで構築します。使用例:

import { CryptographyClient } from "@azure/keyvault-keys";

const jsonWebKey: JsonWebKey = {
  // ...
};
const client = new CryptographyClient(jsonWebKey);

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

特定のキーの使用例に対して、Cryptography クライアントの新しいインスタンスを構築します。

import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let keyClient = new KeyClient(vaultUrl, credentials);
let keyVaultKey = await keyClient.getKey("MyKey");

let client = new CryptographyClient(keyVaultKey.id, credentials);
// or
let client = new CryptographyClient(keyVaultKey, credentials);

プロパティ

keyID	クライアントの暗号化操作を実行するために使用されるキーの ID。
vaultUrl	コンテナーへのベース URL。ローカル <xref:JsonWebKey> が使用されている場合、vaultUrl は空になります。

メソッド

decrypt(DecryptParameters, DecryptOptions)	指定した暗号化解除パラメーターを使用して、指定された暗号テキストを復号化します。復号化パラメーターで使用されるアルゴリズムに応じて、可能な復号化パラメーターのセットが変更されます。使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.decrypt({ algorithm: "RSA1_5", ciphertext: encryptedBuffer }); let result = await client.decrypt({ algorithm: "A256GCM", iv: ivFromEncryptResult, authenticationTag: tagFromEncryptResult });`
decrypt(EncryptionAlgorithm, Uint8Array, DecryptOptions)	指定した暗号アルゴリズムを使用して、指定された暗号テキストを復号化します。使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.decrypt("RSA1_5", encryptedBuffer);`
encrypt(EncryptionAlgorithm, Uint8Array, EncryptOptions)	指定した暗号化アルゴリズムを使用して、指定されたプレーンテキストを暗号化します。使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));`
encrypt(EncryptParameters, EncryptOptions)	指定した暗号化パラメーターを使用して、指定されたプレーンテキストを暗号化します。暗号化パラメーターに設定されているアルゴリズムに応じて、使用可能な暗号化パラメーターのセットが変更されます。使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.encrypt({ algorithm: "RSA1_5", plaintext: Buffer.from("My Message")}); let result = await client.encrypt({ algorithm: "A256GCM", plaintext: Buffer.from("My Message"), additionalAuthenticatedData: Buffer.from("My authenticated data")});`
sign(SignatureAlgorithm, Uint8Array, SignOptions)	メッセージのダイジェストに暗号で署名する使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.sign("RS256", digest);`
signData(SignatureAlgorithm, Uint8Array, SignOptions)	データのブロックに暗号で署名する使用例: `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.signData("RS256", message);`
unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)	指定した暗号化アルゴリズムの使用例を使用して、指定されたラップされたキーのラップを解除します。 `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.unwrapKey("RSA1_5", keyToUnwrap);`
verify(SignatureAlgorithm, Uint8Array, Uint8Array, VerifyOptions)	署名されたメッセージダイジェストの使用例を確認します。 `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verify("RS256", signedDigest, signature);`
verifyData(SignatureAlgorithm, Uint8Array, Uint8Array, VerifyOptions)	データの署名済みブロックの使用例を確認します。 `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.verifyData("RS256", signedMessage, signature);`
wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)	指定した暗号化アルゴリズムの使用例を使用して、指定されたキーをラップします。 `let client = new CryptographyClient(keyVaultKey, credentials); let result = await client.wrapKey("RSA1_5", keyToWrap);`

コンストラクターの詳細

CryptographyClient(JsonWebKey)

指定されたキーの暗号化クライアントの新しいインスタンスをローカルモードで構築します。使用例:

import { CryptographyClient } from "@azure/keyvault-keys";

const jsonWebKey: JsonWebKey = {
  // ...
};
const client = new CryptographyClient(jsonWebKey);

new CryptographyClient(key: JsonWebKey)

パラメーター

key: JsonWebKey

暗号化タスク中に使用するキー。キーの識別子 (URL) をここで渡すこともできます。

CryptographyClient(string | KeyVaultKey, TokenCredential, CryptographyClientOptions)

特定のキーの使用例に対して、Cryptography クライアントの新しいインスタンスを構築します。

import { KeyClient, CryptographyClient } from "@azure/keyvault-keys";
import { DefaultAzureCredential } from "@azure/identity";

let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();

let keyClient = new KeyClient(vaultUrl, credentials);
let keyVaultKey = await keyClient.getKey("MyKey");

let client = new CryptographyClient(keyVaultKey.id, credentials);
// or
let client = new CryptographyClient(keyVaultKey, credentials);

new CryptographyClient(key: string | KeyVaultKey, credential: TokenCredential, pipelineOptions?: CryptographyClientOptions)

パラメーター

key: string | KeyVaultKey

暗号化タスク中に使用するキー。キーの識別子 (URL) をここで渡すこともできます。

credential: TokenCredential

サービスへの要求を認証するために使用する TokenCredential インターフェイスを実装するオブジェクト。 @azure/ID パッケージを使用して、ニーズに合った資格情報を作成します。

pipelineOptions: CryptographyClientOptions

Key Vault API 要求の構成に使用されるパイプラインオプション。既定のパイプライン構成を使用するには、このパラメーターを省略します。

プロパティの詳細

keyID

クライアントの暗号化操作を実行するために使用されるキーの ID。

string | undefined keyID

プロパティ値

string | undefined

vaultUrl

コンテナーへのベース URL。ローカル <xref:JsonWebKey> が使用されている場合、vaultUrl は空になります。

string vaultUrl

プロパティ値

string

メソッドの詳細

decrypt(DecryptParameters, DecryptOptions)

指定した暗号化解除パラメーターを使用して、指定された暗号テキストを復号化します。復号化パラメーターで使用されるアルゴリズムに応じて、可能な復号化パラメーターのセットが変更されます。使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt({ algorithm: "RSA1_5", ciphertext: encryptedBuffer });
let result = await client.decrypt({ algorithm: "A256GCM", iv: ivFromEncryptResult, authenticationTag: tagFromEncryptResult });

function decrypt(decryptParameters: DecryptParameters, options?: DecryptOptions)

パラメーター

decryptParameters: DecryptParameters

復号化パラメーター。

options: DecryptOptions

その他のオプション。

戻り値

Promise<DecryptResult>

decrypt(EncryptionAlgorithm, Uint8Array, DecryptOptions)

警告

この API は非推奨になりました。

Use decrypt({ algorithm, ciphertext }, options) instead.

指定した暗号アルゴリズムを使用して、指定された暗号テキストを復号化します。使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.decrypt("RSA1_5", encryptedBuffer);

function decrypt(algorithm: EncryptionAlgorithm, ciphertext: Uint8Array, options?: DecryptOptions)

パラメーター

algorithm: EncryptionAlgorithm

使用するアルゴリズム。

ciphertext: Uint8Array

復号化するテキスト。

options: DecryptOptions

その他のオプション。

戻り値

Promise<DecryptResult>

encrypt(EncryptionAlgorithm, Uint8Array, EncryptOptions)

警告

この API は非推奨になりました。

Use encrypt({ algorithm, plaintext }, options) instead.

指定した暗号化アルゴリズムを使用して、指定されたプレーンテキストを暗号化します。使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.encrypt("RSA1_5", Buffer.from("My Message"));

function encrypt(algorithm: EncryptionAlgorithm, plaintext: Uint8Array, options?: EncryptOptions)

パラメーター

algorithm: EncryptionAlgorithm

使用するアルゴリズム。

plaintext: Uint8Array

暗号化するテキスト。

options: EncryptOptions

その他のオプション。

戻り値

Promise<EncryptResult>

encrypt(EncryptParameters, EncryptOptions)

指定した暗号化パラメーターを使用して、指定されたプレーンテキストを暗号化します。暗号化パラメーターに設定されているアルゴリズムに応じて、使用可能な暗号化パラメーターのセットが変更されます。使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.encrypt({ algorithm: "RSA1_5", plaintext: Buffer.from("My Message")});
let result = await client.encrypt({ algorithm: "A256GCM", plaintext: Buffer.from("My Message"), additionalAuthenticatedData: Buffer.from("My authenticated data")});

function encrypt(encryptParameters: EncryptParameters, options?: EncryptOptions)

パラメーター

encryptParameters: EncryptParameters

選択した暗号化アルゴリズムに基づく暗号化パラメーター。

options: EncryptOptions

その他のオプション。

戻り値

Promise<EncryptResult>

sign(SignatureAlgorithm, Uint8Array, SignOptions)

メッセージのダイジェストに暗号で署名する使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.sign("RS256", digest);

function sign(algorithm: SignatureAlgorithm, digest: Uint8Array, options?: SignOptions)

パラメーター

algorithm: SignatureAlgorithm

使用する署名アルゴリズム。

digest: Uint8Array

署名するデータのダイジェスト。

options: SignOptions

その他のオプション。

戻り値

Promise<SignResult>

signData(SignatureAlgorithm, Uint8Array, SignOptions)

データのブロックに暗号で署名する使用例:

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.signData("RS256", message);

function signData(algorithm: SignatureAlgorithm, data: Uint8Array, options?: SignOptions)

パラメーター

algorithm: SignatureAlgorithm

使用する署名アルゴリズム。

data: Uint8Array

署名するデータ。

options: SignOptions

その他のオプション。

戻り値

Promise<SignResult>

unwrapKey(KeyWrapAlgorithm, Uint8Array, UnwrapKeyOptions)

指定した暗号化アルゴリズムの使用例を使用して、指定されたラップされたキーのラップを解除します。

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.unwrapKey("RSA1_5", keyToUnwrap);

function unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions)

パラメーター

algorithm: KeyWrapAlgorithm

キーのラップ解除に使用する復号化アルゴリズム。

encryptedKey: Uint8Array

ラップを解除する暗号化されたキー。

options: UnwrapKeyOptions

その他のオプション。

戻り値

Promise<UnwrapResult>

verify(SignatureAlgorithm, Uint8Array, Uint8Array, VerifyOptions)

署名されたメッセージダイジェストの使用例を確認します。

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verify("RS256", signedDigest, signature);

function verify(algorithm: SignatureAlgorithm, digest: Uint8Array, signature: Uint8Array, options?: VerifyOptions)

パラメーター

algorithm: SignatureAlgorithm

検証に使用する署名アルゴリズム。

digest: Uint8Array

確認するダイジェスト。

signature: Uint8Array

ダイジェストを検証する署名。

options: VerifyOptions

その他のオプション。

戻り値

Promise<VerifyResult>

verifyData(SignatureAlgorithm, Uint8Array, Uint8Array, VerifyOptions)

データの署名済みブロックの使用例を確認します。

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.verifyData("RS256", signedMessage, signature);

function verifyData(algorithm: SignatureAlgorithm, data: Uint8Array, signature: Uint8Array, options?: VerifyOptions)

パラメーター

algorithm: SignatureAlgorithm

検証に使用するアルゴリズム。

data: Uint8Array

検証するデータの符号付きブロック。

signature: Uint8Array

ブロックを検証する対象の署名。

options: VerifyOptions

その他のオプション。

戻り値

Promise<VerifyResult>

wrapKey(KeyWrapAlgorithm, Uint8Array, WrapKeyOptions)

指定した暗号化アルゴリズムの使用例を使用して、指定されたキーをラップします。

let client = new CryptographyClient(keyVaultKey, credentials);
let result = await client.wrapKey("RSA1_5", keyToWrap);

function wrapKey(algorithm: KeyWrapAlgorithm, key: Uint8Array, options?: WrapKeyOptions)

パラメーター

algorithm: KeyWrapAlgorithm

指定されたキーをラップするために使用する暗号化アルゴリズム。

key: Uint8Array

ラップするキー。

options: WrapKeyOptions

その他のオプション。

戻り値

Promise<WrapResult>

フィードバック

このページはお役に立ちましたか?