credmp / ghosts

A golang version of hed

Go Hosts file editor

A command-line tool to easily manage you hosts file.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Warning: this repository is not yet feature complete, do not use. Please us hed instead.

ghosts allows you to manipulate your hosts file from the command-line. By providing safe and easy commands you can add new hosts and aliases to your environment. This is a rewrite of the tool hed in the Go programming language.

This tool was inspired by my students to whom I teach a Basic Cyber Security class. In this class we utilize Hack The Box as a learning platform and most students struggle with editing the hosts file when they get started. To make this easier for them I wrote a tool that gives them a safe means of adding and removing hosts in this file.

The tool is to be used as an user that can get elevated rights using sudo.

(back to top)

Built With

• Go

(back to top)

Getting Started

Installation

Using go

If you have the go binary installed you can simply install ghosts by running

go get github.com/credmp/ghosts

It will pull in the latest version.

Manual installation

1. Create your local bin directory

   mkdir ~/.local/bin

2. Download the latest binary release

   wget https://github.com/credmp/ghosts/releases/latest/download/ghosts -O ~/.local/bin/ghosts

3. Make it executable

   chmod +x ~/.local/bin/ghosts

4. Ensure the bin directory is in your path

   echo export PATH=\$PATH:~/.local/bin >> ~/.zshrc # if you use zsh
   echo export PATH=\$PATH:~/.local/bin >> ~/.bashrc # if you use bash

(back to top)

Usage

View the current hostsfile

ghosts show will color print the current hosts file.

ghosts show

Output:

#                    This is a comment
127.0.0.1	localhost	
::1	localhost	
127.0.1.1	pop-os.localdomain	pop-os

Add a new entry

ghosts add example.com 127.1.1.1

Will add the following line to the hosts file.

127.1.1.1	example.com

Add a subdomain

ghosts add demo.example.com

Will update the hosts file to add the subdomain to the parent domain as an alias

127.1.1.1	example.com	demo.example.com

Remove a hostname

ghosts delete demo.example.com

If it is the primary name , the shortest alias will be chosen as new name for the host entry. If there are no aliases, the entire record is deleted.

ghosts delete 127.1.1.1

Will remove the entire record even if there are many aliases defined.

Add an alias

ghosts alias demo.example.com arjenwiersma.nl

Add a non-subdomain alias to a hostname. This is useful when a host (ip) has many different hostnames. Instead of adding an entry for every unique top level domain they can be added as aliasses.

Testing

Use the --file parameter to test the features of ghosts on a file that is not your hosts file.

ghosts --file test.txt add example.com 127.0.0.1

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Write your beautiful code
4. Ensure test coverage did not decrease (cargo tarpaulin --verbose --all-features --workspace --timeout 120 --out Lcov)
5. Commit your Changes (git commit -m 'Add some AmazingFeature')
6. Push to the Branch (git push origin feature/AmazingFeature)
7. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

Arjen Wiersma - @credmp - My website

Project Link: https://github.com/credmp/ghosts

(back to top)

Acknowledgments

• My students for showing me that editing a hosts file is not that easy.

(back to top)