Allow only CA cert to be set in command server TLS settings #1079
Conversation
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
internal/grpc/grpc_test.go
Outdated
| "Test 3: incorrect CA should not error": { // REALLY ?! | ||
| conf: &config.TLSConfig{ | ||
| Ca: "customca.pem", | ||
| }, | ||
| wantErr: false, |
There was a problem hiding this comment.
This feels wrong to me; the user specified a CA cert and we silently ignore it?!
There was a problem hiding this comment.
yeah I agree. Not sure why we aren't returning an error if the CA is invalid. I'd say update the logic to return an error instead of just logging a debug message.
There was a problem hiding this comment.
My thinking is that this should error while building the connection credentials; similar to passing an invalid client cert. I was trying not to disrupt existing behavior too much in case there is a use case I'm missing.
Edit: this comment was made before I saw yours, the page hadn't refreshed
There was a problem hiding this comment.
This doesn't completely solve it, but makes the error notably more visible:
time=2025-05-21T15:41:33.547Z level=ERROR msg="Unable to add transport credentials to gRPC dial options, adding default transport credentials" error="invalid CA cert while building transport credentials: read CA file (/etc/nginx-agent/bad.crt): open /etc/nginx-agent/bad.crt: no such file or directory"
I'm willing to call that good enough -- it is now visible what's gone wrong even if it didn't crash the process.
There was a problem hiding this comment.
Thanks @UnwashedMeme. Yeah that looks good to me.
When generating a self-signed cert for _unit-tests_ it doesn't need to have high security. Using a smaller length makes the tests run faster. The difference is ~0.1s vs ~2.0s to run one test that generates a cert.
This was incorrectly passing in the cert and key backwards which resulted in not actually getting mTLS credentials, but instead insecure credentials. When insecure credentials are used, skipToken means we don't add a addPerRPCCredentials. When it is a secure TLS credential then addPerRPCCredentials increases the dialoption count by one.
|
I have hereby read the F5 CLA and agree to its terms. My employer F5 has ownership of the code I am contributing to F5. ;-) |
UnwashedMeme
force-pushed
the
v3-respect-ca
branch
from
1808146 to
e5b7934
Compare
|
I have hereby read the F5 CLA and agree to its terms |
|
recheck |
|
I haven't actually been able to run this yet to verify that after this change the CA is actually respected. |
internal/grpc/grpc_test.go
Outdated
| "Test 3: incorrect CA should not error": { // REALLY ?! | ||
| conf: &config.TLSConfig{ | ||
| Ca: "customca.pem", | ||
| }, | ||
| wantErr: false, |
There was a problem hiding this comment.
yeah I agree. Not sure why we aren't returning an error if the CA is invalid. I'd say update the logic to return an error instead of just logging a debug message.
dhurley
changed the title
This had been skipping out of the function early if a client key wasn't specified. I don't believe that's correct. If I[User] have specified specified a CA cert because the MPI server I'm trying to talk to is signed by a non-standard CA (e.g. N1 devenv) then it should be respected regardless of whether I've configured mTLS. Silently skipping the CA is really confusing and leads to > Failed to create connection" error="rpc error: code = Unavailable desc = connection error: desc = \"transport: authentication handshake failed: tls: failed to verify certificate: x509: certificate signed by unknown authority\" I've split out the getTLSConfigForCredentials to make it easier to test this translation. Once it is wrapped into a TransportCredential or a DialOption it's opaque and hard to verify.
UnwashedMeme
force-pushed
the
v3-respect-ca
branch
from
e5b7934 to
de7d3b9
Compare
Previously if a consumer specified the CA cert to verify the command connection but that CA wasn't valid then system would log at Debug (default hidden) and proceed anyways. I don't believe this is good behavior. If the consumer is directly specifying a CA cert then that is the CA that should be used, not silently ignored. This patch returns the error up, which is now caught and swallowed at a higher level, but at least it is more visible: > time=2025-05-21T15:41:33.547Z level=ERROR msg="Unable to add transport credentials to gRPC dial options, adding default transport credentials" error="invalid CA cert while building transport credentials: read CA file (/etc/nginx-agent/bad.crt): open /etc/nginx-agent/bad.crt: no such file or directory"
UnwashedMeme
force-pushed
the
v3-respect-ca
branch
from
de7d3b9 to
1859885
Compare
Proposed changes
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the supported keywords here in this description (not in the title of the PR).
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentmake install-toolsand have attached any dependency changes to this pull requestv3(more below)README.md)