docker-mailserver/test/tests/serial/mail_ssl_manual.bats

#!/usr/bin/env bats
load "${REPOSITORY_ROOT}/test/test_helper/common"

function setup_file() {
  # Internal copies made by `start-mailserver.sh`:
  export PRIMARY_KEY='/etc/dms/tls/key'
  export PRIMARY_CERT='/etc/dms/tls/cert'
  export FALLBACK_KEY='/etc/dms/tls/fallback_key'
  export FALLBACK_CERT='/etc/dms/tls/fallback_cert'

  # Volume mounted certs:
  export SSL_KEY_PATH='/config/ssl/key.ecdsa.pem'
  export SSL_CERT_PATH='/config/ssl/cert.ecdsa.pem'
  export SSL_ALT_KEY_PATH='/config/ssl/key.rsa.pem'
  export SSL_ALT_CERT_PATH='/config/ssl/cert.rsa.pem'

  local PRIVATE_CONFIG
  export DOMAIN_SSL_MANUAL='example.test'
  PRIVATE_CONFIG=$(duplicate_config_for_container .)

  docker run -d --name mail_manual_ssl \
    --volume "${PRIVATE_CONFIG}/:/tmp/docker-mailserver/" \
    --volume "$(pwd)/test/test-files/ssl/${DOMAIN_SSL_MANUAL}/with_ca/ecdsa/:/config/ssl/:ro" \
    --env LOG_LEVEL='trace' \
    --env SSL_TYPE='manual' \
    --env TLS_LEVEL='modern' \
    --env SSL_KEY_PATH="${SSL_KEY_PATH}" \
    --env SSL_CERT_PATH="${SSL_CERT_PATH}" \
    --env SSL_ALT_KEY_PATH="${SSL_ALT_KEY_PATH}" \
    --env SSL_ALT_CERT_PATH="${SSL_ALT_CERT_PATH}" \
    --hostname "mail.${DOMAIN_SSL_MANUAL}" \
    --tty \
    "${NAME}" # Image name

  wait_for_finished_setup_in_container mail_manual_ssl
}

function teardown_file() {
  docker rm -f mail_manual_ssl
}

@test "checking ssl: ENV vars provided are valid files" {
  assert docker exec mail_manual_ssl [ -f "${SSL_CERT_PATH}" ]
  assert docker exec mail_manual_ssl [ -f "${SSL_KEY_PATH}" ]
  assert docker exec mail_manual_ssl [ -f "${SSL_ALT_CERT_PATH}" ]
  assert docker exec mail_manual_ssl [ -f "${SSL_ALT_KEY_PATH}" ]
}

@test "checking ssl: manual configuration is correct" {
  local DOVECOT_CONFIG_SSL='/etc/dovecot/conf.d/10-ssl.conf'

  run docker exec mail_manual_ssl grep '^smtpd_tls_chain_files =' '/etc/postfix/main.cf'
  assert_success
  assert_output "smtpd_tls_chain_files = ${PRIMARY_KEY} ${PRIMARY_CERT} ${FALLBACK_KEY} ${FALLBACK_CERT}"

  run docker exec mail_manual_ssl grep '^ssl_key =' "${DOVECOT_CONFIG_SSL}"
  assert_success
  assert_output "ssl_key = <${PRIMARY_KEY}"

  run docker exec mail_manual_ssl grep '^ssl_cert =' "${DOVECOT_CONFIG_SSL}"
  assert_success
  assert_output "ssl_cert = <${PRIMARY_CERT}"

  run docker exec mail_manual_ssl grep '^ssl_alt_key =' "${DOVECOT_CONFIG_SSL}"
  assert_success
  assert_output "ssl_alt_key = <${FALLBACK_KEY}"

  run docker exec mail_manual_ssl grep '^ssl_alt_cert =' "${DOVECOT_CONFIG_SSL}"
  assert_success
  assert_output "ssl_alt_cert = <${FALLBACK_CERT}"
}

@test "checking ssl: manual configuration copied files correctly " {
  run docker exec mail_manual_ssl cmp -s "${PRIMARY_KEY}" "${SSL_KEY_PATH}"
  assert_success
  run docker exec mail_manual_ssl cmp -s "${PRIMARY_CERT}" "${SSL_CERT_PATH}"
  assert_success

  # Fallback cert
  run docker exec mail_manual_ssl cmp -s "${FALLBACK_KEY}" "${SSL_ALT_KEY_PATH}"
  assert_success
  run docker exec mail_manual_ssl cmp -s "${FALLBACK_CERT}" "${SSL_ALT_CERT_PATH}"
  assert_success
}

@test "checking ssl: manual cert works correctly" {
  wait_for_tcp_port_in_container 587 mail_manual_ssl

  local TEST_COMMAND=(timeout 1 openssl s_client -connect mail.example.test:587 -starttls smtp)
  local RESULT

  # Should fail as a chain of trust is required to verify successfully:
  RESULT=$(docker exec mail_manual_ssl "${TEST_COMMAND[@]}" | grep 'Verification error:')
  assert_equal "${RESULT}" 'Verification error: unable to verify the first certificate'

  # Provide the Root CA cert for successful verification:
  local CA_CERT='/config/ssl/ca-cert.ecdsa.pem'
  assert docker exec mail_manual_ssl [ -f "${CA_CERT}" ]
  RESULT=$(docker exec mail_manual_ssl "${TEST_COMMAND[@]}" -CAfile "${CA_CERT}" | grep 'Verification: OK')
  assert_equal "${RESULT}" 'Verification: OK'
}

@test "checking ssl: manual cert changes are picked up by check-for-changes" {
  printf '%s' 'someThingsChangedHere' \
    >>"$(pwd)/test/test-files/ssl/${DOMAIN_SSL_MANUAL}/with_ca/ecdsa/key.ecdsa.pem"

  run timeout 15 docker exec mail_manual_ssl bash -c "tail -F /var/log/supervisor/changedetector.log | sed '/Manual certificates have changed/ q'"
  assert_success

  sed -i '/someThingsChangedHere/d' "$(pwd)/test/test-files/ssl/${DOMAIN_SSL_MANUAL}/with_ca/ecdsa/key.ecdsa.pem"
}