GenerateRandomPassword.psm1
|
<# MIT License Copyright (C) 2023 Robin Stolpe. <https://stolpe.io> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #> function New-RSRandomPassword { <# .SYNOPSIS Generate and returns a random password that includes numbers, letters and special characters. .DESCRIPTION This module generates and returns a random password that contains lower and upper letters, numbers and special characters. It can either generate one with the default options that are 12 characters long and contains 3 special characters, or you can decide how long the password should be and how many special characters it should contain. .PARAMETER Length Specify how many characters you want your password to be. Default is 12, shortest length is 6 and max length is 30. .PARAMETER SpecialCharacters Specify how many special characters your password will has in it. Default is 3, shortest length is 1 and max length is 15. .EXAMPLE New-RSRandomPassword # Returns a random password that are 12 characters long and contains 1 special character. .EXAMPLE New-RSRandomPassword -Length 20 -SpecialCharacters 4 # Returns a random password that are 20 characters long and contains 4 special character. .NOTES Author: Robin Stolpe Mail: robin@stolpe.io Website: https://stolpe.io GitHub: https://github.com/rstolpe Twitter: https://twitter.com/rstolpes PSGallery: https://www.powershellgallery.com/profiles/rstolpe NuGet: https://www.nuget.org/profiles/rstolpe #> [CmdletBinding()] param( [ValidateRange(6, 30)] [Parameter(Mandatory = $false, HelpMessage = "Specify how many character the password should contain")] [int]$Length = 12, [ValidateRange(1, 15)] [Parameter(Mandatory = $false, HelpMessage = "Specify how many special characters the password should conatin")] [int]$SpecialCharacters = 3 ) $Character = 'abcdefghiklmnoprstuvwxyzABCDEFGHKLMNOPRSTUVWXYZ1234567890' $RandomCharacter = 1..$($Length - $SpecialCharacters) | ForEach-Object { Get-Random -Maximum $Character.length } $SpecialCharacter = '!@#$%^&.,_*()=+*?-' $RandomSpecialC = 1..$SpecialCharacters | ForEach-Object { Get-Random -Maximum $SpecialCharacter.length } $private:ofs = "" $inputString = [String]$Character[$RandomCharacter] $inputString += [String]$SpecialCharacter[$RandomSpecialC] $characterArray = $inputString.ToCharArray() $scrambledStringArray = $characterArray | Get-Random -Count $characterArray.Length $outputString = -join $scrambledStringArray return $outputString } |