├── images
├── ossec_log.PNG
├── Email Banner.png
├── wazuh_hits.PNG
├── graylog_response.PNG
├── logo_purple_resize.png
└── logo_orange.svg
├── LICENSE
├── README.md
└── custom-socfortress.py
/images/ossec_log.PNG:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/HEAD/images/ossec_log.PNG
--------------------------------------------------------------------------------
/images/Email Banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/HEAD/images/Email Banner.png
--------------------------------------------------------------------------------
/images/wazuh_hits.PNG:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/HEAD/images/wazuh_hits.PNG
--------------------------------------------------------------------------------
/images/graylog_response.PNG:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/HEAD/images/graylog_response.PNG
--------------------------------------------------------------------------------
/images/logo_purple_resize.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/HEAD/images/logo_purple_resize.png
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 SOCFortress
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/images/logo_orange.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://www.socfortress.co/)
2 |
3 | # SOCFortress Threat Intel Integration [](https://www.socfortress.co/trial.html)
4 | > Integrate your `Wazuh-Manager` or `Graylog` with the SOCFortress Threat Intel API to receive real-time threat intel.
5 |
6 |
7 | [![MIT License][license-shield]][license-url]
8 | [![LinkedIn][linkedin-shield]][linkedin-url]
9 | [](https://youtu.be/2EMb6zYx7_E)
10 |
11 |
12 |
13 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | # Threat Intel API
47 | > The SOCFortress Threat Intel API allows end users to consume SOCFortress's public threat intel. The integration supports both `Wazuh-Manager` and `Graylog`.
48 |
49 | ## API-KEY
50 | > The API key is required to authenticate with the API. To obtain an API key, please use SOCFortress Copilot.
51 |
52 | ## Criteria
53 | > The API is currently **only** built for the following criteria:
54 | * `Windows Sysmon` - Follow our [Wazuh Agent Install Guide](https://medium.com/@socfortress/part-4-wazuh-agent-install-endpoint-monitoring-f24f6a0464ac) to integrate Sysmon with your Windows endpoints.
55 | * `SOCFortress Wazuh Detection Rules` - Follow our [Wazuh Rules Install Guide](https://github.com/socfortress/Wazuh-Rules) to integrate SOCFortress's Wazuh detection rules with your Wazuh-Manager.
56 | * `IoC Type` - The API currently supports IoC types of `IP`, `Domain`, and `SHA256 Hash`.
57 | * `Valid API Key` - Request via [our website](https://www.socfortress.co/request_threat_intel_api.html).
58 |
59 | > ⚠ **NOTE:** API quotas are currently restricted to `500` requests per day. The API is currently in beta and is subject to change. Please contact us at [helpdesk.socfortress.co](https://servicedesk.socfortress.co/help/2979687893) if you have any questions or concerns.
60 |
61 | * `SOCFortress API Wazuh Rules` - [200980-socfortress.xml](https://raw.githubusercontent.com/socfortress/Wazuh-Rules/main/SOCFortress%20API/200980-socfortress.xml) - **NOT REQUIRED IF INTEGRATING WITH GRAYLOG**
62 |
63 |
64 | # Wazuh-Manager Integration
65 | **Not Recommended - Use Graylog Instead If You Can - Graylog's built in Caching will save your API quota**
66 | > Follow the steps below to integrate the SOCFortress Threat Intel API with your Wazuh-Manager. **NOT REQUIRED IF INTEGRATING WITH GRAYLOG**
67 | 1. Download the `custom-socfortress.py` file from the GitHub repository and copy it to `/var/ossec/integrations` of your `Wazuh-Manager`.
68 |
69 | ```
70 | # Download the custom-socfortress.py file from the GitHub repository
71 | curl -o custom-socfortress.py https://raw.githubusercontent.com/socfortress/SOCFortress-Threat-Intel/main/custom-socfortress.py
72 |
73 | # Copy the custom-socfortress.py file to /var/ossec/integrations
74 | sudo cp custom-socfortress.py /var/ossec/integrations
75 |
76 | # Change ownership to root:wazuh
77 | sudo chown root:wazuh /var/ossec/integrations/custom-socfortress.py
78 |
79 | # Set permissions to -rwxr-x---
80 | sudo chmod 750 /var/ossec/integrations/custom-socfortress.py
81 |
82 | # Clean up the downloaded file
83 | rm custom-socfortress.py
84 | ```
85 |
86 | 2. Edit the `/var/ossec/etc/ossec.conf` file and add the following lines to the `ossec.conf` file.
87 |
88 | ```
89 |
90 | custom-socfortress.py
91 | YOUR_API_KEY
92 | sysmon_event3,sysmon_event_22
93 | json
94 |
95 | ```
96 | > ⚠ **NOTE:** The `group` parameter is the name of the Wazuh rule groups that you want to integrate with the SOCFortress Threat Intel API. All of the below rule groups are supported:
97 | * `sysmon_event3` - Network Connections
98 | * `sysmon_event_22` - DNS Query
99 | * `sysmon_evnt1` - Process Creation
100 | * `sysmon_event6` - Remote Thread Creation
101 | * `sysmon_event7` - Raw Access Read
102 | * `sysmon_event_15` - File Creation Time
103 |
104 | **I only include the `sysmon_event3` and `sysmon_event_22` groups in the example above because the others will likely result in you hitting your API Limit quickly**
105 |
106 |
107 | > The `alert_format` parameter is the format of the alert that you want to receive from the SOCFortress Threat Intel API. The `api_key` parameter is the API key that you received from SOCFortress.
108 |
109 | 3. Restart the Wazuh-Manager service.
110 |
111 | ```
112 | sudo systemctl restart wazuh-manager
113 | ```
114 |
115 | 4. If you have any issues, set the `integrator_debug` to `2` in the `/var/ossec/etc/local_internal_options.conf` file and restart the Wazuh-Manager service.
116 |
117 | * Tail the `ossec.log` file and ensure you see valid responses from the SOCFortress Threat Intel API. `tail -f /var/ossec/logs/ossec.log | grep socfortress`
118 |
119 |