Merge pull request #56 from AsBuiltReport/dev

v1.4.2 release

Author: tpcarman

AsBuiltReport.Core.psd1

@@ -13,7 +13,7 @@
 
     # Version number of this module.
 
-    ModuleVersion = '1.4.1'
+    ModuleVersion = '1.4.2'
 
     # Supported PSEditions
     # CompatiblePSEditions = 'Desktop'
@@ -28,7 +28,7 @@
     # CompanyName = ''
 
     # Copyright statement for this module
-    Copyright = '(c) 2024 Tim Carman. All rights reserved.'
+    Copyright = '(c) 2025 Tim Carman. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description = 'A PowerShell module which provides the core framework for generating As-Built documentation for many common datacentre systems.'

CHANGELOG.md

@@ -5,10 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.2] - 2025-01-30
+
+### Fixed
+- Fix password shown in plain text (Fix [#55](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues/55))
+- Prevent execution from Windows PowerShell ISE (Fix [#52](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues/52))
+
 ## [1.4.1] - 2024-12-02
 
 ### Changed
-* Update GitHub release workflow to add post to Bluesky social platform
+- Update GitHub release workflow to add post to Bluesky social platform
 
 ### Fixed
 - Set `$OutputFolderPath` variable as Global variable (Fix [#53](https://github.com/AsBuiltReport/AsBuiltReport.Core/issues/53))

README.md

@@ -213,7 +213,7 @@ Get-Help New-AsBuiltReportConfig -Full
 Here are some examples to get you going.
 
 ```powershell
-# Generate a VMware vSphere As Built report in HTML & Word formats. Perform a health check to highlight particular issues which exist within the Vmware vSphere environment. Save the report to the 'H:\Documents\' folder.
+# Generate a VMware vSphere As Built report in HTML & Word formats. Perform a health check to highlight particular issues which exist within the VMware vSphere environment. Save the report to the 'H:\Documents\' folder.
 New-AsBuiltReport -Report 'VMware.vSphere' -Target '192.168.1.100' -Username 'admin' -Password 'admin' -Format HTML,Word -EnableHealthCheck -OutputFolderPath 'H:\Documents\'
 
 # Generate a Nutanix Prism Element As Built Report using specified username and password credentials. Specify the report configuration file to be used. Export report to Text, HTML & DOCX formats. Use the default report style. Save the report to the '/Users/Tim/Documents' folder. Display verbose messages to the console.

Src/Public/New-AsBuiltReport.ps1

@@ -140,7 +140,7 @@ function New-AsBuiltReport {
 
         [Parameter(
             Position = 3,
-            Mandatory = $true,
+            Mandatory = $false,
             HelpMessage = 'Please provide the password to connect to the target system',
             ParameterSetName = 'UsernameAndPassword'
         )]
@@ -244,9 +244,20 @@ function New-AsBuiltReport {
 
     try {
 
+        if ($psISE) {
+            Write-Error -Message "AsBuiltReport cannot be run from Windows PowerShell ISE. Please use a PowerShell command window instead."
+            break
+        }
+
         # If Username and Password parameters used, convert specified Password to secure string and store in $Credential
-        if (($Username -and $Password)) {
-            $SecurePassword = ConvertTo-SecureString $Password -AsPlainText -Force
+        if ($Username) {
+            if (-not $Password) {
+                # If the Password parameter is not provided, prompt for it securely
+                $SecurePassword = Read-Host "Password for user $Username" -AsSecureString
+            } else {
+                # If the Password parameter is provided, convert it to secure string
+                $SecurePassword = ConvertTo-SecureString $Password -AsPlainText -Force
+            }
             $Credential = New-Object System.Management.Automation.PSCredential ($Username, $SecurePassword)
         }