diff --git a/docgen.sh b/docgen.sh index 4c9059c1..d1befcf1 100755 --- a/docgen.sh +++ b/docgen.sh @@ -33,6 +33,7 @@ pydocmd simple jc.parsers.pip_list+ > ../docs/parsers/pip_list.md pydocmd simple jc.parsers.pip_show+ > ../docs/parsers/pip_show.md pydocmd simple jc.parsers.ps+ > ../docs/parsers/ps.md pydocmd simple jc.parsers.route+ > ../docs/parsers/route.md +pydocmd simple jc.parsers.shadow+ > ../docs/parsers/shadow.md pydocmd simple jc.parsers.ss+ > ../docs/parsers/ss.md pydocmd simple jc.parsers.stat+ > ../docs/parsers/stat.md pydocmd simple jc.parsers.systemctl+ > ../docs/parsers/systemctl.md diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md new file mode 100644 index 00000000..08bafaea --- /dev/null +++ b/docs/parsers/shadow.md @@ -0,0 +1,69 @@ +# jc.parsers.shadow +jc - JSON CLI output utility /etc/shadow file Parser + +Usage: + + specify --shadow as the first argument if the piped input is coming from /etc/shadow + +Compatibility: + + 'linux', 'darwin', 'aix', 'freebsd' + +Examples: + + $ cat /etc/shadow | jc --shadow -p + + + $ cat /etc/shadow | jc --shadow -p -r + + +## info +```python +info(self, /, *args, **kwargs) +``` + +## process +```python +process(proc_data) +``` + +Final processing to conform to the schema. + +Parameters: + + proc_data: (dictionary) raw structured data to process + +Returns: + + List of dictionaries. Structured data with the following schema: + + [ + { + "username": string, + "password": string, + "last_changed": integer, + "minimum": integer, + "maximum": integer, + "warn": integer, + "inactive": integer, + "expire": integer + } + ] + +## 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: + + List of dictionaries. Raw or processed structured data. + diff --git a/jc/cli.py b/jc/cli.py index 384a4c89..2a0f2ee7 100644 --- a/jc/cli.py +++ b/jc/cli.py @@ -51,6 +51,7 @@ parsers = [ 'pip-show', 'ps', 'route', + 'shadow', 'ss', 'stat', 'systemctl', diff --git a/jc/parsers/shadow.py b/jc/parsers/shadow.py new file mode 100644 index 00000000..ef75c867 --- /dev/null +++ b/jc/parsers/shadow.py @@ -0,0 +1,119 @@ +"""jc - JSON CLI output utility /etc/shadow file Parser + +Usage: + + specify --shadow as the first argument if the piped input is coming from /etc/shadow + +Compatibility: + + 'linux', 'darwin', 'aix', 'freebsd' + +Examples: + + $ cat /etc/shadow | jc --shadow -p + + + $ cat /etc/shadow | jc --shadow -p -r + +""" +import jc.utils + + +class info(): + version = '1.0' + description = '/etc/shadow file parser' + author = 'Kelly Brazil' + author_email = 'kellyjonbrazil@gmail.com' + # details = 'enter any other details here' + + # compatible options: linux, darwin, cygwin, win32, aix, freebsd + compatible = ['linux', 'darwin', 'aix', 'freebsd'] + + +__version__ = info.version + + +def process(proc_data): + """ + Final processing to conform to the schema. + + Parameters: + + proc_data: (dictionary) raw structured data to process + + Returns: + + List of dictionaries. Structured data with the following schema: + + [ + { + "username": string, + "password": string, + "last_changed": integer, + "minimum": integer, + "maximum": integer, + "warn": integer, + "inactive": integer, + "expire": integer + } + ] + """ + for entry in proc_data: + int_list = ['last_changed', 'minimum', 'maximum', 'warn', 'inactive', 'expire'] + for key in int_list: + if key in entry: + try: + key_int = int(entry[key]) + entry[key] = key_int + except (ValueError): + entry[key] = None + + return proc_data + + +def 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: + + List of dictionaries. Raw or processed structured data. + """ + if not quiet: + jc.utils.compatibility(__name__, info.compatible) + + raw_output = [] + cleandata = data.splitlines() + + # Clear any blank lines + cleandata = list(filter(None, cleandata)) + + if cleandata: + for entry in cleandata: + if entry.startswith('#'): + continue + + output_line = {} + fields = entry.split(':') + + output_line['username'] = fields[0] + output_line['password'] = fields[1] + output_line['last_changed'] = fields[2] + output_line['minimum'] = fields[3] + output_line['maximum'] = fields[4] + output_line['warn'] = fields[5] + output_line['inactive'] = fields[6] + output_line['expire'] = fields[7] + + raw_output.append(output_line) + + if raw: + return raw_output + else: + return process(raw_output)