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

refactor(zetaclient): use keyring backend file for hotkey #1323

Merged
merged 27 commits into from
Nov 3, 2023

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Oct 20, 2023

Description

  • Remove the password from the ZetaClient config
  • Add option KeyringBackend in ZetaClient config for the keyring backend used for the key
  • Add the File keyring backend for hot key for encryption
  • Use Keyring Backend file in the smoketests

When using keyring backend file, the password must be provided through the env var HOTKEY_PASSWORD

export HOTKEY_PASSWORD=foobarfoo
zetaclientd ... --keyring-backend file

Closes: #1278

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Include instructions and any relevant details so others can reproduce.

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Checklist:

  • I have added unit tests that prove my fix feature works

@lumtis lumtis self-assigned this Oct 20, 2023
@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Oct 29, 2023
@github-actions
Copy link

!!!WARNING!!!
nosec detected in the following files: contrib/localnet/orchestrator/smoketest/main.go

Be very careful about using #nosec in code. It can be a quick way to suppress security warnings and move forward with development, it should be employed with caution. Suppressing warnings with #nosec can hide potentially serious vulnerabilities. Only use #nosec when you're absolutely certain that the security issue is either a false positive or has been mitigated in another way.

Only suppress a single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the #nosec annotation, e.g: /* #nosec G401 */ or //#nosec G201 G202 G203
Broad #nosec annotations should be avoided, as they can hide other vulnerabilities. The CI will block you from merging this PR until you remove #nosec annotations that do not target specific rules.

Pay extra attention to the way #nosec is being used in the files listed above.

@github-actions github-actions bot added the nosec label Oct 29, 2023
@lumtis lumtis marked this pull request as ready for review October 31, 2023 06:02
@github-actions github-actions bot removed the ci Changes to CI pipeline or github actions label Oct 31, 2023
@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Nov 1, 2023
@lumtis
Copy link
Member Author

lumtis commented Nov 1, 2023

I will wait on a review from @kevinssgh before merging if you can have a look sometime. Thanks

@lumtis lumtis requested a review from CryptoFewka November 3, 2023 22:36
@lumtis lumtis removed the ci Changes to CI pipeline or github actions label Nov 3, 2023
@lumtis lumtis removed the request for review from CryptoFewka November 3, 2023 22:38
@lumtis lumtis merged commit e8161c5 into develop Nov 3, 2023
@lumtis lumtis deleted the feat/zetaclient/keyring-file branch November 3, 2023 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More advanced key management for ZetaClient (hotkey)
5 participants