Merge pull request #25 from joshcorr/development

2.0.0 Release

Author: joshcorr

.github/linters/.powershell-psscriptanalyzer.psd1

@@ -11,7 +11,8 @@
     ExcludeRules        = @(
         'PSUseShouldProcessForStateChangingFunctions',
         'PSAvoidUsingConvertToSecureStringWithPlainText',
-        'PSUseDeclaredVarsMoreThanAssignments'
+        'PSUseDeclaredVarsMoreThanAssignments',
+        'PSUseLiteralInitializerForHashtable'
 
     )
     #IncludeRules = @(

CHANGELOG.md

@@ -5,13 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0] - 2021-11-11
+
+*Powershell 5.1 is no longer a supported version for this extension.  
+version 1.1.1-Preview is the last 5.1 compatible version*
+
+Major re-write of the token management to make it compatible with [Constrained Language Mode](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_language_modes?view=powershell-7.1#constrained-language-constrained-language)  
+Fixes issues with  `Unlock-SecretVault` [#24](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/24)  
+Fixes issue using extension from Terminal [#22](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/22)  
+Updated documentation  
+
 ## [1.2.0] - 2021-11-07
 
-Adds `Unlock-SecretVault` [#21](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/21)
-Adds support for checking tokens lifespan and renewing when they are close to expiring or have already expired. [#11](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/11)
-Increase verbose messages and fix formatting
-Add Byte as supported data type
-Fix pester tests
+Adds `Unlock-SecretVault` [#21](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/21)  
+Adds support for checking tokens lifespan and renewing when they are close to expiring or have already expired. [#11](https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/issues/11)  
+Increase verbose messages and fix formatting  
+Add Byte as supported data type  
+Fix pester tests  s
 
 ## [1.1.1] - 2021-08-25
 

README.md

@@ -2,10 +2,11 @@
 
 [![GitHubSuper-Linter][]][GitHubSuper-LinterLink]
 [![PSGallery][]][PSGalleryLink]
+[![SupportBadge][]][SupportBadge]
 
-A PowerShell SecretManagement extension for Hashicorp Vault Key Value (KV) Engine. This supports version 1, version2, and  cubbyhole (similar to v1). It does not currently support all of the version 2 features like versioned secrets.
+A PowerShell SecretManagement extension for Hashicorp Vault Key Value (KV) Engine. This supports version 1, version2, and  cubbyhole (similar to v1). It does not currently support all of the version 2 features like versioned secrets. This extension only supports PowerShell 6+
 
-> **NOTE: This project is not a maintained by Hashicorp.**  
+> **NOTE: This project is not maintained by Hashicorp.**  
 > **I work on this in my free time because I use Vault.**  
 > If Hashicorp would like to adopt this module please reach out.  
 
@@ -17,15 +18,15 @@ When registering a vault you need to provide at least these options:
 Register-SecretVault -ModuleName SecretManagement.Hashicorp.Vault.KV -Name PowerShellTest -VaultParameters @{ VaultServer = 'http://vault.domain.local:8200'; VaultAuthType = 'Token'}
 ```
 
-The vault name should match exactly as Hashicorp vault is case sensitive. If no VaultParameters are provided the functions will prompt you on the first execution in your session. Additionally you may provide which version of KV you are using when registering. It defaults to version 2 of KV.  
+The vault name should match exactly, as Hashicorp vault is case sensitive. If no VaultParameters are provided the functions will prompt you on the first execution in your session. Additionally you may provide which version of KV you are using when registering. It defaults to version 2 of KV.  
 
 ```PowerShell
 $VaultParameters = @{ VaultServer = 'https://vault-cluster.domain.local'
    VaultToken=$(Read-Host -AsSecureString | ConvertFrom-SecureString)
    KVVersion = 'v1'}
 ```
 
-If you stored your secrets in a flat structure (i.e. no slashes in your path).
+If you stored your secrets in a flat structure (i.e. no slashes in your path),
 You may want to return all secrets as a PSCredential. You can do this by providing the following:
 
 ```powershell
@@ -41,12 +42,13 @@ You may provide either a single text string or a hashtable to the `-Secret` para
 ## KV Version 2 distinctions
 
 - Get-Secret only retrieves the newest secret
-- Get-SecretInfo retrieves the Hashicorp Metadata.
+- Get-SecretInfo retrieves the Hashicorp Metadata
 - Set-Secret Adds/Updates without CheckAndSet. Althought it can be passed with `-Metadata @{cas=<versionNumber>}`
-- Remove-Secret Completely Removes the secret and all versions
+- Remove-Secret Removes the latest version of a secret
 
 [GitHubSuper-Linter]: https://github.com/joshcorr/SecretManagement.Hashicorp.Vault.KV/workflows/ci/badge.svg
 [GitHubSuper-LinterLink]: https://github.com/marketplace/actions/super-linter
 
-[PSGallery]: https://img.shields.io/powershellgallery/v/SecretManagement.Hashicorp.Vault.KV?label=Powershell+Gallery+Latest
-[PSGalleryLink]: https://www.powershellgallery.com/packages/SecretManagement.Hashicorp.Vault.KV
+[PSGallery]: https://img.shields.io/powershellgallery/v/SecretManagement.Hashicorp.Vault.KV?include_prereleases
+[PSGalleryLink]: https://www.powershellgallery.com/packages/SecretManagement.Hashicorp.Vault.KV
+[SupportBadge]: https://img.shields.io/powershellgallery/p/SecretManagement.Hashicorp.Vault.KV?label=6.0%2B&logo=powershell

SecretManagement.Hashicorp.Vault.KV.build.ps1

@@ -12,4 +12,11 @@ task copy {
     Copy-Item -Path $Source -Destination $Destination -Force -Recurse -Verbose
 }
 
+task remove {
+    $Version = (Test-ModuleManifest -Path "$PSScriptRoot\$ModuleName\$ModuleName.psd1").Version
+    $UserModulePath = [Environment]::GetEnvironmentVariable('PSModulePath') -split [IO.Path]::PathSeparator | Where-Object {$PSItem -notmatch [Environment]::UserName} | Select-Object -First 1
+    $Destination = $UserModulePath, $ModuleName, $Version -join [io.path]::DirectorySeparatorChar
+    Remove-Item -Path $Destination -Force -Recurse -Verbose
+}
+
 task . copy

SecretManagement.Hashicorp.Vault.KV/SecretManagement.Hashicorp.Vault.KV.Extension/SecretManagement.Hashicorp.Vault.KV.Extension.psd1

@@ -1,5 +1,5 @@
 @{
-    ModuleVersion     = '1.2.0'
+    ModuleVersion     = '2.0.0'
     RootModule        = 'SecretManagement.Hashicorp.Vault.KV.Extension.psm1'
     FunctionsToExport = @('Set-Secret', 'Get-Secret', 'Remove-Secret', 'Get-SecretInfo', 'Test-SecretVault', 'Unlock-SecretVault', 'Unregister-SecretVault')
 }