CryptographyClient class

로컬 모드에서 지정된 키에 대한 Cryptography 클라이언트의 새 인스턴스를 생성합니다.

사용 예제:

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

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

new CryptographyClient(key: JsonWebKey_2)

매개 변수

지정된 키에 대한 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)

매개 변수

클라이언트에 대한 암호화 작업을 수행하는 데 사용되는 키의 ID입니다.

undefined | string keyID

속성 값

자격 증명 모음의 기본 URL입니다. 로컬 JsonWebKey 가 사용되는 경우 vaultUrl은 비어 있습니다.

string vaultUrl

속성 값

지정된 암호 해독 매개 변수를 사용하여 지정된 암호 텍스트를 해독합니다. 암호 해독 매개 변수에 사용되는 알고리즘에 따라 가능한 암호 해독 매개 변수 집합이 변경됩니다.

Microsoft는 먼저 HMAC를 사용하여 암호 텍스트의 무결성을 보장하지 않고 CBC를 사용하지 않는 것이 좋습니다. 자세한 내용은 https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode 을 참조하세요.

예제 사용법:

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): Promise<DecryptResult>

매개 변수

반환

지정된 암호화 알고리즘을 사용하여 지정된 암호화의 암호를 해독합니다.

예제 사용법:

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

Microsoft는 먼저 HMAC를 사용하여 암호 텍스트의 무결성을 보장하지 않고 CBC를 사용하지 않는 것이 좋습니다. 자세한 내용은 https://docs.microsoft.com/dotnet/standard/security/vulnerabilities-cbc-mode 을 참조하세요.

function decrypt(algorithm: string, ciphertext: Uint8Array, options?: DecryptOptions): Promise<DecryptResult>

매개 변수

반환

지정된 암호화 매개 변수를 사용하여 지정된 일반 텍스트를 암호화합니다. 암호화 매개 변수에 설정된 알고리즘에 따라 가능한 암호화 매개 변수 집합이 변경됩니다.

예제 사용법:

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): Promise<EncryptResult>

매개 변수

반환

지정된 암호화 알고리즘을 사용하여 지정된 일반 텍스트를 암호화합니다.

예제 사용법:

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

function encrypt(algorithm: string, plaintext: Uint8Array, options?: EncryptOptions): Promise<EncryptResult>

매개 변수

반환

메시지 다이제스트에 암호화 서명

예제 사용법:

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

function sign(algorithm: string, digest: Uint8Array, options?: SignOptions): Promise<SignResult>

매개 변수

반환

데이터 블록에 암호화 서명

사용 예제:

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

function signData(algorithm: string, data: Uint8Array, options?: SignOptions): Promise<SignResult>

매개 변수

반환

지정된 암호화 알고리즘을 사용하여 지정된 래핑된 키 래핑 해제

예제 사용법:

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

function unwrapKey(algorithm: KeyWrapAlgorithm, encryptedKey: Uint8Array, options?: UnwrapKeyOptions): Promise<UnwrapResult>

매개 변수

반환

서명된 메시지 다이제스트 확인

예제 사용법:

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

function verify(algorithm: string, digest: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>

매개 변수

반환

서명된 데이터 블록 확인

예제 사용법:

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

function verifyData(algorithm: string, data: Uint8Array, signature: Uint8Array, options?: VerifyOptions): Promise<VerifyResult>

매개 변수

반환

지정된 암호화 알고리즘을 사용하여 지정된 키를 래핑합니다.

예제 사용법:

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

function wrapKey(algorithm: KeyWrapAlgorithm, key: Uint8Array, options?: WrapKeyOptions): Promise<WrapResult>

매개 변수

반환