Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document truststore options #1771

Merged
merged 3 commits into from
Feb 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 90 additions & 3 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -4194,7 +4194,10 @@ rpc-http-tls-keystore-file="/home/me/me_node/keystore.pfx"

</Tabs>

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`

Expand Down Expand Up @@ -4234,7 +4237,8 @@ rpc-http-tls-keystore-password-file="/home/me/me_node/password"

</Tabs>

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`

Expand Down Expand Up @@ -4274,7 +4278,7 @@ rpc-http-tls-known-clients-file="/home/me/me_node/knownClients"

</Tabs>

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 `<CommonName> <hex-string>`.

Expand Down Expand Up @@ -4330,6 +4334,89 @@ The singular `--rpc-http-tls-protocol` and plural `--rpc-http-tls-protocols` are

:::

### `rpc-http-tls-truststore-file`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-tls-truststore-file=<FILE>
```

</TabItem>

<TabItem value="Example" label="Example">

```bash
--rpc-http-tls-truststore-file=/home/me/me_node/truststore.pfx
```

</TabItem>

<TabItem value="Environment variable" label="Environment variable">

```bash
BESU_RPC_HTTP_TLS_TRUSTSTORE_FILE=/home/me/me_node/truststore.pfx
```

</TabItem>

<TabItem value="Configuration file" label="Configuration file">

```bash
rpc-http-tls-truststore-file="/home/me/me_node/truststore.pfx"
```

</TabItem>

</Tabs>

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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--rpc-http-tls-truststore-password-file=<FILE>
```

</TabItem>

<TabItem value="Example" label="Example">

```bash
--rpc-http-tls-truststore-password-file=/home/me/me_node/password
```

</TabItem>

<TabItem value="Environment variable" label="Environment variable">

```bash
BESU_RPC_HTTP_TLS_TRUSTSTORE_PASSWORD_FILE=/home/me/me_node/password
```

</TabItem>

<TabItem value="Configuration file" label="Configuration file">

```bash
rpc-http-tls-truststore-password-file="/home/me/me_node/password"
```

</TabItem>

</Tabs>

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`

<Tabs>
Expand Down
Loading