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

Risky documentation (sha256 sum) #15

Closed
TJM opened this issue Jun 6, 2022 · 1 comment · Fixed by #30
Closed

Risky documentation (sha256 sum) #15

TJM opened this issue Jun 6, 2022 · 1 comment · Fixed by #30
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@TJM
Copy link
Contributor

TJM commented Jun 6, 2022

It is my opinion that the following step in the README.md is risky:

$ vault write sys/plugins/catalog/secret/artifactory \
    sha_256="$(sha256sum path/to/plugin/directory/artifactory | cut -d " " -f 1)" \
    command="artifactory"

The whole point of a security product like Vault validating the sha256sum of the binary is to ensure that it has not been modified. If you just read the sha256sum from the filesystem as you "register" the plugin, it will of course match, but you haven't validated anything. At a minimum, it would be a good idea to note that the procedure is for proof of concept or lab testing, and should not be used in production or anywhere security matters.

I would suggest that the binary itself should have a published SHA256sum, that is GPG signed, so that we can ensure that the binary is unmodified. I do thank you for at least publishing the list of sums for the zip files, which allows us to validate the zip file, but as they are not signed, they could be modified at the same time the binaries are being compromised.

Thanks,
Tommy

@alexhung
Copy link
Member

@TJM HashiCorp is planning to add a registry for Vault in the not-too-far future. It may/should work similarly as the Terraform Provider registry and the binary will be signed. I don't have any ETA though so in the meantime your suggestion is great.

We will update the documentation with emphasis on its non-production aspect.

@alexhung alexhung added the documentation Improvements or additions to documentation label Nov 29, 2022
@alexhung alexhung self-assigned this Feb 1, 2023
alexhung added a commit that referenced this issue Feb 1, 2023
Add note for binary checksum should not be used for production
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants