Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Key Vault Keys] Add new algorithms #11380

Merged
merged 10 commits into from
Sep 24, 2020
Merged

[Key Vault Keys] Add new algorithms #11380

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d3f9360
[Key Vault Keys] Add new algorithms
sadasant Sep 21, 2020
e363ffd
seems like this was necessary. Not sure how I didnt catch it before
sadasant Sep 22, 2020
8e6d77b
Renamed aad as additionalAuthenticatedData
sadasant Sep 22, 2020
f296714
formatting
sadasant Sep 22, 2020
d437ff9
this seems better
sadasant Sep 22, 2020
359a578
API changes after recent feedback
sadasant Sep 22, 2020
9fb0ab1
lint fix
sadasant Sep 23, 2020
e155811
swagger property rename WIP
sadasant Sep 24, 2020
872e597
generated changes
sadasant Sep 24, 2020
57e2019
removed console.log
sadasant Sep 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions sdk/keyvault/keyvault-keys/review/keyvault-keys.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export interface CryptographyOptions extends coreHttp.OperationOptions {
}

// @public
export interface DecryptOptions extends CryptographyOptions {
export interface DecryptOptions extends KeyOperationsOptions {
}

// @public
Expand Down Expand Up @@ -99,10 +99,10 @@ export interface DeletedKey {
export type DeletionRecoveryLevel = 'Purgeable' | 'Recoverable+Purgeable' | 'Recoverable' | 'Recoverable+ProtectedSubscription' | 'CustomizedRecoverable+Purgeable' | 'CustomizedRecoverable' | 'CustomizedRecoverable+ProtectedSubscription';

// @public
export type EncryptionAlgorithm = "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5";
export type EncryptionAlgorithm = "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5" | "A128GCM" | "A192GCM" | "A256GCM" | "A128KW" | "A192KW" | "A256KW" | "A128CBC" | "A192CBC" | "A256CBC" | "A128CBCPAD" | "A192CBCPAD" | "A256CBCPAD";

// @public
export interface EncryptOptions extends CryptographyOptions {
export interface EncryptOptions extends KeyOperationsOptions {
}

// @public
Expand Down Expand Up @@ -184,6 +184,13 @@ export type KeyCurveName = "P-256" | "P-384" | "P-521" | "P-256K";
// @public
export type KeyOperation = "encrypt" | "decrypt" | "sign" | "verify" | "wrapKey" | "unwrapKey" | "import";

// @public
export interface KeyOperationsOptions extends CryptographyOptions {
aad?: Uint8Array;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be additionalAuthenticatedData.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

additionalAuthenticatedData is way better! Thank you!

iv?: Uint8Array;
tag?: Uint8Array;
}

// @public
export interface KeyPollerOptions extends coreHttp.OperationOptions {
intervalInMs?: number;
Expand Down Expand Up @@ -295,7 +302,7 @@ export interface SignResult {
}

// @public
export interface UnwrapKeyOptions extends CryptographyOptions {
export interface UnwrapKeyOptions extends KeyOperationsOptions {
}

// @public
Expand Down Expand Up @@ -326,7 +333,7 @@ export interface VerifyResult {
}

// @public
export interface WrapKeyOptions extends CryptographyOptions {
export interface WrapKeyOptions extends KeyOperationsOptions {
}

// @public
Expand Down
39 changes: 7 additions & 32 deletions sdk/keyvault/keyvault-keys/src/cryptographyClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import {
GetKeyOptions,
KeyVaultKey,
LATEST_API_VERSION,
CryptographyOptions,
CryptographyClientOptions,
KeyOperation
} from "./keysModels";
Expand All @@ -46,7 +45,13 @@ import {
SignatureAlgorithm,
SignResult,
VerifyResult,
EncryptResult
EncryptResult,
EncryptOptions,
DecryptOptions,
WrapKeyOptions,
UnwrapKeyOptions,
SignOptions,
VerifyOptions
} from "./cryptographyClientModels";
import { KeyBundle } from "./generated/models";
import { parseKeyVaultKeyId } from "./identifier";
Expand Down Expand Up @@ -737,33 +742,3 @@ export class CryptographyClient {
}
}
}

/**
* Options for {@link encrypt}.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved these from this file to the models file. It made more sense to me.

*/
export interface EncryptOptions extends CryptographyOptions {}

/**
* Options for {@link decrypt}.
*/
export interface DecryptOptions extends CryptographyOptions {}

/**
* Options for {@link sign}.
*/
export interface SignOptions extends CryptographyOptions {}

/**
* Options for {@link verify}.
*/
export interface VerifyOptions extends CryptographyOptions {}

/**
* Options for {@link wrapKey}.
*/
export interface WrapKeyOptions extends CryptographyOptions {}

/**
* Options for {@link unwrapKey}.
*/
export interface UnwrapKeyOptions extends CryptographyOptions {}
70 changes: 68 additions & 2 deletions sdk/keyvault/keyvault-keys/src/cryptographyClientModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import { CryptographyOptions } from "./keysModels";

/**
* Defines values for SignatureAlgorithm.
* @readonly
Expand All @@ -20,11 +22,26 @@ export type SignatureAlgorithm =

/**
* Defines values for EncryptionAlgorithm.
* Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5'
* Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5', 'A128GCM', 'A192GCM', 'A256GCM', 'A128KW', 'A192KW', 'A256KW', 'A128CBC', 'A192CBC', 'A256CBC', 'A128CBCPAD', 'A192CBCPAD', 'A256CBCPAD'
* @readonly
* @enum {string}
*/
export type EncryptionAlgorithm = "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5";
export type EncryptionAlgorithm =
| "RSA-OAEP"
| "RSA-OAEP-256"
| "RSA1_5"
| "A128GCM"
| "A192GCM"
| "A256GCM"
| "A128KW"
| "A192KW"
| "A256KW"
| "A128CBC"
| "A192CBC"
| "A256CBC"
| "A128CBCPAD"
| "A192CBCPAD"
| "A256CBCPAD";

/**
* Defines values for KeyCurveName.
Expand Down Expand Up @@ -137,3 +154,52 @@ export interface VerifyResult {
*/
keyID?: string;
}

/**
* Common optional properties for encrypt, decrypt, wrap and unwrap.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved these from this file to the models file. It made more sense to me.

*/
export interface KeyOperationsOptions extends CryptographyOptions {
/**
* Initialization vector for symmetric algorithms.
*/
iv?: Uint8Array;
/**
* Additional data to authenticate but not encrypt/decrypt when using authenticated crypto
* algorithms.
*/
aad?: Uint8Array;
/**
* The tag to authenticate when performing decryption with an authenticated algorithm.
*/
tag?: Uint8Array;
}

/**
* Options for {@link encrypt}.
*/
export interface EncryptOptions extends KeyOperationsOptions {}

/**
* Options for {@link decrypt}.
*/
export interface DecryptOptions extends KeyOperationsOptions {}

/**
* Options for {@link sign}.
*/
export interface SignOptions extends CryptographyOptions {}

/**
* Options for {@link verify}.
*/
export interface VerifyOptions extends CryptographyOptions {}

/**
* Options for {@link wrapKey}.
*/
export interface WrapKeyOptions extends KeyOperationsOptions {}

/**
* Options for {@link unwrapKey}.
*/
export interface UnwrapKeyOptions extends KeyOperationsOptions {}
20 changes: 10 additions & 10 deletions sdk/keyvault/keyvault-keys/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,7 @@ import {
CryptographyClientOptions
} from "./keysModels";

import {
CryptographyClient,
DecryptOptions,
EncryptOptions,
SignOptions,
UnwrapKeyOptions,
VerifyOptions,
WrapKeyOptions
} from "./cryptographyClient";
import { CryptographyClient } from "./cryptographyClient";

import { LocalCryptographyClient } from "./localCryptographyClient";

Expand All @@ -98,14 +90,22 @@ import {
UnwrapResult,
VerifyResult,
WrapResult,
EncryptResult
KeyOperationsOptions,
EncryptResult,
DecryptOptions,
EncryptOptions,
SignOptions,
UnwrapKeyOptions,
VerifyOptions,
WrapKeyOptions
} from "./cryptographyClientModels";
import { LocalSupportedAlgorithmName } from "./localCryptography/algorithms";

import { parseKeyVaultKeyId, KeyVaultKeyId } from "./identifier";

export {
CryptographyClientOptions,
KeyOperationsOptions,
KeyClientOptions,
BackupKeyOptions,
CreateEcKeyOptions,
Expand Down