KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

Telegram-OSINT-for-Cyber-Threat-Intelligence-Analysis

★ 107 Open GitHub ↗

An OSINT tool tailored for comprehensive collection, analysis, and interpretation of cyber threat intelligence from Telegram channels and groups.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Welcome!
To view more information about the project, visit the [Wiki](https://github.com/kienmarkdo/Telegram-OSINT-for-Cyber-Threat-Intelligence-Analysis/wiki)!

## Quick Setup
**Recommended:** Visit the Wiki's [Set Up Development Environment page](https://github.com/kienmarkdo/Telegram-OSINT-for-Cyber-Threat-Intelligence-Analysis/wiki/Set-Up-Development-Environment) for detailed setup instructions.

### Installations
- Install git https://git-scm.com/downloads
- Install Python *version 3.11 or lower* https://www.python.org/downloads/
- Install SQLite3
    - For Windows 10/11: https://www.sqlite.org/download.html
    - For Linux: `sudo apt install sqlite3`
    - For MacOS: Should already be installed
- Install Elasticsearch and Kibana
   - Elasticsearch: https://www.elastic.co/downloads/elasticsearch
   - Kibana: https://www.elastic.co/downloads/kibana

### Telegram Installation / API Setup
> [!NOTE]
> It is recommended that you use a burner phone number, a burner email address, and a VM to install Telegram Desktop. For more Telegram setup and OPSEC instructions, view the [Wiki](https://github.com/kienmarkdo/Telegram-OSINT-for-Cyber-Threat-Intelligence-Analysis/wiki/Set-Up-Research-Environment).

- Set up a Telegram account on the Telegram app installed on your preferred device
- Navigate to http://my.telegram.org and log in with your phone number
- Navigate to "API development tools" and fill the required fields
    - App title: _anything_
    - URL: www.telegram.org
    - Platform: Desktop
    - Description: _anything_
    - Click "Create application"
- Save "App api_id" and "App api_hash" (to be used in `config.py`)

### Environment Setup
- Create virtual environment
    - `python -m venv venv`
    - Activate venv
        - `source venv/Scripts/activate  # Windows git bash`
        - `source venv/bin/activate  # UNIX` 
    - Deactivate venv
        - `deactivate`
- Download library dependencies
    - `pip install -r requirements.txt`
    - Optional: Download individual dependencies
        - `pip install telethon`
        - `pip install argostranslate`
        - `pip install lingua-language-detector`
        - `pip install requests`
        - `pip install elasticsearch`
        - `pip install ijson`

Create a `configs.py` file. Paste and modify the code below accordingly.
```py
"""
Replace mandatory None values with your info. Ensure correct data types, as specified.
For optional values, replace them with your info as needed. Otherwise, keep values as None.

Configurations:
- Basic configurations           (REQUIRED)
- Collection configurations      (OPTIONAL)
- Elasticsearch configurations   (OPTIONAL)

The file example_configs.py has been created as a guide template.
"""

########################
# Basic configurations #
########################
PHONE_NUMBER: str = None               # (mandatory) (i.e. +12223334444)
API_HASH: str = None                   # (mandatory)
API_ID: int = None                     # (mandatory)

#############################
# Collection configurations #
#############################

# Proxy configuration
PROXIES: list[dict] = None             # (mandatory) default None for no proxy
# Add a each proxy object to the list. Below is an example template for two proxies.
# PROXIES: list[dict] = [
#     {
#         'proxy_type': 'socks5',        # (mandatory) protocol to use (i.e.: socks5)
#         'addr': '',                    # (mandatory) proxy IP address (i.e.: 123.123.123.123)
#         'port': 1080,                  # (mandatory) proxy port number (i.e.: 1080)
#         'username': '',                # (optional) username if the proxy requires auth
#         'password': '',                # (optional) password if the proxy requires auth
#         'rdns': True                   # (optional) whether to use remote or local resolve, default remote
#     },
#     {
#         'proxy_type': '',              # (mandatory) protocol to use (see above)
#         'addr': '',                    # (mandatory) proxy IP address
#         'port': 1080,                  # (mandatory) proxy port number
#         'username': '',                # (optional) username if the proxy requires auth
#         'password': '',                # (optional) password if the proxy requires auth
#         'rdns': True                   # (optional) whether to use remote or local resolve, default remote
#     },
# ]  # uncomment to add proxies

##########################
# Elastic configurations #
##########################
es_username: str = None                # (required) default None
es_password: str = None                # (required) default None
es_ca_cert_path: str = None            # (required) path to 'http_ca.crt' file stored in elasticsearch-<VERSION>/config/certs/http_ca.crt
```

Telegram-OSINT-for-Cyber-Threat-Intelligence-Analysis

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README