You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

97 lines
2.6 KiB

10 years ago
10 years ago
10 years ago
10 years ago
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
3 years ago
10 years ago
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
3 years ago
10 years ago
10 years ago
10 years ago
10 years ago
  1. package security
  2. import (
  3. "fmt"
  4. "net/http"
  5. "strings"
  6. "time"
  7. "github.com/golang-jwt/jwt"
  8. "github.com/seaweedfs/seaweedfs/weed/glog"
  9. )
  10. type EncodedJwt string
  11. type SigningKey []byte
  12. // SeaweedFileIdClaims is created by Master server(s) and consumed by Volume server(s),
  13. // restricting the access this JWT allows to only a single file.
  14. type SeaweedFileIdClaims struct {
  15. Fid string `json:"fid"`
  16. jwt.StandardClaims
  17. }
  18. // SeaweedFilerClaims is created e.g. by S3 proxy server and consumed by Filer server.
  19. // Right now, it only contains the standard claims; but this might be extended later
  20. // for more fine-grained permissions.
  21. type SeaweedFilerClaims struct {
  22. jwt.StandardClaims
  23. }
  24. func GenJwtForVolumeServer(signingKey SigningKey, expiresAfterSec int, fileId string) EncodedJwt {
  25. if len(signingKey) == 0 {
  26. return ""
  27. }
  28. claims := SeaweedFileIdClaims{
  29. fileId,
  30. jwt.StandardClaims{},
  31. }
  32. if expiresAfterSec > 0 {
  33. claims.ExpiresAt = time.Now().Add(time.Second * time.Duration(expiresAfterSec)).Unix()
  34. }
  35. t := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
  36. encoded, e := t.SignedString([]byte(signingKey))
  37. if e != nil {
  38. glog.V(0).Infof("Failed to sign claims %+v: %v", t.Claims, e)
  39. return ""
  40. }
  41. return EncodedJwt(encoded)
  42. }
  43. // GenJwtForFilerServer creates a JSON-web-token for using the authenticated Filer API. Used f.e. inside
  44. // the S3 API
  45. func GenJwtForFilerServer(signingKey SigningKey, expiresAfterSec int) EncodedJwt {
  46. if len(signingKey) == 0 {
  47. return ""
  48. }
  49. claims := SeaweedFilerClaims{
  50. jwt.StandardClaims{},
  51. }
  52. if expiresAfterSec > 0 {
  53. claims.ExpiresAt = time.Now().Add(time.Second * time.Duration(expiresAfterSec)).Unix()
  54. }
  55. t := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
  56. encoded, e := t.SignedString([]byte(signingKey))
  57. if e != nil {
  58. glog.V(0).Infof("Failed to sign claims %+v: %v", t.Claims, e)
  59. return ""
  60. }
  61. return EncodedJwt(encoded)
  62. }
  63. func GetJwt(r *http.Request) EncodedJwt {
  64. // Get token from query params
  65. tokenStr := r.URL.Query().Get("jwt")
  66. // Get token from authorization header
  67. if tokenStr == "" {
  68. bearer := r.Header.Get("Authorization")
  69. if len(bearer) > 7 && strings.ToUpper(bearer[0:6]) == "BEARER" {
  70. tokenStr = bearer[7:]
  71. }
  72. }
  73. return EncodedJwt(tokenStr)
  74. }
  75. func DecodeJwt(signingKey SigningKey, tokenString EncodedJwt, claims jwt.Claims) (token *jwt.Token, err error) {
  76. // check exp, nbf
  77. return jwt.ParseWithClaims(string(tokenString), claims, func(token *jwt.Token) (interface{}, error) {
  78. if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
  79. return nil, fmt.Errorf("unknown token method")
  80. }
  81. return []byte(signingKey), nil
  82. })
  83. }