Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

[AutoPR keyvault/data-plane] EC curve and algorithm name updates #3038

Merged
AutorestCI merged 1 commit into from
Jun 20, 2018
Merged

[AutoPR keyvault/data-plane] EC curve and algorithm name updates #3038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions lib/services/keyvault/LICENSE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
120 changes: 82 additions & 38 deletions lib/services/keyvault/lib/keyVaultClient.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {object} [options] Optional Parameters.
*
* @param {number} [options.keySize] The key size in bytes. For example, 1024
* or 2048.
* @param {number} [options.keySize] The key size in bits. For example: 2048,
* 3072, or 4096 for RSA.
*
* @param {array} [options.keyOps]
*
Expand All @@ -89,7 +89,7 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [options.curve] Elliptic curve name. For valid values, see
* JsonWebKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521',
* 'SECP256K1'
* 'P-256K'
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
Expand Down Expand Up @@ -122,8 +122,8 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {object} [options] Optional Parameters.
*
* @param {number} [options.keySize] The key size in bytes. For example, 1024
* or 2048.
* @param {number} [options.keySize] The key size in bits. For example: 2048,
* 3072, or 4096 for RSA.
*
* @param {array} [options.keyOps]
*
Expand All @@ -141,7 +141,7 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [options.curve] Elliptic curve name. For valid values, see
* JsonWebKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521',
* 'SECP256K1'
* 'P-256K'
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
Expand Down Expand Up @@ -190,8 +190,9 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [key.kid] Key identifier.
*
* @param {string} [key.kty] JsonWebKey key type (kty). Possible values
* include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
* @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible
* values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {array} [key.keyOps]
*
Expand All @@ -218,7 +219,7 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [key.crv] Elliptic curve name. For valid values, see
* JsonWebKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521',
* 'SECP256K1'
* 'P-256K'
*
* @param {buffer} [key.x] X component of an EC public key.
*
Expand Down Expand Up @@ -269,8 +270,9 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [key.kid] Key identifier.
*
* @param {string} [key.kty] JsonWebKey key type (kty). Possible values
* include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
* @param {string} [key.kty] JsonWebKey Key Type (kty), as defined in
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible
* values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {array} [key.keyOps]
*
Expand All @@ -297,7 +299,7 @@ export default class KeyVaultClient extends AzureServiceClient {
*
* @param {string} [key.crv] Elliptic curve name. For valid values, see
* JsonWebKeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521',
* 'SECP256K1'
* 'P-256K'
*
* @param {buffer} [key.x] X component of an EC public key.
*
Expand Down Expand Up @@ -1145,7 +1147,7 @@ export default class KeyVaultClient extends AzureServiceClient {
* more information on possible algorithm types, see
* JsonWebKeySignatureAlgorithm. Possible values include: 'PS256', 'PS384',
* 'PS512', 'RS256', 'RS384', 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512',
* 'ECDSA256'
* 'ES256K'
*
* @param {buffer} value
*
Expand Down Expand Up @@ -1180,7 +1182,7 @@ export default class KeyVaultClient extends AzureServiceClient {
* more information on possible algorithm types, see
* JsonWebKeySignatureAlgorithm. Possible values include: 'PS256', 'PS384',
* 'PS512', 'RS256', 'RS384', 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512',
* 'ECDSA256'
* 'ES256K'
*
* @param {buffer} value
*
Expand Down Expand Up @@ -1236,7 +1238,7 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {string} algorithm The signing/verification algorithm. For more
* information on possible algorithm types, see JsonWebKeySignatureAlgorithm.
* Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384',
* 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ECDSA256'
* 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ES256K'
*
* @param {buffer} digest The digest used for signing.
*
Expand Down Expand Up @@ -1275,7 +1277,7 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {string} algorithm The signing/verification algorithm. For more
* information on possible algorithm types, see JsonWebKeySignatureAlgorithm.
* Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384',
* 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ECDSA256'
* 'RS512', 'RSNULL', 'ES256', 'ES384', 'ES512', 'ES256K'
*
* @param {buffer} digest The digest used for signing.
*
Expand Down Expand Up @@ -3514,15 +3516,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down Expand Up @@ -3631,15 +3638,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down Expand Up @@ -3777,15 +3789,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down Expand Up @@ -3904,15 +3921,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down Expand Up @@ -4184,14 +4206,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if
* the private key can be exported.
*
* @param {string} [certificatePolicy.keyProperties.keyType] The key type.
* @param {string} [certificatePolicy.keyProperties.kty] The type of key pair
* to be used for the certificate. Possible values include: 'EC', 'EC-HSM',
* 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [certificatePolicy.keyProperties.keySize] The key size in
* bytes. For example; 1024 or 2048.
* bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the
* same key pair will be used on certificate renewal.
*
* @param {string} [certificatePolicy.keyProperties.curve] Elliptic curve name.
* For valid values, see JsonWebKeyCurveName. Possible values include: 'P-256',
* 'P-384', 'P-521', 'P-256K'
*
* @param {object} [certificatePolicy.secretProperties] Properties of the
* secret backing a certificate.
*
Expand Down Expand Up @@ -4291,14 +4319,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [certificatePolicy.keyProperties.exportable] Indicates if
* the private key can be exported.
*
* @param {string} [certificatePolicy.keyProperties.keyType] The key type.
* @param {string} [certificatePolicy.keyProperties.kty] The type of key pair
* to be used for the certificate. Possible values include: 'EC', 'EC-HSM',
* 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [certificatePolicy.keyProperties.keySize] The key size in
* bytes. For example; 1024 or 2048.
* bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [certificatePolicy.keyProperties.reuseKey] Indicates if the
* same key pair will be used on certificate renewal.
*
* @param {string} [certificatePolicy.keyProperties.curve] Elliptic curve name.
* For valid values, see JsonWebKeyCurveName. Possible values include: 'P-256',
* 'P-384', 'P-521', 'P-256K'
*
* @param {object} [certificatePolicy.secretProperties] Properties of the
* secret backing a certificate.
*
Expand Down Expand Up @@ -4424,15 +4458,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down Expand Up @@ -4546,15 +4585,20 @@ export default class KeyVaultClient extends AzureServiceClient {
* @param {boolean} [options.certificatePolicy.keyProperties.exportable]
* Indicates if the private key can be exported.
*
* @param {string} [options.certificatePolicy.keyProperties.keyType] The key
* type.
* @param {string} [options.certificatePolicy.keyProperties.kty] The type of
* key pair to be used for the certificate. Possible values include: 'EC',
* 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*
* @param {number} [options.certificatePolicy.keyProperties.keySize] The key
* size in bytes. For example; 1024 or 2048.
* size in bits. For example: 2048, 3072, or 4096 for RSA.
*
* @param {boolean} [options.certificatePolicy.keyProperties.reuseKey]
* Indicates if the same key pair will be used on certificate renewal.
*
* @param {string} [options.certificatePolicy.keyProperties.curve] Elliptic
* curve name. For valid values, see JsonWebKeyCurveName. Possible values
* include: 'P-256', 'P-384', 'P-521', 'P-256K'
*
* @param {object} [options.certificatePolicy.secretProperties] Properties of
* the secret backing a certificate.
*
Expand Down
Loading