Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support encrypted backends for credentials #147

Open
cletomartin opened this issue Jan 26, 2023 · 2 comments
Open

Support encrypted backends for credentials #147

cletomartin opened this issue Jan 26, 2023 · 2 comments
Labels
credentials credentials related issue documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cletomartin
Copy link
Collaborator

Overview

The ~/.credentials could be improved for supporting different back-end alternatives. This would be very useful for local testing where users will not need to store credentials in plain text on disk

Requirements

  • Support, at least, 1password as an alternative back-end for these credentials file.
  • Make it easy to extend for other types of back-ends.
  • Do not break current default behaviour. Make all this feature optional

Approach

  • Extend compliance/utils/credentials.py so that it supports multiple backends. The default behaviour should be the current local file.
  • 1password backend: users could use the Auditree configuration to specify the type of the backend they want to use. For example:
"creds": {
  "backend": "1password",
  "domain": "my-domain"
}

In this case, Auditree will wait for an auditree vault in 1password (this vault name can be part of the config too) which will contain the credentials with the following schema:

  • Name of sections of the credentials file will match with the name of a secure note.
  • Each section key/value of the credentials file will be a field in the secure note.

For example: creds['aws'].username will be searched at op://auditree/aws/username

Test Plan

No configuration provided should keep the same behaviour so far.

@drsm79
Copy link
Contributor

drsm79 commented Jan 26, 2023

Pulling secrets from e.g. github environment would be cool, too.

@cletomartin cletomartin added documentation Improvements or additions to documentation enhancement New feature or request credentials credentials related issue labels Jan 26, 2023
@cletomartin
Copy link
Collaborator Author

For the record, there has been documented a way to use 1Password with auditree in #153

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
credentials credentials related issue documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants