======secret-tool======


----

=====Description=====
Store and retrieve passwords from the keyring.

----

=====Install=====

====apt====
  * Install using apt:<code bash>
sudo apt install libsecret-tools
</code>

----

=====Usage=====
  * **Flags:**
    * ''%%--label%%'' = Mainly for GUI programs but can be used to retrieve a given secret.
    * ''%%{attribute}%%'' = Used by the secret-tool for retrieving or deleting a given secret.
    * ''%%{value}%%'' = Used by the secret-tool for retrieving or deleting a given secret.

  * Add an entry:<code bash>
secret-tool store --label='My Label' {attribute} {value} {attribute2} {value2} [...]
</code>
  * Retrieve a password:<code bash>
secret-tool lookup {attribute} {value} {attribute2} {value2} [...]
</code>
  * Show entries with similar key/values:<code bash>
secret-tool search --all {attribute} {value} {attribute2} {value2} [...]
</code>
  * Delete an entry:<code bash>
secret-tool clear {attribute} {value} {attribute2} {value2} [...]
</code>

----
====Searching====
  * Generic Formatting Example:<code bash>
secret-tool search --all {attribute} {value} [...]
</code>
  * Search ''%%Title%%'':<code bash>
secret-tool search --all Title name
</code>
  * Search ''%%UserName%%'':<code bash>
secret-tool search --all UserName name
</code>
  * Search ''%%URL%%'':<code bash>
secret-tool search --all URL https://www.url.com
</code>
  * Search ''%%Notes%%'':<code bash>
secret-tool search --all Notes value
</code>

----

=====Tips=====
  * Set an alias in ''%%~/.bash_aliases%%'':<code bash>
alias get_password1='secret-tool lookup {attribute} {value} {attribute2} {value2}'
</code>
  * Use in docker: https://www.marian-dan.ro/blog/storing-secrets-using-secret-tool/

----

====Use keyring for Ansible====
  * Create keyring entry:<code bash>
secret-tool store --label='Ansible Playbook' service ansible_playbook username <username>
</code>
  * Create variable in playbook:<code yaml>
admin_user: "username"
ansible_become_pass: "{{ lookup('community.general.keyring', 'ansible_playbook {{ admin_user }}') }}"
</code>
  * https://docs.ansible.com/ansible/latest/collections/community/general/keyring_lookup.html

----