dnrops
/
cryptpad
mirror of https://github.com/xwiki-labs/cryptpad
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1496 from Chouhartem/readme-threat-model 

Update of the readme file for clarity
This commit is contained in:
David Benque 2024-05-23 13:33:02 +01:00 committed by GitHub
parent 069452751c 841a2d5f72
commit 606774c603
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
readme.md
View File

@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
# CryptPad # CryptPad
CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data is encrypted, the service and its administrators have no way of seeing the content being edited and stored. CryptPad is a collaboration suite that is end-to-end-encrypted and open-source. It is built to enable collaboration, synchronizing changes to documents in real time. Because all data are encrypted, in the eventuality of a breach, attackers have no way of seeing the stored content. Moreover, if the administators don’t alter the code, they and the service also cannot infer any piece of information about the users' content.
![Drive screenshot](screenshot.png "preview of the CryptDrive") ![Drive screenshot](screenshot.png "preview of the CryptDrive")
@ -36,7 +36,7 @@ Previously, Docker images were community maintained, had their own repository an
CryptPad offers a variety of collaborative tools that encrypt your data in your browser CryptPad offers a variety of collaborative tools that encrypt your data in your browser
before it is sent to the server and your collaborators. In the event that the server is before it is sent to the server and your collaborators. In the event that the server is
compromized the database holds encrypted data that is not of much value to attackers. compromized, the database holds encrypted data that is not of much value to attackers.
The code which performs the encryption is still loaded from the host server like any The code which performs the encryption is still loaded from the host server like any
other web page, so you still need to trust the administrator to keep their server secure other web page, so you still need to trust the administrator to keep their server secure
@ -44,23 +44,29 @@ and to send you the right code. An expert can download code from the server and
that it isn't doing anything malicious like leaking your encryption keys, which is why that it isn't doing anything malicious like leaking your encryption keys, which is why
this is considered an [active attack]. this is considered an [active attack].
The platform is designed to minimize what data is exposed to its operators. User registration The platform is designed to minimize what data is exposed to its operators. User
and account access is based on a cryptographic key that is derived from your username registration and account access are based on cryptographic keys that are derived from your
and password so the server never needs to see either and you don't need to worry about username and password. Hence, the server never needs to see either, and you don't need to
whether they are being stored securely. It is impossible to verify whether a server's worry about whether they are being stored securely. It is impossible to verify whether a
operators are logging your IP or other activity, so if you consider this information server's operators are logging your IP or other activity, so if you consider this
sensitive it is safest to assume it is being recorded and access your preferred instance information sensitive it is safest to assume it is being recorded and access your
via [Tor browser]. preferred instance via [Tor browser].
A correctly configured instance has safeguards to prevent collaborators from doing some A correctly configured instance has safeguards to prevent collaborators from doing some
nasty things like injecting scripts into collaborative documents or uploads. The project nasty things like injecting scripts into collaborative documents or uploads. The project
is actively maintained and bugs that our safeguards don't catch tend to get fixed quickly. is actively maintained and bugs that our safeguards don't catch tend to get fixed quickly.
For this reason it is best to only use instances that are running the most recent version, For this reason it is best to only use instances that are running the most recent version,
which is currently on a three-week release cycle. It is difficult for a non-expert to which is currently on a three-month release cycle. It is difficult for a non-expert to
determine whether an instance is otherwise configured correctly, so we are actively determine whether an instance is otherwise configured correctly, so we are actively
working on allowing administrators to opt in to a public directory of servers that working on allowing administrators to opt in to a [public directory of
ervers](https://cryptpad.org/instances/) that
meet our strict criteria for safety. meet our strict criteria for safety.
For end users, a [guide](https://blog.cryptpad.org/2024/03/14/Most-Secure-CryptPad-Usage/)
is provided in our blog to help understanding the security of CryptPad. This blog post
also explains and show the best practices when using CryptPad and clarify what end-to-end
encryption entails and not.
# Translations # Translations
CryptPad can be translated with nothing more than a web browser via our CryptPad can be translated with nothing more than a web browser via our