1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
|
package nfqueue
import (
"context"
"encoding/binary"
"fmt"
"sync"
"time"
"github.com/florianl/go-nfqueue/v2/internal/unix"
"github.com/mdlayher/netlink"
)
var _ Logger = (*devNull)(nil)
// devNull satisfies the Logger interface.
type devNull struct{}
func (dn *devNull) Debugf(format string, args ...interface{}) {}
func (dn *devNull) Errorf(format string, args ...interface{}) {}
// Close the connection to the netfilter queue subsystem
func (nfqueue *Nfqueue) Close() error {
err := nfqueue.Con.Close()
nfqueue.wg.Wait()
return err
}
// SetVerdictWithMark signals the kernel the next action and the mark for a specified package id
func (nfqueue *Nfqueue) SetVerdictWithMark(id uint32, verdict, mark int) error {
buf := make([]byte, 4)
binary.BigEndian.PutUint32(buf, uint32(mark))
attributes, err := netlink.MarshalAttributes([]netlink.Attribute{{
Type: nfQaMark,
Data: buf,
}})
if err != nil {
return err
}
return nfqueue.setVerdict(id, verdict, false, attributes)
}
// SetVerdictWithConnMark signals the kernel the next action and the connmark for a specified package id
func (nfqueue *Nfqueue) SetVerdictWithConnMark(id uint32, verdict, mark int) error {
buf := make([]byte, 4)
binary.BigEndian.PutUint32(buf, uint32(mark))
ctAttrs, err := netlink.MarshalAttributes([]netlink.Attribute{{
Type: ctaMark,
Data: buf,
}})
if err != nil {
return err
}
attributes, err := netlink.MarshalAttributes([]netlink.Attribute{{
Type: netlink.Nested | nfQaCt,
Data: ctAttrs,
}})
if err != nil {
return err
}
return nfqueue.setVerdict(id, verdict, false, attributes)
}
// SetVerdictModPacket signals the kernel the next action for an altered packet
func (nfqueue *Nfqueue) SetVerdictModPacket(id uint32, verdict int, packet []byte) error {
data, err := netlink.MarshalAttributes([]netlink.Attribute{{
Type: nfQaPayload,
Data: packet,
}})
if err != nil {
return err
}
return nfqueue.setVerdict(id, verdict, false, data)
}
// SetVerdictModPacketWithMark signals the kernel the next action and mark for an altered packet
func (nfqueue *Nfqueue) SetVerdictModPacketWithMark(id uint32, verdict, mark int, packet []byte) error {
buf := make([]byte, 4)
binary.BigEndian.PutUint32(buf, uint32(mark))
data, err := netlink.MarshalAttributes([]netlink.Attribute{
{
Type: nfQaPayload,
Data: packet,
},
{
Type: nfQaMark,
Data: buf,
},
})
if err != nil {
return err
}
return nfqueue.setVerdict(id, verdict, false, data)
}
// SetVerdictModPacketWithConnMark signals the kernel the next action and connmark for an altered packet
func (nfqueue *Nfqueue) SetVerdictModPacketWithConnMark(id uint32, verdict, mark int, packet []byte) error {
buf := make([]byte, 4)
binary.BigEndian.PutUint32(buf, uint32(mark))
ctAttrs, err := netlink.MarshalAttributes([]netlink.Attribute{{
Type: ctaMark,
Data: buf,
}})
if err != nil {
return err
}
data, err := netlink.MarshalAttributes([]netlink.Attribute{
{
Type: nfQaPayload,
Data: packet,
},
{
Type: netlink.Nested | nfQaCt,
Data: ctAttrs,
},
})
if err != nil {
return err
}
return nfqueue.setVerdict(id, verdict, false, data)
}
// SetVerdict signals the kernel the next action for a specified package id
func (nfqueue *Nfqueue) SetVerdict(id uint32, verdict int) error {
return nfqueue.setVerdict(id, verdict, false, []byte{})
}
// SetVerdictBatch signals the kernel the next action for a batch of packages till id
func (nfqueue *Nfqueue) SetVerdictBatch(id uint32, verdict int) error {
return nfqueue.setVerdict(id, verdict, true, []byte{})
}
// SetOption allows to enable or disable netlink socket options.
func (nfqueue *Nfqueue) SetOption(o netlink.ConnOption, enable bool) error {
return nfqueue.Con.SetOption(o, enable)
}
// Register your own function as callback for a netfilter queue.
//
// The registered callback will stop receiving data if an error
// happened. To handle errors and continue receiving data with the
// registered callback use RegisterWithErrorFunc() instead.
//
// Deprecated: Use RegisterWithErrorFunc() instead.
func (nfqueue *Nfqueue) Register(ctx context.Context, fn HookFunc) error {
return nfqueue.RegisterWithErrorFunc(ctx, fn, func(err error) int {
if opError, ok := err.(*netlink.OpError); ok {
if opError.Timeout() || opError.Temporary() {
return 0
}
}
nfqueue.logger.Errorf("Could not receive message: %v", err)
return 1
})
}
// RegisterWithErrorFunc attaches a callback function to a netfilter queue and allows
// custom error handling for errors encountered when reading from the underlying netlink socket.
func (nfqueue *Nfqueue) RegisterWithErrorFunc(ctx context.Context, fn HookFunc, errfn ErrorFunc) error {
// unbinding existing handler (if any)
seq, err := nfqueue.setConfig(unix.AF_UNSPEC, 0, 0, []netlink.Attribute{
{Type: nfQaCfgCmd, Data: []byte{nfUlnlCfgCmdPfUnbind, 0x0, 0x0, byte(nfqueue.family)}},
})
if err != nil {
return fmt.Errorf("could not unbind existing handlers (if any): %w", err)
}
// binding to family
_, err = nfqueue.setConfig(unix.AF_UNSPEC, seq, 0, []netlink.Attribute{
{Type: nfQaCfgCmd, Data: []byte{nfUlnlCfgCmdPfBind, 0x0, 0x0, byte(nfqueue.family)}},
})
if err != nil {
return fmt.Errorf("could not bind to family %d: %w", nfqueue.family, err)
}
// binding to the requested queue
_, err = nfqueue.setConfig(uint8(unix.AF_UNSPEC), seq, nfqueue.queue, []netlink.Attribute{
{Type: nfQaCfgCmd, Data: []byte{nfUlnlCfgCmdBind, 0x0, 0x0, byte(nfqueue.family)}},
})
if err != nil {
return fmt.Errorf("could not bind to requested queue %d: %w", nfqueue.queue, err)
}
// set copy mode and buffer size
data := append(nfqueue.maxPacketLen, nfqueue.copymode)
_, err = nfqueue.setConfig(uint8(unix.AF_UNSPEC), seq, nfqueue.queue, []netlink.Attribute{
{Type: nfQaCfgParams, Data: data},
})
if err != nil {
return err
}
var attrs []netlink.Attribute
if nfqueue.flags[0] != 0 || nfqueue.flags[1] != 0 || nfqueue.flags[2] != 0 || nfqueue.flags[3] != 0 {
// set flags
attrs = append(attrs, netlink.Attribute{Type: nfQaCfgFlags, Data: nfqueue.flags})
attrs = append(attrs, netlink.Attribute{Type: nfQaCfgMask, Data: nfqueue.flags})
}
attrs = append(attrs, netlink.Attribute{Type: nfQaCfgQueueMaxLen, Data: nfqueue.maxQueueLen})
_, err = nfqueue.setConfig(uint8(unix.AF_UNSPEC), seq, nfqueue.queue, attrs)
if err != nil {
return err
}
nfqueue.wg.Add(1)
go func() {
defer nfqueue.wg.Done()
nfqueue.socketCallback(ctx, fn, errfn, seq)
}()
return nil
}
// /include/uapi/linux/netfilter/nfnetlink.h:struct nfgenmsg{} res_id is Big Endian
func putExtraHeader(familiy, version uint8, resid uint16) []byte {
buf := make([]byte, 2)
binary.BigEndian.PutUint16(buf, resid)
return append([]byte{familiy, version}, buf...)
}
func (nfqueue *Nfqueue) setConfig(afFamily uint8, oseq uint32, resid uint16, attrs []netlink.Attribute) (uint32, error) {
cmd, err := netlink.MarshalAttributes(attrs)
if err != nil {
return 0, err
}
data := putExtraHeader(afFamily, unix.NFNETLINK_V0, resid)
data = append(data, cmd...)
req := netlink.Message{
Header: netlink.Header{
Type: netlink.HeaderType((nfnlSubSysQueue << 8) | nfQnlMsgConfig),
Flags: netlink.Request | netlink.Acknowledge,
Sequence: oseq,
},
Data: data,
}
return nfqueue.execute(req)
}
func (nfqueue *Nfqueue) execute(req netlink.Message) (uint32, error) {
var seq uint32
reply, e := nfqueue.Con.Execute(req)
if e != nil {
return 0, e
}
if e := netlink.Validate(req, reply); e != nil {
return 0, e
}
for _, msg := range reply {
if seq != 0 {
return 0, fmt.Errorf("number of received messages: %d: %w", len(reply), ErrUnexpMsg)
}
seq = msg.Header.Sequence
}
return seq, nil
}
func parseMsg(log Logger, msg netlink.Message) (Attribute, error) {
a, err := extractAttributes(log, msg.Data)
if err != nil {
return a, err
}
return a, nil
}
// Nfqueue represents a netfilter queue handler
type Nfqueue struct {
// Con is the pure representation of a netlink socket
Con *netlink.Conn
logger Logger
wg sync.WaitGroup
flags []byte // uint32
maxPacketLen []byte // uint32
family uint8
queue uint16
maxQueueLen []byte // uint32
copymode uint8
setWriteTimeout func() error
}
// Logger provides logging functionality.
type Logger interface {
Debugf(format string, args ...interface{})
Errorf(format string, args ...interface{})
}
// Open a connection to the netfilter queue subsystem
func Open(config *Config) (*Nfqueue, error) {
var nfqueue Nfqueue
if config.Flags >= nfQaCfgFlagMax {
return nil, ErrInvFlag
}
con, err := netlink.Dial(unix.NETLINK_NETFILTER, &netlink.Config{NetNS: config.NetNS})
if err != nil {
return nil, err
}
nfqueue.Con = con
// default size of copied packages to userspace
nfqueue.maxPacketLen = []byte{0x00, 0x00, 0x00, 0x00}
binary.BigEndian.PutUint32(nfqueue.maxPacketLen, config.MaxPacketLen)
nfqueue.flags = []byte{0x00, 0x00, 0x00, 0x00}
binary.BigEndian.PutUint32(nfqueue.flags, config.Flags)
nfqueue.queue = config.NfQueue
nfqueue.family = config.AfFamily
nfqueue.maxQueueLen = []byte{0x00, 0x00, 0x00, 0x00}
binary.BigEndian.PutUint32(nfqueue.maxQueueLen, config.MaxQueueLen)
if config.Logger == nil {
nfqueue.logger = new(devNull)
} else {
nfqueue.logger = config.Logger
}
nfqueue.copymode = config.Copymode
if config.WriteTimeout > 0 {
nfqueue.setWriteTimeout = func() error {
deadline := time.Now().Add(config.WriteTimeout)
return nfqueue.Con.SetWriteDeadline(deadline)
}
} else {
nfqueue.setWriteTimeout = func() error { return nil }
}
return &nfqueue, nil
}
func (nfqueue *Nfqueue) setVerdict(id uint32, verdict int, batch bool, attributes []byte) error {
/*
struct nfqnl_msg_verdict_hdr {
__be32 verdict;
__be32 id;
};
*/
if verdict != NfDrop && verdict != NfAccept && verdict != NfStolen && verdict != NfQeueue && verdict != NfRepeat {
return ErrInvalidVerdict
}
buf := make([]byte, 4)
binary.BigEndian.PutUint32(buf, uint32(id))
verdictData := append([]byte{0x0, 0x0, 0x0, byte(verdict)}, buf...)
cmd, err := netlink.MarshalAttributes([]netlink.Attribute{
{Type: nfQaVerdictHdr, Data: verdictData},
})
if err != nil {
return err
}
data := putExtraHeader(nfqueue.family, unix.NFNETLINK_V0, nfqueue.queue)
data = append(data, cmd...)
data = append(data, attributes...)
req := netlink.Message{
Header: netlink.Header{
Flags: netlink.Request,
Sequence: 0,
},
Data: data,
}
if batch {
req.Header.Type = netlink.HeaderType((nfnlSubSysQueue << 8) | nfQnlMsgVerdictBatch)
} else {
req.Header.Type = netlink.HeaderType((nfnlSubSysQueue << 8) | nfQnlMsgVerdict)
}
if err := nfqueue.setWriteTimeout(); err != nil {
nfqueue.logger.Errorf("could not set write timeout: %v\n", err)
}
_, sErr := nfqueue.Con.Send(req)
return sErr
}
func (nfqueue *Nfqueue) socketCallback(ctx context.Context, fn HookFunc, errfn ErrorFunc, seq uint32) {
defer func() {
// unbinding from queue
_, err := nfqueue.setConfig(uint8(unix.AF_UNSPEC), seq, nfqueue.queue, []netlink.Attribute{
{Type: nfQaCfgCmd, Data: []byte{nfUlnlCfgCmdUnbind, 0x0, 0x0, byte(nfqueue.family)}},
})
if err != nil {
nfqueue.logger.Errorf("Could not unbind from queue: %v", err)
}
}()
nfqueue.wg.Add(1)
go func() {
defer nfqueue.wg.Done()
// block until context is done
<-ctx.Done()
// Set the read deadline to a point in the past to interrupt
// possible blocking Receive() calls.
nfqueue.Con.SetReadDeadline(time.Now().Add(-1 * time.Second))
}()
for {
if err := ctx.Err(); err != nil {
nfqueue.logger.Errorf("Stop receiving nfqueue messages: %v", err)
return
}
replys, err := nfqueue.Con.Receive()
if err != nil {
if ret := errfn(err); ret != 0 {
return
}
continue
}
for _, msg := range replys {
if msg.Header.Type == netlink.Done {
// this is the last message of a batch
// continue to receive messages
break
}
m, err := parseMsg(nfqueue.logger, msg)
if err != nil {
nfqueue.logger.Errorf("Could not parse message: %v", err)
continue
}
if ret := fn(m); ret != 0 {
return
}
}
}
}
|