DNS App Id Plugin

The DNS App ID plugin identifies traffic passing through your 128T router by applying pattern matching to hostnames contained in DNS requests it processes. You can then configure 128T services for these hostnames, and associate application names to influence routing policy. You can read more about 128T and its application identification concept here.

This plugin relies on the DNS Cache plugin for hostname resolution.

note

The instructions for installing and managing this plugin can be found here.

Configuration

In addition to the configuration snippet from the dns-cache plugin, the below configuration shows an example of dns-app-id configuration:

configure
authority
router lab-router
application-identification
mode module
exit
dns-app-id
enabled true
builtin-apps gmail
builtin-apps windows-update
custom-apps cnn
name cnn
patterns cnn.com
patterns .*\\.cnn.com
exit
exit
exit
exit
exit
ElementTypeDescription
enabledbooleanDefault: true. Governs whether the DNS AppID behavior is enabled or not.
builtin-appsstringMultiple instance object. This can reference any built-in application patterns contained within the version of the plugin you're running.
custom-appssubelementMultiple instance object. Allows administrators to define custom patterns for matching applications.
custom-apps > namestringThe name of the custom-app. This value will subsequently be configured within a service > application-name to give treatment to that application.
custom-apps > descriptionstringA human-readable description of the custom application.
custom-apps > patternsregexA regular expression pattern for matching to DNS requests that the 128T processes.

Built-In Patterns

The plugin contains built in application patterns for Gmail, Google Drive, and Windows Update. The patterns were generated from the following published documents:

ApplicationDocument
Gmaillink
Google Drivelink
Windows Updatelink 1 link 2

As you can see in the configuration snippet above, all you need to configure for the builtin-apps are the names of the apps you wish to include in our pattern matching. The values you can configure are gmail, google-drive, and windows-update.

Custom Patterns

Also shown in the configuration snippet is the custom-app cnn that includes a list of patterns to be applied. Each pattern must be a valid regex that will be applied to a FQDN to identify the application. The identification is dynamic, so you just need to update the configuration on the conductor to include new apps or patterns for your routers.

note

The . character bears special meaning within regular expressions, and matches any single character. Because hostnames contain literal . characters, in order to explicitly reference a dot separator, you must prefix it with two backslash characters. I.e., to have a pattern match the hostname www.128technology.com, you would type it into the PCLI as www\\.128technology\\.com. The PCLI will render the double backslash characters as a single backslash when you show the configuration.

Example

This example shows our builtin gmail application's pattern matching configured as a custom-app. You should not use this example in production, but is intended to document how to build out complicated pattern matching for an application.

custom-apps gmail
name gmail
patterns .*\\.client-channel\\.google\\.com
patterns accounts\\.google\\.com
patterns apis\\.google\\.com
patterns clients.*\\.google\\.com
patterns contacts\\.google\\.com
patterns hangouts\\.google\\.com
patterns .*\\.googleusercontent\\.com
patterns mail\\.google\\.com
patterns www\\.google\\.com
patterns .*\\.gstatic\\.com
patterns ogs\\.google\\.com
patterns play\\.google\\.com
exit
important

If you configure invalid regex patterns, you will see the log message invalid pattern for {name}, will never match!. This means the pattern you configured is not a valid regex therefore the pattern matching will fail for the app until the configuration is fixed.

Associating with a Service

Because the DNS AppID uses the same mechanism as a standard 128T AppID module, you'll reference the application using the application-name field within a service configuration. In the application-name field, use the custom-apps > name field as your key as shown here:

admin@labsystem1.fiedler# show config running authority service cnn
config
authority
service CNN-service
name CNN-service
description "CNN and associated hostnames"
scope private
application-name cnn
access-policy trusted
source trusted
permission allow
exit
service-policy data-best-effort
share-service-routes false
exit
exit
exit

Troubleshooting

Verify the services of the 128T-dns-app-id plugin:

  • systemctl status 128T-dns-app-id

Watch the journal for logging:

  • journalctl -u 128T-dns-app-id -f

You can modify the systemd service unit manually to update the log-level of the application from INFO to DEBUG. The systemd service unit is located at /usr/lib/systemd/system/128T-dns-app-id.service.

You can use show device-interface dns-cache to see all available hostnames and IP addresses found by this plugin.

========================================
tnode:dns-cache
========================================
Type: host
Forwarding: true
Mode: host
MAC Address: 76:23:37:ed:5c:ae
Admin Status: up
Operational Status: up
Redundancy Status: non-redundant
Speed: 1000
Duplex: full
in-octets: 3618779
in-unicast-pkts: 57795
in-errors: 0
out-octets: 2641623
out-unicast-pkts: 57722
out-errors: 0
records:
gmail:
172.217.165.141/32

Similarly you can use show application names.

admin@dc.router# show application names
Sat 2020-03-28 03:28:43 UTC
================== =============== ================ ===================== =====================
Application Name Session Count Ip Tuple Count Date Discovered Last Updated
================== =============== ================ ===================== =====================
gmail 0 15 2020-06-20 03:28:40 2020-06-20 03:28:40
google-drive 0 9 2020-06-20 03:28:40 2020-06-20 03:28:40
windows-update 0 1 2020-06-20 03:28:40 2020-06-20 03:28:40

Release Notes

Release 1.1.0, 2.1.0

Issues Fixed

  • PLUGIN-809 DNS app-id plugin installation fails due to dependency conflict

    Resolution The 128T-dns-app-id-router RPM has been updated to accept all versions of 128T-dns-cache-router RPM.

Release 1.0.2, 2.0.2

Issues Fixed

  • PLUGIN-402 Ensure 128T monitors new file changes and applications restarts with 128T.
Last updated on