README
¶
caddy-ja3
A caddy plugin to get JA3 fingerprints from requests as a header.
Building with xcaddy
xcaddy build \
--with github.com/rushiiMachine/caddy-ja3
Sample Caddyfile
Note that this enforces HTTPS (TLS).
You can add a http_redirect to automatically redirect http -> https like shown below.
TLS ClientHellos do not exist on HTTP/3 connections.
No ja3 header will be present on such requests.
Unless another way is used to fingerprint HTTP/3 aka. QUIC connections, it's recommended to disable HTTP/3.
This module also disables TLS session resumption globally to always retrieve a full ClientHello.
This is done through the usage of
caddytls's session_tickets/disabled
config option internally.
{
# If using a different responder like reverse_proxy, change this accordingly
order ja3 before respond
ja3 {
# (Optional) Sort TLS extensions to counteract randomizing on modern browsers
# More info: https://github.com/salesforce/ja3/issues/88
sort_extensions
}
servers {
# Disable HTTP/3
protocols h1 h2
listener_wrappers {
http_redirect
ja3
tls
}
}
}
localhost {
ja3
# Configure your TLS however you want
tls internal
# JA3 fingerprint is added to the request as the "JA3" header
respond "Your JA3: {header.ja3}"
}
Documentation
¶
Index ¶
Constants ¶
const (
CacheAppId = "ja3.cache"
)
const (
ConfigAppId = "ja3.config"
)
Variables ¶
This section is empty.
Functions ¶
func BareToDigestHex ¶
BareToDigestHex converts a bare []byte to a hex string.
func ReadClientHello ¶
ReadClientHello reads as much of a ClientHello as possible and returns it. If any error was encountered, then an error is returned as well and the raw bytes are not a full ClientHello.
Types ¶
type Cache ¶
type Cache struct {
// contains filtered or unexported fields
}
func (Cache) CaddyModule ¶
func (Cache) CaddyModule() caddy.ModuleInfo
CaddyModule implements caddy.Module
type Config ¶
type Config struct {
// This safeguards against TLS order randomization in Chrome by
// ensuring TLS extensions are always in the same order to ensure
// a consistent fingerprint in the end.
SortExtensions bool `json:"sort_extensions"`
}
func (Config) CaddyModule ¶
func (Config) CaddyModule() caddy.ModuleInfo
CaddyModule implements caddy.Module
type JA3Handler ¶
type JA3Handler struct {
// contains filtered or unexported fields
}
func (JA3Handler) CaddyModule ¶
func (JA3Handler) CaddyModule() caddy.ModuleInfo
func (*JA3Handler) Provision ¶
func (h *JA3Handler) Provision(ctx caddy.Context) error
Provision implements caddy.Provisioner
func (*JA3Handler) ServeHTTP ¶
func (h *JA3Handler) ServeHTTP(rw http.ResponseWriter, req *http.Request, next caddyhttp.Handler) error
ServeHTTP implements caddyhttp.MiddlewareHandler
func (*JA3Handler) UnmarshalCaddyfile ¶
func (h *JA3Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
UnmarshalCaddyfile implements caddyfile.Unmarshaler
type JA3ListenerWrapper ¶
type JA3ListenerWrapper struct {
// contains filtered or unexported fields
}
func (JA3ListenerWrapper) CaddyModule ¶
func (JA3ListenerWrapper) CaddyModule() caddy.ModuleInfo
CaddyModule implements caddy.Module
func (*JA3ListenerWrapper) Provision ¶
func (l *JA3ListenerWrapper) Provision(ctx caddy.Context) error
func (*JA3ListenerWrapper) UnmarshalCaddyfile ¶
func (l *JA3ListenerWrapper) UnmarshalCaddyfile(_ *caddyfile.Dispenser) error
UnmarshalCaddyfile implements caddyfile.Unmarshaler
func (*JA3ListenerWrapper) WrapListener ¶
func (l *JA3ListenerWrapper) WrapListener(ln net.Listener) net.Listener
WrapListener implements caddy.ListenerWrapper
Source Files