unbreak: Secure and resilient remote file storage utility

[ agpl, library, network, program ] [ Propose Tags ]

unbreak is a secure remote file storage utility written in Haskell.

Other than a working SSH server and an empty directory, it requires no configuration on the server-side to set up the file storage. Leveraging existing commands, it simplifies the process of fetching and saving files with a client-side encryption. It aims to make the work flow natural, as if the user is using an unencrypted local file, while keeping the local-remote interaction as rare as possible to be usable even with a highly unstable Internet connection.

unbreak uses modern crypto primitives such as scrypt and ChaCha20-Poly1305 to protect user security and privacy. Some of its usage is documented in the Unbreak.Crypto module. The API is internal and you should not directly depend on them from your code, but browsing the source code from the API docs and copying them to adapt to another free software is highly encouraged.

For a detailed information on how to actually use this utility, please refer to its official web page at https://e.xtendo.org/scs/unbreak.

[Skip to Readme]


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


  • No Candidates
Versions [RSS] 0.3.0, 0.3.1
Change log CHANGELOG.md
Dependencies aeson (>=0.9), aeson-pretty (>=0.7), base (>=4.8 && <4.9), base64-bytestring (>=1 && <2), bytestring (>=0.10), cereal (>=0.4), cmdargs (>=0.10), cryptonite (>=0.9), memory (>=0.10), process (>=1 && <2), text (>=1 && <2), unbreak, unix (>=2 && <3) [details]
License AGPL-3.0-only
Copyright Copyright (C) 2015 Kinoru
Author Kinoru
Maintainer xkinoru@gmail.com
Category Network
Home page https://e.xtendo.org/scs/unbreak
Bug tracker https://github.com/kinoru/unbreak/issues
Uploaded by kinoru at 2015-12-31T04:01:16Z
Executables unbreak
Downloads 1266 total (7 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2015-12-31 [all 1 reports]

Readme for unbreak-0.3.1

[back to package description]

unbreak is a minimal helper utility to have files accessible, encrypted, and stored remotely, even with an unstable Internet connection. Questions, bug reports, feature requests, and pull requests are welcome.

Current version: 0.3.1 (changelog)

See unbreak's web page for more details.

Build from git source

Stack is the recommended tool to build the latest git version of unbreak.

$ git clone --depth=1 https://github.com/kinoru/unbreak
$ cd unbreak
$ stack install