https://github.com/ccding/go-stun

A go implementation of the STUN client (RFC 3489 and RFC 5389)
https://github.com/ccding/go-stun

go golang nat-traversal rfc-5389 stun webrtc

Last synced: 2 days ago
JSON representation

A go implementation of the STUN client (RFC 3489 and RFC 5389)

• Host: GitHub
• URL: https://github.com/ccding/go-stun
• Owner: ccding
• License: apache-2.0
• Created: 2013-08-17T22:16:33.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-01T17:54:45.000Z (5 months ago)
• Last Synced: 2024-11-26T05:04:35.403Z (16 days ago)
• Topics: go, golang, nat-traversal, rfc-5389, stun, webrtc
• Language: Go
• Homepage:
• Size: 116 KB
• Stars: 680
• Watchers: 17
• Forks: 120
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-go - go-stun - Go implementation of the STUN client (RFC 3489 and RFC 5389). (Networking / Transliteration)
• zero-alloc-awesome-go - go-stun - Go implementation of the STUN client (RFC 3489 and RFC 5389). (Networking / Transliteration)
• awesome-webrtc - go-stun - A go implementation of the STUN client (RFC 3489 and RFC 5389). (Stun & Turn / C/C++)
• awesome-go - go-stun - A go implementation of the STUN client (RFC 3489 and RFC 5389) - ★ 273 (Networking)
• awesome-go-extra - go-stun - 08-17T22:16:33Z|2022-04-19T04:23:30Z| (Networking / Uncategorized)
• awesome-go-zh - go-stun

README

        
go-stun

=======

[![License](https://img.shields.io/badge/License-Apache%202.0-red.svg)](https://opensource.org/licenses/Apache-2.0)

[![GoDoc](https://godoc.org/github.com/ccding/go-stun?status.svg)](http://godoc.org/github.com/ccding/go-stun/stun)

[![Go Report Card](https://goreportcard.com/badge/github.com/ccding/go-stun)](https://goreportcard.com/report/github.com/ccding/go-stun)

go-stun is a STUN (RFC 3489, 5389) client implementation in golang

(a.k.a. UDP hole punching).

[RFC 3489](https://tools.ietf.org/html/rfc3489):

STUN - Simple Traversal of User Datagram Protocol (UDP)

Through Network Address Translators (NATs)

[RFC 5389](https://tools.ietf.org/html/rfc5389):

Session Traversal Utilities for NAT (STUN)

### Use the Command Line Tool

Simply run these commands (if you have installed golang and set `$GOPATH`)

```

go get github.com/ccding/go-stun

go-stun

```

or clone this repo and run these commands

```

go build

./go-stun

```

You will get the output like

```

NAT Type: Full cone NAT

External IP Family: 1

External IP: 166.111.4.100

External Port: 23009

```

You can use `-s` flag to use another STUN server, and use `-v` to work on

verbose mode.

```bash

> ./go-stun --help

Usage of ./go-stun:

  -s string

        server address (default "stun1.l.google.com:19302")

  -v    verbose mode

```

### Use the Library

The library `github.com/ccding/go-stun/stun` is extremely easy to use -- just

one line of code.

```go

import "github.com/ccding/go-stun/stun"

func main() {

	nat, host, err := stun.NewClient().Discover()

}

```

More details please go to `main.go` and [GoDoc](http://godoc.org/github.com/ccding/go-stun/stun)