1- r"""jc - JSON Convert `ipconfig` command output parser
2-
1+ r"""jc - JSON Convert `ipconfig` Windows command output parser
32
43Usage (cli):
54
65 $ ipconfig /all | jc --ipconfig
76 $ ipconfig | jc --ipconfig
7+ $ jc ipconfig /all
88
99Usage (module):
1010
2020 "ip_routing_enabled": boolean,
2121 "wins_proxy_enabled": boolean,
2222 "dns_suffix_search_list": [
23- string
23+ string
2424 ],
2525 "adapters": [
2626 {
5151 {
5252 "address": string,
5353 "status": string,
54- "prefix_length": int ,
54+ "prefix_length": integer ,
5555 }
5656 ],
5757 "ipv4_addresses": [
7272 string
7373 ],
7474 "primary_wins_server": string,
75- "lease_expires": string, # [0]
76- "lease_obtained": string, # [0]
75+ "lease_expires": string,
76+ "lease_expires_epoch": integer, # [0]
77+ "lease_expires_iso": string,
78+ "lease_obtained": string,
79+ "lease_obtained_epoch": integer, # [0]
80+ "lease_obtained_iso": string,
7781 "netbios_over_tcpip": boolean,
7882 "media_state": string,
7983 "extras": [
80- string: string
84+ <string>: string
8185 ]
8286 }
8387 ],
8488 "extras": []
8589 }
8690
8791 Notes:
88- [0] - 'lease_expires' and 'lease_obtained' are parsed to ISO8601 format date strings. if the value was unable
89- to be parsed by datetime, the fields will be in their raw form
90- [1] - 'autoconfigured' under 'ipv4_address' is only providing indication if the ipv4 address was labeled as
91- "Autoconfiguration IPv4 Address" vs "IPv4 Address". It does not infer any information from other fields
92- [2] - Windows XP uses 'IP Address' instead of 'IPv4 Address'. Both values are parsed to the 'ipv4_address'
93- object for consistency
92+ [0] - The epoch calculated timestamp field is naive. (i.e. based on
93+ the local time of the system the parser is run on)
94+ [1] - 'autoconfigured' under 'ipv4_address' is only providing
95+ indication if the ipv4 address was labeled as "Autoconfiguration
96+ IPv4 Address" vs "IPv4 Address". It does not infer any
97+ information from other fields
98+ [2] - Windows XP uses 'IP Address' instead of 'IPv4 Address'. Both
99+ values are parsed to the 'ipv4_address' object for consistency
94100
95101Examples:
96102
421427 ],
422428 "extras": []
423429 }
424-
425430"""
426431from datetime import datetime
427432import re
431436class info ():
432437 """Provides parser metadata (version, author, etc.)"""
433438 version = '1.0'
434- description = '`ipconfig` command parser'
439+ description = '`ipconfig` Windows command parser'
435440 author = 'joehacksalot'
436441 author_email = '[email protected] ' 437442 compatible = ['windows' ]
@@ -466,6 +471,7 @@ def parse(data, raw=False, quiet=False):
466471
467472 return raw_output if raw else _process (raw_output )
468473
474+
469475def _process_ipv6_address (ip_address ):
470476 address_split = ip_address ["address" ].split ('%' )
471477 try :
@@ -484,6 +490,7 @@ def _process_ipv6_address(ip_address):
484490 "status" : ip_address ["status" ]
485491 }
486492
493+
487494def _process_ipv4_address (ip_address ):
488495 autoconfigured = True if ip_address .get ("autoconfigured" ,"" ) is not None and 'autoconfigured' in ip_address .get ("autoconfigured" ,"" ) else False
489496 subnet_mask = ip_address ["subnet_mask" ]
@@ -494,6 +501,7 @@ def _process_ipv4_address(ip_address):
494501 "autoconfigured" : autoconfigured
495502 }
496503
504+
497505def _process (proc_data ):
498506 """
499507 Final processing to conform to the schema.
@@ -507,8 +515,7 @@ def _process(proc_data):
507515 Processed Dictionary. Structured data to conform to the schema.
508516 """
509517 processed = proc_data
510-
511-
518+
512519 if "ip_routing_enabled" in processed and processed ["ip_routing_enabled" ] is not None :
513520 processed ["ip_routing_enabled" ] = (processed ["ip_routing_enabled" ].lower () == "yes" )
514521
@@ -518,38 +525,47 @@ def _process(proc_data):
518525 for adapter in processed ["adapters" ]:
519526 if "dhcp_enabled" in adapter and adapter ["dhcp_enabled" ] is not None :
520527 adapter ["dhcp_enabled" ] = (adapter ["dhcp_enabled" ].lower () == "yes" )
528+
521529 if "autoconfiguration_enabled" in adapter and adapter ["autoconfiguration_enabled" ] is not None :
522530 adapter ["autoconfiguration_enabled" ] = (adapter ["autoconfiguration_enabled" ].lower () == "yes" )
531+
523532 if "netbios_over_tcpip" in adapter and adapter ["netbios_over_tcpip" ] is not None :
524533 adapter ["netbios_over_tcpip" ] = (adapter ["netbios_over_tcpip" ].lower () == "enabled" )
525- if "lease_expires" in adapter and adapter ["lease_expires" ] is not None and adapter ["lease_expires" ] != "" :
526- try :
527- adapter ["lease_expires" ] = datetime .strptime (adapter ["lease_expires" ], "%A, %B %d, %Y %I:%M:%S %p" ).isoformat ()
528- except :
529- pass # Leave date in raw format if not parseable
530- if "lease_obtained" in adapter and adapter ["lease_obtained" ] is not None and adapter ["lease_obtained" ] != "" :
531- try :
532- adapter ["lease_obtained" ] = datetime .strptime (adapter ["lease_obtained" ], "%A, %B %d, %Y %I:%M:%S %p" ).isoformat ()
533- except :
534- pass # Leave date in raw format if not parseable
534+
535+ if "lease_expires" in adapter and adapter ["lease_expires" ]:
536+ ts = jc .utils .timestamp (adapter ['lease_expires' ], format_hint = (1720 ,))
537+ adapter ["lease_expires_epoch" ] = ts .naive
538+ adapter ["lease_expires_iso" ] = ts .iso
539+
540+ if "lease_obtained" in adapter and adapter ["lease_obtained" ]:
541+ ts = jc .utils .timestamp (adapter ['lease_obtained' ], format_hint = (1720 ,))
542+ adapter ["lease_obtained_epoch" ] = ts .naive
543+ adapter ["lease_obtained_iso" ] = ts .iso
544+
535545 adapter ["link_local_ipv6_addresses" ] = [_process_ipv6_address (address ) for address in adapter .get ("link_local_ipv6_addresses" , [])]
536546 adapter ["ipv4_addresses" ] = [_process_ipv4_address (address ) for address in adapter .get ("ipv4_addresses" , [])]
547+
537548 return processed
538549
550+
539551class _PushbackIterator :
540552 def __init__ (self , iterator ):
541553 self .iterator = iterator
542554 self .pushback_stack = []
555+
543556 def __iter__ (self ):
544557 return self
558+
545559 def __next__ (self ):
546560 if self .pushback_stack :
547561 return self .pushback_stack .pop ()
548562 else :
549563 return next (self .iterator )
564+
550565 def pushback (self , value ):
551566 self .pushback_stack .append (value )
552567
568+
553569def _parse (data ):
554570 # Initialize the parsed output dictionary with all fields set to None or empty lists
555571 parse_output = {
@@ -609,10 +625,12 @@ def _parse(data):
609625
610626 return parse_output
611627
628+
612629def _is_adapter_start_line (line ):
613630 # Detect adapter start lines, e.g., "Ethernet adapter Ethernet:"
614631 return re .match (r"^[^\s].*adapter.*:" , line , re .IGNORECASE )
615632
633+
616634def _initialize_adapter (adapter_name ):
617635 adapter_name_split = adapter_name .split (" adapter " , 1 )
618636 if len (adapter_name_split ) > 1 :
@@ -650,6 +668,7 @@ def _initialize_adapter(adapter_name):
650668 "extras" : [] # To store unrecognized fields
651669 }
652670
671+
653672def _parse_line (line ):
654673 # Split the line into key and value using ':' or multiple spaces
655674 key_value = re .split (r":" , line .strip (), 1 )
@@ -662,6 +681,7 @@ def _parse_line(line):
662681 else :
663682 return None , None
664683
684+
665685def _parse_header_line (result , key , value , line_iter ):
666686 if key in ["host_name" , "primary_dns_suffix" , "node_type" , "ip_routing_enabled" , "wins_proxy_enabled" ]:
667687 result [key ] = value
@@ -674,11 +694,13 @@ def _parse_header_line(result, key, value, line_iter):
674694 # Store unrecognized fields in extras
675695 result ["extras" ].append ({key : value })
676696
697+
677698def _parse_adapter_line (adapter , key , value , line_iter ):
678699 if key in ["connection_specific_dns_suffix" ,"media_state" , "description" , "physical_address" , "dhcp_enabled" ,
679700 "autoconfiguration_enabled" , "dhcpv6_iaid" , "dhcpv6_client_duid" , "netbios_over_tcpip" , "dhcp_server" ,
680701 "lease_obtained" , "lease_expires" , "primary_wins_server" ]:
681702 adapter [key ] = value
703+
682704 elif key in ["ipv6_address" , "temporary_ipv6_address" , "link_local_ipv6_address" ]:
683705 address_dict = _parse_ipv6_address (value )
684706 if key == "ipv6_address" :
@@ -687,32 +709,39 @@ def _parse_adapter_line(adapter, key, value, line_iter):
687709 adapter ["temporary_ipv6_addresses" ].append (address_dict )
688710 elif key == "link_local_ipv6_address" :
689711 adapter ["link_local_ipv6_addresses" ].append (address_dict )
712+
690713 elif key in ["ipv4_address" , "autoconfiguration_ipv4_address" , "ip_address" , "autoconfiguration_ip_address" ]:
691714 ipv4_address_dict = _parse_ipv4_address (value , key , line_iter )
692715 adapter ["ipv4_addresses" ].append (ipv4_address_dict )
716+
693717 elif key == "connection_specific_dns_suffix_search_list" :
694718 if value :
695719 adapter ["connection_specific_dns_suffix_search_list" ].append (value )
696720 # Process additional connection specific dns suffix search list entries
697721 _parse_additional_entries (adapter ["connection_specific_dns_suffix_search_list" ], line_iter )
722+
698723 elif key == "default_gateway" :
699724 if value :
700725 adapter ["default_gateways" ].append (value )
701726 # Process additional gateways
702727 _parse_additional_entries (adapter ["default_gateways" ], line_iter )
728+
703729 elif key == "dns_servers" :
704730 if value :
705731 adapter ["dns_servers" ].append (value )
706732 # Process additional DNS servers
707733 _parse_additional_entries (adapter ["dns_servers" ], line_iter )
734+
708735 elif key == "subnet_mask" :
709736 # Subnet Mask should be associated with the last IPv4 address
710737 if adapter ["ipv4_addresses" ]:
711738 adapter ["ipv4_addresses" ][- 1 ]["subnet_mask" ] = value
739+
712740 else :
713741 # Store unrecognized fields in extras
714742 adapter ["extras" ].append ({key : value })
715743
744+
716745def _parse_ipv6_address (value ):
717746 # Handle multiple status indicators
718747 match = re .match (r"([^\(]+)\((.*)\)" , value ) if value else None
@@ -727,6 +756,7 @@ def _parse_ipv6_address(value):
727756 "status" : status
728757 }
729758
759+
730760def _parse_ipv4_address (value , key , line_iter ):
731761 # Handle autoconfigured status
732762 match = re .match (r"([^\(]+)\((.*)\)" , value ) if value else None
@@ -758,6 +788,7 @@ def _parse_ipv4_address(value, key, line_iter):
758788 "status" : status
759789 }
760790
791+
761792def _parse_additional_entries (entry_list , line_iter ):
762793 # Process additional lines that belong to the current entry (e.g., additional DNS servers, DNS Suffix Search List)
763794 while True :
@@ -775,4 +806,4 @@ def _parse_additional_entries(entry_list, line_iter):
775806 line_iter .pushback (next_line )
776807 break
777808 except StopIteration :
778- break
809+ break
0 commit comments