adapt texts / doc

This commit is contained in:
Steffen Wittkamp 2023-07-31 14:47:54 +02:00
parent c0a5cfc280
commit b8b02c59e8
6 changed files with 40 additions and 17 deletions

View File

@ -1,4 +1,14 @@
# Banana Split 🍌 · ![Yarn tests](https://github.com/paritytech/banana_split/workflows/Yarn%20tests/badge.svg) [![Join the chat at https://gitter.im/paritytech/banana_split](https://badges.gitter.im/paritytech/banana_split.svg)](https://gitter.im/paritytech/banana_split?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Banana Split fork 🍌
**This is a fork of Banana split (https://bs.parity.io, https://github.com/paritytech/banana_split) adding some optional convenience overrides that may negatively impact security depending on your setup if activated. If you are unsure please always use the original project!!!**
Compared to the original, this fork values guaranteed restorability by laymen / non-technical people higher than security.
* Allows to deactivate the browser offline mode enforcement. Use from browsers that hide or even do not have offline mode, e.g. on mobile devices.
* Allows to deactivate local file enforcement. Local file detection may not work on some setups.
* Additionally prints the qr code json on each shard sheet and allows to manually enter this json during restore instead of scanning the qr code. Use this if scanning qr codes does not work in your restoration setup.
# Banana Split
Banana Split makes your paper backups more resilient and secure using [Shamirs secret sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing).
@ -26,10 +36,10 @@ Your secret will be encrypted with an auto-generated passphrase and split it int
Doing this by hand protects against an attacker intercepting things youre sending to the printer.
### How do you retrieve a Banana Split?
Recovery can be done on any device with a webcam.
Recovery can be done on any device with a webcam (or by entering the qr code json manually).
1. Save the Banana Split [HTML page](https://bs.parity.io/) and **open it in offline mode**.
2. Using your webcam, scan in a majority of your QR code printouts (e.g., if you had 7 printouts, youll need 4).
2. Using your webcam, scan in a majority of your QR code printouts (e.g., if you had 7 printouts, youll need 4). Or enter the qr code json manually for the majority of printouts.
3. Enter your passphrase.
4. Viola! Your secret is restored.
@ -37,7 +47,7 @@ Recovery can be done on any device with a webcam.
### Work local and offline
Banana Split is a self-contained HTML page.
To ensure your precious data is never sent outside, it only works when opened from your local hard drive while your browser is in Offline mode.
To ensure your precious data is never sent outside, it only works when opened from your local hard drive while your browser is in Offline mode. (Note: This can be overriden in this fork)
### Without the passphrase, you wont be able to retrieve your secret

View File

@ -4,11 +4,11 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>Banana split</title>
<title>Banana split fork</title>
</head>
<body>
<noscript>
<strong>We're sorry but Banana split doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
<strong>We're sorry but Banana split fork doesn't work properly without JavaScript enabled. Please enable it to continue.</strong>
</noscript>
<div id="app"></div>
<!-- built files will be auto injected -->

View File

@ -5,7 +5,7 @@
<nav>
<router-link id="logo" to="/">
<span class="logo-text">
Banana Split
Banana Split fork
</span>
<span class="logo-icon">
🍌
@ -18,10 +18,9 @@
<SavePageInfo v-else-if="! (localFile || this.allow_non_local)" />
<GoOfflineInfo v-else-if="isOnline && ! this.allow_online" />
<p style="margin-top:2em;">
<div class="danger-zone" style="margin-top:2em;">
<b>Security Overrides (DANGER ZONE! At your own risk...):</b>
</p>
<div>
<div style="display:inline-block;margin-right:3px">
@ -40,7 +39,8 @@
<label for="allow_non_local" style="display:inline">Do not enforce running from local file</label>
</div>
</div>
</div>
<div class="version-footer">
{{ gitRevision }}
</div>
@ -313,6 +313,12 @@ button {
background: transparent;
}
.danger-zone {
border-radius: 10px;
border: 2px solid #CD232D;
padding: 20px;
}
.version-footer {
padding-top: 30px;
font-size: 80%;

View File

@ -2,7 +2,8 @@
<div class="general-info">
<h2>What is this?</h2>
<p>
Banana Split is a self-contained HTML page, which makes your paper
Banana Split fork is fork of <a href="https://bs.parity.io" target="_blank">Banana Split</a>,
a self-contained HTML page, which makes your paper
backups more resilient and secure using
<a href="https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing" target="_blank">
Shamir's secret sharing scheme</a>.
@ -21,15 +22,17 @@
Banana Split tries to protect your secret from the attack vectors like
"attacker is able to intercept everything you're sending to your printer",
and that's why you'll have to write down the passphrase on your printouts
by hand.
by hand (can be overriden in this fork).
</p>
<p>
Of course you should seal your printouts in non-transparent envelopes and distribute among different locations as soon as you're done writing your seed phrase — Banana Split is only more secure than a single paper with your secret as long as the secrets can't be lost/stolen altogether.
</p>
<p>
All operations must be performed in Offline mode. Recovery can be done
All operations must be performed in Offline mode (can be overriden in this fork).
Recovery can be done
on any device with a webcam just show your QR codes to the webcam
and follow the notifications on screen in the process.
and follow the notifications on screen in the process. This fork additionally prints
the qr code json on the sheets and allows to enter them manually.
</p>
<h2>How to use it?</h2>
<ol>

View File

@ -15,8 +15,9 @@
<textarea
id="shard_json_str"
v-model="shard_json_str"
placeholder="Enter shard json manually"
placeholder="Enter shard json manually. Use this only if QR code scanning does not work."
style="margin-bottom:5px"
spellcheck="false"
/>
<button id="add_shard" class="button-card" @click="addshardjson" style="margin-bottom:10px">
Add shard json
@ -37,6 +38,7 @@
<p>
<label>2. Secret</label>
<textarea
spellcheck="false"
v-if="recoveredSecret"
id="recoveredSecret"
v-model="recoveredSecret"

View File

@ -75,12 +75,14 @@
<div>
Write it by hand on each printed sheet!
</div>
<div style="display:inline-block;margin-right:3px;margin-top:8px">
<div id="print_password_selection" class="danger-zone" style="margin-top:8px">
<div style="display:inline-block;margin-right:3px">
<input type="checkbox" id="printPassword" v-model="printPassword" name="print password" style="display:inline"/>
</div>
<div style="display:inline-block">
<label for="printPassword" style="display:inline">Print Password onto sheets (DANGER ZONE! At your own risk...)</label>
</div>
</div>
</div>
</div>
<div class="card" transparent="true">