Skip to content

Commit

Permalink
Update Readme and Spec files
Browse files Browse the repository at this point in the history
Updated Readme file
Added spec files for pyinstaller
  • Loading branch information
markmckinnon committed May 9, 2021
1 parent 24529eb commit d9596ca
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# cLEAPP
Chrome Logs Events and Protobuf Parser

Details in blog post here:

## Requirements
**Python 3.9 or above** (older versions of 3.x will also work with the exception of one or two modules)

### Dependencies

Dependencies for your python environment are listed in `requirements.txt`. Install them using the below command. Ensure the `py` part is correct for your environment, eg `py`, `python`, or `python3`, etc.

`py -m pip install -r requirements.txt`
or
`pip3 install -r requirements.txt`

To run on **Linux**, you will also need to install `tkinter` separately like so:

`sudo apt-get install python3-tk`

To install dependencies offline Troy Schnack has a neat process here:
https://twitter.com/TroySchnack/status/1266085323651444736?s=19

## Usage

### CLI

```
$ python cleapp.py -t <zip | tar | fs | gz | tgz> -i <path_to_extraction> -o <path_for_report_output>
```

### GUI

```
$ python cleappGUI.py
```

### Help

```
$ python cleapp.py --help
```

## Acknowledgements

This tool is the result of a collaborative effort of many people in the DFIR community.
37 changes: 37 additions & 0 deletions cleapp.spec
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(['cleapp.py'],
pathex=[],
binaries=[],
datas=[('.\\scripts\\logo.jpg', '.\\scripts'),
('.\\scripts\\dashboard.css', '.\\scripts'),
('.\\scripts\\dark-mode.css', '.\\scripts'),
('.\\scripts\\dark-mode-switch.js', '.\\scripts'),
('.\\scripts\\feather.min.js', '.\\scripts'),
('.\\scripts\\MDB-Free_4.13.0', '.\\scripts\\MDB-Free_4.13.0')],
hiddenimports=['simplekml', 'bs4'],
hookspath=[],
runtime_hooks=[],
excludes=[],
win_no_prefer_redirects=False,
win_private_assemblies=False,
cipher=block_cipher,
noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
cipher=block_cipher)
exe = EXE(pyz,
a.scripts,
a.binaries,
a.zipfiles,
a.datas,
[],
name='cleapp',
debug=False,
bootloader_ignore_signals=False,
strip=False,
upx=True,
upx_exclude=[],
runtime_tmpdir=None,
console=True )
37 changes: 37 additions & 0 deletions cleappGUI.spec
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# -*- mode: python ; coding: utf-8 -*-

block_cipher = None

a = Analysis(['cleappGUI.py'],
pathex=[],
binaries=[],
datas=[('.\\scripts\\logo.jpg', '.\\scripts'),
('.\\scripts\\dashboard.css', '.\\scripts'),
('.\\scripts\\feather.min.js', '.\\scripts'),
('.\\scripts\\dark-mode.css', '.\\scripts'),
('.\\scripts\\dark-mode-switch.js', '.\\scripts'),
('.\\scripts\\MDB-Free_4.13.0', '.\\scripts\\MDB-Free_4.13.0')],
hiddenimports=[],
hookspath=[],
runtime_hooks=[],
excludes=[],
win_no_prefer_redirects=False,
win_private_assemblies=False,
cipher=block_cipher,
noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
cipher=block_cipher)
exe = EXE(pyz,
a.scripts,
a.binaries,
a.zipfiles,
a.datas,
[],
name='cleappGUI',
debug=False,
bootloader_ignore_signals=False,
strip=False,
upx=True,
upx_exclude=[],
runtime_tmpdir=None,
console=False )

0 comments on commit d9596ca

Please sign in to comment.