From 281e88f64f6d21ad012b1e0850e4bd80b8b79957 Mon Sep 17 00:00:00 2001 From: Dmytro Shteflyuk Date: Tue, 24 Sep 2024 14:39:52 -0400 Subject: [PATCH] Added support for custom SSL certificate --- lib/kamal/configuration/docs/proxy.yml | 11 +++++++++++ lib/kamal/configuration/proxy.rb | 2 ++ lib/kamal/configuration/validator/proxy.rb | 8 ++++++++ test/commands/app_test.rb | 8 ++++++++ test/configuration/proxy_test.rb | 10 ++++++++++ 5 files changed, 39 insertions(+) diff --git a/lib/kamal/configuration/docs/proxy.yml b/lib/kamal/configuration/docs/proxy.yml index 905f81dc5..362e5a78e 100644 --- a/lib/kamal/configuration/docs/proxy.yml +++ b/lib/kamal/configuration/docs/proxy.yml @@ -46,6 +46,17 @@ proxy: # Defaults to `false`: ssl: true + # Custom SSL certificate + # + # In scenarios where Let's Encrypt is not an option, or you already have your own + # certificates from a different Certificate Authority, you can configure kamal-proxy + # to load the certificate and the corresponding private key from disk. + # + # The certificate must be in PEM format and contain the full chain. The private key + # must also be in PEM format. + ssl_certificate_path: /data/cert/foo.example.com/fullchain.pem + ssl_private_key_path: /data/cert/foo.example.com/privkey.pem + # Response timeout # # How long to wait for requests to complete before timing out, defaults to 30 seconds: diff --git a/lib/kamal/configuration/proxy.rb b/lib/kamal/configuration/proxy.rb index c8fbbb6ae..aa4dcec4a 100644 --- a/lib/kamal/configuration/proxy.rb +++ b/lib/kamal/configuration/proxy.rb @@ -30,6 +30,8 @@ def deploy_options { host: proxy_config["host"], tls: proxy_config["ssl"] ? true : nil, + "tls-certificate-path": proxy_config["ssl_certificate_path"], + "tls-private-key-path": proxy_config["ssl_private_key_path"], "deploy-timeout": seconds_duration(config.deploy_timeout), "drain-timeout": seconds_duration(config.drain_timeout), "health-check-interval": seconds_duration(proxy_config.dig("healthcheck", "interval")), diff --git a/lib/kamal/configuration/validator/proxy.rb b/lib/kamal/configuration/validator/proxy.rb index bf2e5e9ef..0201a2413 100644 --- a/lib/kamal/configuration/validator/proxy.rb +++ b/lib/kamal/configuration/validator/proxy.rb @@ -6,6 +6,14 @@ def validate! if config["host"].blank? && config["ssl"] error "Must set a host to enable automatic SSL" end + + if config["ssl_certificate_path"].present? && config["ssl_private_key_path"].blank? + error "Must set a private key path to use a custom SSL certificate" + end + + if config["ssl_private_key_path"].present? && config["ssl_certificate_path"].blank? + error "Must set a certificate path to use a custom SSL private key" + end end end end diff --git a/test/commands/app_test.rb b/test/commands/app_test.rb index 6704adb63..637009e7e 100644 --- a/test/commands/app_test.rb +++ b/test/commands/app_test.rb @@ -119,6 +119,14 @@ class CommandsAppTest < ActiveSupport::TestCase new_command.deploy(target: "172.1.0.2").join(" ") end + test "deploy with custom SSL certificate" do + @config[:proxy] = { "ssl" => true, "host" => "example.com", "ssl_certificate_path" => "/path/to/cert.pem", "ssl_private_key_path" => "/path/to/key.pem" } + + assert_equal \ + "docker exec kamal-proxy kamal-proxy deploy app-web --target \"172.1.0.2:80\" --host \"example.com\" --tls --tls-certificate-path \"/path/to/cert.pem\" --tls-private-key-path \"/path/to/key.pem\" --deploy-timeout \"30s\" --drain-timeout \"30s\" --buffer-requests --buffer-responses --log-request-header \"Cache-Control\" --log-request-header \"Last-Modified\" --log-request-header \"User-Agent\"", + new_command.deploy(target: "172.1.0.2").join(" ") + end + test "remove" do assert_equal \ "docker exec kamal-proxy kamal-proxy remove app-web --target \"172.1.0.2:80\"", diff --git a/test/configuration/proxy_test.rb b/test/configuration/proxy_test.rb index 891bf6b89..8b56a135a 100644 --- a/test/configuration/proxy_test.rb +++ b/test/configuration/proxy_test.rb @@ -24,6 +24,16 @@ class ConfigurationProxyTest < ActiveSupport::TestCase assert_not config.proxy.deploy_options.has_key?(:tls) end + test "ssl with certificate path and no private key path" do + @deploy[:proxy] = { "ssl" => true, "ssl_certificate_path" => "/path/to/cert.pem" } + assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? } + end + + test "ssl with private key path and no certificate path" do + @deploy[:proxy] = { "ssl" => true, "ssl_private_key_path" => "/path/to/key.pem" } + assert_raises(Kamal::ConfigurationError) { config.proxy.ssl? } + end + private def config Kamal::Configuration.new(@deploy)