Commit 2ebb51f1 by Pedro Cavaleiro

Updated README.md

parent 0a02166f
# Introduction # Introduction
This project is a prototype of a encrypted recycle bin. This project is a prototype of a encrypted recycle bin.
All files are encrypted with an random pin and they're also signed digitally. All files are encrypted with an random pin and they're also signed digitally.
The pin must not be outputed to the user nor saved anywere on the computer. The pin must not be outputed to the user nor saved anywere on the computer.
The user, to recover the file, has 3 attempts to guess the pin of the file, if it fails to guess the pin the file gets deleted
The user, to recover the file, has 3 attempts to guess the pin of the file, if it fails to guess the pin the file gets deleted.
# Available Cyphers # Available Cyphers
So far there is only one cypher implemented, AES-CBC So far there is only one cypher implemented, AES-CBC
...@@ -12,47 +16,75 @@ The hash it's only being used to generate a secure key to encrypt the file, the ...@@ -12,47 +16,75 @@ The hash it's only being used to generate a secure key to encrypt the file, the
# Commands available # Commands available
restorefile restorefile
validatefile validatefile
setcypher setcypher
sethash sethash
setenabled setenabled
showconfig showconfig
help help
exit exit
# Restore a file # Restore a file
restorefile [options] restorefile [options]
-l lists the encrypted files -l lists the encrypted files
-p <pin> <file> tries to decrypt the file using the given pin -p <pin> <file> tries to decrypt the file using the given pin
This command can only contain one of the options This command can only contain one of the options
# Validate a file # Validate a file
validatefile [file] validatefile [file]
The file can be an absolute path or if the file it's in the restored folder there's only the need to type the file name The file can be an absolute path or if the file it's in the restored folder there's only the need to type the file name
The Signature (.sig) and Public Key (.pk) must be in the same directory of the file being checked The Signature (.sig) and Public Key (.pk) must be in the same directory of the file being checked
# Settings # Settings
setchypher [cypher] [keysize] setchypher [cypher] [keysize]
The keysize for now it's allways 16 as there is a problem with java that gives allways Ilegal Key Size even when the sizes are 24 or 32 (valid key sizes for AES-CBC) The keysize for now it's allways 16 as there is a problem with java that gives allways Ilegal Key Size even when the sizes are 24 or 32 (valid key sizes for AES-CBC)
sethash [hash] sethash [hash]
For now only SHA256 is implemented and changing this setting will not have any impact on the software For now only SHA256 is implemented and changing this setting will not have any impact on the software
setenabled [boolean] setenabled [boolean]
Setting this setting to true or false will enable or disable the encryption process Setting this setting to true or false will enable or disable the encryption process
# Other Commands # Other Commands
help help
This show in app help menu explaining all the commands This show in app help menu explaining all the commands
exit exit
Terminates the program and all it's threads Terminates the program and all it's threads
# TODO! # TODO!
CHECK FILE FallIntoOblivion.java line 301 (complete if else sequence) CHECK FILE FallIntoOblivion.java line 301 (complete if else sequence)
CHECK FILE Helpers.java line 223 (follow instructions in TODO tag) CHECK FILE Helpers.java line 223 (follow instructions in TODO tag)
CHECK FILE Helpers.java line 258 (follow instructions in TODO tag) CHECK FILE Helpers.java line 258 (follow instructions in TODO tag)
Implement the decryption check on line 269 on file Helpers.java Implement the decryption check on line 269 on file Helpers.java
# Build and Test # Build and Test
To build and test, open the project using IntelliJ IDEA, Netbeans or other Java IDE and run the program To build and test, open the project using IntelliJ IDEA, Netbeans or other Java IDE and run the program
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment