2020-07-30 16:20:24 -07:00
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
# jc.parsers.ss
|
2020-08-05 16:51:58 -07:00
|
|
|
jc - JSON CLI output utility `ss` command output parser
|
2019-11-13 07:45:37 -08:00
|
|
|
|
2020-08-05 13:32:59 -07:00
|
|
|
Usage (cli):
|
2019-12-12 09:47:14 -08:00
|
|
|
|
2020-08-05 16:51:58 -07:00
|
|
|
$ ss | jc --ss
|
|
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
|
|
|
|
$ jc ss
|
2019-11-14 17:23:44 -08:00
|
|
|
|
2020-08-05 13:32:59 -07:00
|
|
|
Usage (module):
|
|
|
|
|
|
|
|
|
|
import jc.parsers.ss
|
|
|
|
|
result = jc.parsers.ss.parse(ss_command_output)
|
|
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
Limitations:
|
2019-12-12 09:47:14 -08:00
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
Extended information options like -e and -p are not supported and may cause parsing irregularities
|
2019-11-14 13:37:55 -08:00
|
|
|
|
2019-12-12 09:35:42 -08:00
|
|
|
Compatibility:
|
2019-12-12 09:47:14 -08:00
|
|
|
|
2019-12-12 09:35:42 -08:00
|
|
|
'linux'
|
|
|
|
|
|
2019-11-13 07:45:37 -08:00
|
|
|
Examples:
|
|
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
$ sudo ss -a | jc --ss -p
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"netid": "nl",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"channel": "rtnl:kernel"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "nl",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"pid": 893,
|
|
|
|
|
"channel": "rtnl:systemd-resolve"
|
|
|
|
|
},
|
|
|
|
|
...
|
|
|
|
|
{
|
|
|
|
|
"netid": "p_raw",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"link_layer": "LLDP",
|
|
|
|
|
"interface": "ens33"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "u_dgr",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"local_port": "93066",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "0",
|
|
|
|
|
"path": "/run/user/1000/systemd/notify"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "u_seq",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 128,
|
|
|
|
|
"local_port": "20699",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "0",
|
|
|
|
|
"path": "/run/udev/control"
|
|
|
|
|
},
|
|
|
|
|
...
|
|
|
|
|
{
|
|
|
|
|
"netid": "icmp6",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"local_address": "*",
|
|
|
|
|
"local_port": "ipv6-icmp",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "ens33"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "udp",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"local_address": "127.0.0.53",
|
|
|
|
|
"local_port": "domain",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "lo"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 128,
|
|
|
|
|
"local_address": "127.0.0.53",
|
|
|
|
|
"local_port": "domain",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "lo"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 128,
|
|
|
|
|
"local_address": "0.0.0.0",
|
|
|
|
|
"local_port": "ssh",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 128,
|
|
|
|
|
"local_address": "[::]",
|
|
|
|
|
"local_port": "ssh",
|
|
|
|
|
"peer_address": "[::]",
|
|
|
|
|
"peer_port": "*"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "v_str",
|
|
|
|
|
"state": "ESTAB",
|
|
|
|
|
"recv_q": 0,
|
|
|
|
|
"send_q": 0,
|
|
|
|
|
"local_address": "999900439",
|
|
|
|
|
"local_port": "1023",
|
|
|
|
|
"peer_address": "0",
|
|
|
|
|
"peer_port": "976",
|
|
|
|
|
"local_port_num": 1023,
|
|
|
|
|
"peer_port_num": 976
|
|
|
|
|
}
|
|
|
|
|
]
|
2019-11-13 07:45:37 -08:00
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
$ sudo ss -a | jc --ss -p -r
|
|
|
|
|
[
|
|
|
|
|
{
|
|
|
|
|
"netid": "nl",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"channel": "rtnl:kernel"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "nl",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"pid": "893",
|
|
|
|
|
"channel": "rtnl:systemd-resolve"
|
|
|
|
|
},
|
|
|
|
|
...
|
|
|
|
|
{
|
|
|
|
|
"netid": "p_raw",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"link_layer": "LLDP",
|
|
|
|
|
"interface": "ens33"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "u_dgr",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"local_port": "93066",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "0",
|
|
|
|
|
"path": "/run/user/1000/systemd/notify"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "u_seq",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "128",
|
|
|
|
|
"local_port": "20699",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "0",
|
|
|
|
|
"path": "/run/udev/control"
|
|
|
|
|
},
|
|
|
|
|
...
|
|
|
|
|
{
|
|
|
|
|
"netid": "icmp6",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"local_address": "*",
|
|
|
|
|
"local_port": "ipv6-icmp",
|
|
|
|
|
"peer_address": "*",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "ens33"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "udp",
|
|
|
|
|
"state": "UNCONN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"local_address": "127.0.0.53",
|
|
|
|
|
"local_port": "domain",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "lo"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "128",
|
|
|
|
|
"local_address": "127.0.0.53",
|
|
|
|
|
"local_port": "domain",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*",
|
|
|
|
|
"interface": "lo"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "128",
|
|
|
|
|
"local_address": "0.0.0.0",
|
|
|
|
|
"local_port": "ssh",
|
|
|
|
|
"peer_address": "0.0.0.0",
|
|
|
|
|
"peer_port": "*"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "tcp",
|
|
|
|
|
"state": "LISTEN",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "128",
|
|
|
|
|
"local_address": "[::]",
|
|
|
|
|
"local_port": "ssh",
|
|
|
|
|
"peer_address": "[::]",
|
|
|
|
|
"peer_port": "*"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"netid": "v_str",
|
|
|
|
|
"state": "ESTAB",
|
|
|
|
|
"recv_q": "0",
|
|
|
|
|
"send_q": "0",
|
|
|
|
|
"local_address": "999900439",
|
|
|
|
|
"local_port": "1023",
|
|
|
|
|
"peer_address": "0",
|
|
|
|
|
"peer_port": "976"
|
|
|
|
|
}
|
|
|
|
|
]
|
2019-11-13 07:45:37 -08:00
|
|
|
|
2020-07-30 16:20:24 -07:00
|
|
|
|
2019-12-14 23:35:42 -08:00
|
|
|
## info
|
|
|
|
|
```python
|
2020-07-30 16:20:24 -07:00
|
|
|
info()
|
2019-12-14 23:35:42 -08:00
|
|
|
```
|
|
|
|
|
|
2020-07-30 16:20:24 -07:00
|
|
|
|
2019-11-13 07:45:37 -08:00
|
|
|
## process
|
|
|
|
|
```python
|
|
|
|
|
process(proc_data)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Final processing to conform to the schema.
|
|
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
2021-01-04 18:01:16 -08:00
|
|
|
proc_data: (List of Dictionaries) raw structured data to process
|
2019-11-13 07:45:37 -08:00
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
2021-01-04 18:01:16 -08:00
|
|
|
List of Dictionaries. Structured data with the following schema:
|
2019-11-13 07:45:37 -08:00
|
|
|
|
|
|
|
|
[
|
|
|
|
|
{
|
2019-11-14 17:23:44 -08:00
|
|
|
"netid": string,
|
|
|
|
|
"state": string,
|
|
|
|
|
"recv_q": integer,
|
|
|
|
|
"send_q": integer,
|
|
|
|
|
"local_address": string,
|
|
|
|
|
"local_port": string,
|
|
|
|
|
"local_port_num": integer,
|
|
|
|
|
"peer_address": string,
|
|
|
|
|
"peer_port": string,
|
|
|
|
|
"peer_port_num": integer,
|
|
|
|
|
"interface": string,
|
|
|
|
|
"link_layer" string,
|
|
|
|
|
"channel": string,
|
|
|
|
|
"path": string,
|
|
|
|
|
"pid": integer
|
2019-11-13 07:45:37 -08:00
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
|
2019-11-14 17:23:44 -08:00
|
|
|
Information from https://www.cyberciti.biz/files/ss.html used to define field names
|
|
|
|
|
|
2020-07-30 16:20:24 -07:00
|
|
|
|
2019-11-13 07:45:37 -08:00
|
|
|
## parse
|
|
|
|
|
```python
|
|
|
|
|
parse(data, raw=False, quiet=False)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Main text parsing function
|
|
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
|
|
data: (string) text data to parse
|
|
|
|
|
raw: (boolean) output preprocessed JSON if True
|
|
|
|
|
quiet: (boolean) suppress warning messages if True
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
|
2021-01-04 18:01:16 -08:00
|
|
|
List of Dictionaries. Raw or processed structured data.
|
2019-11-13 07:45:37 -08:00
|
|
|
|
