From 336379518150ad69e1fb0670c2a14e8b3bd96c7c Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Mon, 3 Feb 2025 23:04:52 -0800 Subject: [PATCH 1/4] Document truststore options Signed-off-by: Alexandra Tran --- docs/public-networks/reference/cli/options.md | 82 ++++++++++++++++++- 1 file changed, 81 insertions(+), 1 deletion(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index b14f547d88..4de9493657 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -4194,7 +4194,7 @@ rpc-http-tls-keystore-file="/home/me/me_node/keystore.pfx" -The Keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. +The keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. ### `rpc-http-tls-keystore-password-file` @@ -4330,6 +4330,86 @@ The singular `--rpc-http-tls-protocol` and plural `--rpc-http-tls-protocols` are ::: +### `rpc-http-tls-truststore-file` + + + + + +```bash +--rpc-http-tls-truststore-file= +``` + + + + + +```bash +--rpc-http-tls-truststore-file=/home/me/me_node/truststore.pfx +``` + + + + + +```bash +BESU_RPC_HTTP_TLS_TRUSTSTORE_FILE=/home/me/me_node/truststore.pfx +``` + + + + + +```bash +rpc-http-tls-truststore-file="/home/me/me_node/truststore.pfx" +``` + + + + + +The path to the truststore file used for authentication. + +### `rpc-http-tls-truststore-password-file` + + + + + +```bash +--rpc-http-tls-truststore-password-file= +``` + + + + + +```bash +--rpc-http-tls-truststore-password-file=/home/me/me_node/password +``` + + + + + +```bash +BESU_RPC_HTTP_TLS_TRUSTSTORE_PASSWORD_FILE=/home/me/me_node/password +``` + + + + + +```bash +rpc-http-tls-truststore-password-file="/home/me/me_node/password" +``` + + + + + +The path to the file containing the password to decrypt the truststore. + ### `rpc-max-logs-range` From 9fce7700b51ffb69bce3393a52aed64758d1e9d4 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 4 Feb 2025 13:07:55 -0800 Subject: [PATCH 2/4] add more context to descriptions Signed-off-by: Alexandra Tran --- docs/public-networks/reference/cli/options.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 4de9493657..5943a31029 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -4194,7 +4194,10 @@ rpc-http-tls-keystore-file="/home/me/me_node/keystore.pfx" -The keystore file (in PKCS #12 format) that contains private key and the certificate presented to the client during authentication. +Path to the keystore file (in PKCS #12 format) when enabling TLS for the JSON-RPC HTTP service. +The keystore file contains the private key and certificate presented to the client during authentication. + +Specify the keystore password file using [`--rpc-http-tls-keystore-password-file`](#rpc-http-tls-keystore-password-file). ### `rpc-http-tls-keystore-password-file` @@ -4234,7 +4237,8 @@ rpc-http-tls-keystore-password-file="/home/me/me_node/password" -The path to the file containing the password to decrypt the keystore. +Path to the file containing the password for the keystore specified in [`--rpc-http-tls-keystore-file`](#rpc-http-tls-keystore-file), +when enabling TLS for the JSON-RPC HTTP service. ### `rpc-http-tls-known-clients-file` @@ -4274,7 +4278,7 @@ rpc-http-tls-known-clients-file="/home/me/me_node/knownClients" -The path to the file used to [authenticate clients](../../../private-networks/how-to/configure/tls/client-and-server.md#create-the-known-clients-file) using self-signed certificates or non-public certificates. +Path to the file used to [authenticate clients](../../../private-networks/how-to/configure/tls/client-and-server.md#create-the-known-clients-file) using self-signed certificates or non-public certificates. Must contain the certificate's Common Name, and SHA-256 fingerprint in the format ` `. @@ -4368,7 +4372,9 @@ rpc-http-tls-truststore-file="/home/me/me_node/truststore.pfx" -The path to the truststore file used for authentication. +Path to the truststore file when enabling TLS for the JSON-RPC HTTP service. + +Specify the truststore password file using [`--rpc-http-tls-truststore-password-file`](#rpc-http-tls-truststore-password-file). ### `rpc-http-tls-truststore-password-file` @@ -4408,7 +4414,8 @@ rpc-http-tls-truststore-password-file="/home/me/me_node/password" -The path to the file containing the password to decrypt the truststore. +Path to the file containing the password for the truststore specified in [`--rpc-http-tls-truststore-file`](#rpc-http-tls-truststore-file), +when enabling TLS for the JSON-RPC HTTP service. ### `rpc-max-logs-range` From cc071b597e61a912378b869c8b737e6aa72fc802 Mon Sep 17 00:00:00 2001 From: Alexandra Tran Date: Tue, 15 Apr 2025 12:13:07 -0700 Subject: [PATCH 3/4] Remove references to unsupported eth protocol versions Signed-off-by: Alexandra Tran --- docs/public-networks/reference/api/index.md | 2 +- docs/public-networks/reference/cli/options.md | 51 ------------------- 2 files changed, 1 insertion(+), 52 deletions(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index a5bcc8ecdd..6e8971ea7a 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -522,7 +522,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"admin_peers","params":[],"id":1} { "version": "0x5", "name": "besu/v20.10.4-dev-0905d1b2/osx-x86_64/adoptopenjdk-java-11", - "caps": ["eth/62", "eth/63", "eth/64", "eth/65", "IBF/1"], + "caps": ["IBF/1"], "network": { "localAddress": "192.168.1.229:50115", "remoteAddress": "168.61.153.255:40303" diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md index 443a9e4ea4..0aa5832394 100644 --- a/docs/public-networks/reference/cli/options.md +++ b/docs/public-networks/reference/cli/options.md @@ -581,57 +581,6 @@ color-enabled=false Enables or disables color output to console. The default is `true`. -### `compatibility-eth64-forkid-enabled` - - - - - -```bash ---compatibility-eth64-forkid-enabled[=] -``` - - - - - -```bash ---compatibility-eth64-forkid-enabled=true -``` - - - - - -```bash -BESU_COMPATIBILITY_ETH64_FORKID_ENABLED=true -``` - - - - - -```bash -compatibility-eth64-forkid-enabled=true -``` - - - - - -Enables or disables the legacy Eth/64 fork ID. For any networks with nodes using Besu v1.4 or earlier and nodes using Besu v20.10.1 or later, either: - -- All nodes must be upgraded to v20.10.1 or later. -- All nodes using v20.10.1 or later must have `--compatibility-eth64-forkid-enabled` set to `true`. - -The default is `false`. - -:::caution - -If networks have Besu nodes using v1.4 or earlier and other Besu nodes using v20.10.1 or later, the nodes on different versions cannot communicate unless `--compatibility-eth64-forkid-enabled` is set to `true`. - -::: - ### `config-file` From 4f32b43b2cad99af4777dc67d63bc6eb068ed8da Mon Sep 17 00:00:00 2001 From: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com> Date: Tue, 15 Apr 2025 19:24:40 -0700 Subject: [PATCH 4/4] Update index.md Co-authored-by: Gabriel-Trintinalia Signed-off-by: Alexandra Carrillo <12214231+alexandratran@users.noreply.github.com> --- docs/public-networks/reference/api/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md index 6e8971ea7a..22d2ff800b 100644 --- a/docs/public-networks/reference/api/index.md +++ b/docs/public-networks/reference/api/index.md @@ -522,7 +522,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"admin_peers","params":[],"id":1} { "version": "0x5", "name": "besu/v20.10.4-dev-0905d1b2/osx-x86_64/adoptopenjdk-java-11", - "caps": ["IBF/1"], + "caps": ["eth/67", "eth/68", "IBF/1"], "network": { "localAddress": "192.168.1.229:50115", "remoteAddress": "168.61.153.255:40303"