6f18f95893
## Issue Addressed Resolves #2438 Resolves #2437 ## Proposed Changes Changes the permissions for validator client http server api token file and secret key to 600 from 644. Also changes the permission for logfiles generated using the `--logfile` cli option to 600. Logs the path to the api token instead of the actual api token. Updates docs to reflect the change.
51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# Validator Client API: Authorization Header
|
|
|
|
## Overview
|
|
|
|
The validator client HTTP server requires that all requests have the following
|
|
HTTP header:
|
|
|
|
- Name: `Authorization`
|
|
- Value: `Basic <api-token>`
|
|
|
|
Where `<api-token>` is a string that can be obtained from the validator client
|
|
host. Here is an example `Authorization` header:
|
|
|
|
```
|
|
Authorization Basic api-token-0x03eace4c98e8f77477bb99efb74f9af10d800bd3318f92c33b719a4644254d4123
|
|
```
|
|
|
|
## Obtaining the API token
|
|
|
|
The API token is stored as a file in the `validators` directory. For most users
|
|
this is `~/.lighthouse/{network}/validators/api-token.txt`. Here's an
|
|
example using the `cat` command to print the token to the terminal, but any
|
|
text editor will suffice:
|
|
|
|
```
|
|
$ cat api-token.txt
|
|
api-token-0x03eace4c98e8f77477bb99efb74f9af10d800bd3318f92c33b719a4644254d4123
|
|
```
|
|
|
|
|
|
When starting the validator client it will output a log message containing the path
|
|
to the file containing the api token.
|
|
|
|
```
|
|
Sep 28 19:17:52.615 INFO HTTP API started api_token_file: "$HOME/prater/validators/api-token.txt", listen_address: 127.0.0.1:5062
|
|
```
|
|
|
|
## Example
|
|
|
|
Here is an example `curl` command using the API token in the `Authorization` header:
|
|
|
|
```bash
|
|
curl localhost:5062/lighthouse/version -H "Authorization: Basic api-token-0x03eace4c98e8f77477bb99efb74f9af10d800bd3318f92c33b719a4644254d4123"
|
|
```
|
|
|
|
The server should respond with its version:
|
|
|
|
```json
|
|
{"data":{"version":"Lighthouse/v0.2.11-fc0654fbe+/x86_64-linux"}}
|
|
```
|