MOD: updated docs in support of API
This commit is contained in:
parent
3efcd0a482
commit
2e12a2cce1
|
@ -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
|
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
|
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)
|
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
|
4. "table": is the database schema in a hash format to be loaded into the fingerprint program
|
||||||
|
|
||||||
|
|
|
@ -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.
|
1. Generate a fingerprint in JSON format.
|
||||||
2. Compare a sqlite database with a fingerprint.
|
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
|
4. Lightning fast fingerprint comparison
|
||||||
a. creates an index of fingerprints
|
a. creates an index of fingerprints
|
||||||
b. query the index for quick fingerprint comparison
|
b. query the index for quick fingerprint comparison
|
||||||
|
|
|
@ -17,3 +17,16 @@ The fingerprint is stored to disk in JSON format.
|
||||||
This project is completely python. No building required.
|
This project is completely python. No building required.
|
||||||
There are no dependencies.
|
There are no dependencies.
|
||||||
It has been tested on Python 2.7.10
|
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 ]
|
||||||
|
|
||||||
|
|
|
@ -7,8 +7,6 @@
|
||||||
-use adb bridging technique
|
-use adb bridging technique
|
||||||
|
|
||||||
[ MD5 Index ]
|
[ MD5 Index ]
|
||||||
-modify fingerprint compare feature to use the index
|
|
||||||
|
|
||||||
-test modified databases and the fingerprints created
|
-test modified databases and the fingerprints created
|
||||||
|
|
||||||
-index integrity
|
-index integrity
|
||||||
|
@ -57,6 +55,8 @@
|
||||||
|
|
||||||
[ Fingerprint modified by me for testing ]
|
[ Fingerprint modified by me for testing ]
|
||||||
|
|
||||||
|
[ Regression testing of Android pull ]
|
||||||
|
[ Regression testing of data directory parse ]
|
||||||
|
|
||||||
|
|
||||||
[[ Errors ]]
|
[[ Errors ]]
|
||||||
|
|
Loading…
Reference in New Issue