2018-01-05 19:40:57 +02:00
<!doctype html>
< html >
2019-09-08 12:06:53 +02:00
<!--
!!! WARNING !!!
This file was auto-generated from readme/e2ee.md and any manual change
made to it will be overwritten. To make a change to this file please modify
the source Markdown file:
https://github.com/laurent22/joplin/blob/master/readme/e2ee.md
-->
2018-01-05 19:40:57 +02:00
< head >
2018-06-11 23:18:34 +02:00
< title > End-To-End Encryption | Joplin< / title >
2018-01-05 19:40:57 +02:00
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2019-04-18 16:00:32 +02:00
< link rel = "stylesheet" href = "https://joplinapp.org/css/bootstrap.min.css" >
2018-01-05 19:40:57 +02:00
< link rel = "shortcut icon" type = "image/x-icon" href = "favicon.ico" >
2019-11-18 10:39:37 +02:00
<!-- <link rel="stylesheet" href="https://joplinapp.org/css/fontawesome - all.min.css"> -->
< link rel = "stylesheet" href = "https://joplinapp.org/css/fork-awesome.min.css" >
2019-04-18 16:00:32 +02:00
< script src = "https://joplinapp.org/js/jquery-3.2.1.slim.min.js" > < / script >
2018-01-05 19:40:57 +02:00
< style >
body {
background-color: #F1F1F1;
color: #333333;
}
table {
margin-bottom: 1em;
}
td, th {
padding: .8em;
border: 1px solid #ccc;
}
2019-10-01 23:27:57 +02:00
.page-markdown table pre,
.page-markdown table blockquote {
margin-bottom: 0;
}
.page-markdown table pre,
.page-markdown table blockquote {
margin-bottom: 0;
}
.page-markdown table pre {
background-color: rgba(0,0,0,0);
border: none;
margin: 0;
padding: 0;
}
2018-01-05 19:40:57 +02:00
h1, h2 {
border-bottom: 1px solid #eaecef;
padding-bottom: 0.3em;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-weight: 600;
font-size: 2em;
margin-bottom: 16px;
}
h2 {
font-size: 1.6em;
}
h3 {
font-size: 1.3em;
}
code {
color: black;
background-color: #eee;
border: 1px solid #ccc;
2018-02-17 01:14:26 +02:00
font-size: .85em;
2018-01-05 19:40:57 +02:00
}
pre code {
border: none;
}
2018-02-17 01:14:26 +02:00
pre {
font-size: .85em;
}
2019-10-01 23:27:57 +02:00
blockquote {
font-size: 1em;
color: #555;
};
2018-03-29 21:17:11 +02:00
#toc ul {
margin-bottom: 10px;
}
#toc {
padding-bottom: 1em;
}
2019-12-02 22:41:26 +02:00
.title {
display: flex;
align-items: center;
}
2018-01-05 19:40:57 +02:00
.title-icon {
2019-12-02 22:41:26 +02:00
display: flex;
height: 1em;
}
.title-text {
display: flex;
font-weight: normal;
margin-bottom: .2em;
margin-left: .5em;
2018-01-05 19:40:57 +02:00
}
.sub-title {
2019-12-02 22:41:26 +02:00
font-weight: normal;
2018-01-05 19:40:57 +02:00
}
.container {
background-color: white;
padding: 0;
box-shadow: 0 10px 20px #888888;
}
table.screenshots {
margin-top: 2em;
margin-bottom: 2em;
}
table.screenshots th {
height: 3em;
text-align: center;
}
table.screenshots th,
table.screenshots td {
border: 1px solid #C2C2C2;
}
2018-03-20 19:41:48 +02:00
img[align="left"] {
margin-right: 10px;
margin-bottom: 10px;
}
2018-01-05 19:40:57 +02:00
.mobile-screenshot {
height: 40em;
padding: 1em;
}
.cli-screenshot-wrapper {
background-color: black;
vertical-align: top;
padding: 1em 2em 1em 1em;
}
.cli-screenshot {
font-family: "Monaco", "Inconsolata", "CONSOLAS", "Deja Vu Sans Mono", "Droid Sans Mono", "Andale Mono", monospace;
background-color: black;
color: white;
border: none;
}
.cli-screenshot .prompt {
color: #48C2F0;
}
.top-screenshot {
margin-top: 2em;
text-align: center;
}
.header {
position: relative;
padding-left: 2em;
padding-right: 2em;
padding-top: 1em;
padding-bottom: 1em;
color: white;
background-color: #2B2B3D;
}
2018-03-31 20:19:11 +02:00
.header a h1 {
color: white;
}
2019-12-02 22:41:26 +02:00
.header a:hover {
text-decoration: none;
}
2018-01-05 19:40:57 +02:00
.content {
padding-left: 2em;
padding-right: 2em;
padding-bottom: 2em;
padding-top: 2em;
}
.forkme {
position: absolute;
right: 0;
top:0;
}
.nav-wrapper {
position: relative;
width: inherit;
}
.nav {
background-color: black;
display: table;
width: inherit;
}
.nav.sticky {
position:fixed;
top: 0;
width: inherit;
box-shadow: 0 0 10px #000000;
}
.nav a {
color: white;
display: inline-block;
padding: .6em .9em .6em .9em;
}
.nav ul {
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
2019-11-20 20:47:32 +02:00
/* min-width: 250px; */
/* For GSoC: */
min-width: 470px;
2018-01-05 19:40:57 +02:00
}
.nav ul li {
display: inline-block;
padding: 0;
}
.nav li.selected {
background-color: #222;
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
text-align: right;
vertical-align: middle;
line-height: 0;
}
.nav-right .share-btn {
display: none;
}
.nav-right .small-share-btn {
display: none;
}
2018-03-29 21:17:11 +02:00
.footer {
padding-top: 1em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
font-size: .9em;
}
2019-05-03 00:54:52 +02:00
a.heading-anchor {
display: inline-block;
opacity: 0;
width: 1.3em;
font-size: 0.7em;
2019-10-01 23:27:57 +02:00
margin-left: 0.4em;
2019-05-03 00:54:52 +02:00
line-height: 1em;
text-decoration: none;
2019-10-01 23:27:57 +02:00
transition: opacity 0.3s;
2019-05-03 00:54:52 +02:00
}
a.heading-anchor:hover,
h1:hover a.heading-anchor,
h2:hover a.heading-anchor,
h3:hover a.heading-anchor,
h4:hover a.heading-anchor,
h5:hover a.heading-anchor,
h6:hover a.heading-anchor {
opacity: 1;
}
2019-11-18 10:49:01 +02:00
.bottom-links {
display: flex;
justify-content: center;
border-top: 1px solid #d4d4d4;
margin-top: 30px;
padding-top: 25px;
}
2018-01-05 19:40:57 +02:00
@media all and (min-width: 400px) {
.nav-right .share-btn {
display: inline-block;
}
.nav-right .small-share-btn {
display: none;
}
}
< / style >
< / head >
< body >
2019-10-01 23:27:57 +02:00
< div class = "container page-e2ee" >
2018-01-05 19:40:57 +02:00
< div class = "header" >
2019-04-18 16:00:32 +02:00
< a class = "forkme" href = "https://github.com/laurent22/joplin" > < img src = "https://joplinapp.org/images/ForkMe.png" / > < / a >
2019-12-02 22:41:26 +02:00
< a href = "https://joplinapp.org" > < h1 class = "title" > < img class = "title-icon" src = "https://joplinapp.org/images/Icon512.png" > < span class = "title-text" > Joplin< / span > < / h1 > < / a >
< p class = "sub-title" > An open source note taking and to-do application with synchronisation capabilities< / p >
2018-01-05 19:40:57 +02:00
< / div >
< div class = "nav-wrapper" >
< div class = "nav" >
< ul >
2019-04-18 16:00:32 +02:00
< li class = "" > < a href = "https://joplinapp.org/" title = "Home" > < i class = "fa fa-home" > < / i > < / a > < / li >
2019-05-22 17:49:57 +02:00
< li > < a href = "https://discourse.joplinapp.org" title = "Forum" > Forum< / a > < / li >
2018-04-25 19:24:13 +02:00
< li > < a class = "help" href = "#" title = "Menu" > Menu< / a > < / li >
2019-12-17 01:19:45 +02:00
< li > < a class = "gsoc" href = "https://joplinapp.org/gsoc2020/" title = "Google Summer of Code 2020" > GSoC 2020< / a > < / li >
2018-01-05 19:40:57 +02:00
< / ul >
< div class = "nav-right" >
2018-06-15 20:28:58 +02:00
<!--
2019-04-18 16:00:32 +02:00
< iframe class = "share-btn" src = "https://www.facebook.com/plugins/share_button.php?href=http%3A%2F%2Fjoplinapp.org&layout=button&size=small&mobile_iframe=true&width=60&height=20&appId" width = "60" height = "20" style = "border:none;overflow:hidden" scrolling = "no" frameborder = "0" allowTransparency = "true" > < / iframe >
< iframe class = "share-btn" src = "https://platform.twitter.com/widgets/tweet_button.html?url=http%3A%2F%2Fjoplinapp.org" width = "62" height = "20" title = "Tweet" style = "border: 0; overflow: hidden;" > < / iframe >
2018-06-15 20:28:58 +02:00
-->
2018-01-05 19:40:57 +02:00
< iframe class = "share-btn share-btn-github" src = "https://ghbtns.com/github-btn.html?user=laurent22&repo=joplin&type=star&count=true" frameborder = "0" scrolling = "0" width = "100px" height = "20px" > < / iframe >
< / div >
< / div >
< / div >
< div class = "content" >
2018-03-29 21:17:11 +02:00
< div id = "toc" > < ul >
< li >
< p > Applications< / p >
< ul >
2019-10-01 23:27:57 +02:00
< li > < a href = "https://joplinapp.org/desktop/" > Desktop application< / a > < / li >
< li > < a href = "https://joplinapp.org/mobile/" > Mobile applications< / a > < / li >
< li > < a href = "https://joplinapp.org/terminal/" > Terminal application< / a > < / li >
< li > < a href = "https://joplinapp.org/clipper/" > Web Clipper< / a > < / li >
2018-03-29 21:17:11 +02:00
< / ul >
< / li >
< li >
< p > Support< / p >
< ul >
2019-05-22 17:49:57 +02:00
< li > < a href = "https://discourse.joplinapp.org" > Joplin Forum< / a > < / li >
2019-10-14 23:28:24 +02:00
< li > < a href = "https://joplinapp.org/markdown/" > Markdown Guide< / a > < / li >
2019-10-01 23:27:57 +02:00
< li > < a href = "https://joplinapp.org/e2ee/" > How to enable end-to-end encryption< / a > < / li >
< li > < a href = "https://joplinapp.org/spec/" > End-to-end encryption spec< / a > < / li >
< li > < a href = "https://joplinapp.org/debugging/" > How to enable debug mode< / a > < / li >
< li > < a href = "https://joplinapp.org/api/" > API documentation< / a > < / li >
< li > < a href = "https://joplinapp.org/faq/" > FAQ< / a > < / li >
2018-03-29 21:17:11 +02:00
< / ul >
< / li >
< li >
< p > About< / p >
< ul >
2019-10-01 23:27:57 +02:00
< li > < a href = "https://joplinapp.org/changelog/" > Changelog (Desktop App)< / a > < / li >
< li > < a href = "https://joplinapp.org/changelog_cli/" > Changelog (CLI App)< / a > < / li >
< li > < a href = "https://joplinapp.org/stats/" > Stats< / a > < / li >
< li > < a href = "https://joplinapp.org/donate/" > Donate< / a > < / li >
2018-03-29 21:17:11 +02:00
< / ul >
< / li >
< / ul >
< / div >
2019-10-01 23:27:57 +02:00
< h1 > About End-To-End Encryption (E2EE)< a name = "about-end-to-end-encryption-e2ee" href = "#about-end-to-end-encryption-e2ee" class = "heading-anchor" > 🔗< / a > < / h1 >
2018-01-17 02:40:35 +02:00
< p > End-to-end encryption (E2EE) is a system where only the owner of the data (i.e. notes, notebooks, tags or resources) can read it. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data.< / p >
< p > The system is designed to defeat any attempts at surveillance or tampering because no third party can decipher the data being communicated or stored.< / p >
< p > There is a small overhead to using E2EE since data constantly has to be encrypted and decrypted so consider whether you really need the feature.< / p >
2019-10-01 23:27:57 +02:00
< h1 > Enabling E2EE< a name = "enabling-e2ee" href = "#enabling-e2ee" class = "heading-anchor" > 🔗< / a > < / h1 >
2019-09-09 20:03:22 +02:00
< p > Due to the decentralised nature of Joplin, E2EE needs to be manually enabled on a single device first (this will create a Master Key for encryption secured by your password) and then it must be synced with all other remaining devices. It is recommended to start with the desktop or terminal application since they generally run on more powerful devices (unlike the mobile application), and so they can encrypt the initial data faster.< / p >
2018-01-05 19:40:57 +02:00
< p > To enable it, please follow these steps:< / p >
< ol >
< li > On your first device (eg. on the desktop application), go to the Encryption Config screen and click " Enable encryption" < / li >
2018-01-17 02:40:35 +02:00
< li > Input your password. This is the Master Key password which will be used to encrypt all your notes. Make sure you to not forget it since, for security reason, it cannot be recovered.< / li >
< li > Now you need to synchronise all your notes so that they are sent encrypted to the sync target (eg. to OneDrive, Nextcloud, etc.). Wait for any synchronisation that might be in progress and click on " Synchronise" .< / li >
2018-01-05 19:40:57 +02:00
< li > Wait for this synchronisation operation to complete. Since all the data needs to be re-sent (encrypted) to the sync target, it may take a long time, especially if you have many notes and resources. Note that even if synchronisation seems stuck, most likely it is still running - do not cancel it and simply let it run over night if needed.< / li >
< li > Once this first synchronisation operation is done, open the next device you are synchronising with. Click " Synchronise" and wait for the sync operation to complete. The device will receive the master key, and you will need to provide the password for it. At this point E2EE will be automatically enabled on this device. Once done, click Synchronise again and wait for it to complete.< / li >
< li > Repeat step 5 for each device.< / li >
< / ol >
2019-09-09 20:03:22 +02:00
< p > Do not manually enable encryption on multiple devices in parallel, but rather wait for the other ones to sync with the first already encrypted device. Otherwise, you may end up with multiple encryption keys (which is supported by Joplin but most probably not what you want).< / p >
2018-01-05 19:40:57 +02:00
< p > Once all the devices are in sync with E2EE enabled, the encryption/decryption should be mostly transparent. Occasionally you may see encrypted items but they will get decrypted in the background eventually.< / p >
2019-10-01 23:27:57 +02:00
< h1 > Disabling E2EE< a name = "disabling-e2ee" href = "#disabling-e2ee" class = "heading-anchor" > 🔗< / a > < / h1 >
2018-01-05 19:40:57 +02:00
< p > Follow the same procedure as above but instead disable E2EE on each device one by one. Again it might be simpler to do it one device at a time and to wait every time for the synchronisation to complete.< / p >
2019-10-01 23:27:57 +02:00
< h1 > Technical specification< a name = "technical-specification" href = "#technical-specification" class = "heading-anchor" > 🔗< / a > < / h1 >
2019-04-18 16:26:13 +02:00
< p > For a more technical description, mostly relevant for development or to review the method being used, please see the < a href = "https://joplinapp.org/spec/" > Encryption specification< / a > .< / p >
2019-11-18 10:49:01 +02:00
< div class = "bottom-links" >
< a href = "https://github.com/laurent22/joplin/blob/master/readme/e2ee.md" >
< i class = "fa fa-github" > < / i > Improve this doc
< / a >
< / div >
2018-01-05 19:40:57 +02:00
< script >
function stickyHeader() {
2018-03-29 21:17:11 +02:00
return; // Disabled
2018-01-05 19:40:57 +02:00
if ($(window).scrollTop() > 179) {
$('.nav').addClass('sticky');
} else {
$('.nav').removeClass('sticky');
}
}
2018-03-29 21:17:11 +02:00
$('#toc').hide();
$('.help').click(function(event) {
event.preventDefault();
$('#toc').show();
});
2018-01-05 19:40:57 +02:00
$(window).scroll(function() {
stickyHeader();
});
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-103586105-1', 'auto');
ga('send', 'pageview');
< / script >
2018-03-29 21:17:11 +02:00
< div class = "footer" >
2019-01-15 21:10:27 +02:00
Copyright (c) 2016-2019 Laurent Cozic
2018-03-29 21:17:11 +02:00
< / div >
2018-01-05 19:40:57 +02:00
< / body >
< / html >
