andrew
/
CrystalKeep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated pom and readme.

This commit is contained in:
Andrew Lalis 2021-05-30 11:40:49 +02:00
parent ca6bea60dd
commit 4e401d98a5
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,14 +2,20 @@
A comprehensive solution for encrypted data storage. A comprehensive solution for encrypted data storage.
# Features # Running
- Simple Key -> Value storage To get up and running, clone this repository, and open a terminal in the directory containing the `pom.xml` file. Run the following maven command:
- Username / password logins
- Files / Directories ```
mvn javafx:run
```
You can also use the `javafx-maven-plugin` to generate an executable using `mvn javafx:jlink`.
# Design # Design
CrystalKeep makes use of _Shards_ as the most basic form of encrypted data storage. A shard is a single data item, like login credentials, an image, or some text. One or more shards are stored in a _Cluster_, which is essentially a collection of shards (and possibly nested clusters). Top-level clusters (not nested inside another) can be encrypted and saved with a secret key passphrase. CrystalKeep makes use of _Shards_ as the most basic form of encrypted data storage. A shard is a single data item, like login credentials, an image, or some text. One or more shards are stored in a _Cluster_, which is essentially a collection of shards (and possibly nested clusters). Top-level clusters (not nested inside another) can be encrypted and saved with a secret key passphrase.
With this approach, the user minimizes the amount of data that is accessible to an attacker in the event that the attacker gets access to the system while the contents of a cluster are unencrypted in memory, since only one cluster may be actively open at a time. With this approach, the user minimizes the amount of data that is accessible to an attacker in the event that the attacker gets access to the system while the contents of a cluster are unencrypted in memory, since only one cluster may be actively open at a time.
Furthermore, by removing a dependency on the host filesystem for encryption of, for example, files or directories, this solution is guaranteed to be equally secure across all platforms that it can run on.

6
pom.xml
View File

@ -24,7 +24,11 @@
<version>0.0.4</version> <version>0.0.4</version>
<configuration> <configuration>
<mainClass>nl.andrewlalis.crystalkeep.CrystalKeep</mainClass> <mainClass>nl.andrewlalis.crystalkeep.CrystalKeep</mainClass>
<launcher>crystalkeep.exe</launcher> <noManPages>true</noManPages>
<stripDebug>true</stripDebug>
<compress>2</compress>
<noHeaderFiles>true</noHeaderFiles>
<launcher>crystalkeep</launcher>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>