After you’ve uploaded the ping-auth
plugin’s schema to Konnect,
configure the plugin in Gateway Manager or use the Kong API.
Test the operation of the ping-auth
plugin before you use it in
production.
Configuring the plugin using the Gateway Manager UI
- In Gateway Manager, open Plugins from the sidebar, then click New Plugin.
- On the Custom Plugins tab, click the ping-auth plugin.
- Optional: To enable the plugin for specific consumers, services, or routes, click Scoped, and then enter the Service, Route, and Consumer information.
-
In the Service Url field, enter the host name of your
PingAuthorize server and the port of
the HTTPS Connection Handler.
To find this port number in the PingAuthorize administrative console, go to Configuration > System > Connection Handlers. For example,
https://pingauthorize:8443
. - In the Shared Secret field, enter the PingAuthorize sideband client's shared secret.
-
Verify that the Secret Header Name matches the secret
header name configured for the Sideband API Servlet Extension in PingAuthorize.
-
Configure the following additional fields:
Option API Field Name Description Connection KeepAlive Ms
connection_keepAlive_ms
The duration to keep the connection alive for reuse. The default is
60000
.Connection Timeout Ms
connection_timeout_ms
The duration to wait before the connection times out. The default is
10000
.Enable Debug Logging
enable_debug_logging
Controls if the requests and responses are logged at the debug level. The default is
false
. For log messages to show in error.log, you must setlog_level = debug
in kong.conf.Verify Service Certificate
verify_service_certificate
Controls whether the service certificate is verified. This is intended for testing purposes and the default is
true
. - Click Save.
Kong Konnect is now configured to work with PingAuthorize.
Configuring the plugin using the Kong API
-
Send the following in a
POST
request tohttps://{region}.api.konghq.com/konnect-api/api/runtime_groups/{controlPlaneId}/plugins
:{ "name": "ping-auth", "enabled": true, "config": { "enable_debug_logging": true, "verify_service_certificate": false, "secret_header_name": "<shared secret header name>", "service_url": "https://<PingAuthorize Server hostname>:<HTTPS Connection Handler port>", "shared_secret": "<shared secret>" } }
The following list describes the required fields for this API request:
Service_url
: The full URL of the Ping policy provider. This should not contain/sideband
in the path.Shared_secret
: The shared secret value to authenticate this plugin to the policy provider.Secret_header_name
: The header name in which the shared secret is provided. You can provide additional configuration in accordance with the Kong API specification.
-
Configure the optional fields:
Option API Field Name Description Connection KeepAlive Ms
connection_keepAlive_ms
The duration to keep the connection alive for reuse. The default is
60000
.Connection Timeout Ms
connection_timeout_ms
The duration to wait before the connection times out. The default is
10000
.Enable Debug Logging
enable_debug_logging
Controls if the requests and responses are logged at the debug level. The default is
false
. For log messages to show in error.log, you must setlog_level = debug
in kong.conf.Verify Service Certificate
verify_service_certificate
Controls whether the service certificate is verified. This is intended for testing purposes and the default is
true
.Kong Konnect is configured to work with PingAuthorize.