mbrubeck / mysteryshack

A remoteStorage-server

mysteryshack

Mysteryshack is a lightweight, yet self-contained remoteStorage-server.

This project is still in active development. Do not use with sensitive data, or without backup.

Use username demo and password demo on my server to try it out. Don't use that account for actual data though: It is reset daily.

Installation

• Install Rust and Cargo.
• Clone this repository.
• Run cargo build --release.
• Stick ./target/release/mysteryshack into your PATH.

Usage

• Edit config.example and save it as config.
• mysteryshack user create foo to create a new user.
• mysteryshack serve to run the server as configured in ./config.

For advanced usage, see mysteryshack --help and mysteryshack user --help.

Updating

Just git pull and cargo build --release again.

---

Troubleshooting

OS X and OpenSSL

As of OS X 10.11, OpenSSL isn't installed anymore. You'll need to install it manually:

brew install openssl
brew link --force openssl

Implementation notes

• Mysteryshack mostly implements draft-dejong-remotestorage-05.txt, however:

  • it sends two kinds of webfinger responses to stay compatible with remotestorage.js.

  • The app-provided client_id is ignored, Origin of redirect_uri is used for app identification.

• Mysteryshack is set up to be tested against the official api test suite automatically (in Travis).

• Mysteryshack's approach to concurrency is very simplistic. Only storage operations are safe to perform concurrently. User creation and deletion, app authorization and de-authorization are not, because it is assumed that the user performing those operations is a single human with only two hands and one keyboard.

• Web admin sessions are stored inside signed cookies. The key is generated at server startup. To log everybody out, restart the server.

• OAuth tokens are JWTs that are signed with a per-user key. The server stores a list of client_ids the user has authorized, and checks if the token's client_id claim is found in that list.

License

• Logo is licensed under CC-BY-SA, based on:

  • Rust logo, CC-BY

  • remoteStorage logo, CC-BY-SA

• Source code is licensed under the MIT, see LICENSE.