rfq: add tls support for price oracles #1775
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package rfq | ||
|
|
||
| import ( | ||
| "crypto/tls" | ||
| "crypto/x509" | ||
|
|
||
| "google.golang.org/grpc/credentials" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| ) | ||
|
|
||
| // TLSConfig represents TLS configuration options for oracle connections. | ||
| type TLSConfig struct { | ||
| // Enabled indicates that we should use TLS. | ||
| Enabled bool | ||
|
|
||
| // InsecureSkipVerify disables certificate verification. | ||
| InsecureSkipVerify bool | ||
|
|
||
| // TrustSystemRootCAs indicates whether or not to use the operating | ||
| // system's root certificate authority list. | ||
| TrustSystemRootCAs bool | ||
|
|
||
| // CustomCertificates contains PEM data for additional root CA and | ||
| // self-signed certificates to trust. | ||
| CustomCertificates []byte | ||
| } | ||
|
|
||
| // configureTransportCredentials configures the TLS transport credentials to | ||
| // be used for RPC connections. | ||
| func configureTransportCredentials( | ||
| config *TLSConfig) (credentials.TransportCredentials, error) { | ||
|
|
||
| // If TLS is disabled, return insecure credentials. | ||
| if !config.Enabled { | ||
| return insecure.NewCredentials(), nil | ||
| } | ||
|
|
||
| // If we're to skip certificate verification, then return TLS | ||
| // credentials with certificate verification disabled. | ||
| if config.InsecureSkipVerify { | ||
| creds := credentials.NewTLS(&tls.Config{ | ||
| InsecureSkipVerify: true, | ||
| }) | ||
| return creds, nil | ||
| } | ||
|
|
||
| // Initialize the certificate pool. | ||
| certPool, err := constructCertPool(config.TrustSystemRootCAs) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // If we have any custom certificates, add them to the certificate | ||
| // pool. | ||
| certPool.AppendCertsFromPEM(config.CustomCertificates) | ||
|
|
||
| // Return the constructed transport credentials. | ||
| return credentials.NewClientTLSFromCert(certPool, ""), nil | ||
| } | ||
|
|
||
| // constructCertPool is a helper for constructing an initial certificate pool, | ||
| // depending on whether or not we should trust the system root CA list. | ||
| func constructCertPool(trustSystem bool) (*x509.CertPool, error) { | ||
| if trustSystem { | ||
| return x509.SystemCertPool() | ||
| } | ||
| return x509.NewCertPool(), nil | ||
| } |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package rfq | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // validCertificate is a valid certificate. | ||
| const validCertificate = `-----BEGIN CERTIFICATE----- | ||
| MIICmjCCAYICCQCuu1gzY+BBKjANBgkqhkiG9w0BAQsFADAPMQ0wCwYDVQQDDAR0 | ||
| ZXN0MB4XDTI1MDgyODEwNDA1NVoXDTI1MDgyOTEwNDA1NVowDzENMAsGA1UEAwwE | ||
| dGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALTWCm8l3d9nE2QK | ||
| TK8HJ36ftO8pK3//nb8Nj/p97FrPFSgzdgL1ZNJs4gP5/ZsU+iE6VeKhalHoSf6/ | ||
| IMLe3ATTL0rWA1M6z7cw6ll8VS8NQMaMSFWNomncsxyoJAQde++SC5f1RwQJBD/0 | ||
| gGB4bJIIqUHtT12m23GLX48d6JGEEi5kEQtk91S/QGnHtglzZ8CQOogDBzDhSHu2 | ||
| jj4mKYDgkXcyAqN7DoDzoEcrpeAaeAwem8k1sFBeTtrqT1ot7Ey5KG+RUyJbdKGt | ||
| 5adJiwH782NgsSnISQ2X7Sct6Uu0JzHKx9JzyABsA05tf3cNJkLhh1Is9edYI2e9 | ||
| m0dqedECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAQOCs/7xZVPjabbhdv30mUJMG | ||
| lddi2A+R/5IRXW1MKnpemwiv4ZWYQ9PMTmuR7kqaF7AGLkvx+5sp2evUJN4x7vHP | ||
| ao6wihbdh+vBkrobE+Y9dE7nbkvMQSNi1sXzDnfZB9LqY9Huun2soUwBQNCMPVMa | ||
| Wo7g6udwyA48doEVJMjThFLPcW7xmsy6Ldew682m1kD8/ag+9qihX1IJyiqiEjha | ||
| 3uT4CT+zEg0RJorEJKbR38fE4Uhx1wZO4zvjEg6qZeW/I4lw+UzSY5xV7lJ1EQvf | ||
| BcoNuBHB65RxQM5fpA7hkEFm1bxBoowGX2hx6VCCeBBwREISRfgvkUxZahUXNg== | ||
| -----END CERTIFICATE-----` | ||
|
|
||
| // invalidCertificate is an invalid certificate. | ||
| const invalidCertificate = `-----BEGIN CERTIFICATE----- | ||
| This is not a valid certificate | ||
| -----END CERTIFICATE-----` | ||
|
|
||
| // testCaseConfigureTransportCredentials is a test case for the | ||
| // configureTransportCredentials function. | ||
| type testCaseConfigureTransportCredentials struct { | ||
| name string | ||
|
|
||
| expectInsecure bool | ||
|
|
||
| tlsConfig *TLSConfig | ||
| } | ||
|
|
||
| // runConfigureTransportCredentialsTest tests that we get the expected | ||
| // security protocol from the provided test case. | ||
| func runConfigureTransportCredentialsTest(t *testing.T, | ||
| tc *testCaseConfigureTransportCredentials) { | ||
|
|
||
| creds, err := configureTransportCredentials(tc.tlsConfig) | ||
|
|
||
| // We should never see an error here. | ||
| require.Nil(t, err) | ||
|
|
||
| protocol := creds.Info().SecurityProtocol | ||
|
|
||
| if tc.expectInsecure { | ||
| require.Equal(t, "insecure", protocol) | ||
| return | ||
| } | ||
|
|
||
| require.Equal(t, "tls", protocol) | ||
| } | ||
|
|
||
| // defaultTLSConfig is the default TLS config. | ||
| func DefaultTLSConfig() *TLSConfig { | ||
| return &TLSConfig{ | ||
| Enabled: true, | ||
| InsecureSkipVerify: false, | ||
| TrustSystemRootCAs: true, | ||
| } | ||
| } | ||
|
|
||
| // TestConfigureTransportCredentials tests the configureTransportCredentials | ||
| // function. | ||
| func TestConfigureTransportCredentials(t *testing.T) { | ||
| testCases := []*testCaseConfigureTransportCredentials{ | ||
| { | ||
| name: "default configuration", | ||
| expectInsecure: false, | ||
| tlsConfig: DefaultTLSConfig(), | ||
| }, | ||
| { | ||
| name: "tls disabled", | ||
| expectInsecure: true, | ||
| tlsConfig: &TLSConfig{ | ||
| Enabled: false, | ||
| }, | ||
| }, | ||
| { | ||
| name: "trust os root CAs", | ||
| expectInsecure: false, | ||
| tlsConfig: &TLSConfig{ | ||
| Enabled: true, | ||
| InsecureSkipVerify: false, | ||
| TrustSystemRootCAs: true, | ||
| }, | ||
| }, | ||
| { | ||
| name: "no trust os root CAs", | ||
| expectInsecure: false, | ||
| tlsConfig: &TLSConfig{ | ||
| Enabled: true, | ||
| InsecureSkipVerify: false, | ||
| TrustSystemRootCAs: false, | ||
| }, | ||
| }, | ||
| { | ||
| name: "valid custom certificate", | ||
| expectInsecure: false, | ||
| tlsConfig: &TLSConfig{ | ||
| Enabled: true, | ||
| InsecureSkipVerify: false, | ||
| TrustSystemRootCAs: false, | ||
| CustomCertificates: []byte(validCertificate), | ||
| }, | ||
| }, | ||
| { | ||
| name: "invalid custom certificate", | ||
| expectInsecure: false, | ||
| tlsConfig: &TLSConfig{ | ||
| Enabled: true, | ||
| InsecureSkipVerify: false, | ||
| TrustSystemRootCAs: false, | ||
| CustomCertificates: []byte(invalidCertificate), | ||
| }, | ||
| }, | ||
|
Comment on lines
+116
to
+124
There was a problem hiding this comment. I'm not sure I see the purpose of More broadly, do we need certificate examples in our unit tests at all? It seems like we're testing the behavior of the underlying TLS/certificate library rather than the logic we're adding on top of it. |
||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| runConfigureTransportCredentialsTest(t, tc) | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
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.
typo: s/verifiying/verifying