https://github.com/kasperskylab/opentip-scanner
Open-source file scanner that sends requests and optionally uploads files to OpenTIP.kaspersky.com.
https://github.com/kasperskylab/opentip-scanner
Last synced: 11 months ago
JSON representation
Open-source file scanner that sends requests and optionally uploads files to OpenTIP.kaspersky.com.
- Host: GitHub
- URL: https://github.com/kasperskylab/opentip-scanner
- Owner: KasperskyLab
- License: other
- Created: 2022-05-12T13:35:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T16:09:01.000Z (over 2 years ago)
- Last Synced: 2025-04-13T01:56:00.798Z (about 1 year ago)
- Language: Python
- Size: 19.5 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: License.txt
Awesome Lists containing this project
README
## OpenTIP scanner
The script is a Python 3 client to the [OpenTIP service](https://opentip.kaspersky.com).
It can scan files and directories and provide the category (clean, malware, adware). For unknown files, it will also upload them to the service for scanning and Sandbox processing (optional).
To run the script, you need to obtain a valid API key from [OpenTIP](https://opentip.kaspersky.com/token) and set it with the --apikey command line switch or the OPENTIP\_APIKEY environment variable.
## Building
```
python3 -m build
```
## Installation
Install the package via pip.
```
pip3 install opentip
```
## Command line switches
### OpenTIP file scanner
```
usage: opentip [-h] [--no-upload] [--exclude EXCLUDE] [--log LOG] [--apikey APIKEY] [--quiet] path [path ...]
Check files and directories with OpenTIP.kaspersky.com, optionally upload and scan unknown files
positional arguments:
path File or directory location to scan
optional arguments:
-h, --help show this help message and exit
--no-upload DO NOT upload unknown files to scan with the Sandbox, default behaviour is to upload
--exclude EXCLUDE Do not scan or upload the files matching the pattern
--log LOG Write results to the log file
--apikey APIKEY OpenTIP API key, received from https://opentip.kaspersky.com/token
--quiet Do not log clean files
```
### IOC checker
```
usage: check_iocs [-h] [--apikey APIKEY] [--out OUT] type value
Check IOCS (file hashes, IP addresses, domain names, URLs using the service OpenTIP.kaspersky.com
positional arguments:
type hash, ip, domain, url
value Value of the IOC (hash, ip, domain, url, filename with the iocs)
optional arguments:
-h, --help show this help message and exit
--apikey APIKEY OpenTIP API key, received from https://opentip.kaspersky.com/token
--out OUT, -o OUT Write output as JSON to this filename
```