From fc473a304c014820df3f80b4c10cab4f3246fbf0 Mon Sep 17 00:00:00 2001 From: wmarshall Date: Fri, 29 Sep 2023 15:51:03 -0500 Subject: [PATCH] Update code prior to publication. --- README.md | 12 ++++++------ .../private/Invoke-BitwardenCLI.ps1 | 2 +- SecretManagement.Warden.psd1 | 12 ++++++------ 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1b48f46..6e6da01 100644 --- a/README.md +++ b/README.md @@ -113,15 +113,15 @@ While the prompt is the only _secure_ way to use `bw login` directly, you _can_ > * This one can be really bad as the file is stored unencrypted long-term and `bw login` does not contain any exclusion words. > * Not an issue when using the `SecretManagement` module or extensions as all public commands include the word "secret" in them and all private commands are run in a isolated session that does not store history. -## Microsoft.PowerShell.SecretManagement Module -As this module is an extension, you need to have the base module installed first. You can install this module from the PowerShell Gallery via the command: +## Module Installation + +This module has been published to the PowerShell Gallery. To install it and its PowerShell dependencies from there run: ```pwsh -Install-Module -Name Microsoft.PowerShell.SecretManagement +Install-Module -Name SecretManagement.Warden ``` -## Module Installation - -This module has not yet been published to the PowerShell Gallery. To install, download the latest [release](https://gitlab.industrialinfo.com/wmarshall/SecretManagement.Warden/-/releases) (Do not clone the repo; code is only signed during the release process). Open the downloaded file, open the only directory therein, and extract the contents of that subdirectory to the directory: +Alternatively, manually install Microsoft.PowerShell.SecretManagement using the command: `Install-Module -Name Microsoft.PowerShell.SecretManagement`. +Next, download the latest [release](https://gitlab.industrialinfo.com/wmarshall/SecretManagement.Warden/-/releases) (Do not clone the repo; code is only signed during the release process). Open the downloaded file, open the only directory therein, and extract the contents of that subdirectory to the directory: * `$HOME\Documents\PowerShell\Modules\SecretManagement.Warden` (Windows) * `$HOME/.local/share/powershell/Modules/SecretManagement.Warden` (Linux or Mac) diff --git a/SecretManagement.Warden.Extension/private/Invoke-BitwardenCLI.ps1 b/SecretManagement.Warden.Extension/private/Invoke-BitwardenCLI.ps1 index 551e712..b23a9b0 100644 --- a/SecretManagement.Warden.Extension/private/Invoke-BitwardenCLI.ps1 +++ b/SecretManagement.Warden.Extension/private/Invoke-BitwardenCLI.ps1 @@ -26,7 +26,7 @@ else { elseif ( $IsMacOS ) { $platform = "macos" } else { $platform = "linux" } - Write-Error "No Bitwarden CLI found in your path, either specify `$env:BITWARDEN_CLI_PATH or put bw.exe in your path. If the CLI is not installed, you can install it using scoop, chocolatey, npm, or snap. You can also download it directly from: https://vault.bitwarden.com/download/?app=cli&platform=$platform" -ErrorAction Stop + Write-Error "No Bitwarden CLI found in your path, either specify `$env:BITWARDEN_CLI_PATH or put bw.exe in your path. If the CLI is not installed, you can install it using scoop, chocolatey, npm, snap, or winget. You can also download it directly from: https://vault.bitwarden.com/download/?app=cli&platform=$platform" -ErrorAction Stop } if ( $BitwardenCLI -and $CurrentVersion -lt $SupportedVersion ) { diff --git a/SecretManagement.Warden.psd1 b/SecretManagement.Warden.psd1 index 6045b16..b5900aa 100644 --- a/SecretManagement.Warden.psd1 +++ b/SecretManagement.Warden.psd1 @@ -4,7 +4,7 @@ # RootModule = '' # Version number of this module. - ModuleVersion = '0.2.14' + ModuleVersion = '1.0.0' # Supported PSEditions CompatiblePSEditions = @("Core") @@ -22,7 +22,7 @@ Copyright = '© 2023 Industrial Info Resources, Inc. All rights reserved.' # Description of the functionality provided by this module - Description = 'Bitwarden/Vaultwarden extension for the PowerShell SecretManager allowing you to Get, Set, and Remove secrets in a standardized way.' + Description = 'Bitwarden/Vaultwarden extension for the PowerShell SecretManager allowing you to Get, Set, and Remove secrets in a standardized way. Supports storing and retrieving PowerShell Objects as secrets. Targets automated usage.' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '7.0' @@ -92,19 +92,19 @@ Tags = 'SecretManagement', 'Secrets', 'BitWarden', 'Vaultwarden', 'MacOS', 'Linux', 'Windows' # A URL to the license for this module. - LicenseUri = 'https://gitlab.industrialinfo.com/wmarshall/SecretManagement.Warden/blob/master/LICENSE.txt' + LicenseUri = 'https://github.com/BinaryWizard904/SecretManagement.Warden/blob/master/LICENSE.txt' # A URL to the main website for this project. - ProjectUri = 'https://gitlab.industrialinfo.com/wmarshall/SecretManagement.Warden' + ProjectUri = 'https://github.com/BinaryWizard904/SecretManagement.Warden' # A URL to an icon representing this module. - IconUri = 'https://gitlab.industrialinfo.com/wmarshall/SecretManagement.Warden/images/warden_extension_logo_85x85.png' + IconUri = 'https://github.com/BinaryWizard904/SecretManagement.Warden/images/warden_extension_logo_85x85.png' # ReleaseNotes of this module # ReleaseNotes = '' # Prerelease string of this module - Prerelease = 'beta' + # Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false