Intelligent Proxy Steering - Office365
Introduction
This solution started back in May 2015 when I was helping a customer bypass their forward proxy servers due to the significant increase in the number of client connections after moving to Office365. Luckily they had a BIG-IP in front of their forward proxy servers load balancing the traffic and F5 had introduced a new “Proxy Mode” feature in the HTTP profile in TMOS 11.5. This allowed the BIG-IP to terminate Explicit Proxy connections, instead of passing them through to the pool members. The original solution was a simple iRule that referenced a data-group to determine if the connection should bypass the forward proxy pool or reverse proxy and load balance the connection as normal.
Original iRule:
when HTTP_PROXY_REQUEST { # Strip of the port number set hostname [lindex [split [HTTP::host] ":"] 0] # If the hostname matches a MS 0ffice365 domain, enable the Forward Proxy on BIG-IP. # BIG-IP will then perform a DNS lookup and act as a Forward Proxy bypassing the Forward Proxy # Server Pool (BlueCoat/Squid/IronPort etc..) if { [class match $hostname ends_with o365_datagroup] } { # Use a SNAT pool - recommended snatpool o365_snatpool HTTP::proxy } else { # Load balance/reverse proxy to the Forward Proxy Server Pool (BlueCoat/Squid/IronPort etc..) HTTP::proxy disable pool proxy_pool } }
As more organisations move to Office365, they have been facing similar problems with firewalls and other security devices unable to handle the volume of outbound connections as they move the SaaS world. The easiest solution may have been just to create proxy PAC file and send the traffic direct, but this would have involved allowing clients to directly route via the firewall to those IP address ranges. How secure is that?
I decided to revisit my original solution and look at a way to dynamically update the Office365 URL list. Before I started, I did a quick search on DevCentral and found that DevCentral MVP Niels van Sluis had already written an iRule to download the Microsoft Office365 IP and URL database. Perfect starting point. I’ve since made some modifications to his iRulesLX and a new TCL iRule to support the forward proxy use case.
How the solution works
- The iRuleLX is configured to pull the O365IPAddresses.xml every hour. Reformat into JSON and store in a LokiJS DB.
- The BIG-IP is configured as an Explicit Proxy in the Clients network or browser settings.
- The Virtual Server has a HTTP profile attached with the Proxy Mode set to Explicit along we a few other settings. I will go in the detail later.
- An iRule is attached that executes on the HTTP_PROXY_REQUEST event to check if the FQDN should bypass the Explicit Proxy Pool.
- If the result is not in the Cache, then a lookup is performed in the iRuleLX LokiJS DB for a result. The result is retuned to the iRule to make a decision to bypass or not.
- The bypass result is Cached in a table with a specified timeout.
- A different SNAT pool can be enabled or disabled when bypassing the Explicit Proxy Pool
Configuration
My BIG-IP is running TMOS 13.1 and the iRules Language eXtension has been licensed and provisioned. Make sure your BIG-IP has internet access to download the required Node.JS packages.
This guide also assumes you have a basic level of understanding and troubleshooting at a Local Traffic Manager (LTM) level and your BIG-IP Self IP, VLANs, Routes, etc.. are all configured and working as expected.
Before we get started
The iRule/iRuleLX for this solution can be found on DevCentral Code Share.
- Download and install my Explicit Proxy iApp
- Copy the Intelligent Proxy Steering - Office365 iRule
- Copy the Microsoft Office 365 IP Intelligence - V0.2 iRuleLX
Step 1 – Create the Explicit Proxy
1.1 Run the iApp
iApps >> Application Services >> Applications >> “Create”
Supply the following:
- Name: o365proxy
- Template: f5.explicit_proxy
Explicit Proxy Configuration
- IP Address: 10.1.20.100
- FQDN of this Proxy: o365proxy.f5.demo
- VLAN Configuration - Selected: bigip_int_vlan
- SNAT Mode: Automap
DNS Configuration
- External DNS Resolvers: 1.1.1.1
- Do you need to resolve any Internal DNS zones: Yes or No
Select “Finished" to save.
1.2 Test the forward proxy
$ curl -I https://www.f5.com --proxy http://10.1.20.100:3128
HTTP/1.1 200 Connected
HTTP/1.0 301 Moved Permanently
location: https://f5.com
Server: BigIP
Connection: Keep-Alive
Content-Length: 0
Yep, it works!
1.3 Disable Strict Updates
iApps >> Application Services >> Applications >> o365proxy
- Select the Properties tab, change the Application Service to Advanced.
- Uncheck Strict Updates
Select “Update" to save.
1.4 Add an Explicit Proxy server pool
In my test environment I have a Squid Proxy installed on a Linux host listening on port 3128.
Local Traffic >> Pools >> Pool List >> “Create”
Supply the following:
- Name: squid_proxy_3128_pool
- Node Name: squid_node
- Address: 10.1.30.105
- Service Port: 3128
Select “Add" and “Finished” to Save.
Step 2 – iRule and iRuleLX Configuration
2.1 Create a new iRulesLX workspace
Local Traffic >> iRules >> LX Workspaces >> “Create”
Supply the following:
- Name: office365_ipi_workspace
Select “Finished" to save.
You will now have any empty workspace, ready to cut/paste the TCL iRule and Node.JS code.
2.2 Add the iRule
Select “Add iRule” and supply the following:
- Name: office365_proxy_bypass_irule
- Select OK
Cut / Paste the following Intelligent Proxy Steering - Office365 iRule into the workspace editor on the right hand side. Select “Save File” when done.
2.3 Add an Extension
Select “Add extension” and supply the following:
- Name: office365_ipi_extension
- Select OK
Cut / Paste the following Microsoft Office 365 IP Intelligence - V0.2 iRuleLX and replace the default index.js. Select “Save File” when done.
2.4 Install the NPM packages
- SSH to the BIG-IP as root
- cd /var/ilx/workspaces/Common/office365_ipi_workspace/extensions/office365_ipi_extension/
- npm install xml2js https repeat lokijs ip-range-check --save
2.5 Create a new iRulesLX plugin
Local Traffic >> iRules >> LX Plugin >> “Create”
Supply the following:
- Name: office365_ipi_plugin
- From Workspace: office365_ipi_workspace
Select “Finished" to save.
2.6 Verify the Office365 XML downloaded
SSH to the BIG-IP and tail -f /var/log/ltm
The Office365 XML has been downloaded, parsed and stored in the LokiJS:
big-ip1 info sdmd[5782]: 018e0017:6: pid[9603] plugin[/Common/office365_ipi_plugin.office365_ipi_extension] Info: update finished; 20 product records in database.
2.7 Add the iRule and the Explicit Proxy pool to the Explicit Proxy virtual server
Local Traffic >> Virtual Servers >> Virtual Server List >> o365proxy_3128_vs >> Resources
Edit the following:
- Default Pool: squid_proxy_3128_pool
Select “Update" to save.
Select “Manage…” and move office365_proxy_bypass_irule to the Enabled section.
Select “Finished" to save.
Step 3 – Test the solution
SSH to the BIG-IP and tail -f /var/log/ltm
3.1 Test a non-Office365 URL first
$ curl -I https://www.f5.com --proxy http://10.1.20.100:3128
HTTP/1.1 200 Connected
HTTP/1.0 301 Moved Permanently
location: https://f5.com
Server: BigIP
Connection: Keep-Alive
Content-Length: 0
Output from /var/log/ltm:
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58190 --> 10.1.20.100:3128
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : ## HTTP Proxy Request ##
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : CONNECT www.f5.com:443 HTTP/1.1
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Host: www.f5.com:443
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : User-Agent: curl/7.54.0
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Proxy-Connection: Keep-Alive
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.f5.com not in cache - perform DB lookup
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.f5.com - bypass: 0
big-ip1 info tmm2[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58190 (10.1.30.245:24363) --> 10.1.30.105:3128
3.2 Test the same non-Office365 URL again to confirm the cache works
Output from /var/log/ltm:
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58487 --> 10.1.20.100:3128
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : ## HTTP Proxy Request ##
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : CONNECT www.f5.com:443 HTTP/1.1
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Host: www.f5.com:443
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : User-Agent: curl/7.54.0
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Proxy-Connection: Keep-Alive
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.f5.com found in cache
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.f5.com - bypass: 0
big-ip1 info tmm1[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58487 (10.1.30.245:25112) --> 10.1.30.105:3128
3.3 Test a Office365 URL and check it bypasses the Explicit Proxy pool
$ curl -I https://www.outlook.com --proxy http://10.1.20.100:3128
HTTP/1.1 200 Connected
HTTP/1.1 301 Moved Permanently
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 0
Location: https://outlook.live.com/
Server: Microsoft-IIS/10.0
Connection: close
Output from /var/log/ltm:
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58692 --> 10.1.20.100:3128
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : ## HTTP Proxy Request ##
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : CONNECT www.outlook.com:443 HTTP/1.1
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Host: www.outlook.com:443
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : User-Agent: curl/7.54.0
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : Proxy-Connection: Keep-Alive
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.outlook.com not in cache - perform DB lookup
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : www.outlook.com - bypass: 1
big-ip1 info tmm3[12384]: Rule /Common/office365_ipi_plugin/office365_proxy_bypass_irule : 10.10.99.31:58692 (10.1.10.245:21666) --> 40.100.144.226:443
It works!
Conclusion
By combining Microsoft Office365 IP and URL intelligence with LTM, produces a simple and effective method to steer around overloaded Forward Proxy servers without the hassle of messy proxy PAC files.
- SmithyCirrostratus
Are you using the new version? Check out: https://github.com/nvansluis/f5.office365_endpoints_extension
- Guy_iHealthNimbostratus
I forgot to mention I commented 'use strict' because the code stopped executing when arriving on line const uuidv4 = require('uuid/v4');
- Guy_iHealthNimbostratus
Hello Brett,
I've tried to setup your solution as a test on a virtual F5.
I started with version 12.1.3 but because I got a syntax error unexpected token => when I try to load the plugin I upgraded to version 13.1.3.1 because I saw you used version 13.
But I still have the same error.
In the workspace no problem is mentioned, I can save the index.js but when the plugin is reloaded I see the following in the ltm log :
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] /var/sdm/plugin_store/plugins/:Common:lxpi_o365_tst_38969_15/extensions/lxex_o365_tst/index.js:75
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] products.find().forEach((v, i) => {
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] ^^
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] SyntaxError: Unexpected token =>
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at exports.runInThisContext (vm.js:73:16)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at Module._compile (module.js:443:25)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at Object.Module._extensions..js (module.js:478:10)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at Module.load (module.js:355:32)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at Function.Module._load (module.js:310:12)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at Function.Module.runMain (module.js:501:10)
Dec 11 05:46:20 vlbintra err sdmd[23542]: 018e0018:3: pid[14104] plugin[/Common/lxpi_o365_tst.lxex_o365_tst] at startup (node.js:129:16)
I'm not familiar with Javascript but this seams a valid syntax to me :
function logStatistics() {
// statistics about entries in loki database.
var v, i;
console.log('info: ' + products.count() + ' serviceAreas found.');
products.find().forEach((v, i) => {
console.log ('info: serviceArea ' + v.name + ' holds ' + v.ipAddresses.length + ' IP addresses and ' + v.urls.length + ' URLs');
});
}
Am I overlooking something ?
Thanks in advance.
Best regards,
Guy
- APNimbostratus
Hi Nico,
Take a look at the newer version (0.4) of the iRule: https://github.com/nvansluis/f5.office365_endpoints_extension
The iRule covered in this thread is for the old XML based API and the new is a REST API. I believe the XML API was going to be decommissioned earlier this year. The xml2js package (for example) is no longer relevant.
In terms of package versions, there will have been updates since the article was written. Should be fine but of course there's no guarantees something hasn't broken. You can always try to get the older packages if necessary.
- Nico_AmatorioNimbostratus
Hello ,
Is it necessary to have the same value as these below.?
- ke sure you get this:
- /var/ilx/workspaces/Common/office365_ipi_workspace/extensions/office365_ipi_extension
- ├── https@1.0.0
- ├─┬ ip-range-check@0.0.2
- │ └── ipaddr.js@1.8.1
- ├── lokijs@1.5.5
- ├── repeat@0.0.6
- └── xml2js@0.4.19
We are getting these values below.
- Nico_AmatorioNimbostratus
Yes, Our proxy is the BIGIP. How can we call the Office category of SWG? Is there any existing datagroup for O365 that we can use in the iRule?
- Arnaud_LemaireEmployeeYou can create can create an irule matching office category and deactivating apm for this traffic keeping proy only dns resolution. But normally you should do it before your proxy architecture, to move away your traffic from proxy architecture. If your bigip is your proxy, then you will still have the load, but you can disable features based on category.
- Nico_AmatorioNimbostratus
Hi
Then how can i implement the proxy bypass using SWG/URL Filtering if my traffic is going to O365?
- Arnaud_LemaireEmployee
Hello Nico, no you don't have to implement that. SWG or url filtering license are good alternatives. Both of them should have a category for office, thus you can match it to steer it.
- Nico_AmatorioNimbostratus
Hello @Okta Service Team ,
If I have SWG license, do I still need to use the iRule LX- NodeJS for the O365 URL Lookup?
What are the changes in the procedures for the Proxy bypass?
Thank you!