Cryptocat is a browser-based XMPP client that provides multi-user (and private) instant messaging inside chatrooms. It uses the OTR protocol for encrypted two-party chat and the (upcoming) mpOTR protocol for encrypted multi-party chat.
Run make chrome to build a Google Chrome-loadable .zip extension (or just .zip the directory.)
Also available from the Chrome Web Store.
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's model makes an automated build process difficult.
Also available from Cryptocat.
All contributed code, written in JavaScript, must adhere to the following coding style:
1. Tabs are used for indentation, not spaces.
2. Lines are not ended with semicolons.
3. Use camel case for variables, filenames, and so on.
4. Please comment your code sufficiently.
5. Anonymous closures should be used wherever they are useful.
-----------------------------------------
| Windows Mac Linux |
|-----------------------------------------|
| Chrome | Yes Yes Yes |
|--------- |
| Firefox | Yes Yes Yes |
|--------- |
| Safari | Yes Yes |
|--------- |
-----------------------------------------
- XMPP [DONE] | Discussion, Library
- OTR [DONE] | Discussion, Library
- mpOTR | Discussion, Spec in progress. Currently relying on the Cryptocat Multiparty Protocol
- Multiparty Protocol Specification
- OTR Encrypted File Transfer Specification
- Server Deployment Instructions
- Threat Model
- Design and Functionality Overview
- Architecture and Lifecycle
- Run tests using
make tests.
- Builds are available in
release/.
Please review CHANGELOG.md for an account of the changes made with each version update.
Cryptocat is released under the GNU Affero General Public License (AGPL3):
Copyright (C) 2011 - 2013 Nadim Kobeissi <nadim@crypto.cat>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
The full license text is included in LICENSE.txt.
- Lead Developer: Nadim Kobeissi
- Development Contributors: Jacob Appelbaum, Joseph Bonneau, Griffin Boyce, Arlo Breault, Dmitry Chestnykh, David Dahl, Daniel "koolfy" Faucon, Arturo Filasto, Tom Lowenthal, Fabio Pietrosanti
- Multimedia Contributors: A.J. Korkidakis, P.J. Onori, Rich Vreeland
With a warm thanks to the hard-working contributors who wish to remain anonymous.