Documentation
¶
Index ¶
- Constants
- func SessionFingerprintMiddleware(generator *Generator, strict bool) gin.HandlerFunc
- func UpdateFingerprint(s *session.SessionData, fp *DeviceFingerprint)
- func ValidateFingerprint(fp *DeviceFingerprint) error
- type Config
- type DeviceFingerprint
- type Generator
- func (g *Generator) Compare(stored, current *DeviceFingerprint, strict bool) bool
- func (g *Generator) DetectChanges(stored, current *DeviceFingerprint) []string
- func (g *Generator) Generate(c *gin.Context) *DeviceFingerprint
- func (g *Generator) GetConfig() *Config
- func (g *Generator) SetConfig(config *Config)
- type GeneratorOption
- type GeoResolverFunc
Constants ¶
const (
FingerprintKey = "_fingerprint_"
)
Variables ¶
This section is empty.
Functions ¶
func SessionFingerprintMiddleware ¶
func SessionFingerprintMiddleware(generator *Generator, strict bool) gin.HandlerFunc
func UpdateFingerprint ¶
func UpdateFingerprint(s *session.SessionData, fp *DeviceFingerprint)
UpdateFingerprint stores or updates fingerprint in the session this should be called during the login process
func ValidateFingerprint ¶
func ValidateFingerprint(fp *DeviceFingerprint) error
ValidateFingerprint validates a fingerprint structure
Types ¶
type Config ¶
type Config struct {
// IncludeUserAgent determines if User-Agent header should be included
IncludeUserAgent bool `json:"includeUserAgent"`
// IncludeAcceptHeaders determines if Accept-* headers should be included
IncludeAcceptHeaders bool `json:"includeAcceptHeaders"`
// IncludeTimezone determines if timezone should be included
IncludeTimezone bool `json:"includeTimezone"`
// IncludeIPAddress determines if IP address should be included
IncludeIPAddress bool `json:"includeIPAddress"`
// UseIPSubnet determines if IP subnet should be used instead of exact IP
UseIPSubnet bool `json:"useIPSubnet"`
// IncludeGeolocation determines if country detection should be included
IncludeGeolocation bool `json:"includeGeolocation"`
}
Config holds configuration for device fingerprinting
func NewDefaultConfig ¶
func NewDefaultConfig() *Config
NewDefaultConfig creates a default fingerprinting configuration
func NewPrivacyFriendlyConfig ¶
func NewPrivacyFriendlyConfig() *Config
NewPrivacyFriendlyConfig creates a privacy-friendly configuration
func NewStrictConfig ¶
func NewStrictConfig() *Config
NewStrictConfig creates a strict fingerprinting configuration
type DeviceFingerprint ¶
type DeviceFingerprint struct {
UserAgent string `json:"user_agent"`
AcceptLang string `json:"accept_language"`
AcceptEnc string `json:"accept_encoding"`
IPAddress string `json:"ip_address"`
IPSubnet string `json:"ip_subnet"`
Timezone string `json:"timezone"`
Fingerprint string `json:"fingerprint"` // SHA256 hash of components
Location string `json:"location"`
CreatedAt int64 `json:"created_at"`
}
DeviceFingerprint represents a unique device identifier
func GetFingerprint ¶
func GetFingerprint(c *gin.Context) *DeviceFingerprint
GetFingerprint fetch fingerprint from session if exists
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
Generator generates device fingerprints from HTTP requests
func NewGenerator ¶
func NewGenerator(config *Config, opts ...GeneratorOption) *Generator
NewGenerator creates a new device fingerprint generator
func (*Generator) Compare ¶
func (g *Generator) Compare(stored, current *DeviceFingerprint, strict bool) bool
Compare compares two device fingerprints with configurable strictness
func (*Generator) DetectChanges ¶
func (g *Generator) DetectChanges(stored, current *DeviceFingerprint) []string
DetectChanges analyzes differences between fingerprints and returns change flags
func (*Generator) Generate ¶
func (g *Generator) Generate(c *gin.Context) *DeviceFingerprint
Generate creates a device fingerprint from a Gin context
type GeneratorOption ¶
type GeneratorOption func(*Generator)
func WithGeoResolver ¶
func WithGeoResolver(geoResolver GeoResolverFunc) GeneratorOption
WithGeoResolver specify custom function to resolve ipaddr -> location
type GeoResolverFunc ¶
GeoResolverFunc convert ip address in location info
Source Files