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.

203 lines
6.6 KiB

6 years ago
6 years ago
4 years ago
3 years ago
4 years ago
6 years ago
6 years ago
7 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
4 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
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
5 years ago
4 years ago
4 years ago
  1. package weed_server
  2. import (
  3. "context"
  4. "fmt"
  5. "github.com/chrislusf/seaweedfs/weed/pb/filer_pb"
  6. "net/http"
  7. "os"
  8. "sync"
  9. "time"
  10. "github.com/chrislusf/seaweedfs/weed/stats"
  11. "google.golang.org/grpc"
  12. "github.com/chrislusf/seaweedfs/weed/util/grace"
  13. "github.com/chrislusf/seaweedfs/weed/operation"
  14. "github.com/chrislusf/seaweedfs/weed/pb"
  15. "github.com/chrislusf/seaweedfs/weed/pb/master_pb"
  16. "github.com/chrislusf/seaweedfs/weed/util"
  17. "github.com/chrislusf/seaweedfs/weed/filer"
  18. _ "github.com/chrislusf/seaweedfs/weed/filer/cassandra"
  19. _ "github.com/chrislusf/seaweedfs/weed/filer/elastic/v7"
  20. _ "github.com/chrislusf/seaweedfs/weed/filer/etcd"
  21. _ "github.com/chrislusf/seaweedfs/weed/filer/hbase"
  22. _ "github.com/chrislusf/seaweedfs/weed/filer/leveldb"
  23. _ "github.com/chrislusf/seaweedfs/weed/filer/leveldb2"
  24. _ "github.com/chrislusf/seaweedfs/weed/filer/leveldb3"
  25. _ "github.com/chrislusf/seaweedfs/weed/filer/mongodb"
  26. _ "github.com/chrislusf/seaweedfs/weed/filer/mysql"
  27. _ "github.com/chrislusf/seaweedfs/weed/filer/mysql2"
  28. _ "github.com/chrislusf/seaweedfs/weed/filer/postgres"
  29. _ "github.com/chrislusf/seaweedfs/weed/filer/postgres2"
  30. _ "github.com/chrislusf/seaweedfs/weed/filer/redis"
  31. _ "github.com/chrislusf/seaweedfs/weed/filer/redis2"
  32. _ "github.com/chrislusf/seaweedfs/weed/filer/redis3"
  33. _ "github.com/chrislusf/seaweedfs/weed/filer/sqlite"
  34. "github.com/chrislusf/seaweedfs/weed/glog"
  35. "github.com/chrislusf/seaweedfs/weed/notification"
  36. _ "github.com/chrislusf/seaweedfs/weed/notification/aws_sqs"
  37. _ "github.com/chrislusf/seaweedfs/weed/notification/gocdk_pub_sub"
  38. _ "github.com/chrislusf/seaweedfs/weed/notification/google_pub_sub"
  39. _ "github.com/chrislusf/seaweedfs/weed/notification/kafka"
  40. _ "github.com/chrislusf/seaweedfs/weed/notification/log"
  41. "github.com/chrislusf/seaweedfs/weed/security"
  42. )
  43. type FilerOption struct {
  44. Masters []pb.ServerAddress
  45. Collection string
  46. DefaultReplication string
  47. DisableDirListing bool
  48. MaxMB int
  49. DirListingLimit int
  50. DataCenter string
  51. Rack string
  52. DataNode string
  53. DefaultLevelDbDir string
  54. DisableHttp bool
  55. Host pb.ServerAddress
  56. recursiveDelete bool
  57. Cipher bool
  58. SaveToFilerLimit int64
  59. ConcurrentUploadLimit int64
  60. }
  61. type FilerServer struct {
  62. filer_pb.UnimplementedSeaweedFilerServer
  63. option *FilerOption
  64. secret security.SigningKey
  65. filer *filer.Filer
  66. filerGuard *security.Guard
  67. grpcDialOption grpc.DialOption
  68. // metrics read from the master
  69. metricsAddress string
  70. metricsIntervalSec int
  71. // notifying clients
  72. listenersLock sync.Mutex
  73. listenersCond *sync.Cond
  74. // track known metadata listeners
  75. knownListenersLock sync.Mutex
  76. knownListeners map[int32]struct{}
  77. brokers map[string]map[string]bool
  78. brokersLock sync.Mutex
  79. inFlightDataSize int64
  80. inFlightDataLimitCond *sync.Cond
  81. }
  82. func NewFilerServer(defaultMux, readonlyMux *http.ServeMux, option *FilerOption) (fs *FilerServer, err error) {
  83. v := util.GetViper()
  84. signingKey := v.GetString("jwt.filer_signing.key")
  85. v.SetDefault("jwt.filer_signing.expires_after_seconds", 10)
  86. expiresAfterSec := v.GetInt("jwt.filer_signing.expires_after_seconds")
  87. readSigningKey := v.GetString("jwt.filer_signing.read.key")
  88. v.SetDefault("jwt.filer_signing.read.expires_after_seconds", 60)
  89. readExpiresAfterSec := v.GetInt("jwt.filer_signing.read.expires_after_seconds")
  90. fs = &FilerServer{
  91. option: option,
  92. grpcDialOption: security.LoadClientTLS(util.GetViper(), "grpc.filer"),
  93. knownListeners: make(map[int32]struct{}),
  94. brokers: make(map[string]map[string]bool),
  95. inFlightDataLimitCond: sync.NewCond(new(sync.Mutex)),
  96. }
  97. fs.listenersCond = sync.NewCond(&fs.listenersLock)
  98. if len(option.Masters) == 0 {
  99. glog.Fatal("master list is required!")
  100. }
  101. fs.filer = filer.NewFiler(option.Masters, fs.grpcDialOption, option.Host, option.Collection, option.DefaultReplication, option.DataCenter, func() {
  102. fs.listenersCond.Broadcast()
  103. })
  104. fs.filer.Cipher = option.Cipher
  105. // we do not support IP whitelist right now
  106. fs.filerGuard = security.NewGuard([]string{}, signingKey, expiresAfterSec, readSigningKey, readExpiresAfterSec)
  107. fs.checkWithMaster()
  108. go stats.LoopPushingMetric("filer", string(fs.option.Host), fs.metricsAddress, fs.metricsIntervalSec)
  109. go fs.filer.KeepMasterClientConnected()
  110. if !util.LoadConfiguration("filer", false) {
  111. v.SetDefault("leveldb2.enabled", true)
  112. v.SetDefault("leveldb2.dir", option.DefaultLevelDbDir)
  113. _, err := os.Stat(option.DefaultLevelDbDir)
  114. if os.IsNotExist(err) {
  115. os.MkdirAll(option.DefaultLevelDbDir, 0755)
  116. }
  117. glog.V(0).Infof("default to create filer store dir in %s", option.DefaultLevelDbDir)
  118. } else {
  119. glog.Warningf("skipping default store dir in %s", option.DefaultLevelDbDir)
  120. }
  121. util.LoadConfiguration("notification", false)
  122. fs.option.recursiveDelete = v.GetBool("filer.options.recursive_delete")
  123. v.SetDefault("filer.options.buckets_folder", "/buckets")
  124. fs.filer.DirBucketsPath = v.GetString("filer.options.buckets_folder")
  125. // TODO deprecated, will be be removed after 2020-12-31
  126. // replaced by https://github.com/chrislusf/seaweedfs/wiki/Path-Specific-Configuration
  127. // fs.filer.FsyncBuckets = v.GetStringSlice("filer.options.buckets_fsync")
  128. fs.filer.LoadConfiguration(v)
  129. notification.LoadConfiguration(v, "notification.")
  130. handleStaticResources(defaultMux)
  131. if !option.DisableHttp {
  132. defaultMux.HandleFunc("/", fs.filerHandler)
  133. }
  134. if defaultMux != readonlyMux {
  135. handleStaticResources(readonlyMux)
  136. readonlyMux.HandleFunc("/", fs.readonlyFilerHandler)
  137. }
  138. fs.filer.AggregateFromPeers(option.Host)
  139. fs.filer.LoadBuckets()
  140. fs.filer.LoadFilerConf()
  141. fs.filer.LoadRemoteStorageConfAndMapping()
  142. grace.OnInterrupt(func() {
  143. fs.filer.Shutdown()
  144. })
  145. return fs, nil
  146. }
  147. func (fs *FilerServer) checkWithMaster() {
  148. isConnected := false
  149. for !isConnected {
  150. for _, master := range fs.option.Masters {
  151. readErr := operation.WithMasterServerClient(false, master, fs.grpcDialOption, func(masterClient master_pb.SeaweedClient) error {
  152. resp, err := masterClient.GetMasterConfiguration(context.Background(), &master_pb.GetMasterConfigurationRequest{})
  153. if err != nil {
  154. return fmt.Errorf("get master %s configuration: %v", master, err)
  155. }
  156. fs.metricsAddress, fs.metricsIntervalSec = resp.MetricsAddress, int(resp.MetricsIntervalSeconds)
  157. if fs.option.DefaultReplication == "" {
  158. fs.option.DefaultReplication = resp.DefaultReplication
  159. }
  160. return nil
  161. })
  162. if readErr == nil {
  163. isConnected = true
  164. } else {
  165. time.Sleep(7 * time.Second)
  166. }
  167. }
  168. }
  169. }