Skip to content

adambirds/xkcd-pass-pwsh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

XKCDPass PowerShell Module

test-and-publish codecov GitHub release PowerShell Gallery GitHub stars GitHub watchers GitHub forks GitHub issues GitHub contributors License GitHub Sponsors

XKCDPass is a PowerShell module that provides a flexible and scriptable password generator which generates strong passphrases, inspired by XKCD 936.

The command which is exported from this module is Get-XKCDRandomPassword.

Whilst this password generator is inspired by XKCD 936, its defaults have been configured in a way which gives this tool the most compatibility out of the box with the majority of services we use passwords for today. The defaults that we have set are:

  • The password contains 4 words between 5 and 9 characters.
  • The first letter of each word is capitalized.
  • The passphrase is ended with two random digits.

This allows the password generator to provide passwords by default which will be strong, easy to remember, difficult to brute-force and still pass the usual requirements of at least one upper-case letter, one lower-case letter and at least 1 digit.

Support

For support using this bot, please join our official support server on Discord.

discord

Source

The source code can be found here.

Requirements

  • PowerShell 5.1 or Above.

This module will work cross-platform with PowerShell 7.

Installation

Install-Module -Name XKCDPass

Usage

To generate a password using the defaukt settings, run the following command:

Get-XKCDRandomPassword

We also support the following parameters:

  • -NumWords: The number of words to include in the password.
  • -NumDigits: The number of digits to include in the password.
  • -MinWordLength: The minimum length of a word to include in the password.
  • -MaxWordLength: The maximum length of a word to include in the password.
  • -Seperator: The seperator to use between words in the password.
  • -Suffix: The suffix to use at the end of the password.

An example using the above parameters can be found below:

Get-XKCDRandomPassword -NumWords 4 -NumDigits 3 -MinWordLength 4 -MaxWordLength 6 -Separator _ -Suffix !

License

This project is released under the GNU GENERAL PUBLIC LICENSE v3.

About

PowerShell Module to Generate XKCD Style Passwords

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published