go-proxyproto

A Go library implementation of the PROXY protocol, versions 1 and 2.

Github stars Tracking Chart

go-proxyproto

Build Status
Coverage Status
Go Report Card

A Go library implementation of the PROXY protocol, versions 1 and 2,
which provides, as per specification:

(...) a convenient way to safely transport connection
information such as a client's address across multiple layers of NAT or TCP
proxies. It is designed to require little changes to existing components and
to limit the performance impact caused by the processing of the transported
information.

This library is to be used in one of or both proxy clients and proxy servers that need to support said protocol.
Both protocol versions, 1 (text-based) and 2 (binary-based) are supported.

Installation

$ go get -u github.com/pires/go-proxyproto

Usage

Client (TODO)

Server

package main

import (
	"log"
	"net"
	
	proxyproto "github.com/pires/go-proxyproto"
)

func main() {
	// Create a listener
	addr := "localhost:9876"
	list, err := net.Listen("tcp", addr)
	if err != nil {
		log.Fatalf("couldn't listen to %q: %q\n", addr, err.Error())
	}

	// Wrap listener in a proxyproto listener
	proxyListener := &proxyproto.Listener{Listener: list}
	defer proxyListener.Close()

	// Wait for a connection and accept it
	conn, err := proxyListener.Accept()
	defer conn.Close()

	// Print connection details
	if conn.LocalAddr() == nil {
		log.Fatal("couldn't retrieve local address")
	}
	log.Printf("local address: %q", conn.LocalAddr().String())

	if conn.RemoteAddr() == nil {
		log.Fatal("couldn't retrieve remote address")
	}
	log.Printf("remote address: %q", conn.RemoteAddr().String())
}

Documentation

http://godoc.org/github.com/pires/go-proxyproto

Main metrics

Overview
Name With Ownerpires/go-proxyproto
Primary LanguageGo
Program languageGo (Language Count: 1)
Platform
License:Apache License 2.0
所有者活动
Created At2016-08-26 19:08:54
Pushed At2025-05-15 17:20:41
Last Commit At
Release Count19
Last Release Namev0.8.1 (Posted on 2025-05-03 14:33:43)
First Release Name0.1.0 (Posted on )
用户参与
Stargazers Count537
Watchers Count11
Fork Count117
Commits Count193
Has Issues Enabled
Issues Count51
Issue Open Count8
Pull Requests Count60
Pull Requests Open Count3
Pull Requests Close Count13
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private