forked from google/gopacket
/
lldp.go
1593 lines (1472 loc) · 46.5 KB
/
lldp.go
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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2012 Google, Inc. All rights reserved.
//
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file in the root of the source
// tree.
package layers
import (
"encoding/binary"
"errors"
"fmt"
"github.com/google/gopacket"
)
// LLDPTLVType is the type of each TLV value in a LinkLayerDiscovery packet.
type LLDPTLVType byte
const (
LLDPTLVEnd LLDPTLVType = 0
LLDPTLVChassisID LLDPTLVType = 1
LLDPTLVPortID LLDPTLVType = 2
LLDPTLVTTL LLDPTLVType = 3
LLDPTLVPortDescription LLDPTLVType = 4
LLDPTLVSysName LLDPTLVType = 5
LLDPTLVSysDescription LLDPTLVType = 6
LLDPTLVSysCapabilities LLDPTLVType = 7
LLDPTLVMgmtAddress LLDPTLVType = 8
LLDPTLVOrgSpecific LLDPTLVType = 127
)
// LinkLayerDiscoveryValue is a TLV value inside a LinkLayerDiscovery packet layer.
type LinkLayerDiscoveryValue struct {
Type LLDPTLVType
Length uint16
Value []byte
}
func (c *LinkLayerDiscoveryValue) len() int {
return 0
}
// LLDPChassisIDSubType specifies the value type for a single LLDPChassisID.ID
type LLDPChassisIDSubType byte
// LLDP Chassis Types
const (
LLDPChassisIDSubTypeReserved LLDPChassisIDSubType = 0
LLDPChassisIDSubTypeChassisComp LLDPChassisIDSubType = 1
LLDPChassisIDSubtypeIfaceAlias LLDPChassisIDSubType = 2
LLDPChassisIDSubTypePortComp LLDPChassisIDSubType = 3
LLDPChassisIDSubTypeMACAddr LLDPChassisIDSubType = 4
LLDPChassisIDSubTypeNetworkAddr LLDPChassisIDSubType = 5
LLDPChassisIDSubtypeIfaceName LLDPChassisIDSubType = 6
LLDPChassisIDSubTypeLocal LLDPChassisIDSubType = 7
)
type LLDPChassisID struct {
Subtype LLDPChassisIDSubType
ID []byte
}
func (c *LLDPChassisID) serialize() []byte {
var buf = make([]byte, c.serializedLen())
idLen := uint16(LLDPTLVChassisID)<<9 | uint16(len(c.ID)+1) //id should take 7 bits, length should take 9 bits, +1 for subtype
binary.BigEndian.PutUint16(buf[0:2], idLen)
buf[2] = byte(c.Subtype)
copy(buf[3:], c.ID)
return buf
}
func (c *LLDPChassisID) serializedLen() int {
return len(c.ID) + 3 // +2 for id and length, +1 for subtype
}
// LLDPPortIDSubType specifies the value type for a single LLDPPortID.ID
type LLDPPortIDSubType byte
// LLDP PortID types
const (
LLDPPortIDSubtypeReserved LLDPPortIDSubType = 0
LLDPPortIDSubtypeIfaceAlias LLDPPortIDSubType = 1
LLDPPortIDSubtypePortComp LLDPPortIDSubType = 2
LLDPPortIDSubtypeMACAddr LLDPPortIDSubType = 3
LLDPPortIDSubtypeNetworkAddr LLDPPortIDSubType = 4
LLDPPortIDSubtypeIfaceName LLDPPortIDSubType = 5
LLDPPortIDSubtypeAgentCircuitID LLDPPortIDSubType = 6
LLDPPortIDSubtypeLocal LLDPPortIDSubType = 7
)
type LLDPPortID struct {
Subtype LLDPPortIDSubType
ID []byte
}
func (c *LLDPPortID) serialize() []byte {
var buf = make([]byte, c.serializedLen())
idLen := uint16(LLDPTLVPortID)<<9 | uint16(len(c.ID)+1) //id should take 7 bits, length should take 9 bits, +1 for subtype
binary.BigEndian.PutUint16(buf[0:2], idLen)
buf[2] = byte(c.Subtype)
copy(buf[3:], c.ID)
return buf
}
func (c *LLDPPortID) serializedLen() int {
return len(c.ID) + 3 // +2 for id and length, +1 for subtype
}
// LinkLayerDiscovery is a packet layer containing the LinkLayer Discovery Protocol.
// See http:http://standards.ieee.org/getieee802/download/802.1AB-2009.pdf
// ChassisID, PortID and TTL are mandatory TLV's. Other values can be decoded
// with DecodeValues()
type LinkLayerDiscovery struct {
BaseLayer
ChassisID LLDPChassisID
PortID LLDPPortID
TTL uint16
Values []LinkLayerDiscoveryValue
}
type IEEEOUI uint32
// http://standards.ieee.org/develop/regauth/oui/oui.txt
const (
IEEEOUI8021 IEEEOUI = 0x0080c2
IEEEOUI8023 IEEEOUI = 0x00120f
IEEEOUI80211 IEEEOUI = 0x000fac
IEEEOUI8021Qbg IEEEOUI = 0x0013BF
IEEEOUICisco2 IEEEOUI = 0x000142
IEEEOUIMedia IEEEOUI = 0x0012bb // TR-41
IEEEOUIProfinet IEEEOUI = 0x000ecf
IEEEOUIDCBX IEEEOUI = 0x001b21
)
// LLDPOrgSpecificTLV is an Organisation-specific TLV
type LLDPOrgSpecificTLV struct {
OUI IEEEOUI
SubType uint8
Info []byte
}
// LLDPCapabilities Types
const (
LLDPCapsOther uint16 = 1 << 0
LLDPCapsRepeater uint16 = 1 << 1
LLDPCapsBridge uint16 = 1 << 2
LLDPCapsWLANAP uint16 = 1 << 3
LLDPCapsRouter uint16 = 1 << 4
LLDPCapsPhone uint16 = 1 << 5
LLDPCapsDocSis uint16 = 1 << 6
LLDPCapsStationOnly uint16 = 1 << 7
LLDPCapsCVLAN uint16 = 1 << 8
LLDPCapsSVLAN uint16 = 1 << 9
LLDPCapsTmpr uint16 = 1 << 10
)
// LLDPCapabilities represents the capabilities of a device
type LLDPCapabilities struct {
Other bool
Repeater bool
Bridge bool
WLANAP bool
Router bool
Phone bool
DocSis bool
StationOnly bool
CVLAN bool
SVLAN bool
TMPR bool
}
type LLDPSysCapabilities struct {
SystemCap LLDPCapabilities
EnabledCap LLDPCapabilities
}
type IANAAddressFamily byte
// LLDP Management Address Subtypes
// http://www.iana.org/assignments/address-family-numbers/address-family-numbers.xml
const (
IANAAddressFamilyReserved IANAAddressFamily = 0
IANAAddressFamilyIPV4 IANAAddressFamily = 1
IANAAddressFamilyIPV6 IANAAddressFamily = 2
IANAAddressFamilyNSAP IANAAddressFamily = 3
IANAAddressFamilyHDLC IANAAddressFamily = 4
IANAAddressFamilyBBN1822 IANAAddressFamily = 5
IANAAddressFamily802 IANAAddressFamily = 6
IANAAddressFamilyE163 IANAAddressFamily = 7
IANAAddressFamilyE164 IANAAddressFamily = 8
IANAAddressFamilyF69 IANAAddressFamily = 9
IANAAddressFamilyX121 IANAAddressFamily = 10
IANAAddressFamilyIPX IANAAddressFamily = 11
IANAAddressFamilyAtalk IANAAddressFamily = 12
IANAAddressFamilyDecnet IANAAddressFamily = 13
IANAAddressFamilyBanyan IANAAddressFamily = 14
IANAAddressFamilyE164NSAP IANAAddressFamily = 15
IANAAddressFamilyDNS IANAAddressFamily = 16
IANAAddressFamilyDistname IANAAddressFamily = 17
IANAAddressFamilyASNumber IANAAddressFamily = 18
IANAAddressFamilyXTPIPV4 IANAAddressFamily = 19
IANAAddressFamilyXTPIPV6 IANAAddressFamily = 20
IANAAddressFamilyXTP IANAAddressFamily = 21
IANAAddressFamilyFcWWPN IANAAddressFamily = 22
IANAAddressFamilyFcWWNN IANAAddressFamily = 23
IANAAddressFamilyGWID IANAAddressFamily = 24
IANAAddressFamilyL2VPN IANAAddressFamily = 25
)
type LLDPInterfaceSubtype byte
// LLDP Interface Subtypes
const (
LLDPInterfaceSubtypeUnknown LLDPInterfaceSubtype = 1
LLDPInterfaceSubtypeifIndex LLDPInterfaceSubtype = 2
LLDPInterfaceSubtypeSysPort LLDPInterfaceSubtype = 3
)
type LLDPMgmtAddress struct {
Subtype IANAAddressFamily
Address []byte
InterfaceSubtype LLDPInterfaceSubtype
InterfaceNumber uint32
OID string
}
// LinkLayerDiscoveryInfo represents the decoded details for a set of LinkLayerDiscoveryValues
// Organisation-specific TLV's can be decoded using the various Decode() methods
type LinkLayerDiscoveryInfo struct {
BaseLayer
PortDescription string
SysName string
SysDescription string
SysCapabilities LLDPSysCapabilities
MgmtAddress LLDPMgmtAddress
OrgTLVs []LLDPOrgSpecificTLV // Private TLVs
Unknown []LinkLayerDiscoveryValue // undecoded TLVs
}
/// IEEE 802.1 TLV Subtypes
const (
LLDP8021SubtypePortVLANID uint8 = 1
LLDP8021SubtypeProtocolVLANID uint8 = 2
LLDP8021SubtypeVLANName uint8 = 3
LLDP8021SubtypeProtocolIdentity uint8 = 4
LLDP8021SubtypeVDIUsageDigest uint8 = 5
LLDP8021SubtypeManagementVID uint8 = 6
LLDP8021SubtypeLinkAggregation uint8 = 7
)
// VLAN Port Protocol ID options
const (
LLDPProtocolVLANIDCapability byte = 1 << 1
LLDPProtocolVLANIDStatus byte = 1 << 2
)
type PortProtocolVLANID struct {
Supported bool
Enabled bool
ID uint16
}
type VLANName struct {
ID uint16
Name string
}
type ProtocolIdentity []byte
// LACP options
const (
LLDPAggregationCapability byte = 1 << 0
LLDPAggregationStatus byte = 1 << 1
)
// IEEE 802 Link Aggregation parameters
type LLDPLinkAggregation struct {
Supported bool
Enabled bool
PortID uint32
}
// LLDPInfo8021 represents the information carried in 802.1 Org-specific TLVs
type LLDPInfo8021 struct {
PVID uint16
PPVIDs []PortProtocolVLANID
VLANNames []VLANName
ProtocolIdentities []ProtocolIdentity
VIDUsageDigest uint32
ManagementVID uint16
LinkAggregation LLDPLinkAggregation
}
// IEEE 802.3 TLV Subtypes
const (
LLDP8023SubtypeMACPHY uint8 = 1
LLDP8023SubtypeMDIPower uint8 = 2
LLDP8023SubtypeLinkAggregation uint8 = 3
LLDP8023SubtypeMTU uint8 = 4
)
// MACPHY options
const (
LLDPMACPHYCapability byte = 1 << 0
LLDPMACPHYStatus byte = 1 << 1
)
// From IANA-MAU-MIB (introduced by RFC 4836) - dot3MauType
const (
LLDPMAUTypeUnknown uint16 = 0
LLDPMAUTypeAUI uint16 = 1
LLDPMAUType10Base5 uint16 = 2
LLDPMAUTypeFOIRL uint16 = 3
LLDPMAUType10Base2 uint16 = 4
LLDPMAUType10BaseT uint16 = 5
LLDPMAUType10BaseFP uint16 = 6
LLDPMAUType10BaseFB uint16 = 7
LLDPMAUType10BaseFL uint16 = 8
LLDPMAUType10BROAD36 uint16 = 9
LLDPMAUType10BaseT_HD uint16 = 10
LLDPMAUType10BaseT_FD uint16 = 11
LLDPMAUType10BaseFL_HD uint16 = 12
LLDPMAUType10BaseFL_FD uint16 = 13
LLDPMAUType100BaseT4 uint16 = 14
LLDPMAUType100BaseTX_HD uint16 = 15
LLDPMAUType100BaseTX_FD uint16 = 16
LLDPMAUType100BaseFX_HD uint16 = 17
LLDPMAUType100BaseFX_FD uint16 = 18
LLDPMAUType100BaseT2_HD uint16 = 19
LLDPMAUType100BaseT2_FD uint16 = 20
LLDPMAUType1000BaseX_HD uint16 = 21
LLDPMAUType1000BaseX_FD uint16 = 22
LLDPMAUType1000BaseLX_HD uint16 = 23
LLDPMAUType1000BaseLX_FD uint16 = 24
LLDPMAUType1000BaseSX_HD uint16 = 25
LLDPMAUType1000BaseSX_FD uint16 = 26
LLDPMAUType1000BaseCX_HD uint16 = 27
LLDPMAUType1000BaseCX_FD uint16 = 28
LLDPMAUType1000BaseT_HD uint16 = 29
LLDPMAUType1000BaseT_FD uint16 = 30
LLDPMAUType10GBaseX uint16 = 31
LLDPMAUType10GBaseLX4 uint16 = 32
LLDPMAUType10GBaseR uint16 = 33
LLDPMAUType10GBaseER uint16 = 34
LLDPMAUType10GBaseLR uint16 = 35
LLDPMAUType10GBaseSR uint16 = 36
LLDPMAUType10GBaseW uint16 = 37
LLDPMAUType10GBaseEW uint16 = 38
LLDPMAUType10GBaseLW uint16 = 39
LLDPMAUType10GBaseSW uint16 = 40
LLDPMAUType10GBaseCX4 uint16 = 41
LLDPMAUType2BaseTL uint16 = 42
LLDPMAUType10PASS_TS uint16 = 43
LLDPMAUType100BaseBX10D uint16 = 44
LLDPMAUType100BaseBX10U uint16 = 45
LLDPMAUType100BaseLX10 uint16 = 46
LLDPMAUType1000BaseBX10D uint16 = 47
LLDPMAUType1000BaseBX10U uint16 = 48
LLDPMAUType1000BaseLX10 uint16 = 49
LLDPMAUType1000BasePX10D uint16 = 50
LLDPMAUType1000BasePX10U uint16 = 51
LLDPMAUType1000BasePX20D uint16 = 52
LLDPMAUType1000BasePX20U uint16 = 53
LLDPMAUType10GBaseT uint16 = 54
LLDPMAUType10GBaseLRM uint16 = 55
LLDPMAUType1000BaseKX uint16 = 56
LLDPMAUType10GBaseKX4 uint16 = 57
LLDPMAUType10GBaseKR uint16 = 58
LLDPMAUType10_1GBasePRX_D1 uint16 = 59
LLDPMAUType10_1GBasePRX_D2 uint16 = 60
LLDPMAUType10_1GBasePRX_D3 uint16 = 61
LLDPMAUType10_1GBasePRX_U1 uint16 = 62
LLDPMAUType10_1GBasePRX_U2 uint16 = 63
LLDPMAUType10_1GBasePRX_U3 uint16 = 64
LLDPMAUType10GBasePR_D1 uint16 = 65
LLDPMAUType10GBasePR_D2 uint16 = 66
LLDPMAUType10GBasePR_D3 uint16 = 67
LLDPMAUType10GBasePR_U1 uint16 = 68
LLDPMAUType10GBasePR_U3 uint16 = 69
)
// From RFC 3636 - ifMauAutoNegCapAdvertisedBits
const (
LLDPMAUPMDOther uint16 = 1 << 15
LLDPMAUPMD10BaseT uint16 = 1 << 14
LLDPMAUPMD10BaseT_FD uint16 = 1 << 13
LLDPMAUPMD100BaseT4 uint16 = 1 << 12
LLDPMAUPMD100BaseTX uint16 = 1 << 11
LLDPMAUPMD100BaseTX_FD uint16 = 1 << 10
LLDPMAUPMD100BaseT2 uint16 = 1 << 9
LLDPMAUPMD100BaseT2_FD uint16 = 1 << 8
LLDPMAUPMDFDXPAUSE uint16 = 1 << 7
LLDPMAUPMDFDXAPAUSE uint16 = 1 << 6
LLDPMAUPMDFDXSPAUSE uint16 = 1 << 5
LLDPMAUPMDFDXBPAUSE uint16 = 1 << 4
LLDPMAUPMD1000BaseX uint16 = 1 << 3
LLDPMAUPMD1000BaseX_FD uint16 = 1 << 2
LLDPMAUPMD1000BaseT uint16 = 1 << 1
LLDPMAUPMD1000BaseT_FD uint16 = 1 << 0
)
// Inverted ifMauAutoNegCapAdvertisedBits if required
// (Some manufacturers misinterpreted the spec -
// see https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=1455)
const (
LLDPMAUPMDOtherInv uint16 = 1 << 0
LLDPMAUPMD10BaseTInv uint16 = 1 << 1
LLDPMAUPMD10BaseT_FDInv uint16 = 1 << 2
LLDPMAUPMD100BaseT4Inv uint16 = 1 << 3
LLDPMAUPMD100BaseTXInv uint16 = 1 << 4
LLDPMAUPMD100BaseTX_FDInv uint16 = 1 << 5
LLDPMAUPMD100BaseT2Inv uint16 = 1 << 6
LLDPMAUPMD100BaseT2_FDInv uint16 = 1 << 7
LLDPMAUPMDFDXPAUSEInv uint16 = 1 << 8
LLDPMAUPMDFDXAPAUSEInv uint16 = 1 << 9
LLDPMAUPMDFDXSPAUSEInv uint16 = 1 << 10
LLDPMAUPMDFDXBPAUSEInv uint16 = 1 << 11
LLDPMAUPMD1000BaseXInv uint16 = 1 << 12
LLDPMAUPMD1000BaseX_FDInv uint16 = 1 << 13
LLDPMAUPMD1000BaseTInv uint16 = 1 << 14
LLDPMAUPMD1000BaseT_FDInv uint16 = 1 << 15
)
type LLDPMACPHYConfigStatus struct {
AutoNegSupported bool
AutoNegEnabled bool
AutoNegCapability uint16
MAUType uint16
}
// MDI Power options
const (
LLDPMDIPowerPortClass byte = 1 << 0
LLDPMDIPowerCapability byte = 1 << 1
LLDPMDIPowerStatus byte = 1 << 2
LLDPMDIPowerPairsAbility byte = 1 << 3
)
type LLDPPowerType byte
type LLDPPowerSource byte
type LLDPPowerPriority byte
const (
LLDPPowerPriorityUnknown LLDPPowerPriority = 0
LLDPPowerPriorityMedium LLDPPowerPriority = 1
LLDPPowerPriorityHigh LLDPPowerPriority = 2
LLDPPowerPriorityLow LLDPPowerPriority = 3
)
type LLDPPowerViaMDI8023 struct {
PortClassPSE bool // false = PD
PSESupported bool
PSEEnabled bool
PSEPairsAbility bool
PSEPowerPair uint8
PSEClass uint8
Type LLDPPowerType
Source LLDPPowerSource
Priority LLDPPowerPriority
Requested uint16 // 1-510 Watts
Allocated uint16 // 1-510 Watts
}
// LLDPInfo8023 represents the information carried in 802.3 Org-specific TLVs
type LLDPInfo8023 struct {
MACPHYConfigStatus LLDPMACPHYConfigStatus
PowerViaMDI LLDPPowerViaMDI8023
LinkAggregation LLDPLinkAggregation
MTU uint16
}
// IEEE 802.1Qbg TLV Subtypes
const (
LLDP8021QbgEVB uint8 = 0
LLDP8021QbgCDCP uint8 = 1
LLDP8021QbgVDP uint8 = 2
LLDP8021QbgEVB22 uint8 = 13
)
// LLDPEVBCapabilities Types
const (
LLDPEVBCapsSTD uint16 = 1 << 7
LLDPEVBCapsRR uint16 = 1 << 6
LLDPEVBCapsRTE uint16 = 1 << 2
LLDPEVBCapsECP uint16 = 1 << 1
LLDPEVBCapsVDP uint16 = 1 << 0
)
// LLDPEVBCapabilities represents the EVB capabilities of a device
type LLDPEVBCapabilities struct {
StandardBridging bool
ReflectiveRelay bool
RetransmissionTimerExponent bool
EdgeControlProtocol bool
VSIDiscoveryProtocol bool
}
type LLDPEVBSettings struct {
Supported LLDPEVBCapabilities
Enabled LLDPEVBCapabilities
SupportedVSIs uint16
ConfiguredVSIs uint16
RTEExponent uint8
}
// LLDPInfo8021Qbg represents the information carried in 802.1Qbg Org-specific TLVs
type LLDPInfo8021Qbg struct {
EVBSettings LLDPEVBSettings
}
type LLDPMediaSubtype uint8
// Media TLV Subtypes
const (
LLDPMediaTypeCapabilities LLDPMediaSubtype = 1
LLDPMediaTypeNetwork LLDPMediaSubtype = 2
LLDPMediaTypeLocation LLDPMediaSubtype = 3
LLDPMediaTypePower LLDPMediaSubtype = 4
LLDPMediaTypeHardware LLDPMediaSubtype = 5
LLDPMediaTypeFirmware LLDPMediaSubtype = 6
LLDPMediaTypeSoftware LLDPMediaSubtype = 7
LLDPMediaTypeSerial LLDPMediaSubtype = 8
LLDPMediaTypeManufacturer LLDPMediaSubtype = 9
LLDPMediaTypeModel LLDPMediaSubtype = 10
LLDPMediaTypeAssetID LLDPMediaSubtype = 11
)
type LLDPMediaClass uint8
// Media Class Values
const (
LLDPMediaClassUndefined LLDPMediaClass = 0
LLDPMediaClassEndpointI LLDPMediaClass = 1
LLDPMediaClassEndpointII LLDPMediaClass = 2
LLDPMediaClassEndpointIII LLDPMediaClass = 3
LLDPMediaClassNetwork LLDPMediaClass = 4
)
// LLDPMediaCapabilities Types
const (
LLDPMediaCapsLLDP uint16 = 1 << 0
LLDPMediaCapsNetwork uint16 = 1 << 1
LLDPMediaCapsLocation uint16 = 1 << 2
LLDPMediaCapsPowerPSE uint16 = 1 << 3
LLDPMediaCapsPowerPD uint16 = 1 << 4
LLDPMediaCapsInventory uint16 = 1 << 5
)
// LLDPMediaCapabilities represents the LLDP Media capabilities of a device
type LLDPMediaCapabilities struct {
Capabilities bool
NetworkPolicy bool
Location bool
PowerPSE bool
PowerPD bool
Inventory bool
Class LLDPMediaClass
}
type LLDPApplicationType uint8
const (
LLDPAppTypeReserved LLDPApplicationType = 0
LLDPAppTypeVoice LLDPApplicationType = 1
LLDPappTypeVoiceSignaling LLDPApplicationType = 2
LLDPappTypeGuestVoice LLDPApplicationType = 3
LLDPappTypeGuestVoiceSignaling LLDPApplicationType = 4
LLDPappTypeSoftphoneVoice LLDPApplicationType = 5
LLDPappTypeVideoConferencing LLDPApplicationType = 6
LLDPappTypeStreamingVideo LLDPApplicationType = 7
LLDPappTypeVideoSignaling LLDPApplicationType = 8
)
type LLDPNetworkPolicy struct {
ApplicationType LLDPApplicationType
Defined bool
Tagged bool
VLANId uint16
L2Priority uint16
DSCPValue uint8
}
type LLDPLocationFormat uint8
const (
LLDPLocationFormatInvalid LLDPLocationFormat = 0
LLDPLocationFormatCoordinate LLDPLocationFormat = 1
LLDPLocationFormatAddress LLDPLocationFormat = 2
LLDPLocationFormatECS LLDPLocationFormat = 3
)
type LLDPLocationAddressWhat uint8
const (
LLDPLocationAddressWhatDHCP LLDPLocationAddressWhat = 0
LLDPLocationAddressWhatNetwork LLDPLocationAddressWhat = 1
LLDPLocationAddressWhatClient LLDPLocationAddressWhat = 2
)
type LLDPLocationAddressType uint8
const (
LLDPLocationAddressTypeLanguage LLDPLocationAddressType = 0
LLDPLocationAddressTypeNational LLDPLocationAddressType = 1
LLDPLocationAddressTypeCounty LLDPLocationAddressType = 2
LLDPLocationAddressTypeCity LLDPLocationAddressType = 3
LLDPLocationAddressTypeCityDivision LLDPLocationAddressType = 4
LLDPLocationAddressTypeNeighborhood LLDPLocationAddressType = 5
LLDPLocationAddressTypeStreet LLDPLocationAddressType = 6
LLDPLocationAddressTypeLeadingStreet LLDPLocationAddressType = 16
LLDPLocationAddressTypeTrailingStreet LLDPLocationAddressType = 17
LLDPLocationAddressTypeStreetSuffix LLDPLocationAddressType = 18
LLDPLocationAddressTypeHouseNum LLDPLocationAddressType = 19
LLDPLocationAddressTypeHouseSuffix LLDPLocationAddressType = 20
LLDPLocationAddressTypeLandmark LLDPLocationAddressType = 21
LLDPLocationAddressTypeAdditional LLDPLocationAddressType = 22
LLDPLocationAddressTypeName LLDPLocationAddressType = 23
LLDPLocationAddressTypePostal LLDPLocationAddressType = 24
LLDPLocationAddressTypeBuilding LLDPLocationAddressType = 25
LLDPLocationAddressTypeUnit LLDPLocationAddressType = 26
LLDPLocationAddressTypeFloor LLDPLocationAddressType = 27
LLDPLocationAddressTypeRoom LLDPLocationAddressType = 28
LLDPLocationAddressTypePlace LLDPLocationAddressType = 29
LLDPLocationAddressTypeScript LLDPLocationAddressType = 128
)
type LLDPLocationCoordinate struct {
LatitudeResolution uint8
Latitude uint64
LongitudeResolution uint8
Longitude uint64
AltitudeType uint8
AltitudeResolution uint16
Altitude uint32
Datum uint8
}
type LLDPLocationAddressLine struct {
Type LLDPLocationAddressType
Value string
}
type LLDPLocationAddress struct {
What LLDPLocationAddressWhat
CountryCode string
AddressLines []LLDPLocationAddressLine
}
type LLDPLocationECS struct {
ELIN string
}
// LLDP represents a physical location.
// Only one of the embedded types will contain values, depending on Format.
type LLDPLocation struct {
Format LLDPLocationFormat
Coordinate LLDPLocationCoordinate
Address LLDPLocationAddress
ECS LLDPLocationECS
}
type LLDPPowerViaMDI struct {
Type LLDPPowerType
Source LLDPPowerSource
Priority LLDPPowerPriority
Value uint16
}
// LLDPInfoMedia represents the information carried in TR-41 Org-specific TLVs
type LLDPInfoMedia struct {
MediaCapabilities LLDPMediaCapabilities
NetworkPolicy LLDPNetworkPolicy
Location LLDPLocation
PowerViaMDI LLDPPowerViaMDI
HardwareRevision string
FirmwareRevision string
SoftwareRevision string
SerialNumber string
Manufacturer string
Model string
AssetID string
}
type LLDPCisco2Subtype uint8
// Cisco2 TLV Subtypes
const (
LLDPCisco2PowerViaMDI LLDPCisco2Subtype = 1
)
const (
LLDPCiscoPSESupport uint8 = 1 << 0
LLDPCiscoArchShared uint8 = 1 << 1
LLDPCiscoPDSparePair uint8 = 1 << 2
LLDPCiscoPSESparePair uint8 = 1 << 3
)
// LLDPInfoCisco2 represents the information carried in Cisco Org-specific TLVs
type LLDPInfoCisco2 struct {
PSEFourWirePoESupported bool
PDSparePairArchitectureShared bool
PDRequestSparePairPoEOn bool
PSESparePairPoEOn bool
}
// Profinet Subtypes
type LLDPProfinetSubtype uint8
const (
LLDPProfinetPNIODelay LLDPProfinetSubtype = 1
LLDPProfinetPNIOPortStatus LLDPProfinetSubtype = 2
LLDPProfinetPNIOMRPPortStatus LLDPProfinetSubtype = 4
LLDPProfinetPNIOChassisMAC LLDPProfinetSubtype = 5
LLDPProfinetPNIOPTCPStatus LLDPProfinetSubtype = 6
)
type LLDPPNIODelay struct {
RXLocal uint32
RXRemote uint32
TXLocal uint32
TXRemote uint32
CableLocal uint32
}
type LLDPPNIOPortStatus struct {
Class2 uint16
Class3 uint16
}
type LLDPPNIOMRPPortStatus struct {
UUID []byte
Status uint16
}
type LLDPPNIOPTCPStatus struct {
MasterAddress []byte
SubdomainUUID []byte
IRDataUUID []byte
PeriodValid bool
PeriodLength uint32
RedPeriodValid bool
RedPeriodBegin uint32
OrangePeriodValid bool
OrangePeriodBegin uint32
GreenPeriodValid bool
GreenPeriodBegin uint32
}
// LLDPInfoProfinet represents the information carried in Profinet Org-specific TLVs
type LLDPInfoProfinet struct {
PNIODelay LLDPPNIODelay
PNIOPortStatus LLDPPNIOPortStatus
PNIOMRPPortStatus LLDPPNIOMRPPortStatus
ChassisMAC []byte
PNIOPTCPStatus LLDPPNIOPTCPStatus
}
// LayerType returns gopacket.LayerTypeLinkLayerDiscovery.
func (c *LinkLayerDiscovery) LayerType() gopacket.LayerType {
return LayerTypeLinkLayerDiscovery
}
// SerializeTo serializes LLDP packet to bytes and writes on SerializeBuffer.
func (c *LinkLayerDiscovery) SerializeTo(b gopacket.SerializeBuffer, opts gopacket.SerializeOptions) error {
chassIDLen := c.ChassisID.serializedLen()
portIDLen := c.PortID.serializedLen()
vb, err := b.AppendBytes(chassIDLen + portIDLen + 4) // +4 for TTL
if err != nil {
return err
}
copy(vb[:chassIDLen], c.ChassisID.serialize())
copy(vb[chassIDLen:], c.PortID.serialize())
ttlIDLen := uint16(LLDPTLVTTL)<<9 | uint16(2)
binary.BigEndian.PutUint16(vb[chassIDLen+portIDLen:], ttlIDLen)
binary.BigEndian.PutUint16(vb[chassIDLen+portIDLen+2:], c.TTL)
vb, err = b.AppendBytes(2) // End Tlv, 2 bytes
if err != nil {
return err
}
binary.BigEndian.PutUint16(vb[len(vb)-2:], uint16(0)) //End tlv, 2 bytes, all zero
return nil
}
func decodeLinkLayerDiscovery(data []byte, p gopacket.PacketBuilder) error {
var vals []LinkLayerDiscoveryValue
vData := data[0:]
for len(vData) > 0 {
if len(vData) < 2 {
p.SetTruncated()
return errors.New("LLDP vdata < 2 bytes")
}
nbit := vData[0] & 0x01
t := LLDPTLVType(vData[0] >> 1)
val := LinkLayerDiscoveryValue{Type: t, Length: uint16(nbit)<<8 + uint16(vData[1])}
if val.Length > 0 {
if len(vData) < int(val.Length+2) {
p.SetTruncated()
return fmt.Errorf("LLDP VData < %d bytes", val.Length+2)
}
val.Value = vData[2 : val.Length+2]
}
vals = append(vals, val)
if t == LLDPTLVEnd {
break
}
if len(vData) < int(2+val.Length) {
return errors.New("Malformed LinkLayerDiscovery Header")
}
vData = vData[2+val.Length:]
}
if len(vals) < 4 {
return errors.New("Missing mandatory LinkLayerDiscovery TLV")
}
c := &LinkLayerDiscovery{}
gotEnd := false
for _, v := range vals {
switch v.Type {
case LLDPTLVEnd:
gotEnd = true
case LLDPTLVChassisID:
if len(v.Value) < 2 {
return errors.New("Malformed LinkLayerDiscovery ChassisID TLV")
}
c.ChassisID.Subtype = LLDPChassisIDSubType(v.Value[0])
c.ChassisID.ID = v.Value[1:]
case LLDPTLVPortID:
if len(v.Value) < 2 {
return errors.New("Malformed LinkLayerDiscovery PortID TLV")
}
c.PortID.Subtype = LLDPPortIDSubType(v.Value[0])
c.PortID.ID = v.Value[1:]
case LLDPTLVTTL:
if len(v.Value) < 2 {
return errors.New("Malformed LinkLayerDiscovery TTL TLV")
}
c.TTL = binary.BigEndian.Uint16(v.Value[0:2])
default:
c.Values = append(c.Values, v)
}
}
if c.ChassisID.Subtype == 0 || c.PortID.Subtype == 0 || !gotEnd {
return errors.New("Missing mandatory LinkLayerDiscovery TLV")
}
c.Contents = data
p.AddLayer(c)
info := &LinkLayerDiscoveryInfo{}
p.AddLayer(info)
for _, v := range c.Values {
switch v.Type {
case LLDPTLVPortDescription:
info.PortDescription = string(v.Value)
case LLDPTLVSysName:
info.SysName = string(v.Value)
case LLDPTLVSysDescription:
info.SysDescription = string(v.Value)
case LLDPTLVSysCapabilities:
if err := checkLLDPTLVLen(v, 4); err != nil {
return err
}
info.SysCapabilities.SystemCap = getCapabilities(binary.BigEndian.Uint16(v.Value[0:2]))
info.SysCapabilities.EnabledCap = getCapabilities(binary.BigEndian.Uint16(v.Value[2:4]))
case LLDPTLVMgmtAddress:
if err := checkLLDPTLVLen(v, 9); err != nil {
return err
}
mlen := v.Value[0]
if err := checkLLDPTLVLen(v, int(mlen+7)); err != nil {
return err
}
info.MgmtAddress.Subtype = IANAAddressFamily(v.Value[1])
info.MgmtAddress.Address = v.Value[2 : mlen+1]
info.MgmtAddress.InterfaceSubtype = LLDPInterfaceSubtype(v.Value[mlen+1])
info.MgmtAddress.InterfaceNumber = binary.BigEndian.Uint32(v.Value[mlen+2 : mlen+6])
olen := v.Value[mlen+6]
if err := checkLLDPTLVLen(v, int(mlen+6+olen)); err != nil {
return err
}
info.MgmtAddress.OID = string(v.Value[mlen+9 : mlen+9+olen])
case LLDPTLVOrgSpecific:
if err := checkLLDPTLVLen(v, 4); err != nil {
return err
}
info.OrgTLVs = append(info.OrgTLVs, LLDPOrgSpecificTLV{IEEEOUI(binary.BigEndian.Uint32(append([]byte{byte(0)}, v.Value[0:3]...))), uint8(v.Value[3]), v.Value[4:]})
}
}
return nil
}
func (l *LinkLayerDiscoveryInfo) Decode8021() (info LLDPInfo8021, err error) {
for _, o := range l.OrgTLVs {
if o.OUI != IEEEOUI8021 {
continue
}
switch o.SubType {
case LLDP8021SubtypePortVLANID:
if err = checkLLDPOrgSpecificLen(o, 2); err != nil {
return
}
info.PVID = binary.BigEndian.Uint16(o.Info[0:2])
case LLDP8021SubtypeProtocolVLANID:
if err = checkLLDPOrgSpecificLen(o, 3); err != nil {
return
}
sup := (o.Info[0]&LLDPProtocolVLANIDCapability > 0)
en := (o.Info[0]&LLDPProtocolVLANIDStatus > 0)
id := binary.BigEndian.Uint16(o.Info[1:3])
info.PPVIDs = append(info.PPVIDs, PortProtocolVLANID{sup, en, id})
case LLDP8021SubtypeVLANName:
if err = checkLLDPOrgSpecificLen(o, 2); err != nil {
return
}
id := binary.BigEndian.Uint16(o.Info[0:2])
info.VLANNames = append(info.VLANNames, VLANName{id, string(o.Info[3:])})
case LLDP8021SubtypeProtocolIdentity:
if err = checkLLDPOrgSpecificLen(o, 1); err != nil {
return
}
l := int(o.Info[0])
if l > 0 {
info.ProtocolIdentities = append(info.ProtocolIdentities, o.Info[1:1+l])
}
case LLDP8021SubtypeVDIUsageDigest:
if err = checkLLDPOrgSpecificLen(o, 4); err != nil {
return
}
info.VIDUsageDigest = binary.BigEndian.Uint32(o.Info[0:4])
case LLDP8021SubtypeManagementVID:
if err = checkLLDPOrgSpecificLen(o, 2); err != nil {
return
}
info.ManagementVID = binary.BigEndian.Uint16(o.Info[0:2])
case LLDP8021SubtypeLinkAggregation:
if err = checkLLDPOrgSpecificLen(o, 5); err != nil {
return
}
sup := (o.Info[0]&LLDPAggregationCapability > 0)
en := (o.Info[0]&LLDPAggregationStatus > 0)
info.LinkAggregation = LLDPLinkAggregation{sup, en, binary.BigEndian.Uint32(o.Info[1:5])}
}
}
return
}
func (l *LinkLayerDiscoveryInfo) Decode8023() (info LLDPInfo8023, err error) {
for _, o := range l.OrgTLVs {
if o.OUI != IEEEOUI8023 {
continue
}
switch o.SubType {
case LLDP8023SubtypeMACPHY:
if err = checkLLDPOrgSpecificLen(o, 5); err != nil {
return
}
sup := (o.Info[0]&LLDPMACPHYCapability > 0)
en := (o.Info[0]&LLDPMACPHYStatus > 0)
ca := binary.BigEndian.Uint16(o.Info[1:3])
mau := binary.BigEndian.Uint16(o.Info[3:5])
info.MACPHYConfigStatus = LLDPMACPHYConfigStatus{sup, en, ca, mau}
case LLDP8023SubtypeMDIPower:
if err = checkLLDPOrgSpecificLen(o, 3); err != nil {
return
}
info.PowerViaMDI.PortClassPSE = (o.Info[0]&LLDPMDIPowerPortClass > 0)
info.PowerViaMDI.PSESupported = (o.Info[0]&LLDPMDIPowerCapability > 0)
info.PowerViaMDI.PSEEnabled = (o.Info[0]&LLDPMDIPowerStatus > 0)
info.PowerViaMDI.PSEPairsAbility = (o.Info[0]&LLDPMDIPowerPairsAbility > 0)
info.PowerViaMDI.PSEPowerPair = uint8(o.Info[1])
info.PowerViaMDI.PSEClass = uint8(o.Info[2])
if len(o.Info) >= 7 {
info.PowerViaMDI.Type = LLDPPowerType((o.Info[3] & 0xc0) >> 6)
info.PowerViaMDI.Source = LLDPPowerSource((o.Info[3] & 0x30) >> 4)
if info.PowerViaMDI.Type == 1 || info.PowerViaMDI.Type == 3 {
info.PowerViaMDI.Source += 128 // For Stringify purposes
}
info.PowerViaMDI.Priority = LLDPPowerPriority(o.Info[3] & 0x0f)
info.PowerViaMDI.Requested = binary.BigEndian.Uint16(o.Info[4:6])
info.PowerViaMDI.Allocated = binary.BigEndian.Uint16(o.Info[6:8])
}
case LLDP8023SubtypeLinkAggregation:
if err = checkLLDPOrgSpecificLen(o, 5); err != nil {
return
}
sup := (o.Info[0]&LLDPAggregationCapability > 0)
en := (o.Info[0]&LLDPAggregationStatus > 0)
info.LinkAggregation = LLDPLinkAggregation{sup, en, binary.BigEndian.Uint32(o.Info[1:5])}
case LLDP8023SubtypeMTU:
if err = checkLLDPOrgSpecificLen(o, 2); err != nil {
return
}
info.MTU = binary.BigEndian.Uint16(o.Info[0:2])
}
}