Anubis module for Caddy
1package caddy_anubis
2
3import (
4 "crypto/ed25519"
5 "encoding/hex"
6 "fmt"
7 "net"
8 "net/http"
9 "strconv"
10
11 "github.com/TecharoHQ/anubis"
12 libanubis "github.com/TecharoHQ/anubis/lib"
13 "github.com/caddyserver/caddy/v2"
14 "github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
15 "github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
16 "github.com/caddyserver/caddy/v2/modules/caddyhttp"
17 "go.uber.org/zap"
18)
19
20func init() {
21 caddy.RegisterModule(AnubisMiddleware{})
22 httpcaddyfile.RegisterHandlerDirective("anubis", parseCaddyfileHandler)
23 httpcaddyfile.RegisterDirectiveOrder("anubis", httpcaddyfile.Before, "push")
24}
25
26func (AnubisMiddleware) CaddyModule() caddy.ModuleInfo {
27 return caddy.ModuleInfo{
28 ID: "http.handlers.anubis",
29 New: func() caddy.Module { return new(AnubisMiddleware) },
30 }
31}
32
33type AnubisMiddleware struct {
34 Options libanubis.Options `json:"options"`
35 PolicyFname string `json:"policy_fname,omitempty"`
36 DefaultDifficulty int `json:"default_difficulty,omitempty"`
37
38 anubis *libanubis.Server
39 log *zap.Logger
40 next caddyhttp.Handler
41 err error
42}
43
44// Interface guards
45var (
46 _ caddyhttp.MiddlewareHandler = (*AnubisMiddleware)(nil)
47 _ caddyfile.Unmarshaler = (*AnubisMiddleware)(nil)
48 _ caddy.Provisioner = (*AnubisMiddleware)(nil)
49)
50
51func (m *AnubisMiddleware) Provision(ctx caddy.Context) error {
52 m.log = ctx.Logger()
53 m.Options.Logger = ctx.Slogger()
54
55 m.log.Debug("loading anubis policies", zap.String("policy_file", m.PolicyFname), zap.Int("default_difficulty", m.DefaultDifficulty))
56 policy, err := libanubis.LoadPoliciesOrDefault(ctx, m.PolicyFname, m.DefaultDifficulty)
57 if err != nil {
58 return fmt.Errorf("failed to load anubis policies from '%s': %w", m.PolicyFname, err)
59 }
60
61 m.Options.Next = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
62 if m.err = m.next.ServeHTTP(w, r); err != nil {
63 m.log.Debug("received error from next handler", zap.Error(err))
64 }
65 })
66 m.Options.Policy = policy
67 m.anubis, err = libanubis.New(m.Options)
68 if err != nil {
69 return err
70 }
71
72 return nil
73}
74
75func (m *AnubisMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error {
76 remoteHost, _, err := net.SplitHostPort(r.RemoteAddr)
77 if err != nil {
78 return err
79 }
80 r.Header.Set("X-Real-Ip", remoteHost)
81
82 m.next = next
83 m.err = nil
84
85 m.anubis.ServeHTTP(w, r)
86 if m.err != nil {
87 return m.err
88 }
89
90 return nil
91}
92
93func (m *AnubisMiddleware) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
94 d.Next()
95
96 m.DefaultDifficulty = anubis.DefaultDifficulty
97 m.Options.CookieExpiration = anubis.CookieDefaultExpirationTime
98 m.Options.CookieSecure = true
99
100 for nesting := d.Nesting(); d.NextBlock(nesting); {
101 var err error
102
103 switch d.Val() {
104 case "difficulty":
105 if !d.Next() {
106 return d.ArgErr()
107 }
108 m.DefaultDifficulty, err = strconv.Atoi(d.Val())
109 if err != nil {
110 return d.WrapErr(err)
111 }
112 case "policy_fname":
113 if !d.Next() {
114 return d.ArgErr()
115 }
116 m.PolicyFname = d.Val()
117 case "private_key":
118 if !d.Next() {
119 return d.ArgErr()
120 }
121 seed, err := hex.DecodeString(d.Val())
122 if err != nil {
123 return d.WrapErr(err)
124 }
125 m.Options.ED25519PrivateKey = ed25519.NewKeyFromSeed(seed)
126 }
127 } // anubis options
128
129 if d.NextArg() {
130 return d.ArgErr()
131 } // too many args
132
133 return nil
134}
135
136func parseCaddyfileHandler(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
137 var m AnubisMiddleware
138 err := m.UnmarshalCaddyfile(h.Dispenser)
139 return &m, err
140}