chiclientip

README

chiclientip

Getting started

Installation

go get gitea.dwysokinski.me/Kichiyaki/chiclientip

Usage

package main

import (
	"log"
	"net/http"

	"gitea.dwysokinski.me/Kichiyaki/chiclientip"
	"github.com/go-chi/chi/v5"
	"github.com/realclientip/realclientip-go"
)

func main() {
	stratXForwardedFor, err := realclientip.NewRightmostNonPrivateStrategy(http.CanonicalHeaderKey("X-Forwarded-For"))
	if err != nil {
		log.Fatalln("realclientip.NewRightmostNonPrivateStrategy", err)
	}
	strat := realclientip.NewChainStrategy(
		stratXForwardedFor,
		realclientip.RemoteAddrStrategy{},
	)

	router := chi.NewRouter()
	router.Use(chiclientip.ClientIP(strat))
	router.Get("/", func(w http.ResponseWriter, r *http.Request) {
		clientIP, _ := chiclientip.ClientIPFromContext(r.Context())
		_, _ = w.Write([]byte(clientIP))
	})

	http.ListenAndServe(":8080", router)
}

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Dawid Wysokiński - contact@dwysokinski.me

Documentation

Index

• func ClientIP(strategy realclientip.Strategy) func(next http.Handler) http.Handler
• func ClientIPFromContext(ctx context.Context) (string, bool)

Functions

func ClientIP

func ClientIP(strategy realclientip.Strategy) func(next http.Handler) http.Handler

ClientIP is a go-chi middleware that derives the client IP from realclientip.Strategy and stores it in the http.Request Context.

func ClientIPFromContext

func ClientIPFromContext(ctx context.Context) (string, bool)

ClientIPFromContext returns the client ip in context.Context if exists.