-
Notifications
You must be signed in to change notification settings - Fork 5
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
[SECURESIGN-1465] Enable customer provided cert for Fulcio #105
base: main
Are you sure you want to change the base?
Conversation
2e02770
to
ad54901
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, I think this works really well, except some scenarios with cert/key changes that I think would not be covered right now. Specifically, in the certificates.yml
file:
- The whole
Create Fulcio root
block is only ran if one of the files is missing on the managed node. We can no longer do this, as we have to expect the user to e.g. first let the role generate key automatically and then later provide their own cert or change the settings somehow (or rotate their provided cert etc). I think this will be tricky to handle but we have to do it and consider all scenarios when user changes from one way of doing something to another way. - The same applies to the
Create Fulcio public key
task, which would now only run when the public key file doesn't exist (because of thecreates
). - Same for
Create self-signed Fulcio root from CSR
. - I think the
Create certificate signing request (CSR) for Fulcio root certificate
with your changes will run every time and generate a different cert, which is not what we want.
I know this is going to be tedious, but we have to switch from the "do these things" mindset here to "ensure the files are in the desired state". Let me know if you need any help.
a8f11b5
to
3724a8f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Firas, thanks for implementing the requested changes. I think this version is better, but there are still some scenarios that need to be covered - see the comments inline.
src: "{{ tas_single_node_fulcio_private_key }}" | ||
dest: "{{ tas_single_node_remote_fulcio_private_key }}" | ||
mode: '0600' | ||
when: tas_single_node_fulcio_private_key != "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the two private key tasks, I think we should:
- Use a different path for the key file for each task. For example, if the user first provided a key themselves but later wanted to switch to a role-generated key, we would just happily keep using their provided old key. Using different paths for the file should solve this.
- For the user-provided key, I think if it's not provided we should explicitly ensure that the file is absent (we don't want users credentials laying around on the node unnecessarily).
- Based on what the user configured, we can then copy either the role generated key or the user key to
tas_single_node_remote_fulcio_private_key
as the final destination (so we won't have to change any tasks that depend on that file location).
(certs_dir_files.files | selectattr('path', 'equalto', tas_single_node_remote_fulcio_public_key) | list | length) == 0 | ||
when: > | ||
tas_single_node_fulcio_private_key != "" | ||
or (certs_dir_files.files | selectattr('path', 'equalto', tas_single_node_remote_fulcio_public_key) | list | length) == 0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Will this command work even if user provides an RSA key?
- For RSA keys, generating the public key can yield a different output every time. I think what we should do is we should have a task that finds out whether the public key corresponds to the private key; if not, then this task should regenerate.
when: > | ||
tas_single_node_fulcio_root_ca == "" | ||
and (certs_dir_files.files | selectattr('path', 'equalto', tas_single_node_remote_fulcio_root_ca) | list | length) == 0 | ||
or tas_single_node_fulcio_private_key != "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to one of the previous comments - if user first provided cert on their own and then they wanted to switch to role-generated cert, this wouldn't properly regenerate. I think the last line of the conditon should be replaced by checking a result of a new task which will verify whether the existing private/public key match the existing cert.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for putting all the work into this, it looks much better now. I left couple comments inline, but they're mostly minor at this point (still need to be addressed though).
@@ -51,6 +59,9 @@ tas_single_node_tsa_ca_passphrase: rhtas | |||
tas_single_node_tsa_signer_passphrase: rhtas | |||
tas_single_node_ct_logprefix: rhtasansible | |||
|
|||
tas_single_node_fulcio_private_key: "" | |||
tas_single_node_fulcio_root_ca: "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We now have the nested values under tas_single_node_fulcio
, so we can remove these ones, right?
roles/tas_single_node/README.md
Outdated
|---|---|---|---|---| | ||
| certificate | Details on the certificate attributes for Fulcio. | dict of 'certificate' options | no | | | ||
| tas_single_node_fulcio_private_key | The user-provided private key for Fulcio, used for signing root certificate (only RSA with > 2048 B pkey size or ECC with prime256v1 (==secp256r1) are supported). | str | no | | | ||
| tas_single_node_fulcio_root_ca | The user-provided root certificate for Fulcio. | str | no | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's mention that this is mutually exclusive with certificate
(it is, right?)
dest: "{{ tas_single_node_remote_fulcio_private_key }}" | ||
mode: '0600' | ||
remote_src: true | ||
when: auto_generated_key_stat.stat.exists |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to do these 2 stats calls. We can use the user-provided key when tas_single_node_remote_fulcio_user_provided_private_key
is defined and non-empty, otherwise use the auto-generated key. Does that make sense?
ansible.builtin.shell: | ||
cmd: >- | ||
set -o pipefail && | ||
openssl ec -pubout -in '{{ tas_single_node_remote_fulcio_private_key }}' -passin 'pass:{{ tas_single_node_fulcio_ca_passphrase }}' | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will this work if the private key is RSA?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it works
# cat private_key.pem
-----BEGIN PRIVATE KEY-----
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDcRXm+Y2Er3aA3
....
sXlWPzGfjMAx4DPX5NhXFLTR7R051CkKXgSOmxC2sJ1bhiMAySYo00RH0ap0TxWe
Mo44kmQXlw0aWC4C1TaEJyz2Yw==
-----END PRIVATE KEY-----
# openssl rsa -in private_key.pem -pubout -out public_key.pem
writing RSA key
# openssl ec -pubout -in private_key.pem -passin 'pass:rhtas' | openssl md5 | awk '{print $NF}' && openssl md5 public | awk '{print $NF}'
read EC key
writing EC key
4de214eff3b63c39c3a248a7e01f8c22
4de214eff3b63c39c3a248a7e01f8c22
Changes in this PR: