update

linPEAS/builder/src/linpeasBuilder.py

@@ -0,0 +1,240 @@
+import re
+
+from .peasLoaded import PEASLoaded
+from .peassRecord import PEASRecord
+from .fileRecord import FileRecord
+from .yamlGlobals import (
+    LINPEAS_BASE_PATH,
+    PEAS_FINDS_MARKUP,
+    PEAS_STORAGES_MARKUP,
+    PEAS_STORAGES_MARKUP, 
+    INT_HIDDEN_FILES_MARKUP,
+    ROOT_FOLDER,
+    STORAGE_TEMPLATE,
+    FIND_TEMPLATE,
+    FIND_LINE_MARKUP,
+    STORAGE_LINE_MARKUP,
+    STORAGE_LINE_EXTRA_MARKUP,
+    FINAL_LINPEAS_PATH
+)
+
+
+class LinpeasBuilder:
+    def __init__(self, ploaded:PEASLoaded):
+        self.ploaded = ploaded
+        self.hidden_files = set()
+        self.bash_find_f_vars, self.bash_find_d_vars = set(), set()
+        self.bash_storages = set()
+        self.__get_files_to_search()
+        with open(LINPEAS_BASE_PATH, 'r') as file:
+            self.linpeas_sh = file.read()
+
+    def build(self):
+        find_calls = self.__generate_finds()
+        self.__replace_mark(PEAS_FINDS_MARKUP, find_calls, "  ")
+
+        storage_vars = self.__generate_storages()
+        self.__replace_mark(PEAS_STORAGES_MARKUP, storage_vars, "  ")
+
+        #Check all the expected STORAGES in linpeas have been created
+        for s in re.findall(r'PSTORAGE_[\w]*', self.linpeas_sh):
+            assert s in self.bash_storages, f"{s} isn't created"
+
+        #Replace interesting hidden files markup for a list of all the serched hidden files
+        self.__replace_mark(INT_HIDDEN_FILES_MARKUP, self.hidden_files, "|")
+
+        #Check if there are duplecate peass marks
+        peass_marks = self.__get_peass_marks()
+        for i,mark in enumerate(peass_marks):
+            for j in range(i+1,len(peass_marks)):
+                assert mark != peass_marks[j], f"Found repeated peass mark: {mark}"
+
+        #Generate autocheck sections
+        sections = self.__generate_sections()
+        for section_name, bash_lines in sections.items():
+            mark = "peass{"+section_name+"}"
+            assert mark in peass_marks, f"Mark {mark} wasn't found in linpeas base"
+            self.__replace_mark(mark, list(bash_lines), "")
+
+        #Check that there aren peass marks left in linpeas
+        peass_marks = self.__get_peass_marks()
+        assert len(peass_marks) == 0, f"There are peass marks left: {', '.join(peass_marks)}"
+
+        self.__write_linpeas()
+
+    
+    def __get_peass_marks(self):
+        return re.findall(r'peass\{[\w\-\._ ]*\}', self.linpeas_sh)
+
+
+    def __get_files_to_search(self):
+        """Given a PEASLoaded and find the files that need to be searched on each root folder"""
+        self.dict_to_search = {"d": {}, "f": {}}
+        self.dict_to_search["d"] = {r: set() for r in ROOT_FOLDER}
+        self.dict_to_search["f"] = {r: set() for r in ROOT_FOLDER}
+
+        for precord in self.ploaded.peasrecords:
+            for frecord in precord.filerecords:
+                for folder in frecord.search_in:
+                    self.dict_to_search[frecord.type][folder].add(frecord.regex)
+                
+                if frecord.regex[0] == "." or frecord.regex[:2] == "*.":
+                    self.hidden_files.add(frecord.regex.replace("*",""))
+
+
+    def __generate_finds(self) -> list:
+        """Given the regexes to search on each root folder, generate the find command"""
+        finds = []
+        for type,searches in self.dict_to_search.items():
+            for r,regexes in searches.items():
+                if regexes:
+                    find_line = f"{r} "
+                    
+                    if type == "d": 
+                        find_line += "-type d "
+                        bash_find_var = f"FIND_DIR_{r[1:].replace('.','').upper()}"
+                        self.bash_find_d_vars.add(bash_find_var)
+                    else:
+                        bash_find_var = f"FIND_{r[1:].replace('.','').upper()}"
+                        self.bash_find_f_vars.add(bash_find_var)
+
+                    find_line += '-name \\"' + '\\" -o -name \\"'.join(regexes) + '\\"'
+                    find_line = FIND_TEMPLATE.replace(FIND_LINE_MARKUP, find_line)
+                    find_line = f"{bash_find_var}={find_line}"
+                    finds.append(find_line)
+            
+        return finds
+
+    def __generate_storages(self) -> list:
+        """Generate the storages to save the results per entry"""
+        storages = []
+        all_f_finds = "$" + "\\n$".join(self.bash_find_f_vars)
+        all_d_finds = "$" + "\\n$".join(self.bash_find_d_vars)
+        all_finds = "$" + "\\n$".join(list(self.bash_find_f_vars) + list(self.bash_find_d_vars))
+        
+        for precord in self.ploaded.peasrecords:
+            bash_storage_var = f"PSTORAGE_{precord.bash_name}"
+            self.bash_storages.add(bash_storage_var)
+            
+            #Select the FIND_ variables to search on depending on the type files
+            if all(frecord.type == "f" for frecord in precord.filerecords):
+                storage_line = STORAGE_TEMPLATE.replace(STORAGE_LINE_MARKUP, all_f_finds)
+            elif all(frecord.type == "d" for frecord in precord.filerecords):
+                storage_line = STORAGE_TEMPLATE.replace(STORAGE_LINE_MARKUP, all_d_finds)
+            else:
+                storage_line = STORAGE_TEMPLATE.replace(STORAGE_LINE_MARKUP, all_finds)
+
+            #Grep by filename regex (ended in '$')
+            bsp = '\\.' #A 'f' expression cannot contain a backslash, so we generate here the bs need in the line below
+            grep_names = f" | grep -E \"{'|'.join([frecord.regex.replace('.',bsp).replace('*', '.*')+'$' for frecord in precord.filerecords])}\""
+
+            #Grep by searched folders
+            grep_folders_searched = f" | grep -E \"^{'|^'.join(list(set([d for frecord in precord.filerecords for d in frecord.search_in])))}\"".replace("HOMESEARCH","GREPHOMESEARCH")
+
+            #Grep extra paths. They are accumulative between files of the same PEASRecord
+            grep_extra_paths = ""
+            if any(True for frecord in precord.filerecords if frecord.check_extra_path):
+                grep_extra_paths = f" | grep -E '{'|'.join(list(set([frecord.check_extra_path for frecord in precord.filerecords if frecord.check_extra_path])))}'"
+            
+            #Grep to remove paths. They are accumulative between files of the same PEASRecord
+            grep_remove_path = ""
+            if any(True for frecord in precord.filerecords if frecord.remove_path):
+                grep_remove_path = f" | grep -v -E '{'|'.join(list(set([frecord.remove_path for frecord in precord.filerecords if frecord.remove_path])))}'"
+            
+            #Construct the final line like: STORAGE_MYSQL=$(echo "$FIND_DIR_ETC\n$FIND_DIR_USR\n$FIND_DIR_VAR\n$FIND_DIR_MNT" | grep -E '^/etc/.*mysql|/usr/var/lib/.*mysql|/var/lib/.*mysql' | grep -v "mysql/mysql")
+            storage_line = storage_line.replace(STORAGE_LINE_EXTRA_MARKUP, f"{grep_remove_path}{grep_extra_paths}{grep_folders_searched}{grep_names}")
+            storage_line = f"{bash_storage_var}={storage_line}"
+            storages.append(storage_line)
+        
+        return storages
+
+        
+
+    def __generate_sections(self) -> dict:
+        """Generate sections for records with auto_check to True"""
+        sections = {}
+
+        for precord in self.ploaded.peasrecords:
+            if precord.auto_check:
+                section = f'  print_2title "Analizing {precord.name} Files (limit 70)"\n'
+
+                for exec_line in precord.exec:
+                    if exec_line:
+                        section += "    " + exec_line + "\n"
+
+                for frecord in precord.filerecords:
+                    section += "    " + self.__construct_file_line(precord, frecord) + "\n"
+                
+                sections[precord.name] = section
+
+        return sections
+
+    def __construct_file_line(self, precord: PEASRecord, frecord: FileRecord, init: bool = True) -> str:
+        real_regex = frecord.regex[1:] if frecord.regex.startswith("*") else frecord.regex
+        real_regex = real_regex.replace("*",".*").replace(".","\\.")
+        real_regex += "$"
+        
+        analise_line = ""
+        if init:
+            analise_line = 'printf "%s" "$PSTORAGE_'+precord.bash_name+'" | grep -E "'+real_regex+'" | while read f; do ls -ld "$f" | sed -${E} "s,'+real_regex+',${SED_RED},"; '
+
+        #If just list, just list the file/directory
+        if frecord.just_list_file:
+            if frecord.type == "d":
+                analise_line += 'ls -lRA "$f";'
+            analise_line += 'done; echo "";'
+            return analise_line
+        
+        if frecord.type == "f":
+            grep_empty_lines = ' | grep -IEv "^$"'
+            grep_line_grep = f' | grep -E {frecord.line_grep}' if frecord.line_grep else ""
+            grep_only_bad_lines = f' | grep -E "{frecord.bad_regex}"' if frecord.bad_regex else ""
+            grep_remove_regex = f' | grep -Ev "{frecord.remove_regex}"' if frecord.remove_regex else ""
+            sed_bad_regex = ' | sed -${E} "s,'+frecord.bad_regex+',${SED_RED},g"' if frecord.bad_regex else ""
+            sed_good_regex = ' | sed -${E} "s,'+frecord.good_regex+',${SED_GOOD},g"' if frecord.good_regex else ""
+
+            if init:
+                analise_line += 'cat "$f" 2>/dev/null'
+            else:
+                analise_line += 'cat "$ff" 2>/dev/null'
+
+            if grep_empty_lines:
+                analise_line += grep_empty_lines
+
+            if grep_line_grep:
+                analise_line += grep_line_grep
+
+            if frecord.only_bad_lines and not grep_line_grep:
+                analise_line += grep_only_bad_lines
+
+            if grep_remove_regex:
+                analise_line += grep_remove_regex
+            
+            if sed_bad_regex:
+                analise_line += sed_bad_regex
+
+            if sed_good_regex:
+                analise_line += sed_good_regex
+            
+            analise_line += '; done; echo "";'
+            return analise_line
+
+        #In case file is type "d"
+        if frecord.files:
+            for ffrecord in frecord.files:
+                ff_real_regex = ffrecord.regex[1:] if ffrecord.regex.startswith("*") else ffrecord.regex
+                ff_real_regex = ff_real_regex.replace("*",".*")
+                analise_line += 'for ff in $(find "$f" -name "'+ffrecord.regex+'"); do ls -ld "$ff" | sed -${E} "s,'+ff_real_regex+',${SED_RED},"; ' + self.__construct_file_line(precord, ffrecord, init=False)
+        
+        analise_line += 'done; echo "";'
+        return analise_line
+
+
+    def __replace_mark(self, mark: str, find_calls: list, join_char: str):
+        """Substitude the markup with the actual code"""
+        self.linpeas_sh = self.linpeas_sh.replace(mark, join_char.join(find_calls)) #New line char is't needed
+    
+    def __write_linpeas(self):
+        """Write on disk the final linpeas"""
+        with open(FINAL_LINPEAS_PATH, "w") as f:
+            f.write(self.linpeas_sh)