Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 3.58 KB

README.md

File metadata and controls

80 lines (51 loc) · 3.58 KB

CryptoNote

Deploy

CryptoNote in action

CryptoNote is a very simple open source web application that lets users encrypt and share messages. If you'd like to see an example of the site running, go to https://cryptonote.me

  • All data is encrypted client side so that the server never sees what's on it.
  • Messages are deleted from the server once the recipient has viewed it.
  • Bots like Facebook are blocked so that they do not invalidate messages.

Motivation

Sometimes you need to send something to somebody and be sure that they're the only person reading the message. So I decided to make a simple, open source, encrypted messaging system that anybody can pull and deploy to Heroku in minutes. Don't trust me? That's cool, install your own. Don't trust your web host? That's cool, they'll never be able to read your messages.

Known Weaknesses

Getting Started

System dependencies

  • Ruby 2.2.0 or higher
  • Rails 4.1.8 or higher
  • Postgres 9.2.4 or greater
  • Heroku Toolbelt

Configuration

Ensure that you have Postgres installed, preferably through the Heroku Postgres App as we use it in both production and development.

Then, open your terminal to the project folder and run:

rake db:setup
rake db:migrate

Deployment instructions

Run the following commands to get started:

heroku create
git push heroku master
heroku run rake db:migrate

And then run:

heroku open

In order to open the application.

Contributing

I'm always open to pull requests, and there's a lot more that could be done with the site. In general, I will tend towards "track less", so I never want CryptoNote to have user accounts or anything like that. However, there are always cool things that can be done.

Ideas for the future

  • Limit viewing by http referrer. For example, only people who clicked the link on Facebook or Twitter can view the message
  • Time-based expiry. Make messages automatically die after x period of time.
  • Javascript submission so we can carry over the password variable client-side instead of sending it to the server.
  • The application.js file has some horrendously bad javascript that I may or may not rewrite soon depending on time. Don't hate the player, hate the time constraint.
  • Allow Markdown in decrypted messages.
  • Allow code highlighting in decrypted messages.
  • An API endpoint for creating new CryptoNotes + javascript package to do the crypto easily.

License

CryptoNote is released under the terms of the MIT license. See LICENCE for more information or see http://opensource.org/licenses/MIT.

Special Thanks

For the client-side encryption, all of the heavy lifting is done by the Stanford Javascript Crypto Library. Part of the reason I make this project was to help spread the word about the simple, but extremely well made library that anybody can use. Thanks to the team who made it!