Skip to content

PPA Tools PPA Tools: Password Generators

Summary

This module contains actions used to generate different types of password.

Actions

ppa_tools.password_generators.

dictionary_words

Generate a password containing 1 or more dictionary words.

Multiple formats of the password will be generated.

See here for the list of formats, & important information on formats that include spaces.

Minimum Plugin Version: 6.0.0

Input

  • length: the length of the generated password (defaults to 15)

  • word_count: the number of words the password should consist of (defaults to 3)

  • valid_word_lengths: a list of valid word lengths (defaults to 3-8)

Output

A DictionaryPassword.

Example

Generating a 20 character password consisting of 4 words.

1
2
3
4
- ppa_tools.password_generators.dictionary_words:
    length: 20
    word_count: 4
  save: password

ppa_tools.password_generators.

dictionary_words_interactive

Interactively generate a password containing 1 or more dictionary words.

Each time a password is generated, the Task Operator will be given the choice to:

  • Use Password

  • Generate Another

The process can be repeated as many times as needed.

This action will output the password in one of the formats listed here.

Minimum Plugin Version: 9.1.0

Remember

Each generated password will be displayed to the Task Operator.

Input

  • length: the length of the generated password (defaults to 15)

  • word_count: the number of words the password should consist of (defaults to 3)

  • valid_word_lengths: a list of valid word lengths (defaults to 3-8)

  • title: a title displayed to the Task Operator (defaults to Generated Password)

  • format: a DictionaryPassword format to output (defaults to lower)

  • sensitive: set to true to protect sensitive data (requires PPA v3 & plugin version 8.0.0)

Output

The password in the format specified by the format input.

Upper Case

Generating an upper case password using the default word_count & length:

1
2
3
- ppa_tools.password_generators.dictionary_words_interactive:
    format: upper
  save: password
Lower Case With Spaces

Generating a 32 character lower case password that includes spaces.

Because spaces are added after generation, the password length is 27 with a word count of 6.

This is one example combination that yields a 32 character password:

1
2
3
4
5
- ppa_tools.password_generators.dictionary_words_interactive:
    length: 27
    word_count: 6
    format: lower_spaced
  save: password

ppa_tools.password_generators.

from_policy

Generate a password that meets the supplied PasswordPolicy.

Minimum Plugin Version: 6.2.0

Input
Output

The generated password as a string.

Example
1
2
3
4
5
6
7
- ppa_tools.password_generators.from_policy:
    policy:
      lower: 5
      upper: 5
      digit: 5
      symbol: 5
  save: password

ppa_tools.password_generators.

regex

Generate a password based on a regular expression.

Minimum Plugin Version: 6.0.0

Input

  • regex: a regular expression containing a set of characters (defaults to [A-Za-z0-9-£\:\$#\%\&\^])

  • length: the length of the generated password (defaults to 15)

Output

The generated password as a string.

Example

Generating a 20 character password using the default character set.

1
2
3
- ppa_tools.password_genereators.regex:
    length: 20
  save: password