ip

Documentation

Overview

Trusted IPs module.

This module can be used to determine whether or not a given IP address is in the range of trusted IP addresses defined by the trusted_ips configuration property.

Trusted IP addresses are those that are known to send correct replacement addresses for clients (as per the chosen header field, e.g. X-Forwarded-*).

See https://docs.konghq.com/latest/configuration/#trusted_ips

Index

• type Ip
  • func (ip Ip) IsTrusted(address string) (bool, error)

Types

type Ip

type Ip struct {
	bridge.PdkBridge
}

Holds this module's functions. Accessible as `kong.Ip`

func (Ip) IsTrusted

func (ip Ip) IsTrusted(address string) (bool, error)

Depending on the trusted_ips configuration property, this function will return whether a given ip is trusted or not. Both ipv4 and ipv6 are supported.