Files
Yolan Romailler d56639fcd7 [CLEANUP] Migration of options to more appropriate sections (#2681)
* [CLEANUP] Moving options to the correct config section

This adds an easy migration path to our config handling, which should
allow us to migrate option names around much more easily in the future.

Any system level config or env variables options are not migrated.

This also fixes a bug in our test code, where the root mount path was
not properly set in our config, because we used "path:" instead of
"path=" to set it.

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [DOCUMENTATION] Document legacy options and their migration path

This also makes sure that legacy options aren't used in the code anymore using the docs test and its regexp

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [n/a] Removing weird spaces from changelog

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [DOCUMENTATION] Reformatting our Markdown tables properly

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [TESTING] Patching a timezone bug in tests

This is a fun one where if your Timezone isn't UTC and you are past midnight but it's not past midnight UTC, the tests would fail because you're not using the right date to validate it.

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [n/a] Fix a typo and use the correct Env variables in the doc about the custom Env variables

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [BREAKING] Custom Env options moved from GOPASS_CONFIG_CONFIG_KEY_i to GOPASS_CONFIG_KEY_i

As discussed in #2617, this actually reflects the way GIT_CONFIG works.

It also fixes a potential Panic in our codebase when IsSet was called
without any Preset config on a non-existing key.

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [CLEANUP] Patching all of the new linter complaints

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [CLEANUP] Use Go1.21 everywhere

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [n/a] Increase our Golangci timeout

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

* [n/a] code review comment and extra regression test

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>

---------

Signed-off-by: Yolan Romailler <anomalroil@users.noreply.github.com>
2023-11-03 18:40:58 +01:00

5.2 KiB

generate command

The generate command is used to generate a new password and store it into the password store.

Note: If you only want generate a password without storing it in the store, use the pwgen command.

Synopsis

$ gopass generate entry [length]
$ gopass generate entry key [length]

Modes of operation

  • Generate a new entry with a new password, e.g. a new login. Setting the Password field, gopass generate entry [chars]
  • Re-generating a new password and setting it in the Password field of an existing entry
  • Generate a new password and setting it to a new key of an existing secret, e.g. gopass generate entry key [chars]
  • Re-generate a new password for an existing key in an existing entry

Flags

Flag Aliases Description
--clip -c Copy the generated password into the clipboard. Default: Value of autoclip
--print -p Print the generated password to the terminal. Default: false.
--force -f Force overwriting an existing entry.
--edit -e Generate a password and open the entry for editing in $EDITOR.
--generator -g Choose of of the available password generators, desribed below. Default: cryptic
--symbols -s Include symbols in the generated password (default: false)
--strict Ensure each requested character class is actually included. Without this option all requested classes can be included, but not necessarily are. (default: false)
--sep Word separator for multi-word generators.
--lang Language for word-based generators.

Password Generators

Use --generator to select one of the available password generators:

Generator Description
cryptic The default generator yields cryptic passwords that should work with most sites. Use --symbols and --strict if the site has specific requirements. Please note that we auto-detect the correct rules for some sites. The length argument specifies the number of characters.
xkcd Use an XKCD#936 style password. Use --lang and --sep to refine it's behaviour. The length argument specifies the number of words.
memorable Generate a memorable password. The length argument specifies the minimum lenght of characters. Please note that the password might be longer if not all necessary rules were satisfied by the minimum length solution.
external Use the external generator from $GOPASS_EXTERNAL_PWGEN

Relevant configuration options

  • autoclip only applies to generate. If set the generated password is automatically copied to the clipboard - unless --clip is explicitly set to --clip=false
  • safecontent will suppress printing of the password, unless -p is set. The password will not be copied, unless -c or the autoclip option are set.

Templates

When creating a new entry gopass will look for the most specific template by going up in the secret path looking for a file called .pass-template.

If any such file is found it will be used to pre-populate the generated secret.