PSPhrase.psm1
|
#Region './Private/Get-RandomInt.ps1' -1 Function Get-RandomInt { <# .SYNOPSIS More robust method of getting a random number than Get-Random .DESCRIPTION Leverages the .NET RNGCryptoServiceProvider to retrieve a random number .PARAMETER Minimum Minimum number for range of random number generation .PARAMETER Maximum Maximum number for range of random number generation .EXAMPLE PS> Get-RanomInt -Minimum 1 -Maximum 1000 838 will return a random number from between 1 and 1000 #> param ( [UInt32]$Minimum, [UInt32]$Maximum ) $Difference = $Maximum-$Minimum+1 [Byte[]]$Bytes = 1..4 [System.Security.Cryptography.RNGCryptoServiceProvider]::Create().GetBytes($Bytes) [Int32]$Integer = [System.BitConverter]::ToUInt32(($Bytes),0) % $Difference + 1 $Integer } #EndRegion './Private/Get-RandomInt.ps1' 28 #Region './Private/Initialize-Dictionary.ps1' -1 function Initialize-Dictionary { <# .SYNOPSIS Creates ordered hashtables of wordlists for faster retrieval with random number generator .DESCRIPTION Reads in a text file containing one word per line and creates an ordered dictionary starting the keys with '1' and incrementing up from there for each word added. Then using a RNG a corresponding key can be called and the associated value (word) can be retrieved very quickly .PARAMETER Type Whether to load the Nouns or Adjectives list .EXAMPLE $Nouns = Initialize-Dictionary -Type Nouns will turn $Nouns in to a hashtable containing all the words from the Nouns.txt file #> [Cmdletbinding()] [OutputType([System.Collections.Specialized.OrderedDictionary])] param ( [ValidateSet("Nouns","Adjectives")] [String]$Type ) $File = switch ($Type) { "Nouns" {"Nouns.txt"} "Adjectives" {"Adjectives.txt"} } $WordListPath = Join-Path -Path ($PSScriptRoot) -ChildPath "Data/$File" $Words = [System.IO.File]::ReadAllLines($WordListPath) $Dictionary = [Ordered]@{} $Number = 1 foreach ($Word in $Words) { $Dictionary.Add($Number, $Word) $Number++ } $Dictionary } #EndRegion './Private/Initialize-Dictionary.ps1' 38 #Region './Public/Get-PSPhrase.ps1' -1 function Get-PSPhrase { <# .SYNOPSIS Generate a passphrase .DESCRIPTION Creates a passphrase using adjective/noun pairs in the style of natural language. These are robust, random, and significantly easier to remember than random gibberish. .PARAMETER Pairs It generates Adjective/Noun pairs, this defines how many pairs you want returned. The default is 2 pair (two words) .PARAMETER TitleCase Switch parameter to toggle the use of title case. E.g. The First Letter Of Every Word Is Uppercase. .PARAMETER Substitution Switch parameter to toggle common character substitution. E.g. '3's for 'e's and '@'s for 'a's etc. .PARAMETER Prepend Provide a string you would like prepended to the password output .PARAMETER Append Provide a string you would like appended to the password output .PARAMETER Delimiter This parameter accepts any string you would prefer as a delimiter between words. Defaults to a space. .PARAMETER Count The number of passphrases to be generated. Default is 1 .PARAMETER IncludeNumber Switch parameter to randomly include a number within the passphrase .PARAMETER IncludeSymbol Switch parameter to randomly include a symbol within the passphrase .EXAMPLE PS> Get-PSPhrase late wart wrinkly oats returns a random passphrase composed of adjective/noun pairs. Default setting is 2 pairs, and 1 passphrase .EXAMPLE PS> Get-PSPhrase -Count 10 -TitleCase Lewd Cluster Lazy Gazebo Fond Proofs Recent Headwear Decent Baths Cranky Silks Long Chit Sensual Census Red Shrapnel Thin Crime Tedious Port Ceramic Volcano Lucid Pill Modest Militant Pungent Shares Mundane Paramour Smutty Exec Stable Epidural Bronze Pennant Sullen Raises creates 10 passphrases and uses Title case on the output to capitalize the first letter of each word #> [CmdletBinding()] param ( [ValidateRange(1,100)] [Int32]$Pairs = 2, [Switch]$TitleCase, [Switch]$Substitution, [String]$Append, [String]$Prepend, [String]$Delimiter = ' ', [ValidateRange(1,500)] [Int32]$Count = 1, [Switch]$IncludeNumber, [Switch]$IncludeSymbol ) $Settings = [Ordered]@{ Pairs = $Pairs Count = $Count Delimiter = $Delimiter } if ($DefaultSettings = Get-PSPhraseSetting) { foreach ($Setting in $DefaultSettings.PSObject.Properties.Name) { if (-not($PSBoundParameters.ContainsKey($Setting))) { $Settings.$Setting = $DefaultSettings.$Setting } } } if ($TitleCase) { $Settings.Add("TitleCase",$true) } if ($Substitution) { $Settings.Add("Substitution",$true) } if ($IncludeNumber) { $Settings.Add("IncludeNumber",$true) } if ($IncludeSymbol) { $Settings.Add("IncludeSymbol",$true) } if ($Prepend) { $Settings.Add("Prepend",$Prepend) } if ($Append) { $Settings.Add("Append",$Append) } $NounsHash = Initialize-Dictionary -Type Nouns $AdjectivesHash = Initialize-Dictionary -Type Adjectives $Passphrases = 1..$Settings.Count | ForEach-Object { [System.Collections.ArrayList]$WordArray = 1..$Settings.Pairs | ForEach-Object { $Number = Get-RandomInt -Minimum 1 -Maximum $AdjectivesHash.Count $AdjectivesHash.$Number $Number = Get-RandomInt -Minimum 1 -Maximum $NounsHash.Count $NounsHash.$Number } $CultureObj = (Get-Culture).TextInfo switch ($Settings.Keys) { 'TitleCase' { $WordArray = $WordArray | ForEach-Object { $CultureObj.ToTitleCase($_) } } 'Substitution' { $WordArray = $WordArray -replace "e","3" -replace "a","@" -replace "o","0" -replace "s","$" -replace "i","1" } 'IncludeNumber' { $RandomNumber = Get-Random -Minimum 0 -Maximum 9 $WordIndex = $WordArray.IndexOf(($WordArray | Get-Random)) $Position = 0,($WordArray[$WordIndex].Length) | Get-Random $WordArray[$WordIndex] = $WordArray[$WordIndex].Insert($Position, $RandomNumber) } 'IncludeSymbol' { $RandomSymbol = '!', '@', '#', '$', '%', '*', '?' | Get-Random $WordIndex = $WordArray.IndexOf(($WordArray | Get-Random)) $Position = 0,($WordArray[$WordIndex].Length) | Get-Random $WordArray[$WordIndex] = $WordArray[$WordIndex].Insert($Position, $RandomSymbol) } 'Append' { [Void]$WordArray.Add($Settings.Append) } 'Prepend' { $WordArray.Insert(0, $Settings.Prepend) } } $WordArray -join $Settings.Delimiter } $Passphrases } #EndRegion './Public/Get-PSPhrase.ps1' 136 #Region './Public/Get-PSPhraseSetting.ps1' -1 function Get-PSPhraseSetting { <# .SYNOPSIS returns a table of the settings currently being used with PSPhrase .DESCRIPTION returns the current settings being leverage as "defaults" with New-PSPhrase. If custom settings have been specified with Set-PSPhraseSettings those will be returned .EXAMPLE PS> Get-PSPhraseSetting if no settings have been saved via Set-PSPhraseSetting this will return nothing .EXAMPLE PS> Get-PSPhrasesetting Count TitleCase ----- --------- 10 True if settings have been saved this will return them as a PSCustomObject with the properties/values corresponding to parameters for use with Get-PSPhrase #> [CmdletBinding()] param ( # no parameters ) # check to see if we're on Windows or not if ($IsWindows -or $ENV:OS) { $Windows = $true } else { $Windows = $false } if ($Windows) { $SettingsPath = Join-Path -Path $Env:APPDATA -ChildPath "PSPhrase\Settings.json" } else { $SettingsPath = Join-Path -Path ([Environment]::GetEnvironmentVariable("HOME")) -ChildPath ".local/share/powershell/Modules/PSPhrase/Settings.json" } if (Test-Path $SettingsPath) { try { $Settings = Get-Content -Path $SettingsPath | ConvertFrom-Json } catch { throw $_ } $Settings } else { Write-Verbose "No saved settings found" } } #EndRegion './Public/Get-PSPhraseSetting.ps1' 48 #Region './Public/Set-PSPhraseSetting.ps1' -1 function Set-PSPhraseSetting { <# .SYNOPSIS Configures the parameter defaults for New-PSPhrase by saving the settings to a file .DESCRIPTION Default parameter values for New-PSPhrase are retrieved via Get-PSPhraseSettings. To reduce the amount of parameters you have to pass to New-PSPhrase you can set your preferences with Set-PSPhraseSettings and they will be saved to a file for retrieval by Get-PSPhraseSettings by default later. This was created as a more accessible way to achieve default parameter values without using $PSDefaultParameterValues and the $Profile .PARAMETER Pairs It generates Adjective/Noun pairs, this defines how many pairs you want returned. The default is 2 pair (two words) .PARAMETER TitleCase Switch parameter to toggle the use of title case. E.g. The First Letter Of Every Word Is Uppercase. .PARAMETER Substitution Switch parameter to toggle common character substitution. E.g. '3's for 'e's and '@'s for 'a's etc. .PARAMETER Prepend Provide a string you would like prepended to the password output .PARAMETER Append Provide a string you would like appended to the password output .PARAMETER Delimiter This parameter accepts any string you would prefer as a delimiter between words. Defaults to a space. .PARAMETER Count The number of passphrases to be generated. Default is 1 .PARAMETER IncludeNumber Switch parameter to randomly include a number within the passphrase .PARAMETER IncludeSymbol Switch parameter to randomly include a symbol within the passphrase .PARAMETER Defaults Reverts settings to default state by deleting the saved settings file and allowing New-PSPhrase to use default parameter values .EXAMPLE PS> Set-PSPhraseSetting -Count 10 -TitleCase -Delimiter '-' -Verbose VERBOSE: Saving settings to C:\Users\ContosoAdmin\AppData\Roaming\PSPhrase\Settings.json this will save the preferred parameter/values for use with Get-PSPhrase to a file at the described location #> [CmdletBinding(SupportsShouldProcess)] param ( [ValidateRange(1,10)] [Int32]$Pairs, [Switch]$TitleCase, [Switch]$Substitution, [String]$Append, [String]$Prepend, [String]$Delimiter, [ValidateRange(1,500)] [Int32]$Count, [Switch]$IncludeNumber, [Switch]$IncludeSymbol, [Switch]$Defaults ) # check to see if we're on Windows or not if ($IsWindows -or $ENV:OS) { $Windows = $true } else { $Windows = $false } if ($Windows) { $SettingsPath = Join-Path -Path $Env:APPDATA -ChildPath "PSPhrase\Settings.json" } else { $SettingsPath = Join-Path -Path ([Environment]::GetEnvironmentVariable("HOME")) -ChildPath ".local/share/powershell/Modules/PSPhrase/Settings.json" } $Settings = [Ordered]@{} if (-not($Defaults)) { switch ($PSBoundParameters.Keys) { 'Pairs' { $Settings.Pairs = $Pairs } 'TitleCase' { $Settings.TitleCase = $true } 'Substitution' { $Settings.Substitution = $true } 'Delimiter' { $Settings.Delimiter = $Delimiter } 'Count' { $Settings.Count = $Count } 'IncludeNumber' { $Settings.IncludeNumber = $true } 'IncludeSymbol' { $Settings.IncludeSymbol = $true } } # move these out of the switch statement to insure they don't manipulated by other rules if ($Append) { $Settings.Append = $Append } if ($Prepend) { $Settings.Prepend = $Prepend } if ($Settings.Count -gt 0) { try { if (Test-Path $SettingsPath) { Write-Verbose "Saving settings to $($SettingsPath)" $Settings | ConvertTo-Json | Out-File -FilePath $SettingsPath -Force } else { Write-Verbose "Saving settings to $($SettingsPath)" New-Item -Path $SettingsPath -Force | Out-Null $Settings | ConvertTo-Json | Out-File -FilePath $SettingsPath } } catch { throw $_ } } else { Write-Warning "No settings specified. Nothing saved" } } else { try { Write-Verbose "Removing settings file at $($SettingsPath)" Remove-Item -Path $SettingsPath -Force -ErrorAction Stop } catch [System.Management.Automation.ItemNotFoundException] { Write-Warning "No settings file found" } catch { throw $_ } } } #EndRegion './Public/Set-PSPhraseSetting.ps1' 123 |