URL Filter

1.0

NVIDIA DOCA URL Filter Reference App

This document provides a URL filter implementation on top NVIDIA® BlueField® DPU.

URL filtering limits access by comparing web traffic against a database to prevent users from different threats, malware and accessing harmful sites such as phishing pages.

This kind of content filtering can increase network security and enforce policies on different network resources.

URL filtering is designed to run as “bump-on-the-wire” on the BlueField-2 instance. It intercepts traffic coming from the wire and passes it to the physical function (PF) representor connected to the host.

URL filter utilizes the SFT and RegEx engines which are HW accelerators on BlueField.

system-design-diagram.png

  • User adds a URL using the URL command from the CLI. Available commands:
    • Create database – create DB of URLs to be filtered (also removes old signatures)
    • Filter – add specific URL/URL RegEx pattern to be filtered
    • Commit database [PATH] – compile and load signature database
  • Ingress traffic is identified using the connection tracking module
  • Traffic is scanned against compiled signature DB
  • Post-processing is performed for match decision
  • Matched flows are filtered and traffic is blocked


application-architecture-diagram.png

  1. Signatures are compiled by the DPI compiler and are then loaded to the DPI engine.
  2. Ingress traffic is identified and classified using the stateful table module in the DPDK libs which utilizes the connection tracking hardware offloads. This allows flow classifications to be done at the hardware level and forwarded to a hairpin queue without being processed by the software, which increases performance dramatically.
  3. Traffic is scanned against the DPI engine compiled signature DB.
  4. Post-processing is performed for match decision.
  5. Matched flows are identified and can be offloaded to the hardware to increase performance as not further inspection is needed.
  6. Flow termination is done by the aging timer (set in the SFT to 60 seconds). When a flow is offloaded it cannot be tracked and destroyed.
    Note:

    It is important to note that only sites that support non-encrypted HTTP traffic can be matched against signatures created by the URL filtering as it specifically targets the URI field in the HTTP request.

  1. Parse application argument
    Copy
    Copied!
                

    arg_parser_init();

    1. Initialize the arg parser resources.
    2. Register DOCA general flags.
      Copy
      Copied!
                  

      register_url_params();

    3. Register URL filter application flags.
      Copy
      Copied!
                  

      arg_parser_start();

    4. Parse DPDK flag and call rte_eal_init() function.
    5. Parse APP flags.
  2. DPDK initialization.
    Copy
    Copied!
                

    dpdk_init();

    1. Initialize SFT.
    2. Initialize DPDK ports, including mempool allocation.
  3. URL filter initialization.
    Copy
    Copied!
                

    url_filter_init();

    1. Init URL filter resources.
    2. Configure RegEx engine.
    3. Configure DPI queues.
  4. Configure DPI packet processing.
    Copy
    Copied!
                

    dpi_worker_lcores_run();

    1. Configure DPI enqueue packets.
    2. Send jobs to RegEx engine.
    3. Configure DPI dequeue packets.
  5. Add URL shell command
    Copy
    Copied!
                

    initiate_cmdline("URL FILTER>>");

    1. Create database.
    2. Filter http.
    3. Commit database.
  6. DPI destroy
    Copy
    Copied!
                

    url_filter_destroy();

    • Stop DPI worker and free DPI resources.

  1. Please refer to the DOCA Installation Guide for details on how to install BlueField related software.

    The URL filtering example binary is located under /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter.

  2. To re-build the application:
    1. Run:
      Copy
      Copied!
                  

      cd /opt/mellanox/doca/examples/url_filter/src meson /tmp/build ninja -C /tmp/build


      doca_url_filter is created under tmp/build.

    2. The build process depends on the PKG_CONFIG_PATH environment variable to locate the DPDK libraries. If the variable was accidently corrupted, and the build fails, run the following command:
      • For Ubuntu:
        Copy
        Copied!
                    

        export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/opt/mellanox/dpdk/lib/aarch64-linux-gnu/pkgconfig

      • For CentOS:
        Copy
        Copied!
                    

        export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/opt/mellanox/dpdk/lib64/pkgconfig

  3. Pre-run setup.
    1. The URL filter example is based on DPDK libraries. Therefore, the user is required to provide DPDK flags, and allocate huge pages. Run:
      Copy
      Copied!
                  

      echo 2048 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages

    2. Make sure the regex engine is active:
      Copy
      Copied!
                  

      systemctl status mlx-regex

      If the status is inactive (Active: failed), run:
      Copy
      Copied!
                  

      systemctl start mlx-regex


  4. To run the application:
    Copy
    Copied!
                

    Usage: doca_url_filter [DPDK Flags] -- [DOCA Flags] [Program Flags] DOCA Flags: -h, --help Print a help synopsis -l, --log-level Set the log level for the app <CRITICAL=0, DEBUG=4> Program Flags: -p, --print-match Prints FID when matched in DPI engine

    For example:
    Copy
    Copied!
                

    /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter -a 0000:03:00.0,class=regex -a auxiliary:mlx5_core.sf.4,sft_en=1 -a auxiliary:mlx5_core.sf.5,sft_en=1 -c3 -- -p


    Note:

    The SFT supports a maximum of 64 queues. Therefore, the application cannot be run with more than 64 cores. To limit the number of cores, run:

    Copy
    Copied!
                

    /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter -a 0000:03:00.0,class=regex -a auxiliary:mlx5_core.sf.4,sft_en=1 -a auxiliary:mlx5_core.sf.5,sft_en=1 -l 0-64 -- -p

    This limits the application to 65 cores (core-0 to core-64) with 1 core for the main thread and 64 cores to serve as workers.


    Using a JSON file:
    Copy
    Copied!
                

    doca_url_filter --json [json_file]


    For example:
    Copy
    Copied!
                

    /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter --json /root/url_params.json

    Note:

    Sub-functions must be enabled according to the Scalable Function Setup Guide.


    Note:

    The flags -a 0000:03:00.0,class=regex -a auxiliary:mlx5_core.sf.4,sft_en=1 -a auxiliary:mlx5_core.sf.5,sft_en=1 are necessary for proper usage of the application. Modifying them will result in unexpected behavior as only 2 ports are supported. The subfunction number is arbitrary and configurable. The RegEx device, however, is not and must be initiated on port 0.

    For additional information on available flags for DPDK, use -h before the --separator:
    Copy
    Copied!
                

    /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter -h


    For additional information on the app, use -h after the -- separator:
    Copy
    Copied!
                

    /opt/mellanox/doca/examples/url_filter/bin/doca_url_filter -- -h


    The URL filter is based on user interaction with shell commands. Using the TAB key allows autocompletion while the quit command terminates the application. Other available commands are as follows:
    • create database – removes and creates a new signature database at /tmp/signature.txt so it can be used in the filter command
    • filter http [msg] [regex] – a signature containing the regular expression written is created in the database. When a match is found, a message is printed.
    • commit database [path] – compiles and loads the signatures created by the filter command from the file path provided. The default database is /tmp/signature.txt.
      Note:

      To load a signatures file that was created beforehand, simply run commit database with the desired path to load the file.

Note:

For instructions on running the application on the host, please refer to Running Reference Applications Over Host Guide.


Refer to NVIDIA DOCA Arg Parser User Guide for more information.

Flag Type Short Flag Long Flag/JSON Key Description JSON Content
DPDK Flags a devices Add a PCI device into the list of devices to probe
Copy
Copied!
            

"devices": [ {"device": "regex",” id": "0000:03:00.0"}, {"device": "sf", "id": “4”,"sft": true}, {"device": "sf", "id": “5”,"sft": true}, ]

c core-mask Hexadecimal bitmask of cores to run on
Copy
Copied!
            

"core-mask": 3

l core-list List of cores to run on
Copy
Copied!
            

"core-list": "0-4"

General Flags l log-level Sets the log level for the application:
  • CRITICAL=0
  • ERROR=1
  • WARNING=2
  • INFO=3
  • DEBUG=4
Copy
Copied!
            

"log-level": 4

h help Print a help synopsis N/A
Program Flags p print-match Prints FID when matched in DPI engine
Copy
Copied!
            

"print-match": true

x86 CLI examples:

Copy
Copied!
            

doca_url_filter -a 0000:05:00.0,class=regex -a 05:00.3 -a 05:00.4 -v -- -p


Refer to section “Running DOCA Application on Host” in NVIDIA DOCA Virtual Functions User Guide.

For instructions on running the gRPC application server on the BlueField, refer to .

url-filter-grpc.png

To run the Python client of the gRPC-enabled application:

Copy
Copied!
            

./doca_url_filter_gRPC_client.py -d/--debug <server address[:server port]>

For example:

Copy
Copied!
            

/opt/mellanox/doca/examples/url_filter/bin/grpc/client/doca_url_filter_gRPC_client.py -d 192.168.104.2

The URL filter example supports a container-based deployment.

  1. Refer to the NVIDIA DOCA Container Deployment Guide for details on how to deploy a DOCA Container to the BlueField.
  2. Notice that the container starts at sleeping mode. That is because of the interactive nature of the URL filter example app. To run the example, attach to the running container. Run the following:
    Copy
    Copied!
                

    sudo crictl exec -it <container-id> /bin/bash

    Then refer to the entrypoint.sh script at the root directory for an example of how to run the URL filter.

  3. Application-specific configuration steps can be found on NGC, under the application’s container page.

  • /opt/mellanox/doca/examples/url_filter/src/url_filter.c
  • /opt/mellanox/doca/examples/url_filter/src/grpc/url_filter.proto

Notice

This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIA Corporation nor any of its direct or indirect subsidiaries and affiliates (collectively: “NVIDIA”) make no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in this document and assume no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for any infringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material (defined below), code, or functionality.

NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.

Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.

NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreed in an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying any customer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formed either directly or indirectly by this document.

NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applications where failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIA accepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.

NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document, ensure the product is suitable and fit for the application planned by customer, and perform the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this document. NVIDIA accepts no liability related to any default, damage, costs, or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this document or (ii) customer product designs.

No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document. Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party, or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.

Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliance with all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.

THIS DOCUMENT AND ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the products described herein shall be limited in accordance with the Terms of Sale for the product.

Trademarks

NVIDIA, the NVIDIA logo, and Mellanox are trademarks and/or registered trademarks of Mellanox Technologies Ltd. and/or NVIDIA Corporation in the U.S. and in other countries. The registered trademark Linux® is used pursuant to a sublicense from the Linux Foundation, the exclusive licensee of Linus Torvalds, owner of the mark on a world¬wide basis. Other company and product names may be trademarks of the respective companies with which they are associated.

Copyright

© 2022 NVIDIA Corporation & affiliates. All rights reserved.

© Copyright 2023, NVIDIA. Last updated on Jan 12, 2022.