summaryrefslogtreecommitdiff
path: root/Documentation/netlink/specs/conntrack.yaml
blob: 840dc4504216bcfb8d20f34bedf5de3302adad3e (plain)
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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)

name: conntrack
protocol: netlink-raw
protonum: 12

doc:
  Netfilter connection tracking subsystem over nfnetlink

definitions:
  -
    name: nfgenmsg
    type: struct
    members:
      -
        name: nfgen-family
        type: u8
      -
        name: version
        type: u8
      -
        name: res-id
        byte-order: big-endian
        type: u16
  -
    name: nf-ct-tcp-flags-mask
    type: struct
    members:
      -
        name: flags
        type: u8
        enum: nf-ct-tcp-flags
        enum-as-flags: true
      -
        name: mask
        type: u8
        enum: nf-ct-tcp-flags
        enum-as-flags: true
  -
    name: nf-ct-tcp-flags
    type: flags
    entries:
      - window-scale
      - sack-perm
      - close-init
      - be-liberal
      - unacked
      - maxack
      - challenge-ack
      - simultaneous-open
  -
    name: nf-ct-tcp-state
    type: enum
    entries:
      - none
      - syn-sent
      - syn-recv
      - established
      - fin-wait
      - close-wait
      - last-ack
      - time-wait
      - close
      - syn-sent2
      - max
      - ignore
      - retrans
      - unack
      - timeout-max
  -
    name: nf-ct-sctp-state
    type: enum
    entries:
      - none
      - cloned
      - cookie-wait
      - cookie-echoed
      - established
      - shutdown-sent
      - shutdown-received
      - shutdown-ack-sent
      - shutdown-heartbeat-sent
  -
    name: nf-ct-status
    type: flags
    entries:
      - expected
      - seen-reply
      - assured
      - confirmed
      - src-nat
      - dst-nat
      - seq-adj
      - src-nat-done
      - dst-nat-done
      - dying
      - fixed-timeout
      - template
      - nat-clash
      - helper
      - offload
      - hw-offload

attribute-sets:
  -
    name: counter-attrs
    attributes:
      -
        name: packets
        type: u64
        byte-order: big-endian
      -
        name: bytes
        type: u64
        byte-order: big-endian
      -
        name: packets-old
        type: u32
      -
        name: bytes-old
        type: u32
      -
        name: pad
        type: pad
  -
    name: tuple-proto-attrs
    attributes:
      -
        name: proto-num
        type: u8
        doc: l4 protocol number
      -
        name: proto-src-port
        type: u16
        byte-order: big-endian
        doc: l4 source port
      -
        name: proto-dst-port
        type: u16
        byte-order: big-endian
        doc: l4 source port
      -
        name: proto-icmp-id
        type: u16
        byte-order: big-endian
        doc: l4 icmp id
      -
        name: proto-icmp-type
        type: u8
      -
        name: proto-icmp-code
        type: u8
      -
        name: proto-icmpv6-id
        type: u16
        byte-order: big-endian
        doc: l4 icmp id
      -
        name: proto-icmpv6-type
        type: u8
      -
        name: proto-icmpv6-code
        type: u8
  -
    name: tuple-ip-attrs
    attributes:
      -
        name: ip-v4-src
        type: u32
        byte-order: big-endian
        display-hint: ipv4
        doc: ipv4 source address
      -
        name: ip-v4-dst
        type: u32
        byte-order: big-endian
        display-hint: ipv4
        doc: ipv4 destination address
      -
        name: ip-v6-src
        type: binary
        checks:
          min-len: 16
        byte-order: big-endian
        display-hint: ipv6
        doc: ipv6 source address
      -
        name: ip-v6-dst
        type: binary
        checks:
          min-len: 16
        byte-order: big-endian
        display-hint: ipv6
        doc: ipv6 destination address
  -
    name: tuple-attrs
    attributes:
    -
        name: tuple-ip
        type: nest
        nested-attributes: tuple-ip-attrs
        doc: conntrack l3 information
    -
        name: tuple-proto
        type: nest
        nested-attributes: tuple-proto-attrs
        doc: conntrack l4 information
    -
        name: tuple-zone
        type: u16
        byte-order: big-endian
        doc: conntrack zone id
  -
    name: protoinfo-tcp-attrs
    attributes:
    -
        name: tcp-state
        type: u8
        enum: nf-ct-tcp-state
        doc: tcp connection state
    -
        name: tcp-wscale-original
        type: u8
        doc: window scaling factor in original direction
    -
        name: tcp-wscale-reply
        type: u8
        doc: window scaling factor in reply direction
    -
        name: tcp-flags-original
        type: binary
        struct: nf-ct-tcp-flags-mask
    -
        name: tcp-flags-reply
        type: binary
        struct: nf-ct-tcp-flags-mask
  -
    name: protoinfo-dccp-attrs
    attributes:
    -
        name: dccp-state
        type: u8
        doc: dccp connection state
    -
        name: dccp-role
        type: u8
    -
        name: dccp-handshake-seq
        type: u64
        byte-order: big-endian
    -
        name: dccp-pad
        type: pad
  -
    name: protoinfo-sctp-attrs
    attributes:
    -
        name: sctp-state
        type: u8
        doc: sctp connection state
        enum: nf-ct-sctp-state
    -
        name: vtag-original
        type: u32
        byte-order: big-endian
    -
        name: vtag-reply
        type: u32
        byte-order: big-endian
  -
    name: protoinfo-attrs
    attributes:
    -
        name: protoinfo-tcp
        type: nest
        nested-attributes: protoinfo-tcp-attrs
        doc: conntrack tcp state information
    -
        name: protoinfo-dccp
        type: nest
        nested-attributes: protoinfo-dccp-attrs
        doc: conntrack dccp state information
    -
        name: protoinfo-sctp
        type: nest
        nested-attributes: protoinfo-sctp-attrs
        doc: conntrack sctp state information
  -
    name: help-attrs
    attributes:
      -
        name: help-name
        type: string
        doc: helper name
  -
    name: nat-proto-attrs
    attributes:
      -
        name: nat-port-min
        type: u16
        byte-order: big-endian
      -
        name: nat-port-max
        type: u16
        byte-order: big-endian
  -
    name: nat-attrs
    attributes:
      -
        name: nat-v4-minip
        type: u32
        byte-order: big-endian
      -
        name: nat-v4-maxip
        type: u32
        byte-order: big-endian
      -
        name: nat-v6-minip
        type: binary
      -
        name: nat-v6-maxip
        type: binary
      -
        name: nat-proto
        type: nest
        nested-attributes: nat-proto-attrs
  -
    name: seqadj-attrs
    attributes:
      -
        name: correction-pos
        type: u32
        byte-order: big-endian
      -
        name: offset-before
        type: u32
        byte-order: big-endian
      -
        name: offset-after
        type: u32
        byte-order: big-endian
  -
    name: secctx-attrs
    attributes:
      -
        name: secctx-name
        type: string
  -
    name: synproxy-attrs
    attributes:
      -
        name: isn
        type: u32
        byte-order: big-endian
      -
        name: its
        type: u32
        byte-order: big-endian
      -
        name: tsoff
        type: u32
        byte-order: big-endian
  -
    name: conntrack-attrs
    attributes:
      -
        name: tuple-orig
        type: nest
        nested-attributes: tuple-attrs
        doc: conntrack l3+l4 protocol information, original direction
      -
        name: tuple-reply
        type: nest
        nested-attributes: tuple-attrs
        doc: conntrack l3+l4 protocol information, reply direction
      -
        name: status
        type: u32
        byte-order: big-endian
        enum: nf-ct-status
        enum-as-flags: true
        doc: conntrack flag bits
      -
        name: protoinfo
        type: nest
        nested-attributes: protoinfo-attrs
      -
        name: help
        type: nest
        nested-attributes: help-attrs
      -
        name: nat-src
        type: nest
        nested-attributes: nat-attrs
      -
        name: timeout
        type: u32
        byte-order: big-endian
      -
        name: mark
        type: u32
        byte-order: big-endian
      -
        name: counters-orig
        type: nest
        nested-attributes: counter-attrs
      -
        name: counters-reply
        type: nest
        nested-attributes: counter-attrs
      -
        name: use
        type: u32
        byte-order: big-endian
      -
        name: id
        type: u32
        byte-order: big-endian
      -
        name: nat-dst
        type: nest
        nested-attributes: nat-attrs
      -
        name: tuple-master
        type: nest
        nested-attributes: tuple-attrs
      -
        name: seq-adj-orig
        type: nest
        nested-attributes: seqadj-attrs
      -
        name: seq-adj-reply
        type: nest
        nested-attributes: seqadj-attrs
      -
        name: secmark
        type: binary
        doc: obsolete
      -
        name: zone
        type: u16
        byte-order: big-endian
        doc: conntrack zone id
      -
        name: secctx
        type: nest
        nested-attributes: secctx-attrs
      -
        name: timestamp
        type: u64
        byte-order: big-endian
      -
        name: mark-mask
        type: u32
        byte-order: big-endian
      -
        name: labels
        type: binary
      -
        name: labels mask
        type: binary
      -
        name: synproxy
        type: nest
        nested-attributes: synproxy-attrs
      -
        name: filter
        type: nest
        nested-attributes: tuple-attrs
      -
        name: status-mask
        type: u32
        byte-order: big-endian
        enum: nf-ct-status
        enum-as-flags: true
        doc: conntrack flag bits to change
      -
        name: timestamp-event
        type: u64
        byte-order: big-endian
  -
    name: conntrack-stats-attrs
    attributes:
      -
        name: searched
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: found
        type: u32
        byte-order: big-endian
      -
        name: new
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: invalid
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: ignore
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: delete
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: delete-list
        type: u32
        byte-order: big-endian
        doc: obsolete
      -
        name: insert
        type: u32
        byte-order: big-endian
      -
        name: insert-failed
        type: u32
        byte-order: big-endian
      -
        name: drop
        type: u32
        byte-order: big-endian
      -
        name: early-drop
        type: u32
        byte-order: big-endian
      -
        name: error
        type: u32
        byte-order: big-endian
      -
        name: search-restart
        type: u32
        byte-order: big-endian
      -
        name: clash-resolve
        type: u32
        byte-order: big-endian
      -
        name: chain-toolong
        type: u32
        byte-order: big-endian

operations:
  enum-model: directional
  list:
    -
      name: get
      doc: get / dump entries
      attribute-set: conntrack-attrs
      fixed-header: nfgenmsg
      do:
        request:
          value: 0x101
          attributes:
            - tuple-orig
            - tuple-reply
            - zone
        reply:
          value: 0x100
          attributes:
            - tuple-orig
            - tuple-reply
            - status
            - protoinfo
            - help
            - nat-src
            - nat-dst
            - timeout
            - mark
            - counter-orig
            - counter-reply
            - use
            - id
            - nat-dst
            - tuple-master
            - seq-adj-orig
            - seq-adj-reply
            - zone
            - secctx
            - labels
            - synproxy
      dump:
        request:
          value: 0x101
          attributes:
            - nfgen-family
            - mark
            - filter
            - status
            - zone
        reply:
          value: 0x100
          attributes:
            - tuple-orig
            - tuple-reply
            - status
            - protoinfo
            - help
            - nat-src
            - nat-dst
            - timeout
            - mark
            - counter-orig
            - counter-reply
            - use
            - id
            - nat-dst
            - tuple-master
            - seq-adj-orig
            - seq-adj-reply
            - zone
            - secctx
            - labels
            - synproxy
    -
      name: get-stats
      doc: dump pcpu conntrack stats
      attribute-set: conntrack-stats-attrs
      fixed-header: nfgenmsg
      dump:
        request:
          value: 0x104
        reply:
          value: 0x104
          attributes:
            - searched
            - found
            - insert
            - insert-failed
            - drop
            - early-drop
            - error
            - search-restart
            - clash-resolve
            - chain-toolong