Filter on request IP Address when using an Application Gateway

This article shows an Azure API management policy sample that demonstrates how filter on the request IP address when the API Management instance is accessed through an Application Gateway or other intermediary. To set or edit a policy code, follow the steps described in Set or edit a policy. To see other examples, see policy samples.


Paste the code into the inbound block.

    The policy defined in this file shows how to filter request IPs when the API Management instance 
    is accessed from an Application Gateway.  The Application Gateway will write the original request
    IP to the "X-Forwarded-For" header.  The set-header policy evaluates this IP address against a list of
    IP ranges (if any).  If a match is found, a value is written to the X-Forwarded-For header and the
    following check-header policy will validate the match.  If no match is found, the original IP address
    is retained in the X-Forwarded-For variable.
        <base />
        <!-- Save the X-Forwarded-For value -->
        <set-variable name="originalXForwardedForValue" value="@(context.Request.Headers.GetValueOrDefault("X-Forwarded-For"))" />
        <!-- Check the client IP value in the X-Forwarded-For header-->
        <set-header name="X-Forwarded-For" exists-action="override">
            int HostToNetworkOrder(int host)
                return (((int)HostToNetworkOrderShort((short)host) & 0xFFFF) << 16)
                    | ((int)HostToNetworkOrderShort((short)(host >> 16)) & 0xFFFF);
            short HostToNetworkOrderShort(short host)
                return (short)((((int)host & 0xFF) << 8) | (int)((host >> 8) & 0xFF));
            string ipAddress = context.Request.Headers.GetValueOrDefault("x-forwarded-for",""); 
            if (!string.IsNullOrEmpty(ipAddress))
                string[] tokens = ipAddress.Split(':'); 
                if(tokens.Length == 2) 
                { ipAddress = tokens[0]; } 
                //Place IP Ranges into this list in CIDR notation (e.g. "") and separate with commas
                List<string> cidrList = new List<string>(){
                foreach (string cidrAddress in cidrList)
                    string[] cidrParts = cidrAddress.Split('/');
                    string[] inputIPParts = ipAddress.Split('.');
                    string[] cidrIPArray = cidrParts[0].Split('.');

                    if (inputIPParts.Length == 4 && cidrIPArray.Length == 4)
                        byte[] inputIPBytes = new byte[] {Convert.ToByte(int.Parse(inputIPParts[0])), 
                            Convert.ToByte(int.Parse(inputIPParts[3])), };
                        byte[] cidrIPBytes = new byte[] {Convert.ToByte(int.Parse(cidrIPArray[0])), 
                            Convert.ToByte(int.Parse(cidrIPArray[3])), };
                        int cidrAddr = BitConverter.ToInt32(inputIPBytes,0);
                        int ipAddr = BitConverter.ToInt32(cidrIPBytes,0);
                        var host = int.Parse(cidrParts[1]);
                        host = -1 << (32-host);
                        var mask = HostToNetworkOrder(host);
                        if (((ipAddr & mask) == (cidrAddr & mask)))
                            return "{{ipValidated}}";
            return ipAddress; }</value>
        <check-header name="x-forwarded-for" failed-check-httpcode="403" failed-check-error-message="Unauthorized" ignore-case="true">
        <!-- Revert X-Forwarded-For to its original value-->
        <set-header name="X-Forwarded-For" exists-action="override">
                return context.Variables.GetValueOrDefault<string>("originalXForwardedForValue");

Next steps

Learn more about APIM policies: