passwordstore: Support subkey creation and update

[mluzarreta]

SUMMARY

passwordstore lookup - Add the ability to create and update subkeys in password files.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

passwordstore lookup

ADDITIONAL INFORMATION

Here some command lines to illustrate the feature:

# Create a new 'foo' subkey, in an new password store file (in this case, main password is empty)
❯ ansible -m debug -i localhost, -a "msg={{ lookup('community.general.passwordstore', 'example/test', create=true, subkey='foo') }}" localhost
localhost | SUCCESS => {
    "msg": "u6V31gj3d0i3lLbO"
}
# Replace the 'foo' subkey and keep a backup trace in the password file
❯ ansible -m debug -i localhost, -a "msg={{ lookup('community.general.passwordstore', 'example/test', create=true, subkey='foo', overwrite=true, backup=true) }}
" localhost
localhost | SUCCESS => {
    "msg": "8jRMhmn9bE-Ra:Yh"
}
# Replace the main password
❯ ansible -m debug -i localhost, -a "msg={{ lookup('community.general.passwordstore', 'example/test', create=true, overwrite=true) }}" localhost
localhost | SUCCESS => {
    "msg": "Mjol:uhPxIiGcchM"
}
# Display the content of the password file
❯ pass example/test 
Mjol:uhPxIiGcchM

foo: 8jRMhmn9bE-Ra:Yh
lookup_pass: First generated by ansible on 01/10/2024 11:37:25
lookup_pass: old subkey password foo was u6V31gj3d0i3lLbO (Updated on 01/10/2024 11:38:03)

[felixfontein]

Thanks for your contribution! A few first comments are below:

The option actually isn't added to DOCUMENTATION and self.paramvals (line 554 and following ones), so you cannot actually use it.

[mluzarreta]

Thanks for your contribution! A few first comments are below:

The option actually isn't added to DOCUMENTATION and self.paramvals (line 554 and following ones), so you cannot actually use it.

@felixfontein I added some details in the documentation but this PR does not add any parameter, it just allows the creation/update of a subkey using the existing parameters (subkey, create, overwrite, backup).

@felixfontein @russoz I rewrote the commit with your suggestions. Thank you for the review 😄

[felixfontein]

The option actually isn't added to DOCUMENTATION and self.paramvals (line 554 and following ones), so you cannot actually use it.

It seems I totally overlooked that the option already exists. Sorry for that :)

[mluzarreta]

FYI I've just corrected a regression:

-                    elif not self.passdict.get(self.paramvals['subkey']):  # password exists but not the subkey
+                    elif self.paramvals["subkey"] != "password" and not self.passdict.get(self.paramvals['subkey']):  # password exists but not the subkey

[russoz]

LGTM

[felixfontein]

If nobody objects, I'll merge this in a week.

[patchback]

Backport to stable-9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-9/24f2b980b79cedd199959a29cbfd022cd5791076/pr-8952

Backported as #8996

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

[felixfontein]

@mluzarreta thanks for your contribution!
@russoz thanks for reviewing!