Modules icon indicating copy to clipboard operation
Modules copied to clipboard

[SecretsManagement] [FeatureRequest] Arbitrary "Description" property

Open JustinGrote opened this issue 5 years ago • 1 comments

Summary of the new feature/enhancement

As a powershell user, I sometimes want some more information about what a secret is for, and a provider may be able to provide that additional information in a way that I can programatically query/filter that information.

For example:

  • Azure Key Vault could have the description of a byte[] secret as an X509 certificate, when it was modified
  • Keepass may provide a folder structure for where the secret resides, or a flag that a string is an SSH key for use in an SSH agent.

Proposed technical implementation details (optional)

Add a [Object] property to Get-SecretInfo output (currently a [PSCustomObject], it should be more strongly typed).

Some name possibilities: Notes, Description, Metadata

The provider can populate this property with additional information about the secret. This information would be provider specific and the provider can supply any type of object as long as it has a clean ToString() method to convert it. Most providers may just do a simple string description, others may submit a nested hashtable with properties like created, modified, etc.

Future: Some natural commonalities like "LastModified","Comment" may become common and should be added to the [SecretInfo] class designation to standardize them, however this property allows providers to deliver their own extensible information that's important to their provider.

JustinGrote avatar Feb 07 '20 22:02 JustinGrote

@JustinGrote we think this could be a great idea, but we want to have more discussion on how the field would work...would a tags field make more sense?

SydneyhSmith avatar Feb 21 '20 21:02 SydneyhSmith