mirror of https://github.com/CIRCL/PyCIRCLean
245 lines
8.3 KiB
Python
245 lines
8.3 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
import os
|
|
import magic
|
|
import hashlib
|
|
import shutil
|
|
from twiggy import quick_setup, log
|
|
import argparse
|
|
|
|
|
|
class KittenGroomerError(Exception):
|
|
def __init__(self, message):
|
|
'''
|
|
Base KittenGroomer exception handler.
|
|
'''
|
|
super(KittenGroomerError, self).__init__(message)
|
|
self.message = message
|
|
|
|
|
|
class ImplementationRequired(KittenGroomerError):
|
|
'''
|
|
Implementation required error
|
|
'''
|
|
pass
|
|
|
|
|
|
class FileBase(object):
|
|
|
|
def __init__(self, src_path, dst_path):
|
|
'''
|
|
Contains base information for a file on the source USB key,
|
|
initialised with expected src and dest path
|
|
'''
|
|
self.src_path = src_path
|
|
self.dst_path = dst_path
|
|
self.log_details = {'filepath': self.src_path}
|
|
self.log_string = ''
|
|
a, self.extension = os.path.splitext(self.src_path)
|
|
|
|
mt = magic.from_file(self.src_path, mime=True)
|
|
try:
|
|
self.mimetype = mt.decode("utf-8")
|
|
except:
|
|
self.mimetype = mt
|
|
|
|
if self.mimetype and '/' in self.mimetype:
|
|
self.main_type, self.sub_type = self.mimetype.split('/')
|
|
else:
|
|
self.main_type = ''
|
|
self.sub_type = ''
|
|
|
|
def has_mimetype(self):
|
|
if not self.main_type or not self.sub_type:
|
|
self.log_details.update({'broken_mime': True})
|
|
return False
|
|
return True
|
|
|
|
def has_extension(self):
|
|
if not self.extension:
|
|
self.log_details.update({'no_extension': True})
|
|
return False
|
|
return True
|
|
|
|
def is_dangerous(self):
|
|
if self.log_details.get('dangerous'):
|
|
return True
|
|
return False
|
|
|
|
def is_symlink(self):
|
|
if self.has_mimetype() and self.main_type == 'inode' and self.sub_type == 'symlink':
|
|
self.log_details.update({'symlink': os.readlink(self.src_path)})
|
|
return True
|
|
return False
|
|
|
|
def add_log_details(self, key, value):
|
|
'''
|
|
Add an entry in the log dictionary
|
|
'''
|
|
self.log_details[key] = value
|
|
|
|
def make_dangerous(self):
|
|
'''
|
|
This file should be considered as dangerous and never run.
|
|
Prepending and appending DANGEROUS to the destination
|
|
file name avoid double-click of death
|
|
'''
|
|
if self.is_dangerous():
|
|
# Already marked as dangerous, do nothing
|
|
return
|
|
self.log_details['dangerous'] = True
|
|
path, filename = os.path.split(self.dst_path)
|
|
self.dst_path = os.path.join(path, 'DANGEROUS_{}_DANGEROUS'.format(filename))
|
|
|
|
def make_unknown(self):
|
|
'''
|
|
This file has an unknown type and it was not possible to take
|
|
a decision. Theuser will have to decide what to do.
|
|
Prepending UNKNOWN
|
|
'''
|
|
if self.is_dangerous() or self.log_details.get('binary'):
|
|
# Already marked as dangerous or binary, do nothing
|
|
return
|
|
self.log_details['unknown'] = True
|
|
path, filename = os.path.split(self.dst_path)
|
|
self.dst_path = os.path.join(path, 'UNKNOWN_{}'.format(filename))
|
|
|
|
def make_binary(self):
|
|
'''
|
|
This file is a binary, and should probably not be run.
|
|
Appending .bin avoir double click of death but the user
|
|
will have to decide by itself.
|
|
'''
|
|
if self.is_dangerous():
|
|
# Already marked as dangerous, do nothing
|
|
return
|
|
self.log_details['binary'] = True
|
|
path, filename = os.path.split(self.dst_path)
|
|
self.dst_path = os.path.join(path, '{}.bin'.format(filename))
|
|
|
|
def force_ext(self, ext):
|
|
if not self.dst_path.endswith(ext):
|
|
self.log_details['force_ext'] = True
|
|
self.dst_path += ext
|
|
|
|
|
|
class KittenGroomerBase(object):
|
|
|
|
def __init__(self, root_src, root_dst, debug=False):
|
|
'''
|
|
Setup the base options of the copy/convert setup
|
|
'''
|
|
self.src_root_dir = root_src
|
|
self.dst_root_dir = root_dst
|
|
self.log_root_dir = os.path.join(self.dst_root_dir, 'logs')
|
|
self._safe_rmtree(self.log_root_dir)
|
|
self._safe_mkdir(self.log_root_dir)
|
|
self.log_processing = os.path.join(self.log_root_dir, 'processing.log')
|
|
self.log_content = os.path.join(self.log_root_dir, 'content.log')
|
|
self.tree(self.src_root_dir)
|
|
|
|
quick_setup(file=self.log_processing)
|
|
self.log_name = log.name('files')
|
|
self.ressources_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'data')
|
|
os.environ["PATH"] += os.pathsep + self.ressources_path
|
|
|
|
self.cur_file = None
|
|
|
|
self.debug = debug
|
|
if self.debug:
|
|
self.log_debug_err = os.path.join(self.log_root_dir, 'debug_stderr.log')
|
|
self.log_debug_out = os.path.join(self.log_root_dir, 'debug_stdout.log')
|
|
else:
|
|
self.log_debug_err = os.devnull
|
|
self.log_debug_out = os.devnull
|
|
|
|
def _computehash(self, path):
|
|
s = hashlib.sha1()
|
|
with open(path, 'rb') as f:
|
|
while True:
|
|
buf = f.read(0x100000)
|
|
if not buf:
|
|
break
|
|
s.update(buf)
|
|
return s.hexdigest()
|
|
|
|
def tree(self, base_dir, padding=' '):
|
|
with open(self.log_content, 'a') as lf:
|
|
lf.write('#' * 80 + '\n')
|
|
lf.write('{}+- {}/\n'.format(padding, os.path.basename(os.path.abspath(base_dir))))
|
|
padding += '| '
|
|
files = sorted(os.listdir(base_dir))
|
|
for f in files:
|
|
curpath = os.path.join(base_dir, f)
|
|
if os.path.islink(curpath):
|
|
lf.write('{}+-- {}\t- Symbolic link to {}\n'.format(padding, f, os.readlink(curpath)))
|
|
elif os.path.isdir(curpath):
|
|
self.tree(curpath, padding)
|
|
elif os.path.isfile(curpath):
|
|
lf.write('{}+-- {}\t- {}\n'.format(padding, f, self._computehash(curpath)))
|
|
|
|
# ##### Helpers #####
|
|
def _safe_rmtree(self, directory):
|
|
'''Remove a directory tree if it exists'''
|
|
if os.path.exists(directory):
|
|
shutil.rmtree(directory)
|
|
|
|
def _safe_remove(self, filepath):
|
|
'''Remove a file if it exists'''
|
|
if os.path.exists(filepath):
|
|
os.remove(filepath)
|
|
|
|
def _safe_mkdir(self, directory):
|
|
'''Remove a directory if it exists'''
|
|
if not os.path.exists(directory):
|
|
os.makedirs(directory)
|
|
|
|
def _safe_copy(self, src=None, dst=None):
|
|
''' Copy a file and create directory if needed '''
|
|
if src is None:
|
|
src = self.cur_file.src_path
|
|
if dst is None:
|
|
dst = self.cur_file.dst_path
|
|
try:
|
|
dst_path, filename = os.path.split(dst)
|
|
self._safe_mkdir(dst_path)
|
|
shutil.copy(src, dst)
|
|
return True
|
|
except Exception as e:
|
|
# TODO: Logfile
|
|
print(e)
|
|
return False
|
|
|
|
def _list_all_files(self, directory):
|
|
''' Generate an iterator over all the files in a directory tree '''
|
|
for root, dirs, files in os.walk(directory):
|
|
for filename in files:
|
|
filepath = os.path.join(root, filename)
|
|
yield filepath
|
|
|
|
def _print_log(self):
|
|
'''
|
|
Print log, should be called after each file.
|
|
|
|
You probably want to reimplement it in the subclass
|
|
'''
|
|
tmp_log = self.log_name.fields(**self.cur_file.log_details)
|
|
tmp_log.info('It did a thing.')
|
|
|
|
#######################
|
|
|
|
def processdir(self, src_dir=None, dst_dir=None):
|
|
'''
|
|
Main function doing the work, you have to implement it yourself.
|
|
'''
|
|
raise ImplementationRequired('You have to implement the result processdir.')
|
|
|
|
|
|
def main(kg_implementation, description='Call the KittenGroomer implementation to do things on files present in the source directory to the destination directory'):
|
|
parser = argparse.ArgumentParser(prog='KittenGroomer', description=description)
|
|
parser.add_argument('-s', '--source', type=str, help='Source directory')
|
|
parser.add_argument('-d', '--destination', type=str, help='Destination directory')
|
|
args = parser.parse_args()
|
|
kg = kg_implementation(args.source, args.destination)
|
|
kg.processdir()
|