2014-03-30 18:28:04 +00:00
|
|
|
package weed_server
|
|
|
|
|
|
|
|
import (
|
2024-01-17 15:46:37 +00:00
|
|
|
"context"
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
"errors"
|
2014-03-30 18:28:04 +00:00
|
|
|
"net/http"
|
2023-12-21 00:21:11 +00:00
|
|
|
"os"
|
2024-01-10 18:05:27 +00:00
|
|
|
"strconv"
|
2021-01-24 08:01:44 +00:00
|
|
|
"strings"
|
2021-03-30 09:10:50 +00:00
|
|
|
"sync/atomic"
|
2019-06-25 16:49:27 +00:00
|
|
|
"time"
|
|
|
|
|
2024-01-17 15:46:37 +00:00
|
|
|
"github.com/seaweedfs/seaweedfs/weed/filer"
|
2022-08-25 03:03:34 +00:00
|
|
|
"github.com/seaweedfs/seaweedfs/weed/glog"
|
2024-01-17 15:46:37 +00:00
|
|
|
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
|
2022-08-25 03:03:34 +00:00
|
|
|
"github.com/seaweedfs/seaweedfs/weed/security"
|
|
|
|
"github.com/seaweedfs/seaweedfs/weed/util"
|
|
|
|
|
2022-07-29 07:17:28 +00:00
|
|
|
"github.com/seaweedfs/seaweedfs/weed/stats"
|
2014-03-30 18:28:04 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
func (fs *FilerServer) filerHandler(w http.ResponseWriter, r *http.Request) {
|
2021-01-24 08:01:44 +00:00
|
|
|
start := time.Now()
|
2024-01-10 18:05:27 +00:00
|
|
|
statusRecorder := stats.NewStatusResponseWriter(w)
|
|
|
|
w = statusRecorder
|
2023-12-21 00:21:11 +00:00
|
|
|
origin := r.Header.Get("Origin")
|
|
|
|
if origin != "" {
|
|
|
|
if fs.option.AllowedOrigins == nil || len(fs.option.AllowedOrigins) == 0 || fs.option.AllowedOrigins[0] == "*" {
|
|
|
|
origin = "*"
|
|
|
|
} else {
|
|
|
|
originFound := false
|
|
|
|
for _, allowedOrigin := range fs.option.AllowedOrigins {
|
|
|
|
if origin == allowedOrigin {
|
|
|
|
originFound = true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !originFound {
|
|
|
|
writeJsonError(w, r, http.StatusForbidden, errors.New("origin not allowed"))
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
w.Header().Set("Access-Control-Allow-Origin", origin)
|
2022-09-27 18:47:52 +00:00
|
|
|
w.Header().Set("Access-Control-Expose-Headers", "*")
|
|
|
|
w.Header().Set("Access-Control-Allow-Headers", "*")
|
|
|
|
w.Header().Set("Access-Control-Allow-Credentials", "true")
|
|
|
|
w.Header().Set("Access-Control-Allow-Methods", "PUT, POST, GET, DELETE, OPTIONS")
|
|
|
|
}
|
|
|
|
|
2024-01-17 15:17:07 +00:00
|
|
|
if r.Method == http.MethodOptions {
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
OptionsHandler(w, r, false)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2021-01-24 08:01:44 +00:00
|
|
|
// proxy to volume servers
|
|
|
|
var fileId string
|
|
|
|
if strings.HasPrefix(r.RequestURI, "/?proxyChunkId=") {
|
|
|
|
fileId = r.RequestURI[len("/?proxyChunkId="):]
|
|
|
|
}
|
|
|
|
if fileId != "" {
|
2021-01-28 23:23:46 +00:00
|
|
|
fs.proxyToVolumeServer(w, r, fileId)
|
2024-01-10 18:05:27 +00:00
|
|
|
stats.FilerHandlerCounter.WithLabelValues(stats.ChunkProxy).Inc()
|
2022-08-04 08:44:54 +00:00
|
|
|
stats.FilerRequestHistogram.WithLabelValues(stats.ChunkProxy).Observe(time.Since(start).Seconds())
|
2021-01-24 08:01:44 +00:00
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2024-01-10 18:05:27 +00:00
|
|
|
defer func() {
|
|
|
|
stats.FilerRequestCounter.WithLabelValues(r.Method, strconv.Itoa(statusRecorder.Status)).Inc()
|
|
|
|
stats.FilerRequestHistogram.WithLabelValues(r.Method).Observe(time.Since(start).Seconds())
|
|
|
|
}()
|
|
|
|
|
2024-01-17 15:17:07 +00:00
|
|
|
isReadHttpCall := r.Method == http.MethodGet || r.Method == http.MethodHead
|
2023-09-19 01:47:34 +00:00
|
|
|
if !fs.maybeCheckJwtAuthorization(r, !isReadHttpCall) {
|
|
|
|
writeJsonError(w, r, http.StatusUnauthorized, errors.New("wrong jwt"))
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2020-09-20 23:00:01 +00:00
|
|
|
w.Header().Set("Server", "SeaweedFS Filer "+util.VERSION)
|
2022-09-27 18:47:52 +00:00
|
|
|
|
2014-03-30 18:28:04 +00:00
|
|
|
switch r.Method {
|
2024-01-17 15:17:07 +00:00
|
|
|
case http.MethodGet, http.MethodHead:
|
2021-07-19 09:59:12 +00:00
|
|
|
fs.GetOrHeadHandler(w, r)
|
2024-01-17 15:17:07 +00:00
|
|
|
case http.MethodDelete:
|
2020-11-09 09:00:07 +00:00
|
|
|
if _, ok := r.URL.Query()["tagging"]; ok {
|
2020-11-16 00:59:28 +00:00
|
|
|
fs.DeleteTaggingHandler(w, r)
|
2020-11-09 09:00:07 +00:00
|
|
|
} else {
|
|
|
|
fs.DeleteHandler(w, r)
|
|
|
|
}
|
2024-01-17 15:17:07 +00:00
|
|
|
case http.MethodPost, http.MethodPut:
|
2021-03-30 09:10:50 +00:00
|
|
|
// wait until in flight data is less than the limit
|
|
|
|
contentLength := getContentLength(r)
|
|
|
|
fs.inFlightDataLimitCond.L.Lock()
|
2022-08-25 03:03:34 +00:00
|
|
|
inFlightDataSize := atomic.LoadInt64(&fs.inFlightDataSize)
|
|
|
|
for fs.option.ConcurrentUploadLimit != 0 && inFlightDataSize > fs.option.ConcurrentUploadLimit {
|
|
|
|
glog.V(4).Infof("wait because inflight data %d > %d", inFlightDataSize, fs.option.ConcurrentUploadLimit)
|
2021-03-30 09:10:50 +00:00
|
|
|
fs.inFlightDataLimitCond.Wait()
|
2022-08-25 03:03:34 +00:00
|
|
|
inFlightDataSize = atomic.LoadInt64(&fs.inFlightDataSize)
|
2021-03-30 09:10:50 +00:00
|
|
|
}
|
|
|
|
fs.inFlightDataLimitCond.L.Unlock()
|
2021-08-10 21:34:13 +00:00
|
|
|
atomic.AddInt64(&fs.inFlightDataSize, contentLength)
|
2021-03-30 09:10:50 +00:00
|
|
|
defer func() {
|
|
|
|
atomic.AddInt64(&fs.inFlightDataSize, -contentLength)
|
|
|
|
fs.inFlightDataLimitCond.Signal()
|
|
|
|
}()
|
|
|
|
|
2024-01-17 15:17:07 +00:00
|
|
|
if r.Method == http.MethodPut {
|
2021-03-30 09:10:50 +00:00
|
|
|
if _, ok := r.URL.Query()["tagging"]; ok {
|
|
|
|
fs.PutTaggingHandler(w, r)
|
|
|
|
} else {
|
2021-03-31 04:07:34 +00:00
|
|
|
fs.PostHandler(w, r, contentLength)
|
2021-03-30 09:10:50 +00:00
|
|
|
}
|
|
|
|
} else { // method == "POST"
|
2021-03-31 04:07:34 +00:00
|
|
|
fs.PostHandler(w, r, contentLength)
|
2020-11-09 09:00:07 +00:00
|
|
|
}
|
2024-01-17 15:17:07 +00:00
|
|
|
default:
|
|
|
|
w.WriteHeader(http.StatusMethodNotAllowed)
|
2014-03-30 18:28:04 +00:00
|
|
|
}
|
|
|
|
}
|
2017-05-28 03:14:22 +00:00
|
|
|
|
|
|
|
func (fs *FilerServer) readonlyFilerHandler(w http.ResponseWriter, r *http.Request) {
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
|
|
|
|
start := time.Now()
|
2024-01-10 18:05:27 +00:00
|
|
|
statusRecorder := stats.NewStatusResponseWriter(w)
|
|
|
|
w = statusRecorder
|
2022-09-27 18:47:52 +00:00
|
|
|
|
2023-12-21 00:21:11 +00:00
|
|
|
os.Stdout.WriteString("Request: " + r.Method + " " + r.URL.String() + "\n")
|
|
|
|
|
|
|
|
origin := r.Header.Get("Origin")
|
|
|
|
if origin != "" {
|
|
|
|
if fs.option.AllowedOrigins == nil || len(fs.option.AllowedOrigins) == 0 || fs.option.AllowedOrigins[0] == "*" {
|
|
|
|
origin = "*"
|
|
|
|
} else {
|
|
|
|
originFound := false
|
|
|
|
for _, allowedOrigin := range fs.option.AllowedOrigins {
|
|
|
|
if origin == allowedOrigin {
|
|
|
|
originFound = true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !originFound {
|
|
|
|
writeJsonError(w, r, http.StatusForbidden, errors.New("origin not allowed"))
|
|
|
|
return
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
w.Header().Set("Access-Control-Allow-Origin", origin)
|
|
|
|
w.Header().Set("Access-Control-Allow-Headers", "OPTIONS, GET, HEAD")
|
2022-09-27 18:47:52 +00:00
|
|
|
w.Header().Set("Access-Control-Allow-Credentials", "true")
|
|
|
|
}
|
|
|
|
|
2022-08-04 08:44:54 +00:00
|
|
|
defer func() {
|
2024-01-10 18:05:27 +00:00
|
|
|
stats.FilerRequestCounter.WithLabelValues(r.Method, strconv.Itoa(statusRecorder.Status)).Inc()
|
2022-08-04 08:44:54 +00:00
|
|
|
stats.FilerRequestHistogram.WithLabelValues(r.Method).Observe(time.Since(start).Seconds())
|
|
|
|
}()
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
// We handle OPTIONS first because it never should be authenticated
|
2024-01-17 15:17:07 +00:00
|
|
|
if r.Method == http.MethodOptions {
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
OptionsHandler(w, r, true)
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
if !fs.maybeCheckJwtAuthorization(r, false) {
|
|
|
|
writeJsonError(w, r, http.StatusUnauthorized, errors.New("wrong jwt"))
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2020-09-20 23:00:01 +00:00
|
|
|
w.Header().Set("Server", "SeaweedFS Filer "+util.VERSION)
|
2022-09-27 18:47:52 +00:00
|
|
|
|
2017-05-28 03:14:22 +00:00
|
|
|
switch r.Method {
|
2024-01-17 15:17:07 +00:00
|
|
|
case http.MethodGet, http.MethodHead:
|
2021-07-19 09:59:12 +00:00
|
|
|
fs.GetOrHeadHandler(w, r)
|
2024-01-17 15:17:07 +00:00
|
|
|
default:
|
|
|
|
w.WriteHeader(http.StatusMethodNotAllowed)
|
2017-05-28 03:14:22 +00:00
|
|
|
}
|
|
|
|
}
|
2020-10-31 23:44:03 +00:00
|
|
|
|
|
|
|
func OptionsHandler(w http.ResponseWriter, r *http.Request, isReadOnly bool) {
|
|
|
|
if isReadOnly {
|
2022-09-27 18:47:52 +00:00
|
|
|
w.Header().Set("Access-Control-Allow-Methods", "GET, OPTIONS")
|
2020-10-31 23:44:03 +00:00
|
|
|
} else {
|
2022-09-27 18:47:52 +00:00
|
|
|
w.Header().Set("Access-Control-Allow-Methods", "PUT, POST, GET, DELETE, OPTIONS")
|
|
|
|
w.Header().Set("Access-Control-Expose-Headers", "*")
|
2020-10-31 23:44:03 +00:00
|
|
|
}
|
2022-09-27 18:47:52 +00:00
|
|
|
w.Header().Set("Access-Control-Allow-Headers", "*")
|
|
|
|
w.Header().Set("Access-Control-Allow-Credentials", "true")
|
2020-10-31 23:45:38 +00:00
|
|
|
}
|
FEATURE: add JWT to HTTP endpoints of Filer and use them in S3 Client
- one JWT for reading and one for writing, analogous to how the JWT
between Master and Volume Server works
- I did not implement IP `whiteList` parameter on the filer
Additionally, because http_util.DownloadFile now sets the JWT,
the `download` command should now work when `jwt.signing.read` is
configured. By looking at the code, I think this case did not work
before.
## Docs to be adjusted after a release
Page `Amazon-S3-API`:
```
# Authentication with Filer
You can use mTLS for the gRPC connection between S3-API-Proxy and the filer, as
explained in [Security-Configuration](Security-Configuration) -
controlled by the `grpc.*` configuration in `security.toml`.
Starting with version XX, it is also possible to authenticate the HTTP
operations between the S3-API-Proxy and the Filer (especially
uploading new files). This is configured by setting
`filer_jwt.signing.key` and `filer_jwt.signing.read.key` in
`security.toml`.
With both configurations (gRPC and JWT), it is possible to have Filer
and S3 communicate in fully authenticated fashion; so Filer will reject
any unauthenticated communication.
```
Page `Security Overview`:
```
The following items are not covered, yet:
- master server http REST services
Starting with version XX, the Filer HTTP REST services can be secured
with a JWT, by setting `filer_jwt.signing.key` and
`filer_jwt.signing.read.key` in `security.toml`.
...
Before version XX: "weed filer -disableHttp", disable http operations, only gRPC operations are allowed. This works with "weed mount" by FUSE. It does **not work** with the [S3 Gateway](Amazon S3 API), as this does HTTP calls to the Filer.
Starting with version XX: secured by JWT, by setting `filer_jwt.signing.key` and `filer_jwt.signing.read.key` in `security.toml`. **This now works with the [S3 Gateway](Amazon S3 API).**
...
# Securing Filer HTTP with JWT
To enable JWT-based access control for the Filer,
1. generate `security.toml` file by `weed scaffold -config=security`
2. set `filer_jwt.signing.key` to a secret string - and optionally filer_jwt.signing.read.key` as well to a secret string
3. copy the same `security.toml` file to the filers and all S3 proxies.
If `filer_jwt.signing.key` is configured: When sending upload/update/delete HTTP operations to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.key`.
If `filer_jwt.signing.read.key` is configured: When sending GET or HEAD requests to a filer server, the request header `Authorization` should be the JWT string (`Authorization: Bearer [JwtToken]`). The operation is authorized after the filer validates the JWT with `filer_jwt.signing.read.key`.
The S3 API Gateway reads the above JWT keys and sends authenticated
HTTP requests to the filer.
```
Page `Security Configuration`:
```
(update scaffold file)
...
[filer_jwt.signing]
key = "blahblahblahblah"
[filer_jwt.signing.read]
key = "blahblahblahblah"
```
Resolves: #158
2021-12-29 18:47:53 +00:00
|
|
|
|
|
|
|
// maybeCheckJwtAuthorization returns true if access should be granted, false if it should be denied
|
|
|
|
func (fs *FilerServer) maybeCheckJwtAuthorization(r *http.Request, isWrite bool) bool {
|
|
|
|
|
|
|
|
var signingKey security.SigningKey
|
|
|
|
|
|
|
|
if isWrite {
|
|
|
|
if len(fs.filerGuard.SigningKey) == 0 {
|
|
|
|
return true
|
|
|
|
} else {
|
|
|
|
signingKey = fs.filerGuard.SigningKey
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if len(fs.filerGuard.ReadSigningKey) == 0 {
|
|
|
|
return true
|
|
|
|
} else {
|
|
|
|
signingKey = fs.filerGuard.ReadSigningKey
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
tokenStr := security.GetJwt(r)
|
|
|
|
if tokenStr == "" {
|
|
|
|
glog.V(1).Infof("missing jwt from %s", r.RemoteAddr)
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
token, err := security.DecodeJwt(signingKey, tokenStr, &security.SeaweedFilerClaims{})
|
|
|
|
if err != nil {
|
|
|
|
glog.V(1).Infof("jwt verification error from %s: %v", r.RemoteAddr, err)
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
if !token.Valid {
|
|
|
|
glog.V(1).Infof("jwt invalid from %s: %v", r.RemoteAddr, tokenStr)
|
|
|
|
return false
|
|
|
|
} else {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
}
|
2023-10-08 14:03:18 +00:00
|
|
|
|
|
|
|
func (fs *FilerServer) filerHealthzHandler(w http.ResponseWriter, r *http.Request) {
|
|
|
|
w.Header().Set("Server", "SeaweedFS Filer "+util.VERSION)
|
2024-01-17 15:46:37 +00:00
|
|
|
if _, err := fs.filer.Store.FindEntry(context.Background(), filer.TopicsDir); err != nil && err != filer_pb.ErrNotFound {
|
|
|
|
glog.Warningf("filerHealthzHandler FindEntry: %+v", err)
|
|
|
|
w.WriteHeader(http.StatusServiceUnavailable)
|
|
|
|
} else {
|
|
|
|
w.WriteHeader(http.StatusOK)
|
|
|
|
}
|
2023-10-08 14:03:18 +00:00
|
|
|
}
|