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

feat(secret): remove Validator/Verifier secret keys from repository #2033

Merged
merged 1 commit into from
Jul 19, 2022

Conversation

outSH
Copy link
Contributor

@outSH outSH commented May 20, 2022

  • Remove validator sample CA keys hardcoded inside the repository.
  • Generate fresh ECDSA keys when starting up electricity-trade
    or discounted-asset-trade sample apps.
  • Add support for RSA CA keys in fabric-socketio validator.
    I couldn't find any trivial way of generating ECDSA self-signed certificate
    (without calling openssl cmdline, which seems poor from functional test perspective),
    so I've added support for RSA keys to simplify the tests.
  • Allow selection of jwt algorithm in fabric-socketio validator.
    It must correspond to the key used.
  • Update the READMEs, add short description of SSL config option of fabric-socketio validator.

Closes: #2016
Closes: #2017

Depends on #1977
Depends on #2030

Signed-off-by: Michal Bajer michal.bajer@fujitsu.com


I've included commits from the dependencies to simplify the review before they're merged to main. Please review only the last commit: feat(secret): remove Validator/Verifier secret keys from repository

@gitguardian
Copy link

gitguardian bot commented May 20, 2022

⚠️ GitGuardian has uncovered 4 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id Secret Commit Filename
- Elliptic Curve Private Key cf1c07b packages-python/cactus_validator_socketio_indy/sample-CA/connector.priv View secret
- Elliptic Curve Private Key cf1c07b packages/cactus-plugin-ledger-connector-fabric-socketio/sample-config/CA/connector.priv View secret
- Elliptic Curve Private Key cf1c07b packages/cactus-plugin-ledger-connector-go-ethereum-socketio/sample-config/CA/connector.priv View secret
- Elliptic Curve Private Key cf1c07b packages/cactus-plugin-ledger-connector-sawtooth-socketio/sample-config/CA/connector.priv View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secrets safely. Learn here the best practices.
  3. Revoke and rotate these secrets.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

@outSH outSH force-pushed the remove_hardcoded_keys_pr branch from 037100e to 4ec5b88 Compare May 20, 2022 10:46
Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@outSH The CI script is complaining that pull request title " feat(secret): remove Validator/Verifier secret keys from repository" isn't following the convention. It appears there is a leading space character before 'feat'. Can you fix this?
@jagpreetsinghsasan
There is also a test that failed (GitGuardian Security Checks), but I suspect that this is a false positive. It is complaining that there are four secret keys in this PR, but this PR is removing those files. So I don't understand why it is complaining. Can you investigate this problem? thanks.

@jagpreetsinghsasan
Copy link
Contributor

There is also a test that failed (GitGuardian Security Checks), but I suspect that this is a false positive. It is complaining that there are four secret keys in this PR, but this PR is removing those files. So I don't understand why it is complaining. Can you investigate this problem? thanks.

This is happening because the PR has 3 commits within, where the most earliest commit do contains crypto material. I am sure that a squash merge of the 3 commits shall resolve this.

@izuru0
Copy link
Contributor

izuru0 commented May 23, 2022

There is also a test that failed (GitGuardian Security Checks), but I suspect that this is a false positive. It is complaining that there are four secret keys in this PR, but this PR is removing those files. So I don't understand why it is complaining. Can you investigate this problem? thanks.

This is happening because the PR has 3 commits within, where the most earliest commit do contains crypto material. I am sure that a squash merge of the 3 commits shall resolve this.

ah you are totally right. Thanks for correction.

@outSH outSH changed the title feat(secret): remove Validator/Verifier secret keys from repository feat(secret): remove Validator/Verifier secret keys from repository May 26, 2022
@outSH outSH requested a review from sandeepnRES as a code owner May 26, 2022 13:56
Copy link
Contributor

@izuru0 izuru0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@outSH Please fix the merge conflicts + squash and then we should be good to go

@outSH
Copy link
Contributor Author

outSH commented Jun 17, 2022

@outSH Please fix the merge conflicts + squash and then we should be good to go

@petermetz Thanks for the review :) There's still one dependency that needs to me merged first - #2030. I will do the squash after that

@github-actions
Copy link

@outSH
Copy link
Contributor Author

outSH commented Jul 18, 2022

@petermetz @izuru0 @takeutak This could be merged but GitGuardian Security Checks complains about keys that were removed by this PR. Do you have any solution for this, or can this be ignored and merged with failing check anyway?

@outSH outSH requested a review from petermetz July 18, 2022 07:30
Copy link
Contributor

@petermetz petermetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@outSH LGTM, thank you!

@petermetz @izuru0 @takeutak This could be merged but GitGuardian Security Checks complains about keys that were removed by this PR. Do you have any solution for this, or can this be ignored and merged with failing check anyway?

Yes, in my opinion.
The Git Guardian checks are experimental for now because the ignore patterns are something that is not yet fully configurable and the examples/test code trips it up sometimes (like in this case).
So we are good to merge IMO, regardless of the GitGuardian check. Once we figured out all the details of how to make it work properly, we can set it up so that it becomes a hard stop for merging PRs, but that will only happen in the future.

- Remove validator sample CA keys hardcoded inside the repository.
- Generate fresh ECDSA keys when starting up electricity-trade
  or discounted-asset-trade sample apps.
- Add support for RSA CA keys in fabric-socketio validator.
  I couldn't find any trivial way of generating ECDSA self-signed certificate
  (without calling openssl cmdline, which seems poor from functional test perspective),
  so I've added support for RSA keys to simplify the tests.
- Allow selection of jwt algorithm in  fabric-socketio validator.
  It must correspond to the key used.
- Update the READMEs, add short description of SSL config option of fabric-socketio validator.

Closes: 2016
Closes: 2017

Depends on: 1977
Depends on: 2030

Signed-off-by: Michal Bajer <michal.bajer@fujitsu.com>
@petermetz
Copy link
Contributor

FYI: I disabled the git guardian check being required for now.

@petermetz petermetz merged commit 59b4af4 into hyperledger-cacti:main Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants