germanf / cryptocat Goto Github PK

#Cryptocat ###Browser-based app for easy to use, accessible encrypted chat. Cryptocat is an experimental browser-based chat client for easy to use, encrypted conversations. It aims to make encrypted, private chat easy to use and accessible. We want to break down the barrier that prevents the general public from having an accessible privacy alternative that they already know how to use. Cryptocat is currently available for Chrome, Firefox and Safari. It uses the OTR protocol over XMPP for encrypted two-party chat and the (upcoming) mpOTR protocol for encrypted multi-party chat.

##Platforms

###Google Chrome Run make chrome to build a Google Chrome-loadable .zip extension (or just .zip the directory.)
Also available from the Chrome Web Store.

###Mozilla Firefox Run make firefox to build a Mozilla Firefox-loadable .xpi extension (or just .zip the directory and change the extension to .xpi.)
Also available from Mozilla Firefox Addons.

###Apple Safari Apple's model makes an automated build process difficult.
Also available from Cryptocat.

Run make mac, then open src/mac/Cryptocat.xcodeproj to open in XCode. You can then Build or Run.

You will need to disable code signing if you do not have a certificate or keypair set up. Do this by opening the project settings by clicking on Cryptocat in the left column and unchecking Code Sign Application.

##Goals

• XMPP [DONE] | Discussion, Library
• OTR [DONE] | Discussion, Library
• mpOTR | Discussion, Spec in progress. Currently relying on the Cryptocat Multiparty Protocol

##Contributing Please see CONTRIBUTING.md for guidelines on how to contribute.
Please see SECURITY.md for guidelines on reporting security issues.

##Documentation & Wiki

• Multiparty Protocol Specification
• OTR Encrypted File Transfer Specification
• Server Deployment Instructions
• Threat Model
• Design and Functionality Overview
• Architecture and Lifecycle

##Discussion & Blog

• Issue tracker
• Development Blog

##Builds

• Builds are available in release/.

##Changelog Please review CHANGELOG.md for an account of the changes made with each version update.

##License

The full license text is included in LICENSE.txt.