Skip to content

Commit 00ccfc6

Browse files
author
Micah Zoltu
authored
Adjusts wording and removes disk writing requirement. (#298)
We should try to avoid using acronyms in specifications as it makes it harder for new participants in the ecosystem to process, so I have changed all references to EL and CL to execution layer and consensus layer. Also, in many cases in this document the term EL was used when EL client was meant, so I appended "client" as appropriate. While writing to the filesystem is useful in some setups, in others it may be a security risk. For this reason, the **MUST** write to disk was changed to a **SHOULD** write to disk so that a client that doesn't write the token to disk isn't out of compliance.
1 parent a34808e commit 00ccfc6

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

src/engine/authentication.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Authentication
22

3-
The `engine` JSON-RPC interface, exposed by EL and consumed by CL, needs to be authenticated. The authentication scheme chosen for this purpose is [JWT](https://jwt.io/).
3+
The `engine` JSON-RPC interface, exposed by execution layer clients and consumed by consensus layer clients, needs to be authenticated. The authentication scheme chosen for this purpose is [JWT](https://jwt.io/).
44

55
The type of attacks that this authentication scheme attempts to protect against are the following:
66

7-
- RPC port exposed towards the internet, allowing attackers to exchange messages with EL engine API.
8-
- RPC port exposed towards the browser, allowing malicious webpages to submit messages to the EL engine API.
7+
- RPC port exposed towards the internet, allowing attackers to exchange messages with execution layer engine API.
8+
- RPC port exposed towards the browser, allowing malicious webpages to submit messages to the execution layer engine API.
99

1010
The authentication scheme is _not_ designed to
1111

@@ -16,38 +16,38 @@ Authentication is performed as follows:
1616

1717
- For `HTTP` dialogue, each `jsonrpc` request is individually authenticated by supplying `JWT` token in the HTTP header.
1818
- For a WebSocket dialogue, only the initial handshake is authenticated, after which the message dialogue proceeds without further use of JWT.
19-
- Clarification: The websocket handshake starts with the CL performing a websocket upgrade request. This is a regular http GET request, and the actual
19+
- Clarification: The websocket handshake starts with the consensus layer client performing a websocket upgrade request. This is a regular http GET request, and the actual
2020
parameters for the WS-handshake are carried in the http headers.
2121
- For `inproc`, a.k.a raw ipc communication, no authentication is required, under the assumption that a process able to access `ipc` channels for the process, which usually means local file access, is already sufficiently permissioned that further authentication requirements do not add security.
2222

2323

2424
## JWT specifications
2525

26-
- The EL **MUST** expose the authenticated Engine API at a port independent from existing JSON-RPC API.
26+
- The execution layer client **MUST** expose the authenticated Engine API at a port independent from existing JSON-RPC API.
2727
- The default port for the authenticated Engine API is `8551`. The Engine API is exposed under the `engine` namespace.
28-
- The EL **MUST** support at least the following `alg` `HMAC + SHA256` (`HS256`)
29-
- The EL **MUST** reject the `alg` `none`.
28+
- The execution layer client **MUST** support at least the following `alg` `HMAC + SHA256` (`HS256`)
29+
- The execution layer client **MUST** reject the `alg` `none`.
3030

3131

32-
The HMAC algorithm implies that several CLs will be able to use the same key, and from an authentication perspective, be able to impersonate each other. From a deployment perspective, it means that an EL does not need to be provisioned with individual keys for each CL.
32+
The HMAC algorithm implies that several consensus layer clients will be able to use the same key, and from an authentication perspective, be able to impersonate each other. From a deployment perspective, it means that an EL does not need to be provisioned with individual keys for each consensus layer client.
3333

3434
## Key distribution
3535

36-
The `EL` and `CL` clients **MUST** accept a cli/config parameter: `jwt-secret`, which designates a file containing the hex-encoded 256 bit secret key to be used for verifying/generating JWT tokens.
36+
The execution layer and consensus layer clients **SHOULD** accept a configuration parameter: `jwt-secret`, which designates a file containing the hex-encoded 256 bit secret key to be used for verifying/generating JWT tokens.
3737

38-
If such a parameter is not given, the client **SHOULD** generate such a token, valid for the duration of the execution, and store the hex-encoded secret as a `jwt.hex` file on the filesystem. This file can then be used to provision the counterpart client.
38+
If such a parameter is not given, the client **SHOULD** generate such a token, valid for the duration of the execution, and **SHOULD** store the hex-encoded secret as a `jwt.hex` file on the filesystem. This file can then be used to provision the counterpart client.
3939

40-
If such a parameter _is_ given, but the file cannot be read, or does not contain a hex-encoded key of `256` bits, the client should treat this as an error: either abort the startup, or show error and continue without exposing the authenticated port.
40+
If such a parameter _is_ given, but the file cannot be read, or does not contain a hex-encoded key of `256` bits, the client **SHOULD** treat this as an error: either abort the startup, or show error and continue without exposing the authenticated port.
4141

4242
## JWT Claims
4343

4444
This specification utilizes the following list of JWT claims:
4545

46-
- Required: `iat` (issued-at) claim. The EL **SHOULD** only accept `iat` timestamps which are within +-60 seconds from the current time.
47-
- Optional: `id` claim. The CL **MAY** use this to communicate a unique identifier for the individual CL node.
48-
- Optional: `clv` claim. The CL **MAY** use this to communicate the CL node type/version.
46+
- Required: `iat` (issued-at) claim. The execution layer client **SHOULD** only accept `iat` timestamps which are within +-60 seconds from the current time.
47+
- Optional: `id` claim. The consensus layer client **MAY** use this to communicate a unique identifier for the individual consensus layer client.
48+
- Optional: `clv` claim. The consensus layer client **MAY** use this to communicate the consensus layer client type/version.
4949

50-
Other claims **MAY** be included in the JWT payload. If the EL sees claims it does not recognize, these **MUST** be ignored.
50+
Other claims **MAY** be included in the JWT payload. If the execution layer client sees claims it does not recognize, these **MUST** be ignored.
5151

5252
## Examples
5353

0 commit comments

Comments
 (0)