test_dhparam.py 11 KB

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