forked from TrueCloudLab/frostfs-http-gw
docs: Clarify auth scheme
Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
parent
6d9bc994cd
commit
73bd26bc12
1 changed files with 34 additions and 20 deletions
52
README.md
52
README.md
|
@ -23,12 +23,7 @@ NeoFS HTTP Protocol Gateway bridges NeoFS internal protocol and HTTP standard.
|
||||||
Or you can call `make` to build it from the cloned repository (the binary will
|
Or you can call `make` to build it from the cloned repository (the binary will
|
||||||
end up in `bin/neofs-http-gw`).
|
end up in `bin/neofs-http-gw`).
|
||||||
|
|
||||||
Or you can also use a [Docker
|
Notable make targets:
|
||||||
image](https://hub.docker.com/r/nspccdev/neofs-http-gw) provided for released
|
|
||||||
(and occasionaly unreleased) versions of gateway (`:latest` points to the
|
|
||||||
latest stable release).
|
|
||||||
|
|
||||||
### Notable make targets
|
|
||||||
|
|
||||||
```
|
```
|
||||||
dep Check and ensure dependencies
|
dep Check and ensure dependencies
|
||||||
|
@ -39,6 +34,11 @@ lint Run linters
|
||||||
version Show current version
|
version Show current version
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Or you can also use a [Docker
|
||||||
|
image](https://hub.docker.com/r/nspccdev/neofs-http-gw) provided for released
|
||||||
|
(and occasionaly unreleased) versions of gateway (`:latest` points to the
|
||||||
|
latest stable release).
|
||||||
|
|
||||||
## Execution
|
## Execution
|
||||||
|
|
||||||
HTTP gateway itself is not a NeoFS node, so to access NeoFS it uses node's
|
HTTP gateway itself is not a NeoFS node, so to access NeoFS it uses node's
|
||||||
|
@ -54,13 +54,13 @@ $ neofs-http-gw -p 192.168.130.72:8080
|
||||||
$ HTTP_GW_PEERS_0_ADDRESS=192.168.130.72:8080 neofs-http-gw
|
$ HTTP_GW_PEERS_0_ADDRESS=192.168.130.72:8080 neofs-http-gw
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration
|
## Configuration
|
||||||
|
|
||||||
In general, everything available as CLI parameter can also be specified via
|
In general, everything available as CLI parameter can also be specified via
|
||||||
environment variables, so they're not specifically mentioned in most cases
|
environment variables, so they're not specifically mentioned in most cases
|
||||||
(see `--help` also).
|
(see `--help` also).
|
||||||
|
|
||||||
#### Nodes and weights
|
### Nodes and weights
|
||||||
|
|
||||||
You can specify multiple `-p` options to add more NeoFS nodes, this will make
|
You can specify multiple `-p` options to add more NeoFS nodes, this will make
|
||||||
gateway spread requests equally among them (using weight 1 for every node):
|
gateway spread requests equally among them (using weight 1 for every node):
|
||||||
|
@ -78,7 +78,7 @@ $ HTTP_GW_PEERS_0_ADDRESS=192.168.130.72:8080 HTTP_GW_PEERS_0_WEIGHT=9 \
|
||||||
This command will make gateway use 192.168.130.72 for 90% of requests and
|
This command will make gateway use 192.168.130.72 for 90% of requests and
|
||||||
192.168.130.71 for remaining 10%.
|
192.168.130.71 for remaining 10%.
|
||||||
|
|
||||||
#### Keys
|
### Keys
|
||||||
|
|
||||||
By default gateway autogenerates key pair it will use for NeoFS requests. If
|
By default gateway autogenerates key pair it will use for NeoFS requests. If
|
||||||
for some reason you need to have static keys you can pass them via `--key`
|
for some reason you need to have static keys you can pass them via `--key`
|
||||||
|
@ -89,7 +89,7 @@ string or (unencrypted) WIF string. Example:
|
||||||
$ neofs-http-gw -p 192.168.130.72:8080 -k KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
|
$ neofs-http-gw -p 192.168.130.72:8080 -k KxDgvEKzgSBPPfuVfw67oPQBSjidEiqTHURKSDL1R7yGaGYAeYnr
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Binding and TLS
|
### Binding and TLS
|
||||||
|
|
||||||
Gateway binds to `0.0.0.0:8082` by default and you can change that with
|
Gateway binds to `0.0.0.0:8082` by default and you can change that with
|
||||||
`--listen_address` option.
|
`--listen_address` option.
|
||||||
|
@ -107,7 +107,7 @@ $ neofs-http-gw -p 192.168.130.72:8080 --listen_address 192.168.130.130:443 \
|
||||||
--tls_key=key.pem --tls_certificate=cert.pem
|
--tls_key=key.pem --tls_certificate=cert.pem
|
||||||
```
|
```
|
||||||
|
|
||||||
#### HTTP parameters
|
### HTTP parameters
|
||||||
|
|
||||||
You can tune HTTP read and write buffer sizes as well as timeouts with
|
You can tune HTTP read and write buffer sizes as well as timeouts with
|
||||||
`HTTP_GW_WEB_READ_BUFFER_SIZE`, `HTTP_GW_WEB_READ_TIMEOUT`,
|
`HTTP_GW_WEB_READ_BUFFER_SIZE`, `HTTP_GW_WEB_READ_TIMEOUT`,
|
||||||
|
@ -121,19 +121,19 @@ first and only then try sending it to NeoFS).
|
||||||
`HTTP_GW_WEB_MAX_REQUEST_BODY_SIZE` controls maximum request body size
|
`HTTP_GW_WEB_MAX_REQUEST_BODY_SIZE` controls maximum request body size
|
||||||
limiting uploads to files slightly lower than this limit.
|
limiting uploads to files slightly lower than this limit.
|
||||||
|
|
||||||
#### NeoFS parameters
|
### NeoFS parameters
|
||||||
|
|
||||||
Gateway can automatically set timestamps for uploaded files based on local
|
Gateway can automatically set timestamps for uploaded files based on local
|
||||||
time source, use `HTTP_GW_UPLOAD_HEADER_USE_DEFAULT_TIMESTAMP` environment
|
time source, use `HTTP_GW_UPLOAD_HEADER_USE_DEFAULT_TIMESTAMP` environment
|
||||||
variable to control this behavior.
|
variable to control this behavior.
|
||||||
|
|
||||||
#### Monitoring and metrics
|
### Monitoring and metrics
|
||||||
|
|
||||||
Pprof and Prometheus are integrated into the gateway, but not enabled by
|
Pprof and Prometheus are integrated into the gateway, but not enabled by
|
||||||
default. To enable them use `--pprof` and `--metrics` flags or
|
default. To enable them use `--pprof` and `--metrics` flags or
|
||||||
`HTTP_GW_PPROF`/`HTTP_GW_METRICS` environment variables.
|
`HTTP_GW_PPROF`/`HTTP_GW_METRICS` environment variables.
|
||||||
|
|
||||||
#### Timeouts
|
### Timeouts
|
||||||
|
|
||||||
You can tune gRPC interface parameters with `--connect_timeout` (for
|
You can tune gRPC interface parameters with `--connect_timeout` (for
|
||||||
connection to node) and `--request_timeout` (for request processing over
|
connection to node) and `--request_timeout` (for request processing over
|
||||||
|
@ -148,7 +148,7 @@ if needed.
|
||||||
All timing options accept values with suffixes, so "15s" is 15 seconds and
|
All timing options accept values with suffixes, so "15s" is 15 seconds and
|
||||||
"2m" is 2 minutes.
|
"2m" is 2 minutes.
|
||||||
|
|
||||||
#### Logging
|
### Logging
|
||||||
|
|
||||||
`--verbose` flag enables gRPC logging and there is a number of environment
|
`--verbose` flag enables gRPC logging and there is a number of environment
|
||||||
variables to tune logging behavior:
|
variables to tune logging behavior:
|
||||||
|
@ -180,7 +180,6 @@ requests to `/get/$CID/$OID` path, like this:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ wget http://localhost:8082/get/Dxhf4PNprrJHWWTG5RGLdfLkJiSQ3AQqit1MSnEPRkDZ/2m8PtaoricLouCn5zE8hAFr3gZEBDCZFe9BEgVJTSocY
|
$ wget http://localhost:8082/get/Dxhf4PNprrJHWWTG5RGLdfLkJiSQ3AQqit1MSnEPRkDZ/2m8PtaoricLouCn5zE8hAFr3gZEBDCZFe9BEgVJTSocY
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
There is also more complex interface provided for attribute-based downloads,
|
There is also more complex interface provided for attribute-based downloads,
|
||||||
|
@ -285,13 +284,28 @@ object ID, like this:
|
||||||
#### Authentication
|
#### Authentication
|
||||||
|
|
||||||
You can always upload files to public containers (open for anyone to put
|
You can always upload files to public containers (open for anyone to put
|
||||||
objects into), but for restricted containers you need to use bearer tokens
|
objects into), but for restricted containers you need to explicitly allow PUT
|
||||||
(which basically is an owner-signed ACL data, refer to NeoFS documentation for
|
operations for request signed with your HTTP Protocol Gateway keys.
|
||||||
more details). There are two options to pass them to gateway:
|
|
||||||
|
If your don't want to manage gateway's secret keys and adjust eACL rules when
|
||||||
|
gateway configuration changes (new gate, key rotation, etc) or you plan to use
|
||||||
|
public services, there is an option to let your application backend (or you) to
|
||||||
|
issue Bearer Tokens ans pass them from the client via gate down to NeoFS level
|
||||||
|
to grant access.
|
||||||
|
|
||||||
|
NeoFS Bearer Token basically is a container owner-signed ACL data (refer to NeoFS
|
||||||
|
documentation for more details). There are two options to pass them to gateway:
|
||||||
* "Authorization" header with "Bearer" type and base64-encoded token in
|
* "Authorization" header with "Bearer" type and base64-encoded token in
|
||||||
credentials field
|
credentials field
|
||||||
* "__context_bearer_token_key" cookie with base64-encoded token contents
|
* "__context_bearer_token_key" cookie with base64-encoded token contents
|
||||||
|
|
||||||
|
For example you have a mobile application frontend with a backend part storing
|
||||||
|
data in NeoFS. When user authorizes in mobile app, the backend issues a NeoFS
|
||||||
|
Bearer token and provides it to the frontend. Then the mobile app may generate
|
||||||
|
some data and upload it via any available NeoFS HTTP Protocol Gateway by adding
|
||||||
|
the corresponding header to the upload request. Accessing the ACL protected data
|
||||||
|
works the same way.
|
||||||
|
|
||||||
### Metrics and Pprof
|
### Metrics and Pprof
|
||||||
|
|
||||||
If enabled, Prometheus metrics are available at `/metrics/` path and Pprof at
|
If enabled, Prometheus metrics are available at `/metrics/` path and Pprof at
|
||||||
|
|
Loading…
Reference in a new issue