-
-
Notifications
You must be signed in to change notification settings - Fork 30
/
Copy pathmh.py
2764 lines (2272 loc) · 111 KB
/
mh.py
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
# -*- coding: utf-8 -*-
# pylint: disable=fixme
"""mobility header
:mod:`pcapkit.protocols.internet.mh` contains
:class:`~pcapkit.protocols.internet.mh.MH` only,
which implements extractor for Mobility Header
(MH) [*]_, whose structure is described as below:
======= ========= ================== ===============================
Octets Bits Name Description
======= ========= ================== ===============================
0 0 ``mh.next`` Next Header
1 8 ``mh.length`` Header Length
2 16 ``mh.type`` Mobility Header Type
3 24 Reserved
4 32 ``mh.chksum`` Checksum
6 48 ``mh.data`` Message Data
======= ========= ================== ===============================
.. [*] https://en.wikipedia.org/wiki/Mobile_IP#Changes_in_IPv6_for_Mobile_IPv6
"""
import collections
import datetime
import ipaddress
import math
from typing import TYPE_CHECKING, cast, overload
from pcapkit.const.mh.access_type import AccessType as Enum_AccessType
from pcapkit.const.mh.ack_status_code import ACKStatusCode as Enum_ACKStatusCode
from pcapkit.const.mh.ani_suboption import ANISuboption as Enum_ANISuboption
from pcapkit.const.mh.auth_subtype import AuthSubtype as Enum_AuthSubtype
from pcapkit.const.mh.binding_ack_flag import BindingACKFlag as Enum_BindingACKFlag
from pcapkit.const.mh.binding_error import BindingError as Enum_BindingError
from pcapkit.const.mh.binding_revocation import BindingRevocation as Enum_BindingRevocation
from pcapkit.const.mh.binding_update_flag import BindingUpdateFlag as Enum_BindingUpdateFlag
from pcapkit.const.mh.cga_extension import CGAExtension as Enum_CGAExtension
from pcapkit.const.mh.cga_type import CGAType as Enum_CGAType
from pcapkit.const.mh.dhcp_support_mode import DHCPSupportMode as Enum_DHCPSupportMode
from pcapkit.const.mh.dns_status_code import DNSStatusCode as Enum_DNSStatusCode
from pcapkit.const.mh.dsmip6_tls_packet import DSMIP6TLSPacket as Enum_DSMIP6TLSPacket
from pcapkit.const.mh.dsmipv6_home_address import DSMIPv6HomeAddress as Enum_DSMIPv6HomeAddress
from pcapkit.const.mh.enumerating_algorithm import EnumeratingAlgorithm as Enum_EnumeratingAlgorithm
from pcapkit.const.mh.fb_ack_status import FlowBindingACKStatus as Enum_FlowBindingACKStatus
from pcapkit.const.mh.fb_action import FlowBindingAction as Enum_FlowBindingAction
from pcapkit.const.mh.fb_indication_trigger import \
FlowBindingIndicationTrigger as Enum_FlowBindingIndicationTrigger
from pcapkit.const.mh.fb_type import FlowBindingType as Enum_FlowBindingType
from pcapkit.const.mh.flow_id_status import FlowIDStatus as Enum_FlowIDStatus
from pcapkit.const.mh.flow_id_suboption import FlowIDSuboption as Enum_FlowIDSuboption
from pcapkit.const.mh.handoff_type import HandoffType as Enum_HandoffType
from pcapkit.const.mh.handover_ack_flag import HandoverACKFlag as Enum_HandoverACKFlag
from pcapkit.const.mh.handover_ack_status import HandoverACKStatus as Enum_HandoverACKStatus
from pcapkit.const.mh.handover_initiate_flag import \
HandoverInitiateFlag as Enum_HandoverInitiateFlag
from pcapkit.const.mh.home_address_reply import HomeAddressReply as Enum_HomeAddressReply
from pcapkit.const.mh.lla_code import LLACode as Enum_LLACode
from pcapkit.const.mh.lma_mag_suboption import \
LMAControlledMAGSuboption as Enum_LMAControlledMAGSuboption
from pcapkit.const.mh.mn_group_id import MNGroupID as Enum_MNGroupID
from pcapkit.const.mh.mn_id_subtype import MNIDSubtype as Enum_MNIDSubtype
from pcapkit.const.mh.operator_id import OperatorID as Enum_OperatorID
from pcapkit.const.mh.option import Option as Enum_Option
from pcapkit.const.mh.packet import Packet as Enum_Packet
from pcapkit.const.mh.qos_attribute import QoSAttribute as Enum_QoSAttribute
from pcapkit.const.mh.revocation_status_code import \
RevocationStatusCode as Enum_RevocationStatusCode
from pcapkit.const.mh.revocation_trigger import RevocationTrigger as Enum_RevocationTrigger
from pcapkit.const.mh.status_code import StatusCode as Enum_StatusCode
from pcapkit.const.mh.traffic_selector import TrafficSelector as Enum_TrafficSelector
from pcapkit.const.mh.upa_status import \
UpdateNotificationACKStatus as Enum_UpdateNotificationACKStatus
from pcapkit.const.mh.upn_reason import UpdateNotificationReason as Enum_UpdateNotificationReason
from pcapkit.const.reg.transtype import TransType as Enum_TransType
from pcapkit.protocols.data.internet.mh import MH as Data_MH
from pcapkit.protocols.data.internet.mh import \
AlternateCareofAddressOption as Data_AlternateCareofAddressOption
from pcapkit.protocols.data.internet.mh import AuthOption as Data_AuthOption
from pcapkit.protocols.data.internet.mh import \
AuthorizationDataOption as Data_AuthorizationDataOption
from pcapkit.protocols.data.internet.mh import \
BindingAcknowledgementMessage as Data_BindingAcknowledgementMessage
from pcapkit.protocols.data.internet.mh import BindingErrorMessage as Data_BindingErrorMessage
from pcapkit.protocols.data.internet.mh import \
BindingRefreshAdviceOption as Data_BindingRefreshAdviceOption
from pcapkit.protocols.data.internet.mh import \
BindingRefreshRequestMessage as Data_BindingRefreshRequestMessage
from pcapkit.protocols.data.internet.mh import BindingUpdateMessage as Data_BindingUpdateMessage
from pcapkit.protocols.data.internet.mh import CareofTestInitMessage as Data_CareofTestInitMessage
from pcapkit.protocols.data.internet.mh import CareofTestInitOption as Data_CareofTestInitOption
from pcapkit.protocols.data.internet.mh import CareofTestMessage as Data_CareofTestMessage
from pcapkit.protocols.data.internet.mh import CareofTestOption as Data_CareofTestOption
from pcapkit.protocols.data.internet.mh import CGAExtension as Data_CGAExtension
from pcapkit.protocols.data.internet.mh import CGAParameter as Data_CGAParameter
from pcapkit.protocols.data.internet.mh import CGAParametersOption as Data_CGAParametersOption
from pcapkit.protocols.data.internet.mh import \
CGAParametersRequestOption as Data_CGAParametersRequestOption
from pcapkit.protocols.data.internet.mh import HomeTestInitMessage as Data_HomeTestInitMessage
from pcapkit.protocols.data.internet.mh import HomeTestMessage as Data_HomeTestMessage
from pcapkit.protocols.data.internet.mh import LinkLayerAddressOption as Data_LinkLayerAddressOption
from pcapkit.protocols.data.internet.mh import MesgIDOption as Data_MesgIDOption
from pcapkit.protocols.data.internet.mh import MNIDOption as Data_MNIDOption
from pcapkit.protocols.data.internet.mh import \
MobileNetworkPrefixOption as Data_MobileNetworkPrefixOption
from pcapkit.protocols.data.internet.mh import MultiPrefixExtension as Data_MultiPrefixExtension
from pcapkit.protocols.data.internet.mh import NonceIndicesOption as Data_NonceIndicesOption
from pcapkit.protocols.data.internet.mh import PadOption as Data_PadOption
from pcapkit.protocols.data.internet.mh import \
PermanentHomeKeygenTokenOption as Data_PermanentHomeKeygenTokenOption
from pcapkit.protocols.data.internet.mh import SignatureOption as Data_SignatureOption
from pcapkit.protocols.data.internet.mh import UnassignedOption as Data_UnassignedOption
from pcapkit.protocols.data.internet.mh import UnknownExtension as Data_UnknownExtension
from pcapkit.protocols.data.internet.mh import UnknownMessage as Data_UnknownMessage
from pcapkit.protocols.internet.internet import Internet
from pcapkit.protocols.schema.internet.mh import MH as Schema_MH
from pcapkit.protocols.schema.internet.mh import \
AlternateCareofAddressOption as Schema_AlternateCareofAddressOption
from pcapkit.protocols.schema.internet.mh import AuthOption as Schema_AuthOption
from pcapkit.protocols.schema.internet.mh import \
AuthorizationDataOption as Schema_AuthorizationDataOption
from pcapkit.protocols.schema.internet.mh import \
BindingAcknowledgementMessage as Schema_BindingAcknowledgementMessage
from pcapkit.protocols.schema.internet.mh import BindingErrorMessage as Schema_BindingErrorMessage
from pcapkit.protocols.schema.internet.mh import \
BindingRefreshAdviceOption as Schema_BindingRefreshAdviceOption
from pcapkit.protocols.schema.internet.mh import \
BindingRefreshRequestMessage as Schema_BindingRefreshRequestMessage
from pcapkit.protocols.schema.internet.mh import BindingUpdateMessage as Schema_BindingUpdateMessage
from pcapkit.protocols.schema.internet.mh import \
CareofTestInitMessage as Schema_CareofTestInitMessage
from pcapkit.protocols.schema.internet.mh import CareofTestInitOption as Schema_CareofTestInitOption
from pcapkit.protocols.schema.internet.mh import CareofTestMessage as Schema_CareofTestMessage
from pcapkit.protocols.schema.internet.mh import CareofTestOption as Schema_CareofTestOption
from pcapkit.protocols.schema.internet.mh import CGAExtension as Schema_CGAExtension
from pcapkit.protocols.schema.internet.mh import CGAParameter as Schema_CGAParameter
from pcapkit.protocols.schema.internet.mh import CGAParametersOption as Schema_CGAParametersOption
from pcapkit.protocols.schema.internet.mh import \
CGAParametersRequestOption as Schema_CGAParametersRequestOption
from pcapkit.protocols.schema.internet.mh import HomeTestInitMessage as Schema_HomeTestInitMessage
from pcapkit.protocols.schema.internet.mh import HomeTestMessage as Schema_HomeTestMessage
from pcapkit.protocols.schema.internet.mh import \
LinkLayerAddressOption as Schema_LinkLayerAddressOption
from pcapkit.protocols.schema.internet.mh import MesgIDOption as Schema_MesgIDOption
from pcapkit.protocols.schema.internet.mh import MNIDOption as Schema_MNIDOption
from pcapkit.protocols.schema.internet.mh import \
MobileNetworkPrefixOption as Schema_MobileNetworkPrefixOption
from pcapkit.protocols.schema.internet.mh import MultiPrefixExtension as Schema_MultiPrefixExtension
from pcapkit.protocols.schema.internet.mh import NonceIndicesOption as Schema_NonceIndicesOption
from pcapkit.protocols.schema.internet.mh import PadOption as Schema_PadOption
from pcapkit.protocols.schema.internet.mh import \
PermanentHomeKeygenTokenOption as Schema_PermanentHomeKeygenTokenOption
from pcapkit.protocols.schema.internet.mh import SignatureOption as Schema_SignatureOption
from pcapkit.protocols.schema.internet.mh import UnassignedOption as Schema_UnassignedOption
from pcapkit.protocols.schema.internet.mh import UnknownExtension as Schema_UnknownExtension
from pcapkit.protocols.schema.internet.mh import UnknownMessage as Schema_UnknownMessage
from pcapkit.utilities.exceptions import ProtocolError, UnsupportedCall
from pcapkit.utilities.warnings import ProtocolWarning, RegistryWarning, warn
if TYPE_CHECKING:
from datetime import datetime as dt_type
from datetime import timedelta
from enum import IntEnum as StdlibEnum
from ipaddress import IPv6Address, IPv6Network
from typing import IO, Any, Callable, DefaultDict, NoReturn, Optional, Type
from aenum import IntEnum as AenumEnum
from mypy_extensions import DefaultArg, KwArg, NamedArg
from typing_extensions import Literal
from pcapkit.corekit.multidict import OrderedMultiDict
from pcapkit.corekit.protochain import ProtoChain
from pcapkit.protocols.data.internet.mh import Option as Data_Option
from pcapkit.protocols.protocol import ProtocolBase as Protocol
from pcapkit.protocols.schema.internet.mh import Option as Schema_Option
from pcapkit.protocols.schema.internet.mh import Packet as Schema_Packet
from pcapkit.protocols.schema.schema import Schema
Option = OrderedMultiDict[Enum_Option, Data_Option]
Extension = OrderedMultiDict[Enum_CGAExtension, Data_CGAExtension]
PacketParser = Callable[[Schema_Packet, NamedArg(Schema_MH, 'header')], Data_MH]
PacketConstructor = Callable[[DefaultArg(Optional[Data_MH]),
KwArg(Any)], Schema_Packet]
OptionParser = Callable[[Schema_Option, NamedArg(Option, 'options')], Data_Option]
OptionConstructor = Callable[[Enum_Option, DefaultArg(Optional[Data_Option]),
KwArg(Any)], Schema_Option]
ExtensionParser = Callable[[Schema_CGAExtension, NamedArg(Extension, 'extensions')], Data_CGAExtension]
ExtensionConstructor = Callable[[Enum_CGAExtension, DefaultArg(Optional[Data_CGAExtension]),
KwArg(Any)], Schema_CGAExtension]
__all__ = ['MH']
class NTPTimestamp(collections.namedtuple('NTPTimestamp', 'seconds fraction')):
"""NTP timestamp format, c.f., :rfc:`1305`."""
__slots__ = ()
#: Seconds since 1 January 1900.
seconds: int
#: Fraction of a second.
fraction: int
class MH(Internet[Data_MH, Schema_MH],
schema=Schema_MH, data=Data_MH):
"""This class implements Mobility Header.
This class currently supports parsing og the following MH message types,
which are resgitered in the :attr:`self.__message__ <pcapkit.protocols.internet.mh.MH.__message__>`
attribute:
.. list-table::
:header-rows: 1
* - Message Type
- Message Parser
- Message Constructor
* - :attr:`~pcapkit.const.mh.packet.Packet.Binding_Refresh_Request`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_brr`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_brr`
* - :attr:`~pcapkit.const.mh.packet.Packet.Home_Test_Init`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_hoti`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_hoti`
* - :attr:`~pcapkit.const.mh.packet.Packet.Care_of_Test_Init`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_coti`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_coti`
* - :attr:`~pcapkit.const.mh.packet.Packet.Home_Test`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_hot`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_hot`
* - :attr:`~pcapkit.const.mh.packet.Packet.Care_of_Test`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_cot`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_cot`
* - :attr:`~pcapkit.const.mh.packet.Packet.Binding_Update`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_bu`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_bu`
* - :attr:`~pcapkit.const.mh.packet.Packet.Binding_Acknowledgement`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_ba`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_ba`
* - :attr:`~pcapkit.const.mh.packet.Packet.Binding_Error`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_msg_be`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_msg_be`
This class currently supports parsing the following MH options, which are
registered in the :attr:`self.__option__ <pcapkit.protocols.internet.mh.MH.__option__>`
attribute:
.. list-table::
:header-rows: 1
* - Option Code
- Option Parser
- Option Constructor
* - :attr:`~pcapkit.const.mh.option.Option.Pad1`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_pad`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_pad`
* - :attr:`~pcapkit.const.mh.option.Option.PadN`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_pad`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_pad`
* - :attr:`~pcapkit.const.mh.option.Option.Binding_Refresh_Advice`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_bra`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_bra`
* - :attr:`~pcapkit.const.mh.option.Option.Alternate_Care_of_Address`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_aca`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_aca`
* - :attr:`~pcapkit.const.mh.option.Option.Nonce_Indices`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_ni`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_ni`
* - :attr:`~pcapkit.const.mh.option.Option.Authorization_Data`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_bad`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_bad`
* - :attr:`~pcapkit.const.mh.option.Option.Mobile_Network_Prefix_Option`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_mnp`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_mnp`
* - :attr:`~pcapkit.const.mh.option.Option.Mobility_Header_Link_Layer_Address_option`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_lla`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_lla`
* - :attr:`~pcapkit.const.mh.option.Option.MN_ID_OPTION_TYPE`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_mn_id`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_mn_id`
* - :attr:`~pcapkit.const.mh.option.Option.AUTH_OPTION_TYPE`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_auth`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_auth`
* - :attr:`~pcapkit.const.mh.option.Option.MESG_ID_OPTION_TYPE`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_mesg_id`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_mesg_id`
* - :attr:`~pcapkit.const.mh.option.Option.CGA_Parameters_Request`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_cga_pr`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_cga_pr`
* - :attr:`~pcapkit.const.mh.option.Option.CGA_Parameters`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_cga_param`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_cga_param`
* - :attr:`~pcapkit.const.mh.option.Option.Signature`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_signature`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_signature`
* - :attr:`~pcapkit.const.mh.option.Option.Permanent_Home_Keygen_Token`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_phkt`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_phkt`
* - :attr:`~pcapkit.const.mh.option.Option.Care_of_Test_Init`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_ct_init`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_ct_init`
* - :attr:`~pcapkit.const.mh.option.Option.Care_of_Test`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_opt_ct`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_opt_ct`
This class currently supports parsing of the following MH CGA extensions,
which are registered in the :attr:`self.__extension__ <pcapkit.protocols.internet.mh.MH.__extension__>`
attribute:
.. list-table::
:header-rows: 1
* - CGA Extension Code
- CGA Extension Parser
- CGA Extension Constructor
* - :attr:`~pcapkit.const.mh.extension.cga_extension.CGAExtension.Multi_Prefix`
- :meth:`~pcapkit.protocols.internet.mh.MH._read_ext_multiprefix`
- :meth:`~pcapkit.protocols.internet.mh.MH._make_ext_multiprefix`
"""
##########################################################################
# Defaults.
##########################################################################
#: DefaultDict[Enum_Packet, str | tuple[PacketParser, PacketConstructor]]:
#: Message type to method mapping. Method names are expected to be referred
#: to the class by ``_read_msg_${name}`` and/or ``_make_msg_${name}``,
#: and if such name not found, the value should then be a method that can
#: parse the message type by itself.
__message__ = collections.defaultdict(
lambda: 'unknown',
{
Enum_Packet.Binding_Refresh_Request: 'brr',
Enum_Packet.Home_Test_Init: 'hoti',
Enum_Packet.Care_of_Test_Init: 'coti',
Enum_Packet.Home_Test: 'hot',
Enum_Packet.Care_of_Test: 'cot',
Enum_Packet.Binding_Update: 'bu',
Enum_Packet.Binding_Acknowledgement: 'ba',
Enum_Packet.Binding_Error: 'be',
},
) # type: DefaultDict[Enum_Packet | int, str | tuple[PacketParser, PacketConstructor]]
#: DefaultDict[Enum_Option, str | tuple[OptionParser, OptionConstructor]]:
#: Option type to method mapping. Method names are expected to be referred
#: to the class by ``_read_option_${name}`` and/or ``_make_opt_${name}``,
#: and if such name not found, the value should then be a method that can
#: parse the option by itself.
__option__ = collections.defaultdict(
lambda: 'none',
{
Enum_Option.Pad1: 'pad',
Enum_Option.PadN: 'pad',
Enum_Option.Binding_Refresh_Advice: 'bra',
Enum_Option.Alternate_Care_of_Address: 'aca',
Enum_Option.Nonce_Indices: 'ni',
Enum_Option.Authorization_Data: 'bad',
Enum_Option.Mobile_Network_Prefix_Option: 'mnp',
Enum_Option.Mobility_Header_Link_Layer_Address_option: 'lla',
Enum_Option.MN_ID_OPTION_TYPE: 'mn_id',
Enum_Option.AUTH_OPTION_TYPE: 'auth',
Enum_Option.MESG_ID_OPTION_TYPE: 'mesg_id',
Enum_Option.CGA_Parameters_Request: 'cga_pr',
Enum_Option.CGA_Parameters: 'cga_param',
Enum_Option.Signature: 'signature',
Enum_Option.Permanent_Home_Keygen_Token: 'phkt',
Enum_Option.Care_of_Test_Init: 'ct_init',
Enum_Option.Care_of_Test: 'ct',
},
) # type: DefaultDict[Enum_Option | int, str | tuple[OptionParser, OptionConstructor]]
#: DefaultDict[Enum_CGAExtension, str | tuple[ExtensionParser, ExtensionConstructor]]:
#: CGA extension type to method mapping. Method names are expected to be referred
#: to the class by ``_read_extension_${name}`` and/or ``_make_ext_${name}``,
#: and if such name not found, the value should then be a method that can
#: parse the CGA extension by itself.
__extension__ = collections.defaultdict(
lambda: 'none',
{
Enum_CGAExtension.Multi_Prefix: 'multiprefix',
},
) # type: DefaultDict[Enum_CGAExtension | int, str | tuple[ExtensionParser, ExtensionConstructor]]
##########################################################################
# Properties.
##########################################################################
@property
def name(self) -> 'Literal["Mobility Header"]':
"""Name of current protocol."""
return 'Mobility Header'
@property
def length(self) -> 'int':
"""Header length of current protocol."""
return self._info.length
@property
def payload(self) -> 'Protocol | NoReturn':
"""Payload of current instance.
Raises:
UnsupportedCall: if the protocol is used as an IPv6 extension header
"""
if self._extf:
raise UnsupportedCall(f"'{self.__class__.__name__}' object has no attribute 'payload'")
return super().payload
@property
def protocol(self) -> 'Optional[str] | NoReturn':
"""Name of next layer protocol (if any).
Raises:
UnsupportedCall: if the protocol is used as an IPv6 extension header
"""
if self._extf:
raise UnsupportedCall(f"'{self.__class__.__name__}' object has no attribute 'protocol'")
return super().protocol
@property
def protochain(self) -> 'ProtoChain | NoReturn':
"""Protocol chain of current instance.
Raises:
UnsupportedCall: if the protocol is used as an IPv6 extension header
"""
if self._extf:
raise UnsupportedCall(f"'{self.__class__.__name__}' object has no attribute 'protochain'")
return super().protochain
##########################################################################
# Methods.
##########################################################################
def read(self, length: 'Optional[int]' = None, *, version: 'Literal[4, 6]' = 4, # pylint: disable=arguments-differ,unused-argument
extension: bool = False, **kwargs: 'Any') -> 'Data_MH': # pylint: disable=unused-argument
"""Read Mobility Header.
Structure of MH header [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Payload Proto | Header Len | MH Type | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Checksum | |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| |
. .
. Message Data .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
length: Length of packet data.
version: IP protocol version.
extension: If the protocol is used as an IPv6 extension header.
**kwargs: Arbitrary keyword arguments.
Returns:
Parsed packet data.
"""
if length is None:
length = len(self)
schema = self.__header__
name = self.__message__[schema.type]
if isinstance(name, str):
meth_name = f'_read_msg_{name}'
meth = cast('PacketParser',
getattr(self, meth_name, self._read_msg_unknown))
else:
meth = name[0]
mh = meth(schema.data, header=schema)
if extension:
return mh
return self._decode_next_layer(mh, schema.next, length - mh.length)
def make(self,
next: 'Enum_TransType | StdlibEnum | AenumEnum | str | int' = Enum_TransType.UDP,
next_default: 'Optional[int]' = None,
next_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None, # pylint: disable=line-too-long
next_reversed: 'bool' = False,
type: 'Enum_Packet | StdlibEnum | AenumEnum | str | int' = Enum_Packet.Binding_Refresh_Request,
type_default: 'Optional[int]' = None,
type_namespace: 'Optional[dict[str, int] | dict[int, str] | Type[StdlibEnum] | Type[AenumEnum]]' = None, # pylint: disable=line-too-long
type_reversed: 'bool' = False,
chksum: 'bytes' = b'',
data: 'bytes | Data_MH | Schema_Packet | dict[str, Any]' = b'\x00\x00', # minimum length
payload: 'Protocol | Schema | bytes' = b'',
**kwargs: 'Any') -> 'Schema_MH':
"""Make (construct) packet data.
Args:
next: Next header type.
next_default: Default value for next header type field.
next_namespace: Namespace of next header type field.
next_reversed: Whether the bits of next header type field is reversed.
type: Mobility Header type.
type_default: Default value for Mobility Header type field.
type_namespace: Namespace of Mobility Header type field.
type_reversed: Whether the bits of Mobility Header type field is reversed.
chksum: Checksum.
data: Message data.
payload: Payload of next layer protocol.
**kwargs: Arbitrary keyword arguments.
Returns:
Constructed packet data.
"""
next_val = self._make_index(next, next_default, namespace=next_namespace,
reversed=next_reversed, pack=False)
type_val = self._make_index(type, type_default, namespace=type_namespace,
reversed=type_reversed, pack=False)
if isinstance(data, bytes):
data_val = data # type: bytes | Schema_Packet
elif isinstance(data, (dict, Data_MH)):
name = self.__message__[type_val]
if isinstance(name, str):
meth_name = f'_make_msg_{name}'
meth = cast('PacketConstructor',
getattr(self, meth_name, self._make_msg_unknown))
else:
meth = name[1]
if isinstance(data, dict):
data_val = meth(**data)
else:
data_val = meth(data)
elif isinstance(data, Schema_Packet):
data_val = data
else:
raise ProtocolError(f'MH: [Type {type_val}] invalid format')
return Schema_MH(
next=next_val,
length=math.ceil((len(data_val) + 6) / 8) - 1,
type=type_val,
chksum=chksum,
data=data_val,
payload=payload,
)
@classmethod
def register_message(cls, code: 'Enum_Packet', meth: 'str | tuple[PacketParser, PacketConstructor]') -> 'None':
"""Register a message parser.
Args:
code: MH message type code.
meth: Method name or callable to parse and/or construct the message.
"""
if code in cls.__message__:
warn(f'message type {code} already registered, overwriting', RegistryWarning)
cls.__message__[code] = meth
@classmethod
def register_option(cls, code: 'Enum_Option', meth: 'str | tuple[OptionParser, OptionConstructor]') -> 'None':
"""Register an option parser.
Args:
code: MH option code.
meth: Method name or callable to parse and/or construct the option.
"""
if code in cls.__option__:
warn(f'option {code} already registered, overwriting', RegistryWarning)
cls.__option__[code] = meth
@classmethod
def register_extension(cls, code: 'Enum_CGAExtension', meth: 'str | tuple[ExtensionParser, ExtensionConstructor]') -> 'None':
"""Register a CGA extension parser.
Args:
code: CGA extension code.
meth: Method name or callable to parse and/or construct the extension.
"""
if code in cls.__extension__:
warn(f'extension {code} already registered, overwriting', RegistryWarning)
cls.__extension__[code] = meth
##########################################################################
# Data models.
##########################################################################
@overload
def __post_init__(self, file: 'IO[bytes] | bytes', length: 'Optional[int]' = ..., *, # pylint: disable=arguments-differ
extension: 'bool' = ..., **kwargs: 'Any') -> 'None': ...
@overload
def __post_init__(self, **kwargs: 'Any') -> 'None': ... # pylint: disable=arguments-differ
def __post_init__(self, file: 'Optional[IO[bytes] | bytes]' = None, length: 'Optional[int]' = None, *, # pylint: disable=arguments-differ
extension: 'bool' = False, **kwargs: 'Any') -> 'None':
"""Post initialisation hook.
Args:
file: Source packet stream.
length: Length of packet data.
extension: If the protocol is used as an IPv6 extension header.
**kwargs: Arbitrary keyword arguments.
See Also:
For construction argument, please refer to :meth:`self.make <MH.make>`.
"""
#: bool: If the protocol is used as an IPv6 extension header.
self._extf = extension
# call super __post_init__
super().__post_init__(file, length, extension=extension, **kwargs) # type: ignore[arg-type]
def __length_hint__(self) -> 'Literal[6]':
"""Return an estimated length for the object."""
return 6
@classmethod
def __index__(cls) -> 'Enum_TransType': # pylint: disable=invalid-index-returned
"""Numeral registry index of the protocol.
Returns:
Numeral registry index of the protocol in `IANA`_.
.. _IANA: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml
"""
return Enum_TransType.Mobility_Header # type: ignore[return-value]
##########################################################################
# Utilities.
##########################################################################
@classmethod
def _make_data(cls, data: 'Data_MH') -> 'dict[str, Any]': # type: ignore[override]
"""Create key-value pairs from ``data`` for protocol construction.
Args:
data: protocol data
Returns:
Key-value pairs for protocol construction.
"""
return {
'next': data.next,
'type': data.type,
'chksum': data.chksum,
'data': data,
'payload': cls._make_payload(data),
}
def _read_msg_unknown(self, schema: 'Schema_UnknownMessage', *,
header: 'Schema_MH') -> 'Data_UnknownMessage':
"""Read unknown MH message type.
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_UnknownMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
data=schema.data,
)
return data
def _read_msg_brr(self, schema: 'Schema_BindingRefreshRequestMessage', *,
header: 'Schema_MH') -> 'Data_BindingRefreshRequestMessage':
"""Read MH binding refresh request (BRR) message type.
Structure of MH Binding Refresh Request Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_BindingRefreshRequestMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
options=self._read_mh_options(schema.options)
)
return data
def _read_msg_hoti(self, schema: 'Schema_HomeTestInitMessage', *,
header: 'Schema_MH') -> 'Data_HomeTestInitMessage':
"""Read MH home test initiation (HoTI) message type.
Structure of MH Home Test Initiation Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Home Init Cookie +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_HomeTestInitMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
cookie=schema.cookie,
options=self._read_mh_options(schema.options)
)
return data
def _read_msg_coti(self, schema: 'Schema_CareofTestInitMessage', *,
header: 'Schema_MH') -> 'Data_CareofTestInitMessage':
"""Read MH care-of test initiation (CoTI) message type.
Structure of MH Care-of Test Initiation Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Care-of Init Cookie +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_CareofTestInitMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
cookie=schema.cookie,
options=self._read_mh_options(schema.options)
)
return data
def _read_msg_hot(self, schema: 'Schema_HomeTestMessage', *,
header: 'Schema_MH') -> 'Data_HomeTestMessage':
"""Read MH home test (HoT) message type.
Structure of MH Home Test Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Home Nonce Index |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Home Init Cookie +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Home Keygen Token +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_HomeTestMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
nonce_index=schema.nonce_index,
cookie=schema.cookie,
token=schema.token,
options=self._read_mh_options(schema.options),
)
return data
def _read_msg_cot(self, schema: 'Schema_CareofTestMessage', *,
header: 'Schema_MH') -> 'Data_CareofTestMessage':
"""Read MH care-of test (CoT) message type.
Structure of MH Care-of Test Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Care-of Nonce Index |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Care-of Init Cookie +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ Care-of Keygen Token +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_CareofTestMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
nonce_index=schema.nonce_index,
cookie=schema.cookie,
token=schema.token,
options=self._read_mh_options(schema.options),
)
return data
def _read_msg_bu(self, schema: 'Schema_BindingUpdateMessage', *,
header: 'Schema_MH') -> 'Data_BindingUpdateMessage':
"""Read MH binding update (BU) message type.
Structure of MH Binding Update Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Sequence # |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|A|H|L|K| Reserved | Lifetime |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_BindingUpdateMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
seq=schema.seq,
ack=bool(schema.flags['A']),
home=bool(schema.flags['H']),
lla_compat=bool(schema.flags['L']),
key_mngt=bool(schema.flags['K']),
lifetime=datetime.timedelta(seconds=schema.lifetime * 4),
options=self._read_mh_options(schema.options),
)
return data
def _read_msg_ba(self, schema: 'Schema_BindingAcknowledgementMessage', *,
header: 'Schema_MH') -> 'Data_BindingAcknowledgementMessage':
"""Read MH binding acknowledgement (BA) message type.
Structure of MH Binding Acknowledgement Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Status |K| Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Sequence # | Lifetime |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
. .
. Mobility Options .
. .
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
Args:
schema: Parsed message type schema.
header: Parsed MH header schema.
Returns:
Parsed message type data.
"""
data = Data_BindingAcknowledgementMessage(
next=header.next,
length=(header.length + 1) * 8,
type=header.type,
chksum=header.chksum,
status=schema.status,
key_mngt=bool(schema.flags['K']),
seq=schema.seq,
lifetime=datetime.timedelta(seconds=schema.lifetime * 4),
options=self._read_mh_options(schema.options),
)
return data
def _read_msg_be(self, schema: 'Schema_BindingErrorMessage', *,
header: 'Schema_MH') -> 'Data_BindingErrorMessage':
"""Read MH binding error (BE) message type.
Structure of MH Binding Error Message [:rfc:`6275`]:
.. code-block:: text
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Status | Reserved |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ +
| |
+ Home Address +
| |
+ +
| |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
. .
. Mobility Options .
. .
| |