kong.service

The service module contains a set of functions to manipulate the connection aspect of the request to the Service, such as connecting to a given host, IP address/port, or choosing a given Upstream entity for load-balancing and healthchecking.

kong.service.set_upstream(host)

Sets the desired Upstream entity to handle the load-balancing step for this request. Using this method is equivalent to creating a Service with a host property equal to that of an Upstream entity (in which case, the request would be proxied to one of the Targets associated with that Upstream).

The host argument should receive a string equal to the name of one of the Upstream entities currently configured.

Phases

• access

Parameters

• host (string):

Returns

1. boolean|nil: true on success, or nil if no upstream entities where found

2. string|nil: An error message describing the error if there was one.

Usage

local ok, err = kong.service.set_upstream("service.prod")
if not ok then
  kong.log.err(err)
  return
end

kong.service.set_target(host, port)

Sets the host and port on which to connect to for proxying the request. Using this method is equivalent to ask Kong to not run the load-balancing phase for this request, and consider it manually overridden. Load-balancing components such as retries and health-checks will also be ignored for this request. Use kong.service.set_retries to overwrite retries count.

The host argument expects the hostname or IP address of the upstream server, and the port expects a port number.

Phases

• access

Parameters

• host (string):
• port (number):

Usage

kong.service.set_target("service.local", 443)
kong.service.set_target("192.168.130.1", 80)

kong.service.set_retries(retries)

Sets the retries count for the current request. This will override the default retries count set in the Upstream entity.

The retries argument expects an integer between 0 and 32767.

Phases

• access

Parameters

• retries (number):

Usage

kong.service.set_retries(233)

kong.service.set_timeouts(connect_timeout, write_timeout, read_timeout)

Sets the timeouts for the current request. This will override the default timeouts set in the Upstream entity.

The connect_timeout, write_timeout, and read_timeout arguments expect an integer between 1 and 2147483646.

Phases

• access

Parameters

• connect_timeout (number):
• write_timeout (number):
• read_timeout (number):

Usage

kong.service.set_timeouts(233, 233, 233)

kong.service.set_tls_cert_key(chain, key)

Sets the client certificate used while handshaking with the Service.

The chain argument is the client certificate and intermediate chain (if any) returned by functions such as ngx.ssl.parse_pem_cert.

The key argument is the private key corresponding to the client certificate returned by functions such as ngx.ssl.parse_pem_priv_key.

Phases

• rewrite, access, balancer, preread

Parameters

• chain (cdata): The client certificate chain
• key (cdata): The client certificate private key

Returns

1. boolean|nil: true if the operation succeeded, nil if an error occurred

2. string|nil: An error message describing the error if there was one

Usage

local chain = assert(ssl.parse_pem_cert(cert_data))
local key = assert(ssl.parse_pem_priv_key(key_data))
local ok, err = kong.service.set_tls_cert_key(chain, key)
if not ok then
  -- do something with error
end

kong.service.set_tls_verify(on)

Sets whether TLS verification is enabled while handshaking with the Service.

The on argument is a boolean flag, where true means upstream verification is enabled and false disables it.

This call affects only the current request. If the trusted certificate store is not set already (via proxy_ssl_trusted_certificate or kong.service.set_upstream_ssl_trusted_store), then TLS verification will always fail with “unable to get local issuer certificate” error.

Phases

• rewrite, access, balancer, preread

Parameters

• on (boolean): Whether to enable TLS certificate verification for the current request

Returns

1. boolean|nil: true if the operation succeeded, nil if an error occurred

2. string|nil: An error message describing the error if there was one

Usage

local ok, err = kong.service.set_tls_verify(true)
if not ok then
  -- do something with error
end

kong.service.set_tls_verify_depth(depth)

Sets the maximum depth of verification when validating upstream server’s TLS certificate.

This call affects only the current request. For the depth to be actually used the verification has to be enabled with either the proxy_ssl_verify directive or using the kong.service.set_tls_verify function.

Phases

• rewrite, access, balancer, preread

Parameters

• depth (number): Depth to use when validating. Must be non-negative

Returns

1. boolean|nil: true if the operation succeeded, nil if an error occurred

2. string|nil: An error message describing the error if there was one

Usage

local ok, err = kong.service.set_tls_verify_depth(3)
if not ok then
  -- do something with error
end

kong.service.set_tls_verify_store(store)

Sets the CA trust store to use when validating upstream server’s TLS certificate.

This call affects only the current request. For the store to be actually used the verification has to be enabled with either the proxy_ssl_verify directive or using the kong.service.set_tls_verify function.

The resty.openssl.x509.store object can be created by following examples from the Kong/lua-kong-nginx-module repo.

Phases

• rewrite, access, balancer, preread

Parameters

• store (table): resty.openssl.x509.store object to use

Returns

1. boolean|nil: true if the operation succeeded, nil if an error occurred

2. string|nil: An error message describing the error if there was one

Usage

local store = require("resty.openssl.x509.store")
local st = assert(store.new())
-- st:add(...certificate)
local ok, err = kong.service.set_tls_verify_store(st)
if not ok then
  -- do something with error
end