https://github.com/mwyvr/knockr

A port-knocking utility implemented in Go.
https://github.com/mwyvr/knockr

go golang network port-knock port-knockers port-knocking security-tools

Last synced: 5 days ago
JSON representation

A port-knocking utility implemented in Go.

• Host: GitHub
• URL: https://github.com/mwyvr/knockr
• Owner: mwyvr
• License: mit
• Created: 2023-02-21T06:55:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-29T16:37:59.000Z (7 months ago)
• Last Synced: 2024-08-01T13:19:45.920Z (3 months ago)
• Topics: go, golang, network, port-knock, port-knockers, port-knocking, security-tools
• Language: Go
• Homepage:
• Size: 30.3 KB
• Stars: 42
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - mwyvr/knockr - A port-knocking utility implemented in Go. (Go)

README

        
# knockr

`knockr` is a [port-knocking](https://en.wikipedia.org/wiki/Port_knocking)

utility potentially more convenient to use than a general purpose tool like 

`nmap` or `netcat`. Written in Go, the utility is a single binary, installable 

on any platform Go supports including Linux, BSD/Unix, Windows and Mac.

## Installation

### Via the Go tool chain

    go install github.com/mwyvr/knockr@latest

**Linux without** `glibc`: The Go `net` package includes CGO bindings; Linux

distributions not based on `glibc` such as [Alpine

Linux](https://www.alpinelinux.org/), [Chimera

Linux](https://chimera-linux.org/) or [Void Linux](https://voidlinux.org/)

(`musl` variant) can install a statically linked version with:

    CGO_ENABLED=0 go install github.com/mwyvr/knockr@latest

### Other Install Options 

**Pre-built binary for Linux**:

The [releases page](https://github.com/mwyvr/knockr/releases)

provides a link to a non CGO-based binary that will run on various

Linux distributions.

## Usage

*The default timeout and delay durations should be sufficient for

most use cases.*

    Usage: knockr [OPTIONS] address port1,port2...

    -d duration

            delay between knocks (default 100ms)

    -n string

            network protocol (default "tcp")

    -s	silent: suppress all but error output

    -t duration

            timeout for each knock (default 1.5s)

    Example:

    # knock on three ports using the default protocol (tcp) and delays

    knockr my.host.name 1234,8923,1233

**Tip**: Include the port(s) you expect to be unlocked as the first and last

port in the chain to observe status before and after. For example, if intending

to unlock port 22 (ssh) on a specific host:

    # 22 last to demonstrate it has been opened

    knockr my.host.name 1234,18923,1233,22

## What is port-knocking?

Port-knocking is a network access method that opens ports normally left closed

to the outside world, but only when the right sequence of ports has been

visited and within time frames determined by your network access configuration.

That sequence of ports acts as a key.

knockr is the remote side of the solution; a network access device like a

router must be configured.

Port-knocking can be configured on hosts and many routers including some

low-cost, high functionality devices accessible to technical consumers such as

[Mikrotik RouterOS devices](https://help.mikrotik.com/docs/display/ROS/Port+knocking).

Typically the solution will be configured such that the target port (not

necessarily specified in the port-knocking requests) are only opened to the IP

address issuing the correct knock sequence, further improving security and

resiliency to exploit, and reducing port-scanning log burden.

See also: [Wikipedia - port-knocking](https://en.wikipedia.org/wiki/Port_knocking).