Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix TLSContextWrapper to not override tls_verify #10098

Merged
merged 4 commits into from
Sep 13, 2021
Merged

Fix TLSContextWrapper to not override tls_verify #10098

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
afde256
fix tls_verify
fanny-jiang Sep 10, 2021
3c1fa8b
add tests and remove unneeded test
fanny-jiang Sep 10, 2021
99c4b4f
add tls_verify override for tls_ca_cert
fanny-jiang Sep 13, 2021
776e59f
fix tests
fanny-jiang Sep 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions datadog_checks_base/datadog_checks/base/utils/tls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ def __init__(self, instance, remapper=None, overrides=None):

config[field] = value

if any(
(config['tls_ca_cert'], config['tls_cert'], config['tls_private_key'], config['tls_private_key_password'])
):
if config['tls_ca_cert']:
config['tls_verify'] = True

# Populate with the higher-priority configuration options if set
Expand Down
15 changes: 14 additions & 1 deletion datadog_checks_base/tests/base/utils/test_tls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,20 @@ def test_config(self):
tls = TlsContextWrapper({'tls_verify': False})
assert tls.config['tls_verify'] is False

@pytest.mark.parametrize('param', ('tls_ca_cert', 'tls_cert', 'tls_private_key', 'tls_private_key_password'))
@pytest.mark.parametrize('param', ['tls_ca_cert'])
def test_config_overwrite(self, param):
config = {'tls_verify': False, param: 'foo'}
with patch('ssl.SSLContext'):
tls = TlsContextWrapper(config)
assert tls.config['tls_verify'] is True

@pytest.mark.parametrize('param', ('tls_cert', 'tls_private_key'))
def test_config_no_overwrite_tls_verify(self, param):
config = {'tls_verify': False, param: 'foo'}
with patch('ssl.SSLContext'):
tls = TlsContextWrapper(config)
assert tls.config['tls_verify'] is False


@pytest.mark.parametrize(
'param', ('tls_ca_cert', 'tls_cert', 'tls_private_key', 'tls_private_key_password', 'tls_validate_hostname')
Expand Down Expand Up @@ -91,6 +98,12 @@ def test_invert_without_explicit_default(self):
tls = TlsContextWrapper(instance, remapper)
assert tls.config['tls_verify'] is True

def test_remap_validate_cert(self):
instance = {'validate_cert': False}
remapper = {'validate_cert': {'name': 'tls_verify', 'default': True}}
tls = TlsContextWrapper(instance, remapper)
assert tls.config['tls_verify'] is False


class TestHigherPriorityRemapper:
def test_verify_no_remapper(self):
Expand Down