Skip to content

Commit

Permalink
Merge branch 'main' into development
Browse files Browse the repository at this point in the history
  • Loading branch information
yunginnanet committed Jun 20, 2024
2 parents 67877b7 + 35eebac commit 20c41be
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 12 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# HellPot
<div align="center">
<img src="https://tcp.ac/i/00ctL.gif" alt="HellPot"/>

[![GoDoc](https://godoc.org/github.com/yunginnanet/HellPot?status.svg)](https://godoc.org/github.com/yunginnanet/HellPot) [![Go Report Card](https://goreportcard.com/badge/github.com/yunginnanet/HellPot)](https://goreportcard.com/report/github.com/yunginnanet/HellPot) [![IRC](https://img.shields.io/badge/ircd.chat-%23tcpdirect-blue.svg)](ircs://ircd.chat:6697/#tcpdirect) [![Mentioned in Awesome Honeypots](https://awesome.re/mentioned-badge.svg)](https://github.com/paralax/awesome-honeypots)

</div>

## Summary

HellPot is an endless honeypot based on [Heffalump](https://github.com/carlmjohnson/heffalump) that sends unruly HTTP bots to hell.

Notably it implements a [toml configuration file](https://github.com/knadh/koanf), has [JSON logging](https://github.com/rs/zerolog), and comes with significant performance gains.

![Exploding Heffalump](https://tcp.ac/i/H8O9M.gif)

## Grave Consequences

Clients (hopefully bots) that disregard `robots.txt` and connect to your instance of HellPot will **suffer eternal consequences**.
Expand Down
34 changes: 28 additions & 6 deletions internal/config/config.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package config

import (
"errors"
"fmt"
"os"
"path/filepath"
Expand All @@ -24,6 +25,16 @@ var (
snek = viper.New(".")
)

func init() {
home, _ = os.UserHomeDir()
if home == "" {
home = os.Getenv("HOME")
}
if home == "" {
println("WARNING: could not determine home directory")
}
}

// exported generic vars
var (
// Trace is the value of our trace (extra verbose) on/off toggle as per the current configuration.
Expand All @@ -41,8 +52,13 @@ var (
func writeConfig() string {
prefConfigLocation, _ := os.UserConfigDir()

if prefConfigLocation == "" {
home, _ = os.UserHomeDir()
prefConfigLocation = filepath.Join(home, ".config", Title)
}

if _, err := os.Stat(prefConfigLocation); os.IsNotExist(err) {
if err = os.MkdirAll(prefConfigLocation, 0o750); err != nil {
if err = os.MkdirAll(prefConfigLocation, 0o750); err != nil && !errors.Is(err, os.ErrExist) {
println("error writing new config: " + err.Error())
os.Exit(1)
}
Expand Down Expand Up @@ -92,25 +108,31 @@ func Init() {
}

if chosen == "" && uconf != "" {
_ = os.MkdirAll(filepath.Join(uconf, Title), 0750)
chosen = filepath.Join(uconf, Title, "config.toml")
}

if chosen == "" {
pwd, _ := os.Getwd()
if _, err := os.Stat("./config.toml"); err == nil {
chosen = "./config.toml"
} else {
if _, err := os.Stat(filepath.Join(pwd, "config.toml")); err == nil {
chosen = filepath.Join(pwd, "config.toml")
}
}
}

if chosen == "" {
loadErr := snek.Load(file.Provider(chosen), toml.Parser())

if chosen == "" || loadErr != nil {
println("No configuration file found, writing new configuration file...")
chosen = writeConfig()
}

Filename = chosen

if err := snek.Load(file.Provider(chosen), toml.Parser()); err != nil {
println("Error opening specified config file: " + chosen)
println(err.Error())
if loadErr = snek.Load(file.Provider(chosen), toml.Parser()); loadErr != nil {
fmt.Println("failed to load default config file: ", loadErr.Error())
os.Exit(1)
}

Expand Down
7 changes: 4 additions & 3 deletions internal/config/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"io"
"os"
"path"
"path/filepath"
"strings"
"time"

Expand All @@ -20,10 +21,10 @@ var (

func prepLogDir() {
logDir = snek.String("logger.directory")
if err := os.MkdirAll(logDir, 0750); err != nil {
println("cannot create log directory: " + logDir + "(" + err.Error() + ")")
os.Exit(1)
if logDir == "" {
logDir = filepath.Join(home, ".local", "share", Title, "logs")
}
_ = os.MkdirAll(logDir, 0750)
}

// StartLogger instantiates an instance of our zerolog loggger so we can hook it in our main package.
Expand Down

0 comments on commit 20c41be

Please sign in to comment.