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.

204 lines
6.7 KiB

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