clientip

Documentation

Overview

Package clientip provides client IP helpers. Package clientip 提供客户端 IP 辅助函数。

Index

• func FromRemote(remoteAddr string) (netip.Addr, bool)
• func FromRequest(r *http.Request, opts Options) (netip.Addr, bool)
• type Options

Functions

func FromRemote

func FromRemote(remoteAddr string) (netip.Addr, bool)

FromRemote parses an IP from remoteAddr. FromRemote 从 remoteAddr 解析 IP。

func FromRequest

func FromRequest(r *http.Request, opts Options) (netip.Addr, bool)

FromRequest returns the client IP for r. Call FromRequest(r, Options{TrustedProxies: ...}) when forwarded headers are trusted. FromRequest 返回 r 的客户端 IP。 需要信任转发头时，调用 FromRequest(r, Options{TrustedProxies: ...})。

Example / 示例:

ip, ok := clientip.FromRequest(r, clientip.Options{})

Types

type Options

type Options struct {
	TrustedProxies []netip.Prefix
}

Options configures forwarded-header trust. Options 配置转发头信任边界。