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

docs(self-hosted): describe purpose and usage of privateKey option #5897

Merged
merged 2 commits into from
Apr 9, 2020
Merged

docs(self-hosted): describe purpose and usage of privateKey option #5897

merged 2 commits into from
Apr 9, 2020

Conversation

fgreinacher
Copy link
Contributor

@fgreinacher fgreinacher commented Apr 7, 2020

@JamieMagee JamieMagee changed the title Update self-hosted-configuration.md docs: document how to generate public/private keypair Apr 7, 2020
@JamieMagee
Copy link
Contributor

JamieMagee commented Apr 7, 2020

@fgreinacher I updated your title to a semantic commit format.

Also, It seems like current recommendations suggest key sizes of 2048-bit or above. From Wikipedia:

RSA claimed that 1024-bit keys were likely to become crackable some time between 2006 and 2010 and that 2048-bit keys are sufficient until 2030. NIST recommends 2048-bit keys for RSA. An RSA key length of 3072 bits should be used if security is required beyond 2030.

@fgreinacher fgreinacher changed the title docs: document how to generate public/private keypair docs(self-hosted): describe purpose and usage of privateKey option Apr 8, 2020
@fgreinacher fgreinacher marked this pull request as ready for review April 8, 2020 19:18
@fgreinacher
Copy link
Contributor Author

@fgreinacher I updated your title to a semantic commit format.

Thanks!

Also, It seems like current recommendations suggest key sizes of 2048-bit or above. From Wikipedia:

RSA claimed that 1024-bit keys were likely to become crackable some time between 2006 and 2010 and that 2048-bit keys are sufficient until 2030. NIST recommends 2048-bit keys for RSA. An RSA key length of 3072 bits should be used if security is required beyond 2030.

Yeah, we used a 4096-bit key in our instance, so I document it like that :)

@JamieMagee
Copy link
Contributor

JamieMagee commented Apr 8, 2020

Might also be worth including the command to encrypt secrets from the CLI. I think it is

echo 'MY_SECRET' | openssl rsautl -encrypt -pubin -inkey rsa_pub.pem | base64

Though I haven't tested.

I think we can also update the https://renovatebot.com/encrypt page to accept other public keys.

@viceice
Copy link
Member

viceice commented Apr 9, 2020

What about adding a new page for encryption to the docs? so we have a single page with extended docu for creating keypairs and encrypting values.

@rarkins
Copy link
Collaborator

rarkins commented Apr 9, 2020

OK, but let's not let perfect be the enemy of good. I'm going to accept this PR for now and we can add a new page later dedicated to encryption (privateKey and gitPrivateKey I think?). I think I need to rename the latter variable anyway.

@rarkins rarkins merged commit 4ce5860 into renovatebot:master Apr 9, 2020
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 19.203.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to correctly generate public/private key pair
5 participants