test_dhparam.py 11 KB

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