projectdiscovery · ehsandeep · Apr 16, 2021 · Feb 15, 2021 · Feb 15, 2021 · Feb 15, 2021
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,34 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # Maintain dependencies for go modules
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  # Maintain dependencies for docker
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -6,27 +6,18 @@ on:
   pull_request:
 
 jobs:
-  lint:
-    name: golangci-lint
+  golangci-lint:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Run golangci-lint
-        uses: golangci/golangci-lint-action@v2.2.0
+        uses: golangci/golangci-lint-action@v2.4.0
         with:
           # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
           version: v1.31
           args: --timeout 5m
 
-          # Optional: working directory, useful for monorepos
-          # working-directory: somedir
-
-          # Optional: golangci-lint command line arguments.
-          # args: --issues-exit-code=0
-
-          # Optional: show only new issues if it's a pull request. The default value is `false`.
-          # only-new-issues: true
   build:
     name: Build
     runs-on: ubuntu-latest
@@ -41,8 +32,8 @@ jobs:
 
       - name: Test
         run: go test .
-        working-directory: .
+        working-directory: cmd/simplehttpserver
 
       - name: Build
         run: go build .
-        working-directory: .
+        working-directory: cmd/simplehttpserver/
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
 *.exe
-simplehttpserver
+cmd/simplehttpserver/simplehttpserver
diff --git a/.golangci.yml b/.golangci.yml
@@ -41,8 +41,6 @@ linters-settings:
           - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
   # lll:
   #   line-length: 140
-  maligned:
-    suggest-new: true
   misspell:
     locale: US
   nolintlint:
@@ -73,14 +71,12 @@ linters:
     - gosimple
     - govet
     - ineffassign
-    - interfacer
-    - maligned
     - misspell
     - nakedret
     - noctx
     - nolintlint
     - rowserrcheck
-    - scopelint
+    - exportloopref
     - staticcheck
     - structcheck
     - stylecheck

diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -1,6 +1,6 @@
 builds:
     - binary: simplehttpserver
-      main: simplehttpserver.go
+      main: cmd/simplehttpserver/simplehttpserver.go
       goos:
         - linux
         - windows

diff --git a/Dockerfile b/Dockerfile
@@ -1,8 +1,9 @@
-FROM golang:1.14-alpine AS builder
+FROM golang:1.16-alpine AS builder
 RUN apk add --no-cache git
-RUN GO111MODULE=auto go get -u -v github.com/projectdiscovery/simplehttpserver
+RUN GO111MODULE=auto go get -u -v github.com/projectdiscovery/simplehttpserver/cmd/simplehttpserver
 
 FROM alpine:latest
+RUN apk add --no-cache bind-tools ca-certificates
 COPY --from=builder /go/bin/simplehttpserver /usr/local/bin/
 
 ENTRYPOINT ["simplehttpserver"]
diff --git a/README.md b/README.md
@@ -1,65 +1,44 @@
-<h1 align="center">
-  <img src="static/simplehttpserver-logo.png" alt="simplehttpserver" width="200px"></a>
-  <br>
-</h1>
+<h1 align="center">SimpleHTTPserver</h1>
+<h4 align="center">Go alternative of python SimpleHTTPServer</h4>
 
-[![License](https://img.shields.io/badge/license-MIT-_red.svg)](https://opensource.org/licenses/MIT)
-[![Go Report Card](https://goreportcard.com/badge/github.com/projectdiscovery/simplehttpserver)](https://goreportcard.com/report/github.com/projectdiscovery/simplehttpserver)
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/projectdiscovery/simplehttpserver/issues)
-[![GitHub Release](https://img.shields.io/github/release/projectdiscovery/simplehttpserver)](https://github.com/projectdiscovery/simplehttpserver/releases)
-[![Follow on Twitter](https://img.shields.io/twitter/follow/pdiscoveryio.svg?logo=twitter)](https://twitter.com/pdiscoveryio)
-[![Docker Images](https://img.shields.io/docker/pulls/projectdiscovery/simplehttpserver.svg)](https://hub.docker.com/r/projectdiscovery/simplehttpserver)
-[![Chat on Discord](https://img.shields.io/discord/695645237418131507.svg?logo=discord)](https://discord.gg/KECAGdH)
 
-simplehttpserver is a go enhanced version of the well known python simplehttpserver.
+<p align="center">
+<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-_red.svg"></a>
+<a href="https://github.com/projectdiscovery/simplehttpserver/issues"><img src="https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat"></a>
+<a href="https://goreportcard.com/badge/github.com/projectdiscovery/simplehttpserver"><img src="https://goreportcard.com/badge/github.com/projectdiscovery/simplehttpserver"></a>
+<a href="https://hub.docker.com/r/projectdiscovery/simplehttpserver"><img src="https://img.shields.io/docker/pulls/projectdiscovery/simplehttpserver.svg"></a>
+<a href="https://twitter.com/pdiscoveryio"><img src="https://img.shields.io/twitter/follow/pdiscoveryio.svg?logo=twitter"></a>
+<a href="https://discord.gg/projectdiscovery"><img src="https://img.shields.io/discord/695645237418131507.svg?logo=discord"></a>
+</p>
 
-# Resources
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#installing-simplehttpserver">Installation</a> •
+  <a href="#running-simplehttpserver-in-the-current-folder">Run SimpleHTTPserver</a> •
+  <a href="https://discord.gg/projectdiscovery">Join Discord</a>
+</p>
 
-- [Features](#features)
-- [Usage](#usage)
-- [Installation Instructions](#installation-instructions)
-- [Running simplehttpserver](#running-simplehttpserver-in-the-current-folder )
-- [Thanks](#thanks)
-
-# Features
-
-<h1 align="left">
-  <img src="static/simplehttpserver-run.png" alt="simplehttpserver" width="700px"></a>
-  <br>
-</h1>
-
- - File server in arbitrary directory
- - Full request/response dump
- - Configurable ip address and listening port
-
-
-# Installation Instructions
+---
 
+SimpleHTTPserver is a go enhanced version of the well known python simplehttpserver with in addition a fully customizable TCP server, both supporting TLS.
 
-### From Binary
 
-The installation is easy. You can download the pre-built binaries for your platform from the [Releases](https://github.com/projectdiscovery/simplehttpserver/releases/) page. Extract them using tar, move it to your `$PATH`and you're ready to go.
+# Features
 
-```sh
-Download latest binary from https://github.com/projectdiscovery/simplehttpserver/releases
+- HTTPS support
+- File server in arbitrary directory
+- Full request/response dump
+- Configurable ip address and listening port
+- Configurable HTTP/TCP server with customizable response via YAML template
 
-▶ tar -xvf simplehttpserver-linux-amd64.tar
-▶ mv simplehttpserver-linux-amd64 /usr/local/bin/simplehttpserver
-▶ simplehttpserver -h
-```
 
-### From Source
+# Installing SimpleHTTPserver
 
-simplehttpserver requires **go1.14+** to install successfully. Run the following command to get the repo - 
+SimpleHTTPserver requires **go1.14+** to install successfully. Run the following command to get the repo - 
 
 ```sh
-▶ GO111MODULE=on go get -v github.com/projectdiscovery/simplehttpserver
-```
-
-### From Github
-
-```sh
-▶ git clone https://github.com/projectdiscovery/simplehttpserver.git; cd simplehttpserver; go build; mv simplehttpserver /usr/local/bin/; simplehttpserver -h
+▶ GO111MODULE=on go get -v github.com/projectdiscovery/cmd/simplehttpserver
 ```
 
 # Usage
@@ -70,11 +49,23 @@ simplehttpserver -h
 
 This will display help for the tool. Here are all the switches it supports.
 
-| Flag   | Description                                          | Example                                 |
-| ------ | ---------------------------------------------------- | --------------------------------------- |
-| listen | Configure listening ip:port (default 127.0.0.1:8000) | simplehttpserver -listen 127.0.0.1:8000 |
-| path   | Fileserver folder (default current directory)        | simplehttpserver -path /var/docs        |
-| v      | Verbose (dump request/response, default false)       | simplehttpserver -v                     |
+| Flag        | Description                                                          | Example                                           |
+| ----------- | -------------------------------------------------------------------- | ------------------------------------------------- |
+| listen      | Configure listening ip:port (default 127.0.0.1:8000)                 | simplehttpserver -listen 127.0.0.1:8000           |
+| path        | Fileserver folder (default current directory)                        | simplehttpserver -path /var/docs                  |
+| verbose     | Verbose (dump request/response, default false)                       | simplehttpserver -v                               |
+| tcp         | TCP server (default 127.0.0.1:8000)                                  | simplehttpserver -tcp 127.0.0.1:8000              |
+| tls         | Enable TLS for TCP server                                            | simplehttpserver -tls                             |
+| rules       | File containing yaml rules                                           | simplehttpserver -rules rule.yaml                 |              |
+| upload      | Enable file upload in case of http server                            | simplehttpserver -upload                          |
+| https       | Enable HTTPS in case of http server                                  | simplehttpserver -https                           |
+| cert        | HTTPS/TLS certificate (self generated if not specified)              | simplehttpserver -cert cert.pem                   |
+| key         | HTTPS/TLS certificate private key (self generated if not specified)  | simplehttpserver -key cert.key                    |
+| domain      | Domain name to use for the self-generated certificate                | simplehttpserver -domain projectdiscovery.io      |
+| basic-auth  | Basic auth (username:password)                                       | simplehttpserver -basic-auth user:password        |
+| realm       | Basic auth message                                                   | simplehttpserver -realm "insert the credentials"  |
+| version     | Show version                                                         | simplehttpserver -version                         |
+| silent      | Show only results                                                    | simplehttpserver -silent                          |
 
 ### Running simplehttpserver in the current folder  
 
@@ -87,6 +78,91 @@ This will run the tool exposing the current directory on port 8000
 2021/01/11 21:41:15 [::1]:50181 "GET /favicon.ico HTTP/1.1" 404 19
 ```
 
+### Running simplehttpserver in the current folder with HTTPS
+
+This will run the tool exposing the current directory on port 8000 over HTTPS with user provided certificate:
+
+```sh
+▶ simplehttpserver -https -cert cert.pen -key cert.key
+2021/01/11 21:40:48 Serving . on http://0.0.0.0:8000/...
+2021/01/11 21:41:15 [::1]:50181 "GET / HTTP/1.1" 200 383
+2021/01/11 21:41:15 [::1]:50181 "GET /favicon.ico HTTP/1.1" 404 19
+```
+
+Instead, to run with self-signed certificate and specific domain name:
+```sh
+▶ simplehttpserver -https -domain localhost
+2021/01/11 21:40:48 Serving . on http://0.0.0.0:8000/...
+2021/01/11 21:41:15 [::1]:50181 "GET / HTTP/1.1" 200 383
+2021/01/11 21:41:15 [::1]:50181 "GET /favicon.ico HTTP/1.1" 404 19
+```
+
+### Running simplehttpserver with basic auth and file upload
+
+This will run the tool and will request the user to enter username and password before authorizing file uploads
+
+```sh
+▶ simplehttpserver -basic-auth root:root -upload
+2021/01/11 21:40:48 Serving . on http://0.0.0.0:8000/...
+```
+
+To upload files use the following curl request with basic auth header:
+```sh
+▶ curl -v --user 'root:root' --upload-file file.txt http://localhost:8000/file.txt
+```
+
+### Running TCP server with custom responses
+
+This will run the tool as TLS TCP server and enable custom responses based on YAML templates:
+
+```sh
+▶ simplehttpserver -rule rules.yaml -tcp -tls -domain localhost
+```
+
+The rules are written as follows:
+```yaml
+rules:
+  - match: regex
+    response: response data
+```
+
+For example to handle two different paths simulating an HTTP server or SMTP commands:
+```yaml
+rules:
+  # HTTP Requests
+  - match: GET /path1
+    response: |
+              HTTP/1.0 200 OK
+              Server: httpd/2.0
+              x-frame-options: SAMEORIGIN
+              x-xss-protection: 1; mode=block
+              Date: Fri, 16 Apr 2021 14:30:32 GMT
+              Content-Type: text/html
+              Connection: close
+
+              <HTML><HEAD><script>top.location.href='/Main_Login.asp';</script>
+              </HEAD></HTML>
+  - match: GET /path2
+    response: |
+              HTTP/1.0 404 OK
+              Server: httpd/2.0
+
+              <HTML><HEAD></HEAD><BODY>Not found</BODY></HTML>
+  # SMTP Commands
+  - match: "EHLO example.com"
+    response: |
+              250-localhost Nice to meet you, [127.0.0.1]
+              250-PIPELINING
+              250-8BITMIME
+              250-SMTPUTF8
+              250-AUTH LOGIN PLAIN
+              250 STARTTLS
+  - match: "MAIL FROM: <noreply@example.com>"
+    response: 250 Accepted
+  - match: "RCPT TO: <test@example.com>"
+    response: 250 Accepted
+```
+
 # Thanks
 
-simplehttpserver is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team. Community contributions have made the project what it is. See the **[Thanks.md](https://github.com/projectdiscovery/simplehttpserver/blob/master/THANKS.md)** file for more details.
+SimpleHTTPserver is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team.
diff --git a/cmd/simplehttpserver/simplehttpserver.go b/cmd/simplehttpserver/simplehttpserver.go
@@ -0,0 +1,20 @@
+package main
+
+import (
+	"github.com/projectdiscovery/gologger"
+	"github.com/projectdiscovery/simplehttpserver/internal/runner"
+)
+
+func main() {
+	// Parse the command line flags and read config files
+	options := runner.ParseOptions()
+	r, err := runner.New(options)
+	if err != nil {
+		gologger.Fatal().Msgf("Could not create runner: %s\n", err)
+	}
+
+	if err := r.Run(); err != nil {
+		gologger.Info().Msgf("%s\n", err)
+	}
+	defer r.Close() //nolint
+}
diff --git a/go.mod b/go.mod
@@ -1,3 +1,10 @@
 module github.com/projectdiscovery/simplehttpserver
 
-go 1.15
+go 1.14
+
+require (
+	github.com/phayes/freeport v0.0.0-20180830031419-95f893ade6f2
+	github.com/projectdiscovery/gologger v1.1.4
+	github.com/projectdiscovery/sslcert v0.0.0-20210416140253-8f56bec1bb5e
+	gopkg.in/yaml.v2 v2.4.0
+)