MOD: updated docs in support of API

This commit is contained in:
JohnE 2016-01-25 15:28:59 -08:00
parent 3efcd0a482
commit 2e12a2cce1
4 changed files with 26 additions and 3 deletions

View File

@ -1,4 +1,13 @@
JSON Fingerprint Format Design
Fingerprint Naming Convention
Fully Qualified Domain App Name + "__" + database name + "__" + "dbfp.json"
JSON File Format:
1. "_file-metadata": has information regarding how this fingerprint was created
2. "db-metadata": contains the sql create statements for each table in the database
@ -6,3 +15,4 @@
3. "db-metadata-hashes": contains the md5 hashes of each create statement (for quicker comparisons of fingerprints)
4. "table": is the database schema in a hash format to be loaded into the fingerprint program

View File

@ -23,7 +23,7 @@ The fingerprint can be used for historical comparisons to see what has changed i
-------------
1. Generate a fingerprint in JSON format.
2. Compare a sqlite database with a fingerprint.
3. Rip all apps from a phone and create fingerprints for all SQLite databases
3. Rip all apps from an Android phone and create fingerprints for all SQLite databases
4. Lightning fast fingerprint comparison
a. creates an index of fingerprints
b. query the index for quick fingerprint comparison

View File

@ -17,3 +17,16 @@ The fingerprint is stored to disk in JSON format.
This project is completely python. No building required.
There are no dependencies.
It has been tested on Python 2.7.10
-------------
LIBRARY
-------------
The following is documentation regarding the usage of the various libraries included
with this tool.
[ Fingerprint Library ]
[ Fingerprint Index Library ]

View File

@ -7,8 +7,6 @@
-use adb bridging technique
[ MD5 Index ]
-modify fingerprint compare feature to use the index
-test modified databases and the fingerprints created
-index integrity
@ -57,6 +55,8 @@
[ Fingerprint modified by me for testing ]
[ Regression testing of Android pull ]
[ Regression testing of data directory parse ]
[[ Errors ]]