ngocok

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 24, 2023 License: MIT Imports: 20 Imported by: 0

README

ngocok

ngrok Collaborator Link — yet another Burp Collaborator alternative for free with ngrok.

Prerequisites

  • ngrok authtoken: Authentication token from your ngrok account is required to establish a ngrok tunnel. See Your Authtoken.

[!TIP] If ngrok is already configured on your machine with ngrok config add-authtoken, you can install and run it directly.

That's it!

Installation

[!NOTE] Go version 1.20+ should be installed & configured.

$ go install github.com/dwisiswant0/ngocok@latest
— or

Manually build the executable from the source:

$ git clone https://github.com/dwisiswant0/ngocok ngocok/
$ cd $_
$ go build . # or
$ go install .

Usage

It's quite straightforward. Simply execute ngocok, and you're ready to capture the out-of-band requests!

Here are the supported options:

Flag Description Default
-e/--endpoint ngrok tunnel endpoint ("http" or "tcp") "http"
-t/--token ngrok authentication token ""
--unstrip Unstrip X-Forwarded-{For,Host,Proto} headers false
-o/--output Log incoming requests to a file instead of stdout ""

[!IMPORTANT] Using a -t/--token flag will takes precedence over the NGROK_AUTHTOKEN environment variable, and using NGROK_AUTHTOKEN environment variable will takes precedence over the ngrok config file[?].

Examples

Start a tunnel with default endpoint (HTTP) and use the ngrok authentication token from the config file.

$ ngocok

Start a tunnel with a TCP endpoint.

$ ngocok --endpoint tcp

Start a tunnel with an HTTP endpoint and provide the ngrok authentication token using the -t/--token flag.

$ ngocok --token [authtoken]

Start a tunnel with an HTTP endpoint and use the ngrok authentication token from the NGROK_AUTHTOKEN environment variable.

$ NGROK_AUTHTOKEN="..." ngocok

Start a tunnel with an HTTP endpoint and log incoming requests to a file.

$ ngocok --output /path/to/requests.log

Why is this name?

¯\_(ツ)_/¯
TUKAN NGOCOK

Similar Projects

License

ngocok is made with ♥ by @dwisiswant0 under MIT license. See LICENSE.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL