Merge pull request #276 from jakehildreth/samerde/fix-spelling-messages

Fix spelling and user-facing messages

Author: SamErde

.editorconfig

@@ -10,7 +10,7 @@ indent_size = 4
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-# Powershell files
+# PowerShell files
 [*.{ps1,psd1,psm1}]
 indent_size = 4
 

CONTRIBUTING.md

@@ -39,7 +39,7 @@ If you then still feel the need to ask a question and need clarification, we rec
 
 - Open an [Issue](https://github.com/jakehildreth/Locksmith/issues/new/choose).
 - Provide as much context as you can about what you're running into.
-- Provide project and platform versions (Windows Version, Powershell Version, Windows Terminal, etc.), depending on what seems relevant.
+- Provide project and platform versions (Windows Version, PowerShell Version, Windows Terminal, etc.), depending on what seems relevant.
 
 We will then take care of the issue as soon as possible.
 
@@ -65,7 +65,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
 - Collect information about the bug:
   - OS, platform, and version of client machine. (Locksmith is only supported on Windows 10+/2016+ at this time.)
   - Single or multi-domain forest?
-  - PowerShell version, edition, and shell (Windows Powershell / Windows PowerShell ISE / PowerShell / Windows Terminal)
+  - PowerShell version, edition, and shell (Windows PowerShell / Windows PowerShell ISE / PowerShell / Windows Terminal)
   - Possibly your input and the output
   - Can you reliably reproduce the issue?
 

Docs/Invoke-Locksmith.md

@@ -18,7 +18,7 @@ Invoke-Locksmith [[-Mode] <Int32>] [[-Scans] <Array>] [[-OutputPath] <String>] [
 ```
 
 ## DESCRIPTION
-Locksmith uses the Active Directory (AD) Powershell (PS) module to identify 10 misconfigurations
+Locksmith uses the Active Directory (AD) PowerShell (PS) module to identify 10 misconfigurations
 commonly found in Enterprise mode AD CS installations.
 
 ## EXAMPLES
@@ -49,7 +49,7 @@ No attempt is made to fix identified issues.
 
 -Mode 1
 Finds any malconfigurations and displays them in the console.
-Displays example Powershell snippet that can be used to resolve the issue.
+Displays example PowerShell snippet that can be used to resolve the issue.
 No attempt is made to fix identified issues.
 
 -Mode 2

Docs/index.md

@@ -64,7 +64,7 @@ Install-Module -Name Locksmith -Scope CurrentUser
 <a name="RunLocksmith" id="RunLocksmith"></a>
 
 ## Run Locksmith
-There are several modes you can chose from when running `Invoke-Locksmith`. You can also use the **Scans** parameter to choose which scans you want to invoke.
+There are several modes you can choose from when running `Invoke-Locksmith`. You can also use the **Scans** parameter to choose which scans you want to invoke.
 
 <a name="Mode0" id="Mode0"></a>
 

Invoke-Locksmith.ps1

@@ -605,7 +605,7 @@ More info:
 
 <#
     Option 2: Scripted Remediation
-    Step 1: Open an elevated Powershell session as an AD or PKI Admin
+    Step 1: Open an elevated PowerShell session as an AD or PKI Admin
     Step 2: Run Unpublish-SchemaV1Templates.ps1
 #>
 Invoke-WebRequest -Uri https://gist.githubusercontent.com/jakehildreth/13c7d615adc905d317fc4379026ad28e/raw/Unpublish-SchemaV1Templates.ps1 | Invoke-Expression
@@ -2720,7 +2720,7 @@ function Invoke-Remediation {
             Write-Host "$($_.Technique)`n"
             Write-Host 'ACTION TO BE PERFORMED:' -ForegroundColor White
             Write-Host "Locksmith will attempt to enable Manager Approval on the `"$($_.Name)`" template.`n"
-            Write-Host 'CCOMMAND(S) TO BE RUN:'
+            Write-Host 'COMMAND(S) TO BE RUN:'
             Write-Host 'PS> ' -NoNewline
             Write-Host "$($_.Fix)`n" -ForegroundColor Cyan
             Write-Host 'OPERATIONAL IMPACT:' -ForegroundColor White
@@ -4874,7 +4874,7 @@ function Write-HostColorized {
             }
         }
         # Otherwise: $PSCmdlet.ParameterSetName -eq 'PerPatternColor', i.e. a dictionary
-        #            mapping patterns to colors was direclty passed in $PatternColorMap
+        #            mapping patterns to colors was directly passed in $PatternColorMap
 
         try {
 
@@ -5019,7 +5019,7 @@ function Invoke-Locksmith {
     Finds the most common malconfigurations of Active Directory Certificate Services (AD CS).
 
     .DESCRIPTION
-    Locksmith uses the Active Directory (AD) Powershell (PS) module to identify 10 misconfigurations
+    Locksmith uses the Active Directory (AD) PowerShell (PS) module to identify 10 misconfigurations
     commonly found in Enterprise mode AD CS installations.
 
     .COMPONENT
@@ -5037,7 +5037,7 @@ function Invoke-Locksmith {
 
     -Mode 1
     Finds any malconfigurations and displays them in the console.
-    Displays example Powershell snippet that can be used to resolve the issue.
+    Displays example PowerShell snippet that can be used to resolve the issue.
     No attempt is made to fix identified issues.
 
     -Mode 2
@@ -5342,7 +5342,7 @@ function Invoke-Locksmith {
             Format-Result -Issue $ESC16 -Mode 0
             Format-Result -Issue $ESC17 -Mode 0
             Write-Host @"
-[!] You ran Locksmith in Mode 0 which only provides an high-level overview of issues
+[!] You ran Locksmith in Mode 0 which only provides a high-level overview of issues
 identified in the environment. For more details including:
 
   - Detailed Risk Rating
@@ -5385,7 +5385,7 @@ Invoke-Locksmith -Mode 1
                 Write-Host "$Output created successfully!`n"
             }
             catch {
-                Write-Host 'Ope! Something broke.'
+                Write-Host "ERROR: Failed to write '$Output'. $($_.Exception.Message)"
             }
         }
         3 {
@@ -5396,7 +5396,7 @@ Invoke-Locksmith -Mode 1
                 Write-Host "$Output created successfully!`n"
             }
             catch {
-                Write-Host 'Ope! Something broke.'
+                Write-Host "ERROR: Failed to write '$Output'. $($_.Exception.Message)"
             }
         }
         4 {

Private/Find-ESC15.ps1

@@ -84,7 +84,7 @@ More info:
 
 <#
     Option 2: Scripted Remediation
-    Step 1: Open an elevated Powershell session as an AD or PKI Admin
+    Step 1: Open an elevated PowerShell session as an AD or PKI Admin
     Step 2: Run Unpublish-SchemaV1Templates.ps1
 #>
 Invoke-WebRequest -Uri https://gist.githubusercontent.com/jakehildreth/13c7d615adc905d317fc4379026ad28e/raw/Unpublish-SchemaV1Templates.ps1 | Invoke-Expression

Private/Invoke-Remediation.ps1

@@ -314,7 +314,7 @@ function Invoke-Remediation {
             Write-Host "$($_.Technique)`n"
             Write-Host 'ACTION TO BE PERFORMED:' -ForegroundColor White
             Write-Host "Locksmith will attempt to enable Manager Approval on the `"$($_.Name)`" template.`n"
-            Write-Host 'CCOMMAND(S) TO BE RUN:'
+            Write-Host 'COMMAND(S) TO BE RUN:'
             Write-Host 'PS> ' -NoNewline
             Write-Host "$($_.Fix)`n" -ForegroundColor Cyan
             Write-Host 'OPERATIONAL IMPACT:' -ForegroundColor White

Private/Write-HostColorized.ps1

@@ -126,7 +126,7 @@ Function Write-HostColorized {
 
         }
         # Otherwise: $PSCmdlet.ParameterSetName -eq 'PerPatternColor', i.e. a dictionary
-        #            mapping patterns to colors was direclty passed in $PatternColorMap
+        #            mapping patterns to colors was directly passed in $PatternColorMap
 
         try {
 

Public/Invoke-Locksmith.ps1

@@ -4,7 +4,7 @@ function Invoke-Locksmith {
     Finds the most common malconfigurations of Active Directory Certificate Services (AD CS).
 
     .DESCRIPTION
-    Locksmith uses the Active Directory (AD) Powershell (PS) module to identify 10 misconfigurations
+    Locksmith uses the Active Directory (AD) PowerShell (PS) module to identify 10 misconfigurations
     commonly found in Enterprise mode AD CS installations.
 
     .COMPONENT
@@ -22,7 +22,7 @@ function Invoke-Locksmith {
 
     -Mode 1
     Finds any malconfigurations and displays them in the console.
-    Displays example Powershell snippet that can be used to resolve the issue.
+    Displays example PowerShell snippet that can be used to resolve the issue.
     No attempt is made to fix identified issues.
 
     -Mode 2
@@ -324,7 +324,7 @@ function Invoke-Locksmith {
             Format-Result -Issue $ESC16 -Mode 0
             Format-Result -Issue $ESC17 -Mode 0
             Write-Host @"
-[!] You ran Locksmith in Mode 0 which only provides an high-level overview of issues
+[!] You ran Locksmith in Mode 0 which only provides a high-level overview of issues
 identified in the environment. For more details including:
 
   - Detailed Risk Rating
@@ -366,7 +366,7 @@ Invoke-Locksmith -Mode 1
                 $AllIssues | Select-Object Forest, Technique, Name, Issue, @{l = 'Risk'; e = { $_.RiskName } } | Export-Csv -NoTypeInformation -Encoding UTF8 $Output
                 Write-Host "$Output created successfully!`n"
             } catch {
-                Write-Host 'Ope! Something broke.'
+                Write-Host "ERROR: Failed to write '$Output'. $($_.Exception.Message)"
             }
         }
         3 {
@@ -376,7 +376,7 @@ Invoke-Locksmith -Mode 1
                 $AllIssues | Select-Object Forest, Technique, Name, DistinguishedName, Issue, Fix, @{l = 'Risk'; e = { $_.RiskName } }, @{l = 'Risk Score'; e = { $_.RiskValue } }, @{l = 'Risk Score Detail'; e = { $_.RiskScoring -join "`n" } } | Export-Csv -NoTypeInformation -Encoding UTF8 $Output
                 Write-Host "$Output created successfully!`n"
             } catch {
-                Write-Host 'Ope! Something broke.'
+                Write-Host "ERROR: Failed to write '$Output'. $($_.Exception.Message)"
             }
         }
         4 {

README.md

@@ -78,7 +78,7 @@ Install-Module -Name Locksmith -Scope CurrentUser
 <a name="run-locksmith" id="run-locksmith"></a>
 ## Run Locksmith
 
-There are several modes you can chose from when running `Invoke-Locksmith`. You can also use the **Scans** parameter to choose which scans you want to invoke.
+There are several modes you can choose from when running `Invoke-Locksmith`. You can also use the **Scans** parameter to choose which scans you want to invoke.
 
 <a name="mode-0-identify-issues-output-to-console-default" id="mode-0-identify-issues-output-to-console-default"></a>
 ### Mode 0: Identify Issues, Output to Console (Default)