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.

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

[KeyVault] KeyVault Round 3 Commands #1215

Merged
merged 3 commits into from
Nov 4, 2016
Merged

[KeyVault] KeyVault Round 3 Commands #1215

merged 3 commits into from
Nov 4, 2016

Conversation

tjprescott
Copy link
Member

@tjprescott tjprescott commented Nov 2, 2016

This PR adds the following KeyVault commands and associated tests:

  • key: import, backup, restore
  • certificate: import (PEM and PFX support)
  • certificate pending: show, merge, delete

@tjprescott
Copy link
Member Author

key import

Command
    az keyvault key import

Arguments
    --name -n    [Required]: Name of the key.
    --vault-name [Required]: Name of the key vault.
    --disabled             : Create key in disabled state.
    --expires              : Expiration UTC datetime  (Y-m-d'T'H:M'Z').
    --not-before           : Key not usable before the provided UTC datetime  (Y-m-d'T'H:M'Z').
    --ops                  : Space separated list of permitted JSON web key operations. Possible
                             values: encrypt, decrypt, sign, verify, wrapKey, unwrapKey.
    --protection -p        : Specifies the type of key protection.  Allowed values: hsm, software.
    --tags                 : Space separated tags in 'key[=value]' format. Use "" to clear existing
                             tags.

key backup

Command
    az keyvault key backup: Requests that a backup of the specified key be downloaded to the client.

Arguments
    --file-path  [Required]
    --name -n    [Required]: Name of the key.
    --vault-name [Required]: Name of the key vault.

key restore

Command
    az keyvault key restore: Restores the backup key in to a vault.

Arguments
    --file-path  [Required]
    --vault-name [Required]: Name of the key vault.

certificate import

Command
    az keyvault certificate import: Imports a certificate into the specified vault.

Arguments
    --file -f    [Required]: PKCS12 file or PEM file containing the certificate and private key.
    --name -n    [Required]: Name of the certificate.
    --vault-name [Required]: Name of the key vault.
    --disabled             : Create certificate in disabled state.
    --expires              : Expiration UTC datetime  (Y-m-d'T'H:M'Z').
    --not-before           : Key not usable before the provided UTC datetime  (Y-m-d'T'H:M'Z').
    --password             : If the private key in base64EncodedCertificate is encrypted, the
                             password used for encryption.
    --policy -p            : JSON encoded policy defintion. Use @{file} to load from a file.
    --tags                 : Space separated tags in 'key[=value]' format. Use "" to clear existing
                             tags.

certificate pending merge

Command
    az keyvault certificate pending merge: Merges a certificate or a certificate chain with a key
    pair existing on the server.

Arguments
    --file -f    [Required]: File containing the certificate or certificate chain to merge.
    --name -n    [Required]: Name of the certificate.
    --vault-name [Required]: Name of the key vault.
    --disabled             : Create certificate in disabled state.
    --expires              : Expiration UTC datetime  (Y-m-d'T'H:M'Z').
    --not-before           : Key not usable before the provided UTC datetime  (Y-m-d'T'H:M'Z').
    --tags                 : Space separated tags in 'key[=value]' format. Use "" to clear existing
                             tags.

@tjprescott
Copy link
Member Author

Group Help

keyvault key

Group
    az keyvault key: Manage keys.

Commands:
    backup        : Requests that a backup of the specified key be downloaded to the client.
    create        : Creates a new, named, key in the specified vault.
    delete        : Deletes the specified key.
    import
    list          : List keys in the specified vault.
    list-versions : List the versions of the specified key.
    restore       : Restores the backup key in to a vault.
    set-attributes: Updates the Key Attributes associated with the specified key.
    show          : Retrieves the public portion of a key plus its attributes.

keyvault certificate

Group
    az keyvault certificate: Manage certificates.

Subgroups:
    contact       : Manage contacts for certificate management.
    issuer        : Manage certificate issuer information.
    pending       : Manage pending certificate creation operations.

Commands:
    create        : Creates a new certificate version.
    delete        : Deletes a certificate from the specified vault.
    import        : Imports a certificate into the specified vault.
    list          : List certificates in the specified vault.
    list-versions : List the versions of a certificate.
    set-attributes: Updates the attributes associated with the specified certificate.
    show          : Gets a Certificate.

keyvault certificate pending

Group
    az keyvault certificate pending: Manage pending certificate creation operations.

Commands:
    delete: Deletes the certificate operation.
    merge : Merges a certificate or a certificate chain with a key pair existing on the server.
    show  : Gets the certificate operation response.

@tjprescott
Copy link
Member Author

tjprescott commented Nov 2, 2016

Already see a few params that need help text and some command help cleanup.

Also, I plan to do a complete sweep for completers and ids in Round 4 so please hold those 😁

Copy link
Member

@derekbekoe derekbekoe left a comment

Choose a reason for hiding this comment

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

Added a few small comments

@@ -17,6 +17,7 @@ def extract_full_summary_from_signature(operation):
summary = lines[:match.regs[0][0]]
else:
summary = lines
summary = summary.replace('\n', ' ').replace('\r', '')
Copy link
Member

Choose a reason for hiding this comment

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

Since this affects the 'core' module, what's the impact of this change / why?
Want to know if it will adversely affect other modules.

Copy link
Member Author

Choose a reason for hiding this comment

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

The first sentence is used as the short summary. If the first sentence has a newline, it would be preserved which resulted in some wonky output. This strips out the newlines the same way the long-summary does. So it will affect other modules, but in a positive way.

@@ -61,6 +67,8 @@ def validate_key_type(ns):
'hsm': 'RSA-HSM'
}
ns.destination = dest_to_type_map[ns.destination]
if ns.destination == 'RSA' and hasattr(ns, 'byok_file') and ns.byok_file:
raise CLIError('BYOK keys are hardward protected. Omit --protection')
Copy link
Member

Choose a reason for hiding this comment

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

hardward?

Copy link
Member Author

Choose a reason for hiding this comment

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

should be hardware

def download_secret(client, vault_base_url, secret_name, file_path, file_encoding='utf8',
secret_version='', decode_binary=None):
secret = client.keyvault.get_secret(vault_base_url, secret_name, secret_version)
raise CLIError('TODO: implement')
Copy link
Member

Choose a reason for hiding this comment

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

Just checking this is intended?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, this was intended. I was going to finish these commands in Round 3, but decided to defer them to Round 4 because the secret set command needs some additional convenience arguments added in tandem.

@tjprescott tjprescott merged commit 81372d0 into Azure:master Nov 4, 2016
@tjprescott tjprescott deleted the KeyVaultRound3 branch November 4, 2016 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants