python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

update ufw parser docs

Browse Source
This commit is contained in:
Kelly Brazil
2021-04-25 20:49:35 -07:00
parent d1f33645ca
commit 66cb4e9bde
5 changed files with 219 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
EXAMPLES.md
View File

@ -3135,7 +3135,7 @@ ufw status verbose | jc --ufw -p # or jc -p ufw status verbose
"status": "active", "status": "active",
"logging": "on", "logging": "on",
"logging_level": "low", "logging_level": "low",
"default": "deny (incoming), allow (outgoing), deny (routed)", "default": "deny (incoming), allow (outgoing), disabled (routed)",
"new_profiles": "skip", "new_profiles": "skip",
"rules": [ "rules": [
{ {
@ -3144,10 +3144,11 @@ ufw status verbose | jc --ufw -p # or jc -p ufw status verbose
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": "tcp", "to_transport": "any",
"to_start_port": 22,
"to_end_port": 22,
"to_service": null, "to_service": null,
"to_ports": [
22
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": 0, "to_ip_prefix": 0,
"comment": null, "comment": null,
@ -3155,29 +3156,12 @@ ufw status verbose | jc --ufw -p # or jc -p ufw status verbose
"from_ip_prefix": 0, "from_ip_prefix": 0,
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": 0, "from_port_ranges": [
"from_end_port": 65535, {
"from_service": null "start": 0,
}, "end": 65535
{ }
"action": "ALLOW", ],
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_transport": "tcp",
"to_start_port": 22,
"to_end_port": 22,
"to_service": null,
"to_ip": "::",
"to_ip_prefix": 0,
"comment": null,
"from_ip": "::",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null "from_service": null
}, },
{ {
@ -3186,10 +3170,12 @@ ufw status verbose | jc --ufw -p # or jc -p ufw status verbose
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": null, "to_transport": "tcp",
"to_service": "Apache Full", "to_service": null,
"to_start_port": null, "to_ports": [
"to_end_port": null, 80,
443
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": 0, "to_ip_prefix": 0,
"comment": null, "comment": null,
@ -3197,50 +3183,12 @@ ufw status verbose | jc --ufw -p # or jc -p ufw status verbose
"from_ip_prefix": 0, "from_ip_prefix": 0,
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": 0, "from_port_ranges": [
"from_end_port": 65535, {
"from_service": null "start": 0,
}, "end": 65535
{ }
"action": "ALLOW", ],
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_ip": "2405:204:7449:49fc:f09a:6f4a:bc93:1955",
"to_ip_prefix": 128,
"to_transport": "any",
"to_start_port": 0,
"to_end_port": 65535,
"to_service": null,
"comment": null,
"from_ip": "::",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null
},
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "en0",
"to_ip": "10.10.10.10",
"to_ip_prefix": 32,
"to_transport": "any",
"to_start_port": 0,
"to_end_port": 65535,
"to_service": null,
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null "from_service": null
} }
] ]

230
docs/parsers/ufw.md
View File

@ -3,8 +3,6 @@
# jc.parsers.ufw # jc.parsers.ufw
jc - JSON CLI output utility `ufw status` command output parser jc - JSON CLI output utility `ufw status` command output parser
Note: a list of ports will be parsed to the `to_service` or `from_service` field as a comma-separated string.
Usage (cli): Usage (cli):
$ ufw status | jc --ufw $ ufw status | jc --ufw
@ -35,17 +33,31 @@ Schema:
"to_ip": string, "to_ip": string,
"to_ip_prefix": integer, "to_ip_prefix": integer,
"to_interface": string, "to_interface": string,
"to_transport": string, # null if to_service is set and not a list of ports "to_transport": string,
"to_start_port": integer, # null if to_service is set and not a list of ports "to_ports": [
"to_end_port": integer, # null if to_service is set and not a list of ports integer
"to_service": string, # null if any above are set (can also be a list of ports) ],
"to_port_ranges": [
{
"start": integer,
"end": integer
}
],
"to_service": string, # null if any to ports or port_ranges are set
"from_ip": string, "from_ip": string,
"from_ip_prefix": integer, "from_ip_prefix": integer,
"from_interface": string, "from_interface": string,
"from_transport": string, # null if to_service is set and not a list of ports "from_transport": string,
"from_start_port": integer, # null if to_service is set and not a list of ports "from_ports": [
"from_end_port": integer, # null if to_service is set and not a list of ports integer
"from_service": string, # null if any above are set (can also be a list of ports) ],
"from_port_ranges": [
{
"start": integer,
"end": integer
}
],
"from_service": string, # null if any from ports or port_ranges are set
"comment": string # null if no comment "comment": string # null if no comment
} }
] ]
@ -58,7 +70,7 @@ Examples:
"status": "active", "status": "active",
"logging": "on", "logging": "on",
"logging_level": "low", "logging_level": "low",
"default": "deny (incoming), allow (outgoing), deny (routed)", "default": "deny (incoming), allow (outgoing), disabled (routed)",
"new_profiles": "skip", "new_profiles": "skip",
"rules": [ "rules": [
{ {
@ -67,10 +79,11 @@ Examples:
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": "tcp", "to_transport": "any",
"to_start_port": 22,
"to_end_port": 22,
"to_service": null, "to_service": null,
"to_ports": [
22
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": 0, "to_ip_prefix": 0,
"comment": null, "comment": null,
@ -78,29 +91,12 @@ Examples:
"from_ip_prefix": 0, "from_ip_prefix": 0,
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": 0, "from_port_ranges": [
"from_end_port": 65535, {
"from_service": null "start": 0,
}, "end": 65535
{ }
"action": "ALLOW", ],
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_transport": "tcp",
"to_start_port": 22,
"to_end_port": 22,
"to_service": null,
"to_ip": "::",
"to_ip_prefix": 0,
"comment": null,
"from_ip": "::",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null "from_service": null
}, },
{ {
@ -109,10 +105,12 @@ Examples:
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": null, "to_transport": "tcp",
"to_service": "Apache Full", "to_service": null,
"to_start_port": null, "to_ports": [
"to_end_port": null, 80,
443
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": 0, "to_ip_prefix": 0,
"comment": null, "comment": null,
@ -120,52 +118,15 @@ Examples:
"from_ip_prefix": 0, "from_ip_prefix": 0,
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": 0, "from_port_ranges": [
"from_end_port": 65535, {
"start": 0,
"end": 65535
}
],
"from_service": null "from_service": null
}, },
{ ...
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_ip": "2405:204:7449:49fc:f09a:6f4a:bc93:1955",
"to_ip_prefix": 128,
"to_transport": "any",
"to_start_port": 0,
"to_end_port": 65535,
"to_service": null,
"comment": null,
"from_ip": "::",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null
},
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "en0",
"to_ip": "10.10.10.10",
"to_ip_prefix": 32,
"to_transport": "any",
"to_start_port": 0,
"to_end_port": 65535,
"to_service": null,
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_start_port": 0,
"from_end_port": 65535,
"from_service": null
}
] ]
} }
@ -174,7 +135,7 @@ Examples:
"status": "active", "status": "active",
"logging": "on", "logging": "on",
"logging_level": "low", "logging_level": "low",
"default": "deny (incoming), allow (outgoing), deny (routed)", "default": "deny (incoming), allow (outgoing), disabled (routed)",
"new_profiles": "skip", "new_profiles": "skip",
"rules": [ "rules": [
{ {
@ -183,10 +144,11 @@ Examples:
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": "tcp", "to_transport": "any",
"to_start_port": "22",
"to_end_port": "22",
"to_service": null, "to_service": null,
"to_ports": [
"22"
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": "0", "to_ip_prefix": "0",
"comment": null, "comment": null,
@ -194,29 +156,12 @@ Examples:
"from_ip_prefix": "0", "from_ip_prefix": "0",
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": "0", "from_port_ranges": [
"from_end_port": "65535", {
"from_service": null "start": "0",
}, "end": "65535"
{ }
"action": "ALLOW", ],
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_transport": "tcp",
"to_start_port": "22",
"to_end_port": "22",
"to_service": null,
"to_ip": "::",
"to_ip_prefix": "0",
"comment": null,
"from_ip": "::",
"from_ip_prefix": "0",
"from_interface": "any",
"from_transport": "any",
"from_start_port": "0",
"from_end_port": "65535",
"from_service": null "from_service": null
}, },
{ {
@ -225,10 +170,12 @@ Examples:
"index": null, "index": null,
"network_protocol": "ipv4", "network_protocol": "ipv4",
"to_interface": "any", "to_interface": "any",
"to_transport": null, "to_transport": "tcp",
"to_service": "Apache Full", "to_service": null,
"to_start_port": null, "to_ports": [
"to_end_port": null, "80",
"443"
],
"to_ip": "0.0.0.0", "to_ip": "0.0.0.0",
"to_ip_prefix": "0", "to_ip_prefix": "0",
"comment": null, "comment": null,
@ -236,52 +183,15 @@ Examples:
"from_ip_prefix": "0", "from_ip_prefix": "0",
"from_interface": "any", "from_interface": "any",
"from_transport": "any", "from_transport": "any",
"from_start_port": "0", "from_port_ranges": [
"from_end_port": "65535", {
"start": "0",
"end": "65535"
}
],
"from_service": null "from_service": null
}, },
{ ...
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv6",
"to_interface": "any",
"to_ip": "2405:204:7449:49fc:f09a:6f4a:bc93:1955",
"to_ip_prefix": "128",
"to_transport": "any",
"to_start_port": "0",
"to_end_port": "65535",
"to_service": null,
"comment": null,
"from_ip": "::",
"from_ip_prefix": "0",
"from_interface": "any",
"from_transport": "any",
"from_start_port": "0",
"from_end_port": "65535",
"from_service": null
},
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "en0",
"to_ip": "10.10.10.10",
"to_ip_prefix": "32",
"to_transport": "any",
"to_start_port": "0",
"to_end_port": "65535",
"to_service": null,
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": "0",
"from_interface": "any",
"from_transport": "any",
"from_start_port": "0",
"from_end_port": "65535",
"from_service": null
}
] ]
} }

BIN
jc/man/jc.1.gz
View File

Binary file not shown.

128
jc/parsers/ufw.py
View File

@ -63,10 +63,134 @@ Schema:
Examples: Examples:
$ ufw status verbose | jc --ufw -p $ ufw status verbose | jc --ufw -p
{
"status": "active",
"logging": "on",
"logging_level": "low",
"default": "deny (incoming), allow (outgoing), disabled (routed)",
"new_profiles": "skip",
"rules": [
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "any",
"to_transport": "any",
"to_service": null,
"to_ports": [
22
],
"to_ip": "0.0.0.0",
"to_ip_prefix": 0,
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_port_ranges": [
{
"start": 0,
"end": 65535
}
],
"from_service": null
},
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "any",
"to_transport": "tcp",
"to_service": null,
"to_ports": [
80,
443
],
"to_ip": "0.0.0.0",
"to_ip_prefix": 0,
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": 0,
"from_interface": "any",
"from_transport": "any",
"from_port_ranges": [
{
"start": 0,
"end": 65535
}
],
"from_service": null
},
...
]
}
$ ufw status verbose | jc --ufw -p -r $ ufw status verbose | jc --ufw -p -r
{
"status": "active",
"logging": "on",
"logging_level": "low",
"default": "deny (incoming), allow (outgoing), disabled (routed)",
"new_profiles": "skip",
"rules": [
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "any",
"to_transport": "any",
"to_service": null,
"to_ports": [
"22"
],
"to_ip": "0.0.0.0",
"to_ip_prefix": "0",
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": "0",
"from_interface": "any",
"from_transport": "any",
"from_port_ranges": [
{
"start": "0",
"end": "65535"
}
],
"from_service": null
},
{
"action": "ALLOW",
"action_direction": "IN",
"index": null,
"network_protocol": "ipv4",
"to_interface": "any",
"to_transport": "tcp",
"to_service": null,
"to_ports": [
"80",
"443"
],
"to_ip": "0.0.0.0",
"to_ip_prefix": "0",
"comment": null,
"from_ip": "0.0.0.0",
"from_ip_prefix": "0",
"from_interface": "any",
"from_transport": "any",
"from_port_ranges": [
{
"start": "0",
"end": "65535"
}
],
"from_service": null
},
...
]
}
""" """
import jc.utils import jc.utils
import re import re

BIN
man/jc.1.gz
View File

Binary file not shown.