gaspersic/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move all documentation below /docs (#20072)

Browse Source 
* Move pages one level deeper under the /docs folder and fix broken links

* Fix broken links

* Flatten clef/qubes links to clef

* Remove path debugging from main template
This commit is contained in:
Adam Schmideg
2019-10-01 10:40:09 +02:00
committed by Felix Lange
parent 8dc979183f
commit 8e49d1571d
28 changed files with 85 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/_clef/Overview.md
View File

@ -24,9 +24,9 @@ or a separate VM in a [QubesOS](https://www.qubes-os.org/) type os setup.
Check out
* the [tutorial](Tutorial) for some concrete examples on how the signer works.
* the [setup docs](Setup) for some information on how to configure it to work on QubesOS or USBArmory.
* more info about [rules](Rules)
* the [tutorial](tutorial) for some concrete examples on how the signer works.
* the [setup docs](setup) for some information on how to configure it to work on QubesOS or USBArmory.
* more info about [rules](rules)
* the [data types](datatypes) for detailed information on the json types used in the communication between
clef and an external UI
@ -65,7 +65,7 @@ Clef relies on __sign-what-you-see__. To provide as much context as possible,
One setup scenario is to use virtualization, e.g. within QubesOS, where to
Clef is deployed on a non-networked machine (`ethvault` below)
![](./qubes/clef_qubes_qrexec.png)
![](clef_qubes_qrexec.png)
Another option is to deploy Clef on a separate physical device, e.g. USB Armory,

14
docs/_clef/Setup.md
View File

@ -40,7 +40,7 @@ There are two ways that this can be achieved: integrated via Qubes or integrated
Qubes provdes a facility for inter-qubes communication via `qrexec`. A qube can request to make a cross-qube RPC request
to another qube. The OS then asks the user if the call is permitted.
![Example](qubes/qrexec-example.png)
![Example](qrexec-example.png)
A policy-file can be created to allow such interaction. On the `target` domain, a service is invoked which can read the
`stdin` from the `client` qube.
@ -49,11 +49,11 @@ This is how [Split GPG](https://www.qubes-os.org/doc/split-gpg/) is implemented.
##### Server
![Clef via qrexec](qubes/clef_qubes_qrexec.png)
![Clef via qrexec](clef_qubes_qrexec.png)
On the `target` qubes, we need to define the rpc service.
[qubes.Clefsign](qubes/qubes.Clefsign):
[qubes.Clefsign](qubes.Clefsign):
```bash
#!/bin/bash
@ -97,7 +97,7 @@ with minimal requirements.
On the `client` qube, we need to create a listener which will receive the request from the Dapp, and proxy it.
[qubes-client.py](qubes/client/qubes-client.py):
[qubes-client.py](qubes-client.py):
```python
@ -140,11 +140,11 @@ $ cat newaccnt.json| qrexec-client-vm debian-work qubes.Clefsign
This should pop up first a dialog to allow the IPC call:
![one](qubes/qubes_newaccount-1.png)
![one](qubes_newaccount-1.png)
Followed by a GTK-dialog to approve the operation
![two](qubes/qubes_newaccount-2.png)
![two](qubes_newaccount-2.png)
To test the full flow, we use the client wrapper. Start it on the `client` qube:
```
@ -182,7 +182,7 @@ However, it comes with a couple of drawbacks:
The second way to set up Clef on a qubes system is to allow networking, and have Clef listen to a port which is accessible
form other qubes.
![Clef via http](qubes/clef_qubes_http.png)
![Clef via http](clef_qubes_http.png)

2
docs/_clef/apis.md
View File

@ -280,7 +280,7 @@ Response
### account_signTypedData
#### Sign data
Signs a chunk of structured data conformant to [EIP712]([EIP-712](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md)) and returns the calculated signature.
Signs a chunk of structured data conformant to [EIP712](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-712.md) and returns the calculated signature.
#### Arguments
- account [address]: account to sign with