test_dhparam.py 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. import re
  2. import subprocess
  3. import backoff
  4. import docker
  5. import pytest
  6. docker_client = docker.from_env()
  7. ###############################################################################
  8. #
  9. # Tests helpers
  10. #
  11. ###############################################################################
  12. @backoff.on_exception(backoff.constant, AssertionError, interval=2, max_tries=15, jitter=None)
  13. def assert_log_contains(expected_log_line, container_name="nginxproxy"):
  14. """
  15. Check that the nginx-proxy container log contains a given string.
  16. The backoff decorator will retry the check 15 times with a 2 seconds delay.
  17. :param expected_log_line: string to search for
  18. :return: None
  19. :raises: AssertError if the expected string is not found in the log
  20. """
  21. sut_container = docker_client.containers.get(container_name)
  22. docker_logs = sut_container.logs(stdout=True, stderr=True, stream=False, follow=False)
  23. assert bytes(expected_log_line, encoding="utf8") in docker_logs
  24. def require_openssl(required_version):
  25. """
  26. This function checks that the required version of OpenSSL is present, and skips the test if not.
  27. Use it as a test function decorator:
  28. @require_openssl("2.3.4")
  29. def test_something():
  30. ...
  31. :param required_version: minimal required version as a string: "1.2.3"
  32. """
  33. def versiontuple(v):
  34. clean_v = re.sub(r"[^\d\.]", "", v)
  35. return tuple(map(int, (clean_v.split("."))))
  36. try:
  37. command_output = subprocess.check_output(["openssl", "version"])
  38. except OSError:
  39. return pytest.mark.skip("openssl command is not available in test environment")
  40. else:
  41. if not command_output:
  42. raise Exception("Could not get openssl version")
  43. openssl_version = str(command_output.split()[1])
  44. return pytest.mark.skipif(
  45. versiontuple(openssl_version) < versiontuple(required_version),
  46. reason=f"openssl v{openssl_version} is less than required version {required_version}")
  47. @require_openssl("1.0.2")
  48. def negotiate_cipher(sut_container, additional_params='', grep='Cipher is'):
  49. host = f"{sut_container.attrs['NetworkSettings']['IPAddress']}:443"
  50. try:
  51. # Enforce TLS 1.2 as newer versions don't support custom dhparam or ciphersuite preference.
  52. # The empty `echo` is to provide `openssl` user input, so that the process exits: https://stackoverflow.com/a/28567565
  53. # `shell=True` enables using a single string to execute as a shell command.
  54. # `text=True` prevents the need to compare against byte strings.
  55. # `stderr=subprocess.PIPE` removes the output to stderr being interleaved with test case status (output during exceptions).
  56. return subprocess.check_output(
  57. f"echo '' | openssl s_client -connect {host} -tls1_2 {additional_params} | grep '{grep}'",
  58. shell=True,
  59. text=True,
  60. stderr=subprocess.PIPE,
  61. )
  62. except subprocess.CalledProcessError as e:
  63. # Output a more helpful error, the original exception in this case isn't that helpful.
  64. # `from None` to ignore undesired output from exception chaining.
  65. raise Exception("Failed to process CLI request:\n" + e.stderr) from None
  66. # The default `dh_bits` can vary due to configuration.
  67. # `additional_params` allows for adjusting the request to a specific `VIRTUAL_HOST`,
  68. # where DH size can differ from the configured global default DH size.
  69. def can_negotiate_dhe_ciphersuite(sut_container, dh_bits=4096, additional_params=''):
  70. openssl_params = f"-cipher 'EDH' {additional_params}"
  71. r = negotiate_cipher(sut_container, openssl_params)
  72. assert "New, TLSv1.2, Cipher is DHE-RSA-AES256-GCM-SHA384\n" == r
  73. r2 = negotiate_cipher(sut_container, openssl_params, "Server Temp Key")
  74. assert f"Server Temp Key: DH, {dh_bits} bits" in r2
  75. def cannot_negotiate_dhe_ciphersuite(sut_container):
  76. # Fail to negotiate a DHE cipher suite:
  77. r = negotiate_cipher(sut_container, "-cipher 'EDH'")
  78. assert "New, (NONE), Cipher is (NONE)\n" == r
  79. # Correctly establish a connection (TLS 1.2):
  80. r2 = negotiate_cipher(sut_container)
  81. assert "New, TLSv1.2, Cipher is ECDHE-RSA-AES256-GCM-SHA384\n" == r2
  82. r3 = negotiate_cipher(sut_container, grep="Server Temp Key")
  83. assert "X25519" in r3
  84. def should_be_equivalent_content(sut_container, expected, actual):
  85. expected_checksum = sut_container.exec_run(f"md5sum {expected}").output.split()[0]
  86. actual_checksum = sut_container.exec_run(f"md5sum {actual}").output.split()[0]
  87. assert expected_checksum == actual_checksum
  88. # Parse array of container ENV, splitting at the `=` and returning the value, otherwise `None`
  89. def get_env(sut_container, var):
  90. env = sut_container.attrs['Config']['Env']
  91. for e in env:
  92. if e.startswith(var):
  93. return e.split('=')[1]
  94. return None
  95. ###############################################################################
  96. #
  97. # Tests
  98. #
  99. ###############################################################################
  100. def test_default_dhparam_is_ffdhe4096(docker_compose):
  101. container_name="dh-default"
  102. sut_container = docker_client.containers.get(container_name)
  103. assert sut_container.status == "running"
  104. assert_log_contains("Setting up DH Parameters..", container_name)
  105. # `dhparam.pem` contents should match the default (ffdhe4096.pem):
  106. should_be_equivalent_content(
  107. sut_container,
  108. "/app/dhparam/ffdhe4096.pem",
  109. "/etc/nginx/dhparam/dhparam.pem"
  110. )
  111. can_negotiate_dhe_ciphersuite(sut_container, 4096)
  112. # Overrides default DH group via ENV `DHPARAM_BITS=3072`:
  113. def test_can_change_dhparam_group(docker_compose):
  114. container_name="dh-env"
  115. sut_container = docker_client.containers.get(container_name)
  116. assert sut_container.status == "running"
  117. assert_log_contains("Setting up DH Parameters..", container_name)
  118. # `dhparam.pem` contents should not match the default (ffdhe4096.pem):
  119. should_be_equivalent_content(
  120. sut_container,
  121. "/app/dhparam/ffdhe3072.pem",
  122. "/etc/nginx/dhparam/dhparam.pem"
  123. )
  124. can_negotiate_dhe_ciphersuite(sut_container, 3072)
  125. def test_fail_if_dhparam_group_not_supported(docker_compose):
  126. container_name="invalid-group-1024"
  127. sut_container = docker_client.containers.get(container_name)
  128. assert sut_container.status == "exited"
  129. DHPARAM_BITS = get_env(sut_container, "DHPARAM_BITS")
  130. assert DHPARAM_BITS == "1024"
  131. assert_log_contains(
  132. f"ERROR: Unsupported DHPARAM_BITS size: {DHPARAM_BITS}. Use: 2048, 3072, or 4096 (default).",
  133. container_name
  134. )
  135. # Overrides default DH group by providing a custom `/etc/nginx/dhparam/dhparam.pem`:
  136. def test_custom_dhparam_is_supported(docker_compose):
  137. container_name="dh-file"
  138. sut_container = docker_client.containers.get(container_name)
  139. assert sut_container.status == "running"
  140. assert_log_contains(
  141. "Warning: A custom dhparam.pem file was provided. Best practice is to use standardized RFC7919 DHE groups instead.",
  142. container_name
  143. )
  144. # `dhparam.pem` contents should not match the default (ffdhe4096.pem):
  145. should_be_equivalent_content(
  146. sut_container,
  147. "/app/dhparam/ffdhe3072.pem",
  148. "/etc/nginx/dhparam/dhparam.pem"
  149. )
  150. can_negotiate_dhe_ciphersuite(sut_container, 3072)
  151. # Only `web2` has a site-specific DH param file (which overrides all other DH config)
  152. # Other tests here use `web5` explicitly, or implicitly (via ENV `DEFAULT_HOST`, otherwise first HTTPS server)
  153. def test_custom_dhparam_is_supported_per_site(docker_compose):
  154. container_name="dh-file"
  155. sut_container = docker_client.containers.get(container_name)
  156. assert sut_container.status == "running"
  157. # A site specific `dhparam.pem` with DH group size of 2048-bit.
  158. # DH group size should not match the:
  159. # - 4096-bit default.
  160. # - 3072-bit default, overriden by file.
  161. should_be_equivalent_content(
  162. sut_container,
  163. "/app/dhparam/ffdhe2048.pem",
  164. "/etc/nginx/certs/web2.nginx-proxy.tld.dhparam.pem"
  165. )
  166. # `-servername` required for nginx-proxy to respond with site-specific DH params used:
  167. can_negotiate_dhe_ciphersuite(sut_container, 2048, '-servername web2.nginx-proxy.tld')
  168. # NOTE: These two tests will fail without the ENV `DEFAULT_HOST` to prevent
  169. # accidentally falling back to `web2` as the default server, which has explicit DH params configured.
  170. # Only copying DH params is skipped, not explicit usage via user providing custom files.
  171. def test_can_skip_dhparam(docker_compose):
  172. container_name="dh-skip"
  173. sut_container = docker_client.containers.get(container_name)
  174. assert sut_container.status == "running"
  175. assert_log_contains("Skipping Diffie-Hellman parameters setup.", container_name)
  176. cannot_negotiate_dhe_ciphersuite(sut_container)
  177. def test_can_skip_dhparam_backward_compatibility(docker_compose):
  178. container_name="dh-skip-backward"
  179. sut_container = docker_client.containers.get(container_name)
  180. assert sut_container.status == "running"
  181. assert_log_contains("Warning: The DHPARAM_GENERATION environment variable is deprecated, please consider using DHPARAM_SKIP set to true instead.", container_name)
  182. assert_log_contains("Skipping Diffie-Hellman parameters setup.", container_name)
  183. cannot_negotiate_dhe_ciphersuite(sut_container)
  184. def test_web5_https_works(docker_compose, nginxproxy):
  185. r = nginxproxy.get("https://web5.nginx-proxy.tld/port", allow_redirects=False)
  186. assert r.status_code == 200
  187. assert "answer from port 85\n" in r.text