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
|
#!/usr/bin/env python3
# This file is part of Firejail project
# Copyright (C) 2014-2026 Firejail Authors
# License GPL v2
# Requirements:
# python >= 3.6
from os import path
from sys import argv, exit as sys_exit, stderr
__doc__ = f"""\
Strip whitespace and sort the arguments of commands in profiles.
Usage: {path.basename(argv[0])} [-h] [-i] [-n] [--] [/path/to/profile ...]
The following commands are supported:
private-bin, private-etc, private-lib, caps.drop, caps.keep, seccomp,
seccomp.drop, seccomp.keep, protocol
Note that this is only applicable to commands that support multiple arguments.
Trailing whitespace is removed in all lines (that is, not just in lines
containing supported commands) and other whitespace is stripped depending on
the command.
Options:
-h Print this message.
-i Edit the profile file(s) in-place (this is the default).
-n Do not edit the profile file(s) in-place.
-- End of options.
Examples:
$ {argv[0]} MyAwesomeProfile.profile
$ {argv[0]} new_profile.profile second_new_profile.profile
$ {argv[0]} ~/.config/firejail/*.{{profile,inc,local}}
$ sudo {argv[0]} /etc/firejail/*.{{profile,inc,local}}
Exit Codes:
0: Success: No profiles needed fixing.
1: Error: One or more profiles could not be processed correctly.
2: Error: Invalid or missing arguments.
101: Info: One or more profiles were fixed.
"""
def sort_alphabetical(original_items):
items = original_items.split(",")
items = set(map(str.strip, items))
items = filter(None, items)
items = sorted(items)
return ",".join(items)
def sort_protocol(original_protocols):
"""
Sort the given protocols into the following order:
unix,inet,inet6,netlink,packet,bluetooth
"""
# remove all whitespace
original_protocols = "".join(original_protocols.split())
# shortcut for common protocol lines
if original_protocols in ("unix", "unix,inet,inet6"):
return original_protocols
fixed_protocols = ""
for protocol in ("unix", "inet", "inet6", "netlink", "packet", "bluetooth"):
for prefix in ("", "-", "+", "="):
if f",{prefix}{protocol}," in f",{original_protocols},":
fixed_protocols += f"{prefix}{protocol},"
return fixed_protocols[:-1]
def check_profile(filename, overwrite):
with open(filename, "r+") as profile:
original_profile_str = profile.read()
if not original_profile_str:
return
lines = original_profile_str.split("\n")
was_fixed = False
fixed_profile = []
for lineno, original_line in enumerate(lines, 1):
line = original_line.rstrip()
if line[:12] in ("private-bin ", "private-etc ", "private-lib "):
line = f"{line[:12]}{sort_alphabetical(line[12:])}"
elif line[:13] in ("seccomp.drop ", "seccomp.keep "):
line = f"{line[:13]}{sort_alphabetical(line[13:])}"
elif line[:10] in ("caps.drop ", "caps.keep "):
line = f"{line[:10]}{sort_alphabetical(line[10:])}"
elif line[:8] == "protocol":
line = f"protocol {sort_protocol(line[9:])}"
elif line[:8] == "seccomp ":
line = f"{line[:8]}{sort_alphabetical(line[8:])}"
if line != original_line:
was_fixed = True
print(
f"{filename}:{lineno}:-'{original_line}'\n"
f"{filename}:{lineno}:+'{line}'"
)
fixed_profile.append(line)
fixed_profile_str = "\n".join(fixed_profile)
stripped_profile_str = fixed_profile_str.strip() + "\n"
while "\n\n\n" in stripped_profile_str:
stripped_profile_str = stripped_profile_str.replace("\n\n\n", "\n\n")
if stripped_profile_str != fixed_profile_str:
was_fixed = True
print(f"{filename}:(fixed whitespace)")
if was_fixed:
if overwrite:
profile.seek(0)
profile.truncate()
profile.write(stripped_profile_str)
profile.flush()
print(f"[ Fixed ] {filename}")
return 101
return 0
def main(args):
overwrite = True
while len(args) > 0:
if args[0] == "-h":
print(__doc__)
return 0
elif args[0] == "-i":
overwrite = True
args.pop(0)
elif args[0] == "-n":
overwrite = False
args.pop(0)
elif args[0] == "--":
args.pop(0)
break
elif args[0][0] == "-":
print(f"[ Error ] Unknown option: {args[0]}", file=stderr)
return 2
else:
break
if len(args) < 1:
print(__doc__, file=stderr)
return 2
print(f"sort.py: checking {len(args)} profile(s)...")
exit_code = 0
for filename in args:
try:
if exit_code not in (1, 101):
exit_code = check_profile(filename, overwrite)
else:
check_profile(filename, overwrite)
except FileNotFoundError as err:
print(f"[ Error ] {err}", file=stderr)
exit_code = 1
except PermissionError as err:
print(f"[ Error ] {err}", file=stderr)
exit_code = 1
except Exception as err:
print(
f"[ Error ] An error occurred while processing '{filename}': {err}",
file=stderr,
)
exit_code = 1
return exit_code
if __name__ == "__main__":
sys_exit(main(argv[1:]))
|