-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3ec9892
Showing
4 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Commands | ||
-------- | ||
|
||
The exact set of commands will be determined later. | ||
|
||
However, the following should give a reasonable first approach. | ||
|
||
The commands can be implemented as subcommands, | ||
like in git. | ||
|
||
h|help provide help | ||
v|version display the software version | ||
l|list list all scans in a database | ||
st|stats display statistics about the DB contents | ||
sc|scan scan a location and add to the database | ||
qs|quickscan quick-scan a location (ignore hashes) and add to the DB | ||
f|find|s|search: search for a file, according to criteria | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
Data | ||
---- | ||
|
||
The following data should be stored for each file: | ||
- name | ||
- size | ||
- full path (relative to scan point) | ||
- a number of hashes (md5, sha-1, xxh32, xxh64, git-sha, ssdeep, sdhash, ...) | ||
- basename | ||
- extension | ||
- dirname | ||
|
||
Less useful data that can also be stored: | ||
- permissions | ||
- dates (creation, modification, access) | ||
|
||
Each database should also keep track | ||
of all the commands (scans) that were used | ||
to add content. | ||
|
||
The data model should be extensible | ||
(for example, more hashes may be added in later versions), | ||
so the data storage should take this parameter into account. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
Storage | ||
------- | ||
|
||
All the information is stored into an SQL database. | ||
|
||
Individual SQLite files seem to be | ||
the perfect point between functionality and complexity, | ||
allowing all operations on data | ||
and easy transfer between systems. | ||
|
||
All the command-line utilities should accept | ||
a "-d|--database <arg>" to specify the location | ||
of this file. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
fileDB -- utilities for handling file metadata | ||
|
||
In the direcotry "Notes", a number of text files contain | ||
design notes describing the problem domain. | ||
|