Refresh default TLS context on secret update #13342
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,151 @@ | ||
| ''' | ||
| Test default server certificate updates through TSSslSecretSet/TSSslSecretUpdate. | ||
| ''' | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import os | ||
|
|
||
| Test.Summary = ''' | ||
|
Contributor
There was a problem hiding this comment. Optional: tls_check_cert_select_plugin.test.py already has the same plugin/wildcard-policy/CopyAs+touch scaffolding — a no-SNI run added there might cover this without a second copy of the update dance. |
||
| Verify that secret updates refresh the default server SSL_CTX used without SNI. | ||
| ''' | ||
|
|
||
|
|
||
| class TestDefaultSecretUpdate: | ||
| '''Verify default server certificate updates through the secret API.''' | ||
|
|
||
| initial_cert = 'signed-bar.pem' | ||
| updated_cert = 'signed2-bar.pem' | ||
| key_file = 'signed-bar.key' | ||
| plugin = 'ssl_secret_load_test.so' | ||
|
|
||
| def __init__(self): | ||
|
Contributor
There was a problem hiding this comment. Type annotations on these methods, please — matching the other class-style tests in this directory (e.g. |
||
| '''Configure the ATS process, origin server, and test runs.''' | ||
| self._configure_server() | ||
| self._configure_traffic_server() | ||
| self._add_initial_certificate_run() | ||
| self._add_mtime_delay_run() | ||
| self._add_certificate_update_run() | ||
| self._add_secret_update_wait_run() | ||
| self._add_updated_certificate_run() | ||
|
|
||
| def _configure_server(self): | ||
| '''Configure the origin server.''' | ||
| server = Test.MakeOriginServer('server') | ||
| self._server = server | ||
|
|
||
| request_header = {'headers': 'GET / HTTP/1.1\r\nHost: doesnotmatter\r\n\r\n', 'timestamp': '1469733493.993', 'body': ''} | ||
| response_header = {'headers': 'HTTP/1.1 200 OK\r\nConnection: close\r\n\r\n', 'timestamp': '1469733493.993', 'body': ''} | ||
| server.addResponse('sessionlog.json', request_header, response_header) | ||
| return server | ||
|
|
||
| def _configure_traffic_server(self): | ||
| '''Configure the Traffic Server process.''' | ||
| ts = Test.MakeATSProcess('ts', enable_tls=True) | ||
| self._ts = ts | ||
|
|
||
| ts.addSSLfile(f'ssl/{self.initial_cert}') | ||
| ts.addSSLfile(f'ssl/{self.updated_cert}') | ||
| ts.addSSLfile(f'ssl/{self.key_file}') | ||
| Test.PrepareTestPlugin(os.path.join(Test.Variables.AtsTestPluginsDir, self.plugin), ts) | ||
|
|
||
| ts.Disk.records_config.update( | ||
| { | ||
| 'proxy.config.diags.debug.enabled': 1, | ||
| 'proxy.config.diags.debug.tags': 'ssl_secret_load_test|ssl|ssl_config_updateCTX', | ||
| 'proxy.config.ssl.server.cert.path': f'{ts.Variables.SSLDir}/../', | ||
| 'proxy.config.ssl.server.private_key.path': f'{ts.Variables.SSLDir}/../', | ||
|
Comment on lines
+69
to
+70
|
||
| 'proxy.config.exec_thread.autoconfig.scale': 1.0, | ||
| 'proxy.config.url_remap.pristine_host_hdr': 1, | ||
| }) | ||
|
|
||
| ts.Disk.ssl_multicert_yaml.AddLines( | ||
| [ | ||
| 'ssl_multicert:', | ||
| ' - dest_ip: "*"', | ||
| f' ssl_cert_name: {self.initial_cert}', | ||
| f' ssl_key_name: {self.key_file}', | ||
| ]) | ||
| ts.Disk.remap_config.AddLine(f'map / http://127.0.0.1:{self._server.Variables.Port}') | ||
| return ts | ||
|
|
||
| def _add_initial_certificate_run(self): | ||
| '''Verify the original default certificate before the secret update.''' | ||
| tr = self._add_curl_run( | ||
| 'Initial default certificate', | ||
| expected_cn='signer.yahoo.com', | ||
| unexpected_cn='signer2.yahoo.com', | ||
| expected_description='Initial cert uses signer.', | ||
| unexpected_description='Initial cert is not updated yet.') | ||
| tr.Processes.Default.StartBefore(self._server) | ||
| tr.Processes.Default.StartBefore(self._ts) | ||
| return tr | ||
|
|
||
| def _add_mtime_delay_run(self): | ||
| '''Make the replacement certificate mtime differ from the original.''' | ||
| tr = Test.AddTestRun('Make the cert mtime differ') | ||
| tr.Processes.Default.Command = 'sleep 2' | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| self._keep_processes_running(tr) | ||
| return tr | ||
|
|
||
| def _add_certificate_update_run(self): | ||
| '''Replace the plugin backing certificate file.''' | ||
| tr = Test.AddTestRun('Update the plugin backing certificate') | ||
| tr.Setup.CopyAs(f'ssl/{self.updated_cert}', '.', f'{self._ts.Variables.SSLDir}/{self.initial_cert}') | ||
| tr.Processes.Default.Command = f'touch {self._ts.Variables.SSLDir}/{self.initial_cert}' | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| self._keep_processes_running(tr) | ||
| return tr | ||
|
|
||
| def _add_secret_update_wait_run(self): | ||
| '''Wait for the test plugin to update the certificate secret.''' | ||
| tr = Test.AddTestRun('Wait for the secret update') | ||
| tr.Processes.Default.Command = 'echo awaiting secret update' | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| await_update = tr.Processes.Process('await_update', 'sleep 30') | ||
| await_update.Ready = When.FileContains(self._ts.Disk.traffic_out.Name, 'update cert for secret') | ||
| tr.Processes.Default.StartBefore(await_update) | ||
| self._keep_processes_running(tr) | ||
| return tr | ||
|
|
||
| def _add_updated_certificate_run(self): | ||
| '''Verify the updated default certificate after the secret update.''' | ||
| return self._add_curl_run( | ||
| 'Updated default certificate', | ||
| expected_cn='signer2.yahoo.com', | ||
| unexpected_cn='signer.yahoo.com', | ||
| expected_description='Updated cert uses signer2.', | ||
| unexpected_description='Updated cert no longer uses signer.') | ||
|
|
||
| def _add_curl_run(self, name, expected_cn, unexpected_cn, expected_description, unexpected_description): | ||
| '''Add a curl run against ATS without SNI.''' | ||
| tr = Test.AddTestRun(name) | ||
| self._keep_processes_running(tr) | ||
| tr.MakeCurlCommand( | ||
| f"-k -v --http1.1 -H 'host: doesnotmatter' https://127.0.0.1:{self._ts.Variables.ssl_port}/", ts=self._ts) | ||
| tr.Processes.Default.ReturnCode = 0 | ||
| tr.Processes.Default.Streams.All = Testers.ContainsExpression(f'issuer:.*CN={expected_cn}', expected_description) | ||
| tr.Processes.Default.Streams.All += Testers.ExcludesExpression(f'issuer:.*CN={unexpected_cn}', unexpected_description) | ||
| return tr | ||
|
|
||
| def _keep_processes_running(self, tr): | ||
| '''Keep ATS and the origin server running after a TestRun.''' | ||
| tr.StillRunningAfter = self._ts | ||
| tr.StillRunningAfter = self._server | ||
|
|
||
|
|
||
| TestDefaultSecretUpdate() | ||
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.
Can this move to the private section next to
default_ctx_mutex? Nothing accesses it directly anymore, and keeping it public leaves the door open for the kind of unlocked read this PR fixed in SSLStats.cc.