Custom Protocols [Документация VAS Experts]
Документация VAS Experts Документация VAS Experts-mobile
in

Settings

  • Show page
  • Old revisions
  • Export to PDF
  • Fold/unfold all
  • Backlinks
  • Show page
  • Old revisions
  • Export to PDF
  • Fold/unfold all
  • Backlinks

    • Differences

    This shows you the differences between two versions of the page.

    Link to this comparison view

    Both sides previous revisionPrevious revision
    Next revision    		Previous revision
    en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols [2025/01/16 07:06] – elena.krasnobryzhen:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols [2025/05/21 12:12] (current) – elena.krasnobryzh
    Line 1: Line 1:
    -====== Custom protocols ====== +{{indexmenu_n>1}} 
    -{{indexmenu_n> 1}}+======Custom Protocols======
      
    -<note tip>The priority of user-defined protocols is higher than that of cloud protocols (downloaded from VAS Cloud).\\ Additionally, in user-defined protocols, the priority of IP:PORT is higher than that of IP and CIDR.</note>+Protocols/signatures available to the user are divided into the following types: 
     +  - **Built-in protocols** — updated along with the SSG software version. Installing a new version requires a DPI reboot, which causes traffic interruption.\\ If needed, they can be supplemented with up-to-date attributes from the VAS Cloud. This is only necessary for complex protocols, but the option is available for all. 
     +  - **Cloud protocols** created by VAS Experts — are periodically updated from the VAS Cloud. This ensures that popular applications remain up-to-date as their behavior changes. 
     +  - **Custom (user-defined) protocols** — protocols created by users via the GUI using VAS Cloud tools. These have higher priority than those loaded from the VAS Cloud, and within them, IP:PORT takes precedence over IP and CIDR. It is possible to add a protocol based on IP, SNI, or AS.
      
    -To go to the "Custom protocols" section, in the shutting down menu, do the path // "VAS CLOUD SERVICES" -> "PROTOCOLS" -> "CUSTOM PROTOCOLS" //.+Users can add protocols based on IP, SNI, and AS. Custom protocols override Built-in and Cloud protocols.
      
    -{{ en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols:prtcl_chptr_1.jpg |}}+Adding a new protocol is done in the **VAS Cloud Services** → **Custom Protocols** section in 3 steps:
      
    -The section "Custom Protocols" includes three blocks: "Hardware" collapsed to the left, "Protocols" and "Resources".+=====Step 1. Adding a New Protocol===== 
     +{{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:protocols.png?nolink&700 |}} 
     +On the **Protocols** panel, you can: 
     +  - **Add list item.** 
     +    * Fill in the following parameters: 
     +    * **Name** — a mandatory field. It must contain only letters, numbers, or their combinations. Each name is automatically prefixed with “cp_” (CP stands for Custom Protocol), which is mandatory; 
     +    * **Custom Number** — a mandatory unique field, limited to the range of 1 to 1024; 
     +    * **Port** — filled in automatically; 
     +    * **Description** — an optional field; 
     +    * **Main List** — if this parameter is ignored, the default list type is “test.” The flags “main” and “test” are used for debugging the protocol (“test”) and subsequently launching it for policing subscribers (“main”). Usually, the test protocol is first uploaded to the DPI test stand, and after debugging is complete, the “main” flag is set, and it is uploaded to all other DPIs.\\ {{ :en:implementation:use_case:add_protocol.png?nolink&550 |}} 
     +  - **Enable or disable the protocol.**\\ Performing any actions with a disabled protocol (step 7) automatically activates it. These changes are also reflected in the main section of the “User Interface” as an activation button next to the “Name” column of each protocol in the list. 
     +  - **Import data from a file.**\\ To facilitate the completion of the protocol creation fields, a template is provided that can be exported in Excel format, filled out, and uploaded in this window. After uploading the file, the data cannot be changed; only the protocol can be deleted.\\ {{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:protocol_import.png?nolink&600 |}} 
     +  - **Delete an item from the list.** 
     +  - **Clear the list.** 
     +  - **Refresh the list.** 
     +  - **Enable and disable list items.** 
     +  - **Modify a list item.** 
     +  - **Export the list.** Available formats: Excel, CSV, PDF, PNG.
      
    -===== Hardware =====+=====Step 2. Add Resources Defining the Protocol===== 
     +{{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:resources.png?nolink&700 |}} 
     +On the **Resource List** panel, you can: 
     +  - **Add list item.**\\ Fill in the following parameters: 
     +    * **Type** — a mandatory field, filled by selecting from the offered list (Auto, IP, SNI, ASN (only external AS can be specified, e.g., Facebook or Google)); 
     +    * **URI (Uniform Resource Identifier)** — a mandatory field, how to fill it depends on the type of resource (IP or SNI);\\ Example:\\ Type IP — 201.1.1.1.\\ Type SNI — google.com.\\ {{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:uri.png?nolink&500 |}} 
     +  - **Enable or disable the resource.**\\ Performing any actions with a disabled protocol (step 7) automatically activates it. These changes are also reflected in the main section of the “User Interface” as an activation button next to the “Name” column of each protocol in the list. 
     +  - **Import data from a file.** and **Check resource.**\\ To facilitate the completion of the protocol creation fields, a template is provided that can be exported in Excel format, filled out, and uploaded in this window. After uploading the file, the data cannot be changed; only the protocol can be deleted.\\ {{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:resources_import.png?nolink&600 |}} 
     +  - **Delete list items.** 
     +  - **Clear the list.** 
     +  - **Refresh the list.** 
     +  - **Enable and disable list items.** 
     +  - **Modify a list item.** 
     +  - **Export the list.** Available formats: Excel, CSV, PDF, PNG.
      
    -This block contains a summary table of user equipment, which can be filtered by name, mode, list type, status and description.+=====Step 3. After Preparing the Protocol, It Needs to Be Uploaded to the DPI Devices from the List.===== 
     +<note important>Adding and removing devices from this list **is not allowed**.</note>
      
    -Equipment in this list cannot be added or removed. The pivot table can be updated and edited the list type, synchronization mode (By DPIUI2 - dpiui2 module downloads lists to equipment. By URL - FastDPI downloads lists by reference. By URL by default) and state (enable or disable) of each equipment in the list.+{{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:dpi.png?nolink&700 |}}
      
    -At the bottom of the block there is a button for exporting the list to a user-selected format (Excel, CSV, PDF, PNG).+On the **Hardwares** panel, you can: 
     +  - **Refresh the list.** 
     +  - **Enable and disable list items.** 
     +  - **Edit a list item.** 
     +  - **Export the list.** Available formats: Excel, CSV, PDF, PNG.
      
    -===== Protocols ===== +=====Logs===== 
    - +In **VAS Cloud Services** → **Logs** section, you can view all actions performed with protocols. 
    -<note tip>Utility to check for custom protocol entry - ''[[en:dpi:dpi_components:utilities:management_utilities|checkproto]]''.</note> +You can delete specific entries, clear the list, refresh, and export it in formats Excel, CSV, PDF, PNG.
    - +
    -The "Protocols" block consists of a panel of elements, which includes: +
    - +
    -* ** Adding a list item ** +
    - +
    -To add an item to the list, you must fill in the fields: +
    - +
    -// name // - is a required field, containing only Latin letters, numbers or their combination. At the beginning of each name, by default, the prefix "cp_" (CP stands for Custom Protocol) is assigned, which is mandatory; +
    - +
    -// user number // - is a required field, as well as unique and limited to the range from 1 to 1024; +
    - +
    -// port // - filled in automatically; +
    - +
    -// description // - is not a required field; +
    - +
    -// main list // - if this parameter is ignored, the default list type is test; +
    - +
    -At the very bottom of the window. there are the //"save"// button, which saves the user-created protocol and adds it to the list, and the "cancel" // button // that minimizes the window without saving the new protocol. +
    - +
    -{{ en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols:prtcl_crt_2.jpg?400 ||}} +
    - +
    - +
    -* ** Startup and shutdown ** +
    - +
    -Or activation and deactivation of the protocol, allows the user to enable the selected protocol for further work or disable it. Any action with a disabled protocol will automatically activate it. These changes are also displayed in the main section of the "Custom interface" in the form of an enable button, which is located next to the "Name" column of each protocol in the list. +
    - +
    -<note important>More specific custom SNI signatures are prioritized.\\ +
    -Example: for host ''a.b.c.d'', if the signatures ''*.d'', ''*.c.d'' and ''*.b.c.d'' are present, the protocol defined by the signature ''*.b.c.d'' works only for signatures with ''*''.\\ +
    -Detailed example in section [[en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols#example_of_prioritization_of_a_custom_protocol_over_a_cloud_protocol|Example of prioritization of a custom protocol over a cloud protocol]]</note> +
    - +
    -* ** Import from file ** +
    - +
    -For the convenience of filling out the fields for creating a protocol, a template is provided that can be downloaded in excel format, filled in and downloaded back. It is impossible to change the data after downloading the file, you can only delete the protocol. +
    - +
    -{{ en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols:prtcl_imp_3.jpg?400 |}} +
    - +
    - +
    -* ** Delete ** - the ability to delete selected protocols, the selection of which is carried out by checking the box in the window located in the main section of the user interface. This action can also be performed by pressing the button in the form of an image of a "trash can", which is located next to the "Description" column of each protocol in the list; +
    - +
    -* ** Clearing the list ** - deleting all protocols in the list; +
    - +
    -* ** Update list ** - updates the list; +
    - +
    -Below is a list of all user-created protocols, which can be filtered by name, user number, port, list type and description. You can change the protocol using the button located next to the "Name" column of each protocol in the list. +
    - +
    -At the bottom of the block there is a button for exporting the list to a user-selected format (Excel, CSV, PDF, PNG) +
    - +
    -====Example of prioritization of a custom protocol over a cloud protocol==== +
    -**1. Let's upload two protocols:** +
    - +
    -Cloud Protocol: ''cloudflare'' +
    -  * ''cloudflare.com'' +
    -  * ''*.cloudflare.com'' +
    - +
    -Custom protocol: ''cp_test1234'' +
    -  * ''cloudflare.com'' +
    -  * ''*www.cloudflare.com'' (you can enter ''www.cloudflare.com'', it will automatically change to ''*www.cloudflare.com'' and notify you of the change and intersection with a particular protocol.) +
    - +
    -**2. Result of uploaded lists in DPI:** +
    - +
    -''cloudflare'' contains: +
    -  * ''*.cloudflare.com'' +
    - +
    -''cp_test1234'' contains: +
    -  * ''cloudflare.com'' +
    -  * ''*www.cloudflare.com'' +
    - +
    -**3. The ''cp_test1234 drop'' rule would mean:** +
    -  * Subdomains are not affected, example: ''my.cloudflare.com'' is available, excluding ''www.cloudflare.com''. +
    -  * ''cloudflare.com'' and ''www.cloudflare.com'' are blocked. +
    - +
    -**4. The ''cp_test1234 session policing'' rule would mean:** +
    -  * Subdomains are not affected, example: ''my.cloudflare.com'' is available, excluding ''www.cloudflare.com''. +
    -  * Impact on ''cloudflare.com'' and ''www.cloudflare.com'' resources +
    - +
    -**In the cloud** ''cloudflare.com'' is excluded from the cloud protocol and placed in the custom protocol, and **In DPI** the entry ''*www.cloudflare.com'' signifies the priority of the custom protocol over the entry ''*.cloudflare.com'' +
    - +
    -===== Resources ===== +
    - +
    -The list of resources depends on the protocol selected by the user from the previous block. +
    - +
    -The "resources" block consists of a panel of elements, which includes: +
    - +
    -* ** Adding an element ** +
    - +
    -To add an item to the list, you must fill in the fields: +
    - +
    -// type // - is a required field, filled in by choosing from the proposed list (ip or sni); +
    - +
    -// uri (Uniform Resource Identifier - a uniform resource identifier) ​​// - is a mandatory field for filling, the filling method of which depends on the "type" of the resource selected by the user (ip or sni); +
    - +
    -P.S. Example of filling in ip type (201.1.1.1), Example of filling in sni of type (yandex.ru). +
    - +
    -{{ en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols:prtcl_add_4.jpg?300 |}} +
    - +
    -* ** Startup and shutdown ** +
    - +
    -Or activation and deactivation of a resource, allows the user to enable the selected resource for further work or disable it. Performing any actions with a disabled resource leads to its activation automatically. These changes are also displayed in the main section of the user interface as an enable button located in front of the Name column of each resource in the list; +
    - +
    -* ** Import from file ** +
    - +
    -For the convenience of filling out the fields for creating a resource, a template is provided that can be downloaded in excel format, filled in and downloaded back. It is impossible to change the data after downloading the file, you can only delete the resource. +
    - +
    - {{ en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:custom_protocols:prtcl_imp_5.jpg?400 |}} +
    - +
    -* ** Delete ** - the ability to delete the selected resources, the selection of which is carried out by checking the box in the window located in the main section of the user interface next to the "Uri" column of each resource; +
    - +
    -* ** Clearing the list ** - deleting all protocols in the list; +
    - +
    -* ** Update list ** - update the list; +
    - +
    -Below is a list of all user-created resources, which can be filtered by protocol name, type and uri. You can change the protocol using the button located next to the "Name" column of each resource in the list. +
    - +
    -At the bottom of the block there is a button for exporting the list to a user-selected format (Excel, CSV, PDF, PNG). +
      
     +{{ :en:dpi:dpi_components:dpiui:user_guide:vas_cloud_services:logs.png?nolink&1200 |}}