WMN-Docker

Introduction

Overview

WhatsMyName (WMN) by Micah “WebBreacher” Hoffman was created in 2015 with the goal of discovering usernames on a given website. WMN-Docker creates an API wrapper in a containerized Docker environment around WMN for integration, modularity, and scalability with other open-source intelligence (OSINT) tooling.

Purpose and Key Features

The project offers straightforward functionality to compliment the original intent of WMN while ensuring a basic level of security and bonus features.

Audience

Anyone who conducts OSINT investigations with the need to identify potentially related accounts for a given username. This might include but is not limited to:

Getting Started

Dependencies and Prerequisites

Python
It’s not the most popular coding language for nothing. WMN-Docker requires python 3.10 or greater; however, that should not be much of an issue if all you need is the container. Speaking of containers…

Docker
Docker provides scalability and portability (not to mention it’s in the name). WMN-Docker currently supports docker-compose and docker-compose-v2 during installation; the practical difference being docker-compose up -d versus docker compose up -d when launching the API.

Git (recommended)
If you intend to utilize the GitHub docker compose files and other utilities, the simplest way is to make sure you have git installed.

Installation

There is more then one way to install and utilize WMN-Docker. More advanced users may wish to pull the container image, kodamachameleon/whatsmyname:latest, directly from DockerHub. For the purposes of this documentation we will stick with utilizing the docker compose file in the GitHub repo. Start by cloning the repository.

git clone https://github.com/kodamaChameleon/wmn-docker.git
cd wmn-docker

(Recommended) Use a python virtual environment. Not necessary if all you wish to launch is the Docker API.

python3 -m venv .venv
source .venv/bin/activate

Quick Setup
The quick setup is designed to get you up and running fast. To initialize the local .env and pulls container images from DockerHub use:

python3 client.py --setup

Development
If you are interested in contributing, tweaking, or just closer examination of the code, initialize the local .env and build container from source code with:

python3 client.py --setup dev

User Initialization
By default, authentication is required. If you wish to disble this requirement (not recommended for production environments), set AUTH_REQUIRED=False in your .env file. To initialize the user database and retrieve credentials:

💡 Additional user management features are available from the users.py command line utility inside the container. Just run docker exec -it wmn-api python3 users.py -h

Usage

Basic Functions

The client.py sub-library, utils/api.py, already contains an example python wrapper for API usage. Here are a few more examples to get you started using curl.

Authentication

curl -X POST "http://localhost:8000/api/v1/token" \
     -H "Content-Type: application/json" \
     -d '{"user_id": "your_user_id", "secret": "your_secret"}'

Returns a JSON Web Token (JWT) for use in subsequent calls.

Submit a Username for Lookup

curl -X POST "http://localhost:8000/api/v1/lookup" \
     -H "Authorization: Bearer your_jwt_token" \
     -H "Content-Type: application/json" \
     -d '{"username": "kodamachameleon"}'

Returns a Job ID to lookup results.

Submit Multiple Usernames at Once

curl -X POST "http://localhost:8000/api/v1/batch" \
     -H "Authorization: Bearer your_jwt_token" \
     -H "Content-Type: application/json" \
     -d '{
           "usernames": ["kodamachameleon", "webbreacher"]
         }'

Check Job Status

curl -X GET "http://localhost:8000/api/v1/status/your_job_id" \
     -H "Authorization: Bearer your_jwt_token"

Returns JSON results of username lookup.

Configuration Options

Environment
The .env file creating at setup contains several configuration options for customization to your specific needs. Default values are annotated in parenthesis.

Docker-Compose
WMN-Docker currently requires three separate containers.

Examples and Use Cases

If you are conducting username OSINT and need an API, you likely are enumerating high volumes of usernames, looking to integrate with another service, and/or simply trying to automate your investigative workflow.

Project Structure

Layout

WMN-Docker can be divided into four main categories.

Contributing

Report an Issue

If you encounter a bug, performance issue, or security vulnerability, we encourage you to report it.

Steps to report:

Feature Request and Suggestions

We welcome ideas for improving the project! If you have a feature request or general suggestion:

Submitting Pull Requests

Fork the repository: Click the Fork button at the top-right corner of the project page on GitHub.

Clone your fork:

git clone https://github.com/your-username/wmn-docker.git
cd wmn-docker

Create a Branch
Create a new branch for your changes:

git checkout -b feature/your-feature-name

Make Your Changes
Ensure your changes adhere to the project’s coding style and pass existing tests. Consider adding new tests for any added functionality. Please make sure your code is well-documented. To ensure consistency and code quality, please follow these rules:

Commit Your Changes
Use clear and descriptive commit messages:

git commit -m "Add detailed description of your changes"

Push Your Branch
Push the changes to your forked repository:

git push origin feature/your-feature-name

Create a Pull Request
Once your code is ready for review:

The project maintainers will review your PR and provide feedback as necessary.

Code of Conduct

Our Pledge

We as members, contributors, and leaders pledge to make participation in the project and community a harassment-free experience for everyone, regardless of age, body size, abilities, ethnicity, experience, education, socioeconomic status, nationality, personal appearance, race, or religion.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Our Standards

Examples of behavior that contributes to a positive environment for our community include:

Examples of unacceptable behavior include:

Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

Scope

This Code of Conduct applies within all community spaces, and it also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at contact@kodamachameleon.com. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

Correction

Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

Warning

Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

Temporary Ban

Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

Permanent Ban

Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the project community.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

Advanced Topics

Customization and Extending the Project

Here are a few ideas to get you started with how to customize or extend the project.

Website Username OSINT Enumeration
Using WMN-Docker as an API back end, you could design a custom website in which users enter usernames for lookup. The API retrieves the results and returns them to the web service for display to users.

Personal Discord Bot
Create a Discord (or other messaging service) bot which can query usernames directly from the messaging terminal.

There are many more possibilities then this, and I would love to hear from you! How are you using WMN-Docker?

Performance

It is recommended to allow memory over commit for Redis servers in production. Try sysctl vm.overcommit_memory=1

Troubleshooting & FAQs

Common Issues

A known limitation in WMN-Docker is false positives. WMN primarily relies on common HTTP/HTTPS error codes for determining whether an account exists on a specified website. Some website behaviors treat URI’s differently causing variable results. Future work may attempt to solve this issue; however, the difficulty lies in planning for all the potential edge case scenarios.

Debugging

By default, WMN-Docker saves it’s logs to /var/log/wmn-docker/wmn.log. Note that this location is not mapped to any data volume and will therefore disappear if the container is destroyed or rebuilt. You can also use docker logs to view logs from the containers themselves.

FAQ

Why username OSINT?
Username enumeration exploits a common trait in human psychology, the need for coherency and the desire to be known. Many people use the same username across multiple platforms to avoid having to remember multiple usernames and/or to be recognized as belonging to the same person. This is not a guarantee that the same usernames are in fact the same person. No, I’m not actually on Bandcamp🎺🥁

Why do my results always seem to have errors?
Some of the website configurations stored in WMN may be down or unavailable from your location. You can try using a VPN to change location, but some websites may be gone permanently. If you find this to be the case, you are encouraged to report it to the WMN issues tracker.

License & Credits

License

WMN-Docker inherits the same license from it’s parent project WMN, the Creative Commons Attribution-ShareAlike 4.0 International License. The summary is as follows:

You are free to:

1. Share — copy and redistribute the material in any medium or format for any purpose, even commercially.
2. Adapt — remix, transform, and build upon the material for any purpose, even commercially.
3. The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

1. Attribution — You must give appropriate credit , provide a link to the license, and indicate if changes were made . You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
2. ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
3. No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

Notices:

You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation .

No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.

Acknowledgements

Of course I would like to thank WebBreacher for enabling WMN-Docker through the creation and maintaining of WhatsMyName (WMN). This project was also inspired by work from OSINT Tactical and the now archived GitOSINT_bot.

Related

If you like OSINT username enumeration, these other projects may be of interest to you.