ipfilter

README

gogin-ip-filter

IP filter middleware for Gin Web Framework

Usage

import (
    "github.com/gin-gonic/gin"
    "github.com/allape/gogin-ip-filter"
)

func main() {
    prefixes, hosts, err := ip_filter.ReadFile("allowed-ips.txt")
	if err != nil {
        panic(err)
    }
	
    r := gin.Default()
	r.Use(ip_filter.New(prefixes, hosts))
	
	// ...
}

Documentation

Index

• func CanPass(addr string, prefixes []netip.Prefix, hosts []string) (passed bool, prefix *netip.Prefix, host string, err error)
• func New(prefixes []netip.Prefix, hosts []string, onHandle OnHandle) func(ctx *gin.Context)
• func ReadFile(filename string) (prefixes []netip.Prefix, hosts []string, err error)
• func SetupIPFilter(okIPSet []string) (prefixes []netip.Prefix, hosts []string)
• type OnHandle

Functions

func CanPass

func CanPass(addr string, prefixes []netip.Prefix, hosts []string) (passed bool, prefix *netip.Prefix, host string, err error)

func New

func New(prefixes []netip.Prefix, hosts []string, onHandle OnHandle) func(ctx *gin.Context)

New middleware for Gin Web Framework

func ReadFile

func ReadFile(filename string) (prefixes []netip.Prefix, hosts []string, err error)

ReadFile reads the config file and sets up the IP filter. Line starts with # will be ignored It returns the prefixes and hosts that are allowed.

func SetupIPFilter

func SetupIPFilter(okIPSet []string) (prefixes []netip.Prefix, hosts []string)

Types

type OnHandle

type OnHandle func(ctx *gin.Context, passed bool, prefix *netip.Prefix, host string, err error)