-
Notifications
You must be signed in to change notification settings - Fork 152
fix: validate mTLS client identity files #951
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,89 @@ | ||
| from unittest.mock import Mock | ||
|
|
||
| import pytest | ||
|
|
||
| from databricks.sql.exc import ProgrammingError | ||
| from databricks.sql.types import SSLOptions | ||
|
|
||
|
|
||
| class TestSSLOptionsMutualTls: | ||
| def test_private_key_without_client_certificate_is_rejected_before_file_access( | ||
| self, | ||
| ): | ||
| options = SSLOptions( | ||
| tls_client_cert_key_file="/path/does/not/need/to/exist.pem" | ||
| ) | ||
|
|
||
| with pytest.raises(ProgrammingError) as exc_info: | ||
| options.load_client_cert_chain(Mock()) | ||
|
|
||
| message = str(exc_info.value) | ||
| assert "tls_client_cert_key_file" in message | ||
| assert "tls_client_cert_file" in message | ||
| assert "requires" in message | ||
|
|
||
| @pytest.mark.parametrize( | ||
| "failing_input,empty", | ||
| [ | ||
| ("certificate", False), | ||
| ("private key", False), | ||
| ("certificate", True), | ||
| ("private key", True), | ||
| ], | ||
| ids=[ | ||
| "missing-certificate", | ||
| "missing-private-key", | ||
| "empty-certificate", | ||
| "empty-private-key", | ||
| ], | ||
| ) | ||
| def test_unreadable_or_empty_identity_file_names_failing_input( | ||
| self, tmp_path, failing_input, empty | ||
| ): | ||
| # Deliberately not PEM: file readability/emptiness must be checked for both | ||
| # inputs before SSL parsing begins, so a malformed peer cannot mask the | ||
| # missing/empty input this case is exercising. | ||
| readable_nonempty = tmp_path / "readable-nonempty.pem" | ||
| readable_nonempty.write_bytes(b"not PEM, but readable and non-empty") | ||
| failing_path = tmp_path / ("empty.pem" if empty else "missing.pem") | ||
| if empty: | ||
| failing_path.write_bytes(b"") | ||
|
|
||
| if failing_input == "certificate": | ||
| cert_file = failing_path | ||
| key_file = readable_nonempty | ||
| expected_option = "tls_client_cert_file" | ||
| else: | ||
| cert_file = readable_nonempty | ||
| key_file = failing_path | ||
| expected_option = "tls_client_cert_key_file" | ||
|
|
||
| ssl_context = Mock() | ||
| options = SSLOptions( | ||
| tls_client_cert_file=str(cert_file), | ||
| tls_client_cert_key_file=str(key_file), | ||
| ) | ||
|
|
||
| with pytest.raises(ProgrammingError) as exc_info: | ||
| options.load_client_cert_chain(ssl_context) | ||
|
|
||
| message = str(exc_info.value) | ||
| assert expected_option in message | ||
| assert str(failing_path) in message | ||
| assert ("is empty" in message) is empty | ||
| ssl_context.load_cert_chain.assert_not_called() | ||
|
|
||
| def test_combined_cert_key_file_and_password_are_forwarded(self, tmp_path): | ||
| combined = tmp_path / "combined.pem" | ||
| combined.write_bytes(b"non-empty combined PEM placeholder") | ||
| ssl_context = Mock() | ||
| password = "encrypted-key-password" | ||
|
|
||
| SSLOptions( | ||
| tls_client_cert_file=str(combined), | ||
| tls_client_cert_key_password=password, | ||
| ).load_client_cert_chain(ssl_context) | ||
|
|
||
| ssl_context.load_cert_chain.assert_called_once_with( | ||
| certfile=str(combined), keyfile=None, password=password | ||
| ) |
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.
Uh oh!
There was an error while loading. Please reload this page.