Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 3.28 KB

Demo.md

File metadata and controls

102 lines (74 loc) · 3.28 KB
Raw

Quick demo

Datasafe-CLI

You can try datasafe as a CLI (command-line-interface) executable for encryption of your own sensitive files. Your encrypted files can be saved either in S3 bucket or local filesystem safely, because encryption will happen locally - on your machine (See CLI-README for details).

Download CLI executable:

  1. MacOS native executable
  2. Linux native executable
  3. Windows executable (N/A yet), please use java version below
  4. Java-based jar, requires JRE (1.8+), use java -jar datasafe-cli.jar to execute

Example actions:

Download application and create new user:
New profile animation transcript
  • Download CLI application (MacOS url)
curl -L https://github.com/adorsys/datasafe/releases/download/v0.6.0/datasafe-cli-osx-x64 > datasafe-cli && chmod +x datasafe-cli
  • Create file with your credentials (they also can be passed through command line)
echo '{"username": "john", "password": "Doe", "systemPassword": "password"}' > john.credentials
  • Create your new user profile (credentials come from john.credentials). You can enter value or click enter to accept the default value when prompted.
./datasafe-cli -c john.credentials profile create

new_profile

Note: Instead of creating file with credentials you can provide credentials directly into terminal (this is less secure than having credentials file, but is fine for demo purposes):

./datasafe-cli -u=MeHappyUser -p=MyCoolPassword -sp=greatSystemPassword private cat secret.txt

Command above will show private file secret.txt content for user MeHappyUser who has password MyCoolPassword and system password greatSystemPassword

Encrypt and decrypt some secret data for our user:
Encrypting/decrypting data animation transcript
  • Create some unencrypted content
echo "Hello world" > unencrypted.txt
  • Encrypt and store file from above in privatespace. In privatespace it will have decrypted name secret.txt
./datasafe-cli -c john.credentials private cp unencrypted.txt secret.txt
  • Show that filename is encrypted in privatespace:
ls private
  • Show that file content is encrypted too:
cat private/encrypted_file_name_from_above
  • Decrypt file content:
./datasafe-cli -c john.credentials private cat secret.txt

encrypt_decrypt_file

You can always list available actions in context:
List actions animation transcript
  • Show top-level commands
./datasafe-cli -c john.credentials
  • Show commands for privatespace
./datasafe-cli -c john.credentials private

list_actions

REST API demo

Here you can find quick docker-based demo of project capabilities with instructions of how to use it (REST-api based to show how to deploy as encryption server).