Extract gRPC TLS configuration into a shared package #1840
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
October 6, 2019 21:22
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
yurishkuro
requested review from
black-adder,
jpkrohling,
objectiser,
pavolloffay,
tiffon and
vprithvi
as code owners
jpkrohling
reviewed
Oct 7, 2019
added 3 commits
October 7, 2019 18:21
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
yurishkuro
commented
Oct 8, 2019
| flags.String(collectorTLSCA, "", "Path to a TLS CA file used to verify the remote server. (default use the systems truststore)") | ||
| flags.String(collectorTLSServerName, "", "Override the TLS server name we expected in the remote certificate") | ||
| flags.String(agentCert, "", "Path to a TLS client certificate file, used to identify this agent to the collector") | ||
| flags.String(agentKey, "", "Path to the TLS client key for the client certificate") |
There was a problem hiding this comment.
Now:
$ go run ./cmd/agent help | grep tls
--reporter.grpc.tls Enable TLS when talking to the remote server(s)
--reporter.grpc.tls.ca string Path to a TLS CA (Certification Authority) file used to verify the remote server(s) (by default will use the system truststore)
--reporter.grpc.tls.cert string Path to a TLS Certificate file, used to identify this process to the remote server(s)
--reporter.grpc.tls.key string Path to a TLS Private Key file, used to identify this process to the remote server(s)
--reporter.grpc.tls.server-name string Override the TLS server name we expect in the certificate of the remove server(s)
Signed-off-by: Yuri Shkuro <ys@uber.com>
Codecov Report
@@ Coverage Diff @@
## master #1840 +/- ##
==========================================
+ Coverage 98.21% 98.44% +0.22%
==========================================
Files 195 197 +2
Lines 9603 9619 +16
==========================================
+ Hits 9432 9469 +37
+ Misses 134 114 -20
+ Partials 37 36 -1
Continue to review full report at Codecov.
|
yurishkuro
commented
Oct 8, 2019
| flags.Bool(collectorGRPCTLS, false, "Enable TLS for the gRPC collector port") | ||
| flags.String(collectorGRPCCert, "", "Path to TLS certificate for the gRPC collector TLS service") | ||
| flags.String(collectorGRPCKey, "", "Path to TLS key for the gRPC collector TLS cert") | ||
| flags.String(collectorGRPCClientCA, "", "Path to a TLS CA to verify certificates presented by clients (if unset, all clients are permitted)") |
There was a problem hiding this comment.
now:
$ go run ./cmd/collector help | grep grpc.tls
--collector.grpc.tls Enable TLS on the server
--collector.grpc.tls.cert string Path to a TLS Certificate file, used to identify this server to clients
--collector.grpc.tls.client-ca string Path to a TLS CA (Certification Authority) file used to verify certificates presented by clients (if unset, all clients are permitted)
--collector.grpc.tls.client.ca string (deprecated) see --collector.grpc.tls.client-ca
--collector.grpc.tls.key string Path to a TLS Private Key file, used to identify this server to clients
added 3 commits
October 7, 2019 22:33
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
Signed-off-by: Yuri Shkuro <ys@uber.com>
yurishkuro
changed the title
yurishkuro
changed the title
Sorry, I pushed as WIP to show @backjo the approach I was taking. It's now ready for review. |
yurishkuro
changed the title
vprithvi
reviewed
Oct 8, 2019
|
|
||
| if test.checkSuffixOnly { | ||
| assert.True(t, strings.HasSuffix(conn.Target(), test.target)) | ||
| } else { | ||
| assert.True(t, conn.Target() == test.target) | ||
| } | ||
| } else { | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), test.expectedError) |
There was a problem hiding this comment.
https://godoc.org/github.com/stretchr/testify/assert#EqualError is more concise
There was a problem hiding this comment.
That function performs exact comparison of the error message. Since the error is wrapped multiple times, the message consists of multiple segments. I don't know or care what the underlying stdlib error was, I only care about the substring introduced by the code under test.
vprithvi
approved these changes
Oct 8, 2019
backjo
pushed a commit
to backjo/jaeger
that referenced
this pull request
Dec 19, 2019
) * Extract TLS flags and cert loading logic Signed-off-by: Yuri Shkuro <ys@uber.com> * Rename package Signed-off-by: Yuri Shkuro <ys@uber.com> * Refactor grpc Signed-off-by: Yuri Shkuro <ys@uber.com> * Repair tests Signed-off-by: Yuri Shkuro <ys@uber.com> * Refactor gRPC server in collector Signed-off-by: Yuri Shkuro <ys@uber.com> * Add ShowCA option Signed-off-by: Yuri Shkuro <ys@uber.com> * Switch options order Signed-off-by: Yuri Shkuro <ys@uber.com> * Separate client and server TLS options Signed-off-by: Yuri Shkuro <ys@uber.com> * Update usage Signed-off-by: Yuri Shkuro <ys@uber.com> * Rename test, add filepath.Clean Signed-off-by: Yuri Shkuro <ys@uber.com> Signed-off-by: Jonah Back <jonah@jonahback.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #1837
Moves TLS configuration from gRPC client (agent) and server (collector) into a shared package
pkg/config/tlscfg. This allows fewer unit tests to be written for the call sites, since all error handling of TLS certificates loading is covered in the new package.