- Description
- Usage
2.1. Windows
2.2. Unix - Installation
3.1. Requirements
3.2. Windows Installation
3.3. Unix Installation - Modules
4.1. event
4.2. events
4.3. help
4.4. leaderboard
4.5. profile
4.6. scope
4.7. user
4.8. version - License
This is a (unofficial) utility that works as a client to the Ethiack platform. It allows you to perform multiple operations directly from the command-line.
The tool uses the official Ethiack API and the Ethiack's GraphQL endpoint to access the data it needs.
It contains several modules so you can manage and view information related to your profile, users, leaderboard, events, etc.
After installing, just run python3 ethiack.py to use the utility.
After installing, you can call ethiack directly from the command-line (since a symbolic link will be created during installation) or use python (python3 ethiack.py).
- Python >= 3.10
- Ethiack API Key & Secret (you can get it from here)
-
Open Powershell in the same directory as the project
-
Run the installation file:
.\install.ps1
-
Export the required environment variables (don't forget to replace the values between double quotes):
echo 'ETHIACK_API_KEY="<api-key>"' > .env echo 'ETHIACK_API_SECRET="<api-secret>"' >> .env
or
$env:ETHIACK_API_KEY = "<api-key>" $env:ETHIACK_API_SECRET = "<api-secret>"
-
Open a shell in the same directory as the project
-
Run the installation file:
chmod +x install.sh ./install.sh
-
Export the required environment variables (don't forget to replace the values between double quotes):
echo 'ETHIACK_API_KEY="<api-key>"' > .env echo 'ETHIACK_API_SECRET="<api-secret>"' >> .env
or
export ETHIACK_API_KEY="<api-key>" export ETHIACK_API_SECRET="<api-secret>"
-
Optionally, you can set the environment variables permanently (if you're not using the first option, in the previous process):
(using ZSH shell)
echo 'export ETHIACK_API_KEY="<api-key>"' >> .zshrc echo 'export ETHIACK_API_SECRET="<api-secret>"' >> .zshrc
(using Bash shell)
echo 'export ETHIACK_API_KEY="<api-key>"' >> .bashrc echo 'export ETHIACK_API_SECRET="<api-secret>"' >> .bashrc
event <event> Get information regarding a specific event
events [running] Gets a list of events you're associated with
help Show the help page
leaderboard [country] Hacker leaderboard
profile Your public profile
scope <event> [save] Get the scope of an event
user <user> Get a user's public profile
version Show the utility versionAllows you to get information from an event/program such as its dimension, category, start and end dates, physical location and status.
ethiack event example-p1
Event
----------------------------------------
ID: 1337
Slug: example-p1
Name: Example P1
Dimension: virtual
Category: pentest
Type: human
Start: Sat, 01 Jul 2023 15:00:00 GMT
End: Mon, 31 Jul 2023 18:00:00 GMT
Latitude:
Longitude:
Status: Retesting
----------------------------------------Get a list of all the events you've worked in. You can optionally pass running as a second parameter to only get a list of the running events.
ethiack events
Events
----------------------------------------
ethiack-p1 | Ethiack P1
ethiack-p2 | Ethiack P2
example-rt1 | Example RT1
example-p1 | Example P1
----------------------------------------Shows the help page, listing the modules available, their descriptions, and the parameters to be passed.
Displays the leaderboard, detailing the rank position, points, username and country from each hacker. You can optionally pass the country code as a second parameter to only get a list of the leaderboard in that country.
ethiack leaderboard pt
Leaderboard (TOP 6)
----------------------------------------
1. | 31337 | 701 | PT
2. | hackerman | 464 | PT
3. | fidgetspinner | 342 | PT
4. | artihacker | 320 | PT
5. | ethiacker | 237 | PT
6. | newbie | 73 | PT
----------------------------------------Displays information from your profile in Ethiack. This contains data such as username, name, rank, points, VAT, role, entity type, join date, country and URL to portal.
ethiack profile
Profile
----------------------------------------
Username: hackerman
Name: Hacker Man
Rank: #2 (TOP 3)
Points: 464.48
Role: hacker
Joined at: 2023-06-08T22:52:18
Country: PT
URL: https://portal.ethiack.com/hackerman
----------------------------------------Displays the scope of an event - in-scope and out-of-scope assets - such as domains, URLs, IP addresses, CIDR addresses, and wildcards. Optionally, you can pass the extra parameter save to save all the domains, IP addresses, URLs and wildcard domains to a text file inscope.txt and outofscope.txt.
ethiack scope example-p1 save
Scope (example-p1)
----------------------------------------
In-Scope
--------------------------------------
*.example.com | domain
qa.example.com | domain | https://qa.example.com/juicy/
dev.example.com | domain | https://dev.example.com/juicy/
Out-of-Scope
--------------------------------------
prod.example.com | domain
File 'inscope.txt' saved!
File 'outofscope.txt' saved!The file inscope.txt will contain the following content:
*.example.com
qa.example.com
dev.example.comShows information from a user (can be a hacker, triager or an organization member or account). This contains data such as username, rank, points, role, entity type, join date, country and URL to portal.
ethiack user newbie
User
----------------------------------------
Username: newbie
Rank: #6 (TOP 10)
Points: 73.50
Role: hacker
Joined at: 2023-09-08T15:30:18
Country: PT
URL: https://portal.ethiack.com/newbie
----------------------------------------Display the utility version.
ethiack version
ethiack-cli v1.0.1License is available here.