انتقل إلى المحتوى

الويب هوك

يمكنك تعيين Wallarm لإرسال الإشعارات الفورية لأي نظام يقبل الويب هوك الواردة عبر بروتوكول HTTPS.

تنسيق الإشعار

تُرسل الإشعارات بإما تنسيق JSON Array أو تنسيق New Line Delimited JSON (NDJSON) حسب اختيارك أثناء إعداد التكامل. يعتمد مجموعة من الأجسام JSON على الحدث الذي أرسلت له الإشعار. مثلاً:

  • اكتشاف الهجوم

    [
    {
        "summary": "[Wallarm] New hit detected",
        "details": {
          "client_name": "Test Company",
          "cloud": "EU",
          "notification_type": "new_hits",
          "hit": {
            "domain": "example.com",
            "heur_distance": 20.714285714285715,
            "method": "GET",
            "path": "/",
            "payloads": [
              "1' select version();"
            ],
            "point": [
              "get",
              "id"
            ],
            "probability": 20.714285714285715,
            "remote_country": null,
            "remote_port": 41253,
            "remote_addr4": "8.8.8.8",
            "remote_addr6": null,
            "datacenter": "unknown",
            "tor": "none",
            "request_time": 1703519823,
            "create_time": 1703519826,
            "response_len": 345,
            "response_status": 404,
            "response_time": 359,
            "stamps": [
              7965
            ],
            "regex": [],
            "stamps_hash": 271168947,
            "regex_hash": -2147483648,
            "type": "sqli",
            "block_status": "monitored",
            "brute_counter": "b:1111:xxxxxxxxxxxxxxxx",
            "final_wallarm_mode": "monitoring",
            "libproton_version": "4.8.0",
            "lom_id": 932,
            "protocol": "rest",
            "proxy_type": null,
            "request_id": "xxxxxxxxxxxxxxxx",
            "wallarm_mode": null,
            "id": [
              "hits_production_1111_202312_v_1",
              "xxxxxxxxxxxxxxxx"
            ],
            "object_type": "hit",
            "anomaly": 1.0357142857142858,
            "parameter": "GET_id_value",
            "applications": [
              "default"
            ]
          }
       }
    },
    {
        "summary": "[Wallarm] New hit detected",
        "details": {
          "client_name": "Test Company",
          "cloud": "EU",
          "notification_type": "new_hits",
          "hit": {
            "domain": "example.com",
            "heur_distance": 2.5,
            "method": "GET",
            "path": "/etc/passwd",
            "payloads": [
              "/etc/passwd"
            ],
            "point": [
              "uri"
            ],
            "probability": 2.5,
            "remote_country": null,
            "remote_port": 41254,
            "remote_addr4": "8.8.8.8",
            "remote_addr6": null,
            "datacenter": "unknown",
            "tor": "none",
            "request_time": 1703519826,
            "create_time": 1703519829,
            "response_len": 345,
            "response_status": 404,
            "response_time": 339,
            "stamps": [
              2907
            ],
            "regex": [],
            "stamps_hash": -1063984326,
            "regex_hash": -2147483648,
            "type": "ptrav",
            "block_status": "monitored",
            "brute_counter": "b:1111:xxxxxxxxxxxxxxxx",
            "final_wallarm_mode": "monitoring",
            "libproton_version": "4.8.0",
            "lom_id": 932,
            "protocol": "none",
            "proxy_type": null,
            "request_id": "xxxxxxxxxxxxxxxx",
            "wallarm_mode": null,
            "id": [
              "hits_production_1111_202312_v_1",
              "xxxxxxxxxxxxxxxx"
            ],
            "object_type": "hit",
            "anomaly": 0.22727272727272727,
            "parameter": "URI_value",
            "applications": [
              "default"
            ]
          }
       }
    }
    ]
    
    {"summary":"[Wallarm] New hit detected","details":{"client_name":"Test Company","cloud":"EU","notification_type":"new_hits","hit":{"domain":"example.com","heur_distance":20.714285714285715,"method":"GET","path":"/","payloads":["1' select version();"],"point":["get","id"],"probability":20.714285714285715,"remote_country":null,"remote_port":41253,"remote_addr4":"8.8.8.8","remote_addr6":null,"datacenter":"unknown","tor":"none","request_time":1703519823,"create_time":1703519826,"response_len":345,"response_status":404,"response_time":359,"stamps":[7965],"regex":[],"stamps_hash":271168947,"regex_hash":-2147483648,"type":"sqli","block_status":"monitored","brute_counter":"b:1111:xxxxxxxxxxxxxxxx","final_wallarm_mode":"monitoring","libproton_version":"4.8.0","lom_id":932,"protocol":"rest","proxy_type":null,"request_id":"xxxxxxxxxxxxxxxx","wallarm_mode":null,"id":["hits_production_1111_202312_v_1","xxxxxxxxxxxxxxxx"],"object_type":"hit","anomaly":1.0357142857142858,"parameter":"GET_id_value","applications":["default"]}}
    {"summary":"[Wallarm] New hit detected","details":{"client_name":"Test Company","cloud":"EU","notification_type":"new_hits","hit":{"domain":"example.com","heur_distance":2.5,"method":"GET","path":"/etc/passwd","payloads":["/etc/passwd"],"point":["uri"],"probability":2.5,"remote_country":null,"remote_port":41254,"remote_addr4":"8.8.8.8","remote_addr6":null,"datacenter":"unknown","tor":"none","request_time":1703519826,"create_time":1703519829,"response_len":345,"response_status":404,"response_time":339,"stamps":[2907],"regex":[],"stamps_hash":-1063984326,"regex_hash":-2147483648,"type":"ptrav","block_status":"monitored","brute_counter":"b:1111:xxxxxxxxxxxxxxxx","final_wallarm_mode":"monitoring","libproton_version":"4.8.0","lom_id":932,"protocol":"none","proxy_type":null,"request_id":"xxxxxxxxxxxxxxxx","wallarm_mode":null,"id":["hits_production_1111_202312_v_1","xxxxxxxxxxxxxxxx"],"object_type":"hit","anomaly":0.22727272727272727,"parameter":"URI_value","applications":["default"]}}
    
  • كشف أمني

    [
        {
            summary:"[Wallarm] New vulnerability detected",
            description:"Notification type: vuln
    
                        New vulnerability was detected in your system.
    
                        ID: 
                        Title: Test
                        Domain: example.com
                        Path: 
                        Method: 
                        Discovered by: 
                        Parameter: 
                        Type: Info
                        Threat: Medium
    
                        More details: https://us1.my.wallarm.com/object/555
    
    
                        Client: TestCompany
                        Cloud: US
                        ",
            details:{
                client_name:"TestCompany",
                cloud:"US",
                notification_type:"vuln",
                vuln_link:"https://us1.my.wallarm.com/object/555",
                vuln:{
                    domain:"example.com",
                    id:null,
                    method:null,
                    parameter:null,
                    path:null,
                    title:"Test",
                    discovered_by:null,
                    threat:"Medium",
                    type:"Info"
                }
            }
        }
    ]
    
    {"summary":"[Wallarm] New vulnerability detected","description":"Notification type: vuln\nNew vulnerability was detected in your system.\nID: \nTitle: Test\nDomain: example.com\nPath: \nMethod: \nDiscovered by: \nParameter: \nType: Info\nThreat: Medium\nMore details: https://us1.my.wallarm.com/object/555\nClient: TestCompany\nCloud: US","details":{"client_name":"TestCompany","cloud":"US","notification_type":"vuln","vuln_link":"https://us1.my.wallarm.com/object/555","vuln":{"domain":"example.com","id":null,"method":null,"parameter":null,"path":null,"title":"Test","discovered_by":null,"threat":"Medium","type":"Info"}}}
    

إعداد التكامل

  1. افتح Wallarm UI → التكاملات.

  2. انقر على الويب هوك أو انقر فوق الزر إضافة تكامل واختر الويب هوك.

  3. أدخل اسم التكامل.

  4. أدخل URL الويب هوك الهدف.

  5. إذا كان مطلوبًا، قم بتكوين الإعدادات المتقدمة:

    • Request method: POST or PUT. By default, POST requests are sent.
    • Request header and its value if the server requires a non-standard header to execute the request. The number of headers is not limited.
    • CA certificate: certificate of CA that signed a server certificate. If CA is publicly trusted, this field is optional. If a server certificate is self-signed, this field is required and must contain a certificate of your own CA that signed a server certificate.
    • Verify TLS certificate: this setting allows to disable verification of the specified server certificate. By default, Wallarm verifies whether a server certificate is signed by a publicly trusted CA. We do not recommend disabling the verification of production server certificates. If your server uses a self-signed TLS certificate, you can add a self-signed CA certificate to allow sending requests to this server.
    • Request timeout, in seconds: if the server does not respond to the request within the specified time, the request fails. By default: 15 seconds.
    • Connection timeout, in seconds: if the connection to the server cannot be established during the specified time, the request fails. By default: 20 seconds.
    • Wallarm data format: either a JSON Array (default) or a New Line Delimited JSON (NDJSON).

    مثال على الإعدادات المتقدمة

  6. اختر أنواع الأحداث لتحفيز الإشعارات.

    تكامل الويب هوك

    تفاصيل حول الأحداث المتاحة:

    • Hits detected except for:

    • System related:

    • Vulnerabilities detected, all by default or only for the selected risk level(s) - high, medium or low.
    • Rules and triggers changed (creating, updating, or deleting the rule or trigger)
    • On an hourly basis, you can get a notification with the number of requests processed during the previous hour
  7. انقر على اختبار التكامل للتحقق من صحة الإعدادات، وتوفر سحابة Wallarm، وتنسيق الإشعارات. يتم دائمًا إرسال الإشعارات الاختبارية بتنسيق JSON Array، حتى إذا تم اختيار New Line Delimited JSON (NDJSON).

  8. انقر إضافة التكامل.

إعداد التنبيهات الإضافية

Besides the notifications you have already set up through the integration card, Wallarm triggers allow you to select additional events for notifications:

For condition detailing, you can add one or more filters. As soon, as condition and filters are set, select the integration through which the selected alert should be sent. You can select several integrations simultaneously.

Choosing an integration

مثال: الإشعار إلى URL الويب هوك إذا تمت إضافة عنوان IP إلى القائمة السوداء

إذا تمت إضافة عنوان IP إلى القائمة السوداء، سيتم إرسال الويب هوك حول هذا الحدث إلى URL الويب هوك.

مثال على المحفز لـIP القائمة السوداء

لاختبار المحفز:

  1. افتح وحدة تحكم Wallarm → قوائم IPالقائمة السوداء وأضف عنوان IP إلى القائمة السوداء. على سبيل المثال:

    إضافة IP إلى القائمة السوداء

  2. تحقق من أن ال̉ويب هوك التالي تم إرساله إلى URL الويب هوك:

    [
        {
            "summary": "[Wallarm] Trigger: New IP address was denylisted",
            "description": "Notification type: ip_blocked\n\nIP address 1.1.1.1 was denylisted until 2021-06-10 02:27:15 +0300 for the reason Produces many attacks. You can review blocked IP addresses in the \"Denylist\" section of Wallarm Console.\nThis notification was triggered by the \"Notification about denylisted IP\" trigger. The IP is blocked for the application Application #8.\n\nClient: TestCompany\nCloud: EU\n",
            "details": {
            "client_name": "TestCompany",
            "cloud": "EU",
            "notification_type": "ip_blocked",
            "trigger_name": "Notification about denylisted IP",
            "application": "Application #8",
            "reason": "Produces many attacks",
            "expire_at": "2021-06-10 02:27:15 +0300",
            "ip": "1.1.1.1"
            }
        }
    ]
    
    • Notification about denylisted IP هو اسم المحفز
    • TestCompany هو اسم حساب شركتك في وحدة تحكم Wallarm
    • EU هو Wallarm Cloud حيث تم تسجيل حساب شركتك

تعطيل وحذف التكامل

You can delete or temporarily disable the integration. While deleting stops sending notificatioins and completely deletes all configuration, disabling just stops sending notifications which you can at any moment re-enable with the same settings.

If for the integration the System related events are selected to trigger notifications, Wallarm will notify about both of these actions.

عدم توفر النظام ومعلمات التكامل غير الصحيحة

Notifications to the system are sent via requests. If the system is unavailable or integration parameters are configured incorrectly, the error code is returned in the response to the request.

If the system responds to Wallarm request with any code other than 2xx, Wallarm resends the request with the interval until the 2xx code is received:

  • The first cycle intervals: 1, 3, 5, 10, 10 seconds

  • The second cycle intervals: 0, 1, 3, 5, 30 seconds

  • The third cycle intervals: 1, 1, 3, 5, 10, 30 minutes

If the percentage of unsuccessful requests reaches 60% in 12 hours, the integration is automatically disabled. If you receive system notifications, you will get a message about automatically disabled integration.