You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
69 lines
3.2 KiB
Markdown
69 lines
3.2 KiB
Markdown
<p align="center">
|
|
<img src="https://github.com/cjdelisle/cryptpad/raw/master/cryptofist.png" width="60%">
|
|
</p>
|
|
|
|
Unity is Strength - Collaboration is Key
|
|
|
|
|
|
|
|
|
|
|
|
CryptPad is the **zero knowledge** realtime collaborative editor.
|
|
Encryption carried out in your web browser protects the data from the server, the cloud
|
|
and the NSA. This project uses the [CKEditor] Visual Editor and the [ChainPad] realtime
|
|
engine. The secret key is stored in the URL [fragment identifier] which is never sent to
|
|
the server but is available to javascript so by sharing the URL, you give authorization
|
|
to others who want to participate.
|
|
|
|
To install:
|
|
|
|
git clone <this repo>
|
|
npm install
|
|
npm install -g bower ## if necessary
|
|
bower install
|
|
## copy config.js.dist to config.js and modify configuration (use your own mongodb instance)
|
|
node ./server.js
|
|
|
|
|
|
## Security
|
|
|
|
CryptPad is *private* not *anonymous*. Privacy protects your data, anonymity protects you.
|
|
As such, it is possible for a collaborator on the pad to include some silly/ugly/nasty things
|
|
in a CryptPad such as an image which reveals your IP address when your browser automatically
|
|
loads it or a script which plays Rick Asleys's greatest hits. It is acceptable for anyone
|
|
who does not have the key to be able to change anything in the pad or add anything, even the
|
|
server.
|
|
|
|
The server does have a certain power, it can send you evil javascript which does the wrong
|
|
thing (leaks the key or the data back to the server or to someone else). This is however an
|
|
[active attack] which makes it detectable. The NSA really hates doing these because they might
|
|
get caught and laughed at and humiliated in front of the whole world (again). If you're making
|
|
the NSA mad enough for them to use an active attack against you, Great Success Highfive, now take
|
|
the battery out of your computer before it spawns Agent Smith.
|
|
|
|
Still there are other low-lives in the world so using CryptPad over HTTPS is probably a good idea.
|
|
|
|
## Contributing
|
|
|
|
We love Open Source and we love contribution. It is our intent to keep this project available
|
|
under the AGPL license forever but in order to finance more development on this and other FOSS
|
|
projects, we also wish to sell other licenses to this software. Before making a pull request,
|
|
please read and
|
|
[sign the Commons Management Agreement](https://www.clahub.com/agreements/cjdelisle/cryptpad).
|
|
|
|
### License
|
|
|
|
This software is and will always be available under 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. If you wish to use this technology in a proprietary product, please contact
|
|
sales@xwiki.com
|
|
|
|
* Icons thanks to http://www.famfamfam.com/ licensed [Creative Commons Attribution 2.5 License]
|
|
|
|
|
|
[ChainPad]: https://github.com/xwiki-contrib/chainpad
|
|
[CKEditor]: http://ckeditor.com/
|
|
[fragment identifier]: https://en.wikipedia.org/wiki/Fragment_identifier
|
|
[active attack]: https://en.wikipedia.org/wiki/Attack_(computing)#Types_of_attacks
|
|
[Creative Commons Attribution 2.5 License]: http://creativecommons.org/licenses/by/2.5/
|