aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/clef
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/clef')
-rw-r--r--cmd/clef/README.md1
-rw-r--r--cmd/clef/docs/qubes/clef_qubes_http.pngbin14302 -> 12237 bytes
-rw-r--r--cmd/clef/docs/qubes/clef_qubes_qrexec.pngbin20261 -> 17443 bytes
-rw-r--r--cmd/clef/docs/qubes/qrexec-example.pngbin19109 -> 16166 bytes
-rw-r--r--cmd/clef/docs/qubes/qubes_newaccount-1.pngbin25142 -> 22348 bytes
-rw-r--r--cmd/clef/docs/qubes/qubes_newaccount-2.pngbin42747 -> 37250 bytes
-rw-r--r--cmd/clef/extapi_changelog.md7
-rw-r--r--cmd/clef/main.go10
-rw-r--r--cmd/clef/sign_flow.pngbin36397 -> 20753 bytes
-rw-r--r--cmd/clef/tutorial.md93
10 files changed, 69 insertions, 42 deletions
diff --git a/cmd/clef/README.md b/cmd/clef/README.md
index 027c22c98..c02ac44d8 100644
--- a/cmd/clef/README.md
+++ b/cmd/clef/README.md
@@ -875,3 +875,4 @@ There are a couple of implementation for a UI. We'll try to keep this list up to
| QtSigner| https://github.com/holiman/qtsigner/| Python3/QT-based| :+1:| :+1:| :+1:| :+1:| :+1:| :x: | :+1: (partially)|
| GtkSigner| https://github.com/holiman/gtksigner| Python3/GTK-based| :+1:| :x:| :x:| :+1:| :+1:| :x: | :x: |
| Frame | https://github.com/floating/frame/commits/go-signer| Electron-based| :x:| :x:| :x:| :x:| ?| :x: | :x: |
+| Clef UI| https://github.com/kyokan/clef-ui| Golang/QT-based| :+1:| :+1:| :x:| :+1:| :+1:| :x: | :+1: (approve tx only)|
diff --git a/cmd/clef/docs/qubes/clef_qubes_http.png b/cmd/clef/docs/qubes/clef_qubes_http.png
index a641e1987..e95ad8da4 100644
--- a/cmd/clef/docs/qubes/clef_qubes_http.png
+++ b/cmd/clef/docs/qubes/clef_qubes_http.png
Binary files differ
diff --git a/cmd/clef/docs/qubes/clef_qubes_qrexec.png b/cmd/clef/docs/qubes/clef_qubes_qrexec.png
index f57fc8933..b1814e7c3 100644
--- a/cmd/clef/docs/qubes/clef_qubes_qrexec.png
+++ b/cmd/clef/docs/qubes/clef_qubes_qrexec.png
Binary files differ
diff --git a/cmd/clef/docs/qubes/qrexec-example.png b/cmd/clef/docs/qubes/qrexec-example.png
index 0d86fde19..fc5d57725 100644
--- a/cmd/clef/docs/qubes/qrexec-example.png
+++ b/cmd/clef/docs/qubes/qrexec-example.png
Binary files differ
diff --git a/cmd/clef/docs/qubes/qubes_newaccount-1.png b/cmd/clef/docs/qubes/qubes_newaccount-1.png
index 598dbbee7..3bfc8b5b7 100644
--- a/cmd/clef/docs/qubes/qubes_newaccount-1.png
+++ b/cmd/clef/docs/qubes/qubes_newaccount-1.png
Binary files differ
diff --git a/cmd/clef/docs/qubes/qubes_newaccount-2.png b/cmd/clef/docs/qubes/qubes_newaccount-2.png
index cd762a193..c6dbd535d 100644
--- a/cmd/clef/docs/qubes/qubes_newaccount-2.png
+++ b/cmd/clef/docs/qubes/qubes_newaccount-2.png
Binary files differ
diff --git a/cmd/clef/extapi_changelog.md b/cmd/clef/extapi_changelog.md
index 2014e90ae..6c2c3e819 100644
--- a/cmd/clef/extapi_changelog.md
+++ b/cmd/clef/extapi_changelog.md
@@ -1,6 +1,13 @@
### Changelog for external API
+#### 4.0.0
+* The external `account_Ecrecover`-method was removed.
+* The external `account_Import`-method was removed.
+
+#### 3.0.0
+
+* The external `account_List`-method was changed to not expose `url`, which contained info about the local filesystem. It now returns only a list of addresses.
#### 2.0.0
diff --git a/cmd/clef/main.go b/cmd/clef/main.go
index f363a86f2..c060285be 100644
--- a/cmd/clef/main.go
+++ b/cmd/clef/main.go
@@ -48,7 +48,7 @@ import (
)
// ExternalAPIVersion -- see extapi_changelog.md
-const ExternalAPIVersion = "2.0.0"
+const ExternalAPIVersion = "3.0.0"
// InternalAPIVersion -- see intapi_changelog.md
const InternalAPIVersion = "2.0.0"
@@ -70,6 +70,10 @@ var (
Value: 4,
Usage: "log level to emit to the screen",
}
+ advancedMode = cli.BoolFlag{
+ Name: "advanced",
+ Usage: "If enabled, issues warnings instead of rejections for suspicious requests. Default off",
+ }
keystoreFlag = cli.StringFlag{
Name: "keystore",
Value: filepath.Join(node.DefaultDataDir(), "keystore"),
@@ -191,6 +195,7 @@ func init() {
ruleFlag,
stdiouiFlag,
testFlag,
+ advancedMode,
}
app.Action = signer
app.Commands = []cli.Command{initCommand, attestCommand, addCredentialCommand}
@@ -384,7 +389,8 @@ func signer(c *cli.Context) error {
c.String(keystoreFlag.Name),
c.Bool(utils.NoUSBFlag.Name),
ui, db,
- c.Bool(utils.LightKDFFlag.Name))
+ c.Bool(utils.LightKDFFlag.Name),
+ c.Bool(advancedMode.Name))
api = apiImpl
diff --git a/cmd/clef/sign_flow.png b/cmd/clef/sign_flow.png
index 9c0f3cc5d..93ef81a32 100644
--- a/cmd/clef/sign_flow.png
+++ b/cmd/clef/sign_flow.png
Binary files differ
diff --git a/cmd/clef/tutorial.md b/cmd/clef/tutorial.md
index d59e08ac7..dfb31ba4e 100644
--- a/cmd/clef/tutorial.md
+++ b/cmd/clef/tutorial.md
@@ -31,43 +31,51 @@ NOTE: This file does not contain your accounts. Those need to be backed up separ
## Creating rules
-Now, you can create a rule-file.
+Now, you can create a rule-file. Note that it is not mandatory to use predefined rules, but it's really handy.
```javascript
function ApproveListing(){
return "Approve"
}
```
-Get the `sha256` hash....
+
+Get the `sha256` hash. If you have openssl, you can do `openssl sha256 rules.js`...
```text
#sha256sum rules.js
6c21d1737429d6d4f2e55146da0797782f3c0a0355227f19d702df377c165d72 rules.js
```
-...And then `attest` the file:
+...now `attest` the file...
```text
#./signer attest 6c21d1737429d6d4f2e55146da0797782f3c0a0355227f19d702df377c165d72
INFO [02-21|12:14:38] Ruleset attestation updated sha256=6c21d1737429d6d4f2e55146da0797782f3c0a0355227f19d702df377c165d72
```
-At this point, we then start the signer with the rule-file:
+...and (this is required only for non-production versions) load a mock-up `4byte.json` by copying the file from the source to your current working directory:
```text
-#./signer --rules rules.json
-
-INFO [02-21|12:15:18] Using CLI as UI-channel
-INFO [02-21|12:15:18] Loaded 4byte db signatures=5509 file=./4byte.json
-INFO [02-21|12:15:18] Could not load rulefile, rules not enabled file=rulefile
-DEBUG[02-21|12:15:18] FS scan times list=35.335µs set=5.536µs diff=5.073µs
-DEBUG[02-21|12:15:18] Ledger support enabled
-DEBUG[02-21|12:15:18] Trezor support enabled
-INFO [02-21|12:15:18] Audit logs configured file=audit.log
-INFO [02-21|12:15:18] HTTP endpoint opened url=http://localhost:8550
+#cp $GOPATH/src/github.com/ethereum/go-ethereum/cmd/clef/4byte.json $PWD
+```
+
+At this point, we can start the signer with the rule-file:
+```text
+#./signer --rules rules.js --rpc
+
+INFO [09-25|20:28:11.866] Using CLI as UI-channel
+INFO [09-25|20:28:11.876] Loaded 4byte db signatures=5509 file=./4byte.json
+INFO [09-25|20:28:11.877] Rule engine configured file=./rules.js
+DEBUG[09-25|20:28:11.877] FS scan times list=100.781µs set=13.253µs diff=5.761µs
+DEBUG[09-25|20:28:11.884] Ledger support enabled
+DEBUG[09-25|20:28:11.888] Trezor support enabled
+INFO [09-25|20:28:11.888] Audit logs configured file=audit.log
+DEBUG[09-25|20:28:11.888] HTTP registered namespace=account
+INFO [09-25|20:28:11.890] HTTP endpoint opened url=http://localhost:8550
+DEBUG[09-25|20:28:11.890] IPC registered namespace=account
+INFO [09-25|20:28:11.890] IPC endpoint opened url=<nil>
------- Signer info -------
+* extapi_version : 2.0.0
+* intapi_version : 2.0.0
* extapi_http : http://localhost:8550
* extapi_ipc : <nil>
-* extapi_version : 2.0.0
-* intapi_version : 1.2.0
-
```
Any list-requests will now be auto-approved by our rule-file.
@@ -107,16 +115,16 @@ The `master_seed` was then used to derive a few other things:
## Adding credentials
-In order to make more useful rules; sign transactions, the signer needs access to the passwords needed to unlock keystores.
+In order to make more useful rules like signing transactions, the signer needs access to the passwords needed to unlock keystores.
```text
-#./signer addpw 0x694267f14675d7e1b9494fd8d72fefe1755710fa test
+#./signer addpw "0x694267f14675d7e1b9494fd8d72fefe1755710fa" "test_password"
INFO [02-21|13:43:21] Credential store updated key=0x694267f14675d7e1b9494fd8d72fefe1755710fa
```
## More advanced rules
-Now let's update the rules to make use of credentials
+Now let's update the rules to make use of credentials:
```javascript
function ApproveListing(){
@@ -134,13 +142,15 @@ function ApproveSignData(r){
}
```
-In this example,
-* any requests to sign data with the account `0x694...` will be
- * auto-approved if the message contains with `bazonk`,
- * and auto-rejected if it does not.
- * Any other signing-requests will be passed along for manual approve/reject.
+In this example:
+* Any requests to sign data with the account `0x694...` will be
+ * auto-approved if the message contains with `bazonk`
+ * auto-rejected if it does not.
+* Any other signing-requests will be passed along for manual approve/reject.
+
+_Note: make sure that `0x694...` is an account you have access to. You can create it either via the clef or the traditional account cli tool. If the latter was chosen, make sure both clef and geth use the same keystore by specifing `--keystore path/to/your/keystore` when running clef._
-..attest the new file
+Attest the new file...
```text
#sha256sum rules.js
2a0cb661dacfc804b6e95d935d813fd17c0997a7170e4092ffbc34ca976acd9f rules.js
@@ -153,23 +163,26 @@ INFO [02-21|14:36:30] Ruleset attestation updated sha256=2a0cb661da
And start the signer:
```
-#./signer --rules rules.js
-
-INFO [02-21|14:41:56] Using CLI as UI-channel
-INFO [02-21|14:41:56] Loaded 4byte db signatures=5509 file=./4byte.json
-INFO [02-21|14:41:56] Rule engine configured file=rules.js
-DEBUG[02-21|14:41:56] FS scan times list=34.607µs set=4.509µs diff=4.87µs
-DEBUG[02-21|14:41:56] Ledger support enabled
-DEBUG[02-21|14:41:56] Trezor support enabled
-INFO [02-21|14:41:56] Audit logs configured file=audit.log
-INFO [02-21|14:41:56] HTTP endpoint opened url=http://localhost:8550
+#./signer --rules rules.js --rpc
+
+INFO [09-25|21:02:16.450] Using CLI as UI-channel
+INFO [09-25|21:02:16.466] Loaded 4byte db signatures=5509 file=./4byte.json
+INFO [09-25|21:02:16.467] Rule engine configured file=./rules.js
+DEBUG[09-25|21:02:16.468] FS scan times list=1.45262ms set=21.926µs diff=6.944µs
+DEBUG[09-25|21:02:16.473] Ledger support enabled
+DEBUG[09-25|21:02:16.475] Trezor support enabled
+INFO [09-25|21:02:16.476] Audit logs configured file=audit.log
+DEBUG[09-25|21:02:16.476] HTTP registered namespace=account
+INFO [09-25|21:02:16.478] HTTP endpoint opened url=http://localhost:8550
+DEBUG[09-25|21:02:16.478] IPC registered namespace=account
+INFO [09-25|21:02:16.478] IPC endpoint opened url=<nil>
------- Signer info -------
* extapi_version : 2.0.0
-* intapi_version : 1.2.0
+* intapi_version : 2.0.0
* extapi_http : http://localhost:8550
* extapi_ipc : <nil>
-INFO [02-21|14:41:56] error occurred during execution error="ReferenceError: 'OnSignerStartup' is not defined"
```
+
And then test signing, once with `bazonk` and once without:
```
@@ -190,9 +203,9 @@ INFO [02-21|14:42:56] Op rejected
The signer also stores all traffic over the external API in a log file. The last 4 lines shows the two requests and their responses:
```text
-#tail audit.log -n 4
+#tail -n 4 audit.log
t=2018-02-21T14:42:41+0100 lvl=info msg=Sign api=signer type=request metadata="{\"remote\":\"127.0.0.1:49706\",\"local\":\"localhost:8550\",\"scheme\":\"HTTP/1.1\"}" addr="0x694267f14675d7e1b9494fd8d72fefe1755710fa [chksum INVALID]" data=202062617a6f6e6b2062617a2067617a0a
t=2018-02-21T14:42:42+0100 lvl=info msg=Sign api=signer type=response data=93e6161840c3ae1efc26dc68dedab6e8fc233bb3fefa1b4645dbf6609b93dace160572ea4ab33240256bb6d3dadb60dcd9c515d6374d3cf614ee897408d41d541c error=nil
t=2018-02-21T14:42:56+0100 lvl=info msg=Sign api=signer type=request metadata="{\"remote\":\"127.0.0.1:49708\",\"local\":\"localhost:8550\",\"scheme\":\"HTTP/1.1\"}" addr="0x694267f14675d7e1b9494fd8d72fefe1755710fa [chksum INVALID]" data=2020626f6e6b2062617a2067617a0a
t=2018-02-21T14:42:56+0100 lvl=info msg=Sign api=signer type=response data= error="Request denied"
-```
+``` \ No newline at end of file
generated by cgit (git 2.34.1) at 2024-10-13 02:13:25 +0800