Skip to content

[KeyVault] az keyvault key import: Support --curve parameter for importing BYOK keys #16593

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

Merged
houk-ms merged 3 commits into from
Jan 22, 2021
Merged

[KeyVault] az keyvault key import: Support --curve parameter for importing BYOK keys #16593

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f5cd90
support --curve parameter in key import
houk-ms Jan 20, 2021
6b313ec
code refining
houk-ms Jan 20, 2021
44b5aee
Update src/azure-cli/azure/cli/command_modules/keyvault/_validators.py
houk-ms Jan 20, 2021
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
12 changes: 10 additions & 2 deletions src/azure-cli/azure/cli/command_modules/keyvault/_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
get_keyvault_name_completion_list, get_keyvault_version_completion_list)
from azure.cli.command_modules.keyvault._validators import (
datetime_type, certificate_type,
get_vault_base_url_type, get_hsm_base_url_type,
get_vault_base_url_type, get_hsm_base_url_type, validate_key_import_type,
validate_key_import_source, validate_key_type, validate_policy_permissions, validate_principal,
validate_resource_group_name, validate_x509_certificate_chain,
secret_text_encoding_values, secret_binary_encoding_values, validate_subnet,
Expand Down Expand Up @@ -71,6 +71,12 @@ class CLIKeyTypeForBYOKImport(str, Enum):
ec = "EC" #: Elliptic Curve.
rsa = "RSA" #: RSA (https://tools.ietf.org/html/rfc3447)

class CLIJsonWebKeyCurveName(str, Enum):
p_256 = "P-256" #: The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
p_256k = "P-256K" #: The SECG SECP256K1 elliptic curve.
p_384 = "P-384" #: The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
p_521 = "P-521" #: The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.

(KeyPermissions, SecretPermissions, CertificatePermissions, StoragePermissions,
NetworkRuleBypassOptions, NetworkRuleAction) = self.get_models(
'KeyPermissions', 'SecretPermissions', 'CertificatePermissions', 'StoragePermissions',
Expand Down Expand Up @@ -347,8 +353,10 @@ class CLIKeyTypeForBYOKImport(str, Enum):
help='Elliptic curve name. For valid values, see: https://docs.microsoft.com/en-us/rest/api/keyvault/createkey/createkey#jsonwebkeycurvename')

with self.argument_context('keyvault key import') as c:
c.argument('kty', arg_type=get_enum_type(CLIKeyTypeForBYOKImport),
c.argument('kty', arg_type=get_enum_type(CLIKeyTypeForBYOKImport), validator=validate_key_import_type,
help='The type of key to import (only for BYOK).')
c.argument('curve', arg_type=get_enum_type(CLIJsonWebKeyCurveName), validator=validate_key_import_type,
help='The curve name of the key to import (only for BYOK).')

with self.argument_context('keyvault key import', arg_group='Key Source') as c:
c.argument('pem_file', type=file_type, help='PEM file containing the key to be imported.', completer=FilesCompleter(), validator=validate_key_import_source)
Expand Down
10 changes: 10 additions & 0 deletions src/azure-cli/azure/cli/command_modules/keyvault/_validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,16 @@ def validate_key_import_source(ns):
raise ValueError('--pem-password must be used with --pem-file or --pem-string')


def validate_key_import_type(ns):
# Default value of kty is: RSA
kty = getattr(ns, 'kty', None)
crv = getattr(ns, 'curve', None)

if (kty == 'EC' and crv is None) or (kty != 'EC' and crv):
Copy link
Member

@qwordy qwordy Jan 20, 2021

Choose a reason for hiding this comment

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

add a lower()?

Copy link
Contributor Author

@houk-ms houk-ms Jan 20, 2021

Choose a reason for hiding this comment

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

We don't accept the lower case, it also applies to other existing commands.

from azure.cli.core.azclierror import ValidationError
raise ValidationError('parameter --curve should be specified when key type is EC.')


def validate_key_type(ns):
crv = getattr(ns, 'curve', None)
kty = getattr(ns, 'kty', None) or ('EC' if crv else 'RSA')
Expand Down
3 changes: 2 additions & 1 deletion src/azure-cli/azure/cli/command_modules/keyvault/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1189,7 +1189,7 @@ def import_key(cmd, client, key_name=None, vault_base_url=None, # pylint: disab
hsm_name=None, identifier=None, # pylint: disable=unused-argument
protection=None, key_ops=None, disabled=False, expires=None,
not_before=None, tags=None, pem_file=None, pem_string=None, pem_password=None, byok_file=None,
byok_string=None, kty='RSA'):
byok_string=None, kty='RSA', curve=None):
""" Import a private key. Supports importing base64 encoded private keys from PEM files or strings.
Supports importing BYOK keys into HSM for premium key vaults. """
KeyAttributes = cmd.get_models('KeyAttributes', resource_type=ResourceType.DATA_KEYVAULT)
Expand Down Expand Up @@ -1234,6 +1234,7 @@ def import_key(cmd, client, key_name=None, vault_base_url=None, # pylint: disab

key_obj.kty = kty + '-HSM'
key_obj.t = byok_data
key_obj.crv = curve

return client.import_key(vault_base_url, key_name, key_obj, protection == 'hsm', key_attrs, tags)

Expand Down