-
Notifications
You must be signed in to change notification settings - Fork 139
[BESU-163] Add inbound and outbound TLS information. #124
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
97297aa
BESU-163: Add inbound TLS information.
bgravenorst 42cb941
Implement reviewer feedback..
bgravenorst 20fff7b
Add privacy CLI options.
bgravenorst 0ca75dd
Add privact CLI options.
bgravenorst cff8a40
Added privacy CLI commands.
bgravenorst d8d928a
Add Privacy CLI options.
bgravenorst dfe6a61
Implement reviewer feedback.
bgravenorst e50dabf
Implement reviewer feedback.
bgravenorst 5ce0688
Merge branch 'master' into BESU-163
bgravenorst File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| description: TLS overview | ||
| <!--- END of page meta data --> | ||
|
|
||
| # TLS Communication | ||
|
|
||
| Hyperledger Besu supports inbound TLS communication (for example from EthSigner | ||
| or curl). | ||
|
|
||
| All TLS versions are supported. However, certificates must be PKCS #12 | ||
| formatted. | ||
|
|
||
| [Configure client authentication](../HowTo/Configure/Configure-TLS.md#create-known-clients-file) to specify which clients can | ||
| connect to Besu, and use the [command line options](../HowTo/Configure/Configure-TLS.md#start-besu) to specify the | ||
| certificate locations. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| description: Configure TLS | ||
|
bgravenorst marked this conversation as resolved.
|
||
| <!--- END of page meta data --> | ||
|
|
||
| # Configure TLS | ||
|
|
||
| Hyperledger Besu supports TLS for inbound communication. For example, you can | ||
| configure TLS for communication between EthSigner and Besu. | ||
|
|
||
| Use the command line to configure TLS. | ||
|
|
||
| Besu only supports password-protected PKSC #12 keystore files. | ||
|
|
||
| **Prerequisites**: | ||
|
|
||
| * Password-protected PKSC #12 keystore. | ||
| * File containing the keystore password | ||
|
|
||
| ## Create Known Clients File | ||
|
|
||
| Create a file (in this example, `knownClients`) that lists one or more clients | ||
| with permission to connect to Besu. Use the format`<common_name> <hex-string>` | ||
|
bgravenorst marked this conversation as resolved.
Outdated
|
||
| where `<common_name>` is the Common Name specified in the client certificate, | ||
| and `<hex-string>` is the SHA-256 fingerprint of the client certificate. | ||
|
|
||
| Only clients with self-signed certificates must be added to the file. | ||
|
|
||
| !!! example | ||
| ``` | ||
| localhost DF:65:B8:02:08:5E:91:82:0F:91:F5:1C:96:56:92:C4:1A:F6:C6:27:FD:6C:FC:31:F2:BB:90:17:22:59:5B:50 | ||
| ``` | ||
|
|
||
| You can use `openssl` or `keytool` command to display the fingerprint. For | ||
| example, `keytool -list -v -keystore <keystore> -storetype PKCS12 -storepass <MY_PASSWORD>`. | ||
|
|
||
| !!! note | ||
| Common Names used in the certificates must not be identical. | ||
|
|
||
| ## Start Besu | ||
|
|
||
| ```bash | ||
| besu --rpc-http-enabled --rpc-http-tls-enabled --rpc-http-tls-keystore-file=/Users/me/my_node/keystore.pfx --rpc-http-tls-keystore-password-file=/Users/me/my_node/keystorePassword --rpc-http-tls-known-clients-file=/Users/me/my_node/knownClients | ||
| ``` | ||
|
|
||
| The command line: | ||
|
|
||
| * Enables the HTTP JSON-RPC service using the [`--rpc-http-enabled`](../../Reference/CLI/CLI-Syntax.md#rpc-http-enabled) option. | ||
| * Enables TLS for the HTTP JSON-RPC service using the [`--rpc-http-tls-enabled`](../../Reference/CLI/CLI-Syntax.md#rpc-http-tls-enabled) | ||
| option. | ||
| * Specifies the keystore using the [`--rpc-http-tls-keystore-file`](../../Reference/CLI/CLI-Syntax.md#rpc-http-tls-keystore-file) option. | ||
| * Specifies the file that contains the password to decrypt the keystore using | ||
| the [`--rpc-http-tls-keystore-password-file`](../../Reference/CLI/CLI-Syntax.md#rpc-http-tls-keystore-password-file) option. | ||
| * Specify the clients that are allowed to connect to Besu using the | ||
| [`--rpc-http-tls-known-clients-file`](../../Reference/CLI/CLI-Syntax.md#rpc-http-tls-known-clients-file) option. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.