cryptomator/README.md

55 lines
2.4 KiB
Markdown
Raw Normal View History

2014-11-29 16:05:28 +00:00
Cryptomator
2014-02-02 00:43:47 +00:00
====================
2015-02-14 11:44:48 +00:00
[![Join the chat at https://gitter.im/totalvoidness/cryptomator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/totalvoidness/cryptomator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-01-13 12:57:38 +00:00
Multiplatform transparent client-side encryption of your files in the cloud.
2014-02-02 08:48:23 +00:00
2015-02-22 22:03:47 +00:00
If you want to take a look at the current beta version, go ahead and get your copy of cryptomator on [Cryptomator.org](https://cryptomator.org) or clone and build Cryptomator using Maven (instructions below).
2014-11-29 23:24:16 +00:00
2014-02-02 08:48:23 +00:00
## Features
- Totally transparent: Just work on the encrypted volume, as if it was an USB drive
- Works with Dropbox, OneDrive (Skydrive), Google Drive and any other cloud storage, that syncs with a local directory
- In fact it works with any directory. You can use it to encrypt as many folders as you like
2015-01-18 14:35:35 +00:00
- AES encryption with 256 bit key length
2014-02-02 08:48:23 +00:00
- Client-side. No accounts, no data shared with any online service
- Filenames get encrypted too
- No need to provide credentials for any 3rd party service
- Open Source means: No backdoors. Control is better than trust
- Use as many encrypted folders in your dropbox as you want. Each having individual passwords
2015-01-13 12:57:38 +00:00
### Privacy
2015-01-18 14:35:35 +00:00
- 256 bit keys (unlimited strength policy bundled with native binaries - 128 bit elsewhere)
- Scrypt key derivation
2014-02-02 08:48:23 +00:00
- Cryptographically secure random numbers for salts, IVs and the masterkey of course
- Sensitive data is swiped from the heap asap
- Lightweight: Complexity kills security
2015-01-13 12:57:38 +00:00
### Consistency
2015-01-18 14:35:35 +00:00
- HMAC over file contents to recognize changed ciphertext before decryption
2014-02-02 08:48:23 +00:00
- I/O operations are transactional and atomic, if the file systems supports it
2015-01-18 14:35:35 +00:00
- Each file contains all information needed for decryption (except for the key of course). No common metadata means no SPOF
2014-02-02 08:48:23 +00:00
2015-01-13 12:57:38 +00:00
## Building
#### Dependencies
* Java 8
* Maven 3
* Optional: OS-dependent build tools for native packaging
* Optional: JCE unlimited strength policy (needed for 256 bit keys)
#### Building on Debian-based OS
```bash
apt-get install oracle-java8-installer oracle-java8-unlimited-jce-policy fakeroot maven git
git clone https://github.com/totalvoidness/cryptomator.git
cd cryptomator/main
git checkout v0.4.0
mvn clean install
```
2014-02-02 08:48:23 +00:00
## License
2015-01-18 14:35:35 +00:00
Distributed under the MIT X Consortium license. See the LICENSE file for more info.
2014-11-29 20:09:14 +00:00
[![Build Status](https://travis-ci.org/totalvoidness/cryptomator.svg?branch=master)](https://travis-ci.org/totalvoidness/cryptomator)