Merge pull request #1499 from tkan145/THREESCALE-5105-proxy-mtls

[THREESCALE-5105] Adding support for mtls when using proxy policy

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Fixed Conditional policy evaluating incorrectly: second policy in policy chain that implement export() always triggers [PR #1485](https://github.com/3scale/APIcast/pull/1485) [THREESCALE-9320](https://issues.redhat.com/browse/THREESCALE-9320)
 - Fix APIcast using stale configuration for deleted products [PR #1488](https://github.com/3scale/APIcast/pull/1488) [THREESCALE-10130](https://issues.redhat.com/browse/THREESCALE-10130)
+- Fixed Mutual TLS between APIcast and the Backend API fails when using a Forward Proxy [PR #1499](https://github.com/3scale/APIcast/pull/1499) [THREESCALE-5105](https://issues.redhat.com/browse/THREESCALE-5105)
 
 ### Added
 

gateway/src/apicast/http_proxy.lua

@@ -143,9 +143,7 @@ local function forward_https_request(proxy_uri, uri, proxy_opts)
         path = format('%s%s%s', ngx.var.uri, ngx.var.is_args, ngx.var.query_string or ''),
         body = body,
         proxy_uri = proxy_uri,
-        proxy_auth = opts.proxy_auth,
-        upstream_connection_opts = opts.upstream_connection_opts,
-        skip_https_connect = opts.skip_https_connect
+        proxy_options = opts
     }
 
     local httpc, err = http_proxy.new(request)
@@ -226,7 +224,8 @@ function _M.request(upstream, proxy_uri)
             proxy_auth = proxy_auth,
             skip_https_connect = upstream.skip_https_connect,
             request_unbuffered = upstream.request_unbuffered,
-            upstream_connection_opts = upstream.upstream_connection_opts
+            upstream_connection_opts = upstream.upstream_connection_opts,
+            upstream_ssl = upstream.upstream_ssl
         }
 
         forward_https_request(proxy_uri, uri, proxy_opts)

gateway/src/apicast/policy/apicast/apicast.lua

@@ -5,6 +5,9 @@ local math = math
 local setmetatable = setmetatable
 local assert = assert
 local table_insert = table.insert
+local base = require "resty.core.base"
+local get_request = base.get_request
+local tls = require 'resty.tls'
 
 local user_agent = require('apicast.user_agent')
 
@@ -156,6 +159,40 @@ function _M:export()
     }
 end
 
-_M.balancer = balancer.call
+function _M:balancer(context)
+  -- All of this happens on balancer because this is subrequest inside APICAst
+  --to @upstream, so the request need to be the one that connects to the
+  --upstreamssl_client_raw_cert0
+  local r = get_request()
+  if not r then
+    ngx.log(ngx.WARN, "Invalid request")
+    return
+  end
+
+  if context.upstream_certificate and context.upstream_key then
+    local ok, err = tls.set_upstream_cert_and_key(context.upstream_certificate, context.upstream_key)
+    if ok ~= nil then
+      ngx.log(ngx.ERR, "Certificate cannot be set correctly, err: ", err)
+    end
+  end
+
+  if context.upstream_verify then
+    local ok, err = tls.set_upstream_ssl_verify(true, 1)
+    if ok ~= nil then
+      ngx.log(ngx.WARN, "Cannot verify SSL upstream connection, err: ", err)
+    end
+
+    if not context.upstream_ca_store then
+      ngx.log(ngx.WARN, "Set verify without including CA certificates")
+    end
+
+    ok, err = tls.set_upstream_ca_cert(context.upstream_ca_store)
+    if ok ~= nil then
+      ngx.log(ngx.WARN, "Cannot set a valid trusted CA store, err: ", err)
+    end
+  end
+
+  balancer:call(context)
+end
 
 return _M

gateway/src/apicast/policy/upstream_mtls/Readme.md

@@ -42,3 +42,5 @@ When using http forms and file upload
 This policy overwrites `APICAST_PROXY_HTTPS_CERTIFICATE_KEY` and
 `APICAST_PROXY_HTTPS_CERTIFICATE` values and it uses the certificates set by
 the policy, so those environment variables will have no effect.
+
+This policy is not compatible with Camel proxy.

gateway/src/apicast/policy/upstream_mtls/upstream_mtls.lua

@@ -1,28 +1,14 @@
 -- This policy enables MTLS with the upstream API endpoint
 
 local ssl = require('ngx.ssl')
-local ffi = require "ffi"
-local base = require "resty.core.base"
 local data_url = require('resty.data_url')
 local util = require 'apicast.util'
 
-local C = ffi.C
-local get_request = base.get_request
 local pairs = pairs
 
 local X509_STORE = require('resty.openssl.x509.store')
 local X509 = require('resty.openssl.x509')
 
-ffi.cdef([[
-  int ngx_http_apicast_ffi_set_proxy_cert_key(
-    ngx_http_request_t *r, void *cdata_chain, void *cdata_key);
-  int ngx_http_apicast_ffi_set_proxy_ca_cert(
-    ngx_http_request_t *r, void *cdata_ca);
-  int ngx_http_apicast_ffi_set_ssl_verify(
-    ngx_http_request_t *r, int verify, int verify_deph);
-]])
-
-
 local policy = require('apicast.policy')
 local _M = policy.new('mtls', "builtin")
 
@@ -104,54 +90,11 @@ function _M.new(config)
   return self
 end
 
-
--- Set the certs for the upstream connection. Need to receive the pointers from
--- parse_* functions.
---- Public function to be able to unittest this.
-function _M.set_certs(r, cert, key)
-  local val = C.ngx_http_apicast_ffi_set_proxy_cert_key(r, cert, key)
-  if val ~= ngx.OK then
-    ngx.log(ngx.ERR, "Certificate cannot be set correctly")
-  end
-end
-
-function _M.set_ca_cert(r, store)
-  local val = C.ngx_http_apicast_ffi_set_proxy_ca_cert(r, store)
-  if val ~= ngx.OK then
-    ngx.log(ngx.WARN, "Cannot set a valid trusted CA store")
-    return
-  end
-end
-
--- All of this happens on balancer because this is subrequest inside APICAst
---to @upstream, so the request need to be the one that connects to the
---upstream0
-function _M:balancer(context)
-  local r = get_request()
-  if not r then
-    ngx.log(ngx.WARN, "Invalid request")
-    return
-  end
-
-  if self.cert and self.cert_key then
-    self.set_certs(r, self.cert, self.cert_key)
-  end
-
-  if not self.verify then
-    return
-  end
-
-  local val = C.ngx_http_apicast_ffi_set_ssl_verify(r, ffi.new("int", 1), ffi.new("int", 1))
-  if val ~= ngx.OK then
-    ngx.log(ngx.WARN, "Cannot verify SSL upstream connection")
-  end
-
-  if not self.ca_store then
-    ngx.log(ngx.WARN, "Set verify without including CA certificates")
-    return
-  end
-
-  self.set_ca_cert(r, self.ca_store)
+function _M:access(context)
+  context.upstream_certificate = self.cert
+  context.upstream_key = self.cert_key
+  context.upstream_verify = self.verify
+  context.upstream_ca_store = self.ca_store
 end
 
 return _M

gateway/src/apicast/upstream.lua

@@ -233,6 +233,11 @@ function _M:call(context)
 
         self.request_unbuffered = context.request_unbuffered
         self.upstream_connection_opts = context.upstream_connection_opts
+        self.upstream_ssl = {
+          ssl_verify = context.upstream_verify,
+          ssl_client_cert = context.upstream_certificate,
+          ssl_client_priv_key = context.upstream_key
+        }
         http_proxy.request(self, proxy_uri)
     else
         local err = self:rewrite_request()

gateway/src/resty/http/proxy.lua

@@ -32,9 +32,10 @@ end
 local function connect(request)
     request = request or { }
     local httpc = http.new()
+    local proxy_options = request.proxy_options or {}
 
-    if request.upstream_connection_opts then
-      local con_opts = request.upstream_connection_opts
+    if proxy_options.upstream_connection_opts then
+      local con_opts = request.proxy_options.upstream_connection_opts
       ngx.log(ngx.DEBUG, 'setting timeouts (secs), connect_timeout: ', con_opts.connect_timeout,
         ' send_timeout: ', con_opts.send_timeout, ' read_timeout: ', con_opts.read_timeout)
       -- lua-resty-http uses nginx API for lua sockets
@@ -51,7 +52,7 @@ local function connect(request)
     local scheme = uri.scheme
     local host = uri.host
     local port = default_port(uri)
-    local skip_https_connect = request.skip_https_connect
+    local skip_https_connect = proxy_options.skip_https_connect
 
     -- set ssl_verify: lua-resty-http set ssl_verify to true by default if scheme is https, whereas
     -- openresty treat nil as false, so we need to explicitly set ssl_verify to false if nil
@@ -68,6 +69,10 @@ local function connect(request)
     if scheme == 'https' then
         options.ssl_server_name = host
         options.ssl_verify = ssl_verify
+        if proxy_options.upstream_ssl then
+          options.ssl_client_cert = proxy_options.upstream_ssl.ssl_client_cert
+          options.ssl_client_priv_key = proxy_options.upstream_ssl.ssl_client_priv_key
+        end
     end
 
     -- Connect via proxy
@@ -79,7 +84,7 @@ local function connect(request)
         end
 
         local proxy_url = format("%s://%s:%s", proxy_uri.scheme, proxy_uri.host, proxy_uri.port)
-        local proxy_auth = request.proxy_auth
+        local proxy_auth = proxy_options.proxy_auth
 
         if scheme == 'http' then
             -- Used by http_ng module to send request to 3scale backend through proxy.

gateway/src/resty/tls.lua

@@ -0,0 +1,91 @@
+local base = require "resty.core.base"
+
+local type = type
+local tostring = tostring
+
+local get_request = base.get_request
+local ffi = require "ffi"
+local C = ffi.C
+
+local _M = {}
+
+local NGX_OK = ngx.OK
+
+local ngx_http_apicast_ffi_set_proxy_cert_key;
+local ngx_http_apicast_ffi_set_proxy_ca_cert;
+local ngx_http_apicast_ffi_set_ssl_verify
+
+ffi.cdef([[
+  int ngx_http_apicast_ffi_set_proxy_cert_key(
+    ngx_http_request_t *r, void *cdata_chain, void *cdata_key);
+  int ngx_http_apicast_ffi_set_proxy_ca_cert(
+    ngx_http_request_t *r, void *cdata_ca);
+  int ngx_http_apicast_ffi_set_ssl_verify(
+    ngx_http_request_t *r, int verify, int verify_deph);
+]])
+
+ngx_http_apicast_ffi_set_proxy_cert_key = C.ngx_http_apicast_ffi_set_proxy_cert_key
+ngx_http_apicast_ffi_set_proxy_ca_cert = C.ngx_http_apicast_ffi_set_proxy_ca_cert
+ngx_http_apicast_ffi_set_ssl_verify = C.ngx_http_apicast_ffi_set_ssl_verify
+
+-- Set the certs for the upstream connection. Need to receive the pointers from
+-- parse_* functions.
+function _M.set_upstream_cert_and_key(cert, key)
+  local r = get_request()
+  if not r then
+      error("no request found")
+  end
+
+  if not cert or not key then
+    return nil, "cert and key must not be nil"
+  end
+
+  local ret = ngx_http_apicast_ffi_set_proxy_cert_key(r, cert, key)
+  if ret ~= NGX_OK then
+    return nil, "error while setting upstream client certificate and key"
+  end
+end
+
+-- Set the trusted store for the upstream connection.
+function _M.set_upstream_ca_cert(store)
+  local r = get_request()
+  if not r then
+      error("no request found")
+  end
+
+  if not store then
+    return nil, "trusted store must not be nil"
+  end
+
+  local ret = ngx_http_apicast_ffi_set_proxy_ca_cert(r, store)
+  if ret ~= NGX_OK then
+    return nil, "error while setting upstream trusted CA store"
+  end
+end
+
+-- Verify upstream connection
+function _M.set_upstream_ssl_verify(verify, verify_deph)
+  local r = get_request()
+  if not r then
+      error("no request found")
+  end
+
+  if type(verify) ~= 'boolean' then
+    return nil, "verify expects a boolean but found " .. type(verify)
+  end
+
+  if type(verify_deph) ~= 'number' then
+    return nil, "verify depth expects a number but found " .. type(verify)
+  end
+
+  if verify_deph < 0 then
+    return nil, "verify_deph expects a non-negative interger but found" .. tostring(verify_deph)
+  end
+
+  local val = ngx_http_apicast_ffi_set_ssl_verify(r, verify, verify_deph)
+  if val ~= NGX_OK then
+    return nil, "error while setting upstream verify"
+  end
+end
+
+return _M