daemon.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830
  1. package main
  2. import (
  3. "context"
  4. "crypto/tls"
  5. "fmt"
  6. "net"
  7. "os"
  8. "path/filepath"
  9. "runtime"
  10. "sort"
  11. "strings"
  12. "time"
  13. containerddefaults "github.com/containerd/containerd/defaults"
  14. "github.com/docker/docker/api"
  15. apiserver "github.com/docker/docker/api/server"
  16. buildbackend "github.com/docker/docker/api/server/backend/build"
  17. "github.com/docker/docker/api/server/middleware"
  18. "github.com/docker/docker/api/server/router"
  19. "github.com/docker/docker/api/server/router/build"
  20. checkpointrouter "github.com/docker/docker/api/server/router/checkpoint"
  21. "github.com/docker/docker/api/server/router/container"
  22. distributionrouter "github.com/docker/docker/api/server/router/distribution"
  23. grpcrouter "github.com/docker/docker/api/server/router/grpc"
  24. "github.com/docker/docker/api/server/router/image"
  25. "github.com/docker/docker/api/server/router/network"
  26. pluginrouter "github.com/docker/docker/api/server/router/plugin"
  27. sessionrouter "github.com/docker/docker/api/server/router/session"
  28. swarmrouter "github.com/docker/docker/api/server/router/swarm"
  29. systemrouter "github.com/docker/docker/api/server/router/system"
  30. "github.com/docker/docker/api/server/router/volume"
  31. buildkit "github.com/docker/docker/builder/builder-next"
  32. "github.com/docker/docker/builder/dockerfile"
  33. "github.com/docker/docker/cli/debug"
  34. "github.com/docker/docker/cmd/dockerd/trap"
  35. "github.com/docker/docker/daemon"
  36. "github.com/docker/docker/daemon/cluster"
  37. "github.com/docker/docker/daemon/config"
  38. "github.com/docker/docker/daemon/listeners"
  39. "github.com/docker/docker/dockerversion"
  40. "github.com/docker/docker/libcontainerd/supervisor"
  41. dopts "github.com/docker/docker/opts"
  42. "github.com/docker/docker/pkg/authorization"
  43. "github.com/docker/docker/pkg/homedir"
  44. "github.com/docker/docker/pkg/jsonmessage"
  45. "github.com/docker/docker/pkg/pidfile"
  46. "github.com/docker/docker/pkg/plugingetter"
  47. "github.com/docker/docker/pkg/sysinfo"
  48. "github.com/docker/docker/pkg/system"
  49. "github.com/docker/docker/plugin"
  50. "github.com/docker/docker/rootless"
  51. "github.com/docker/docker/runconfig"
  52. "github.com/docker/go-connections/tlsconfig"
  53. swarmapi "github.com/docker/swarmkit/api"
  54. "github.com/moby/buildkit/session"
  55. "github.com/pkg/errors"
  56. "github.com/sirupsen/logrus"
  57. "github.com/spf13/pflag"
  58. )
  59. // DaemonCli represents the daemon CLI.
  60. type DaemonCli struct {
  61. *config.Config
  62. configFile *string
  63. flags *pflag.FlagSet
  64. api *apiserver.Server
  65. d *daemon.Daemon
  66. authzMiddleware *authorization.Middleware // authzMiddleware enables to dynamically reload the authorization plugins
  67. }
  68. // NewDaemonCli returns a daemon CLI
  69. func NewDaemonCli() *DaemonCli {
  70. return &DaemonCli{}
  71. }
  72. func (cli *DaemonCli) start(opts *daemonOptions) (err error) {
  73. opts.setDefaultOptions()
  74. if cli.Config, err = loadDaemonCliConfig(opts); err != nil {
  75. return err
  76. }
  77. if err := checkDeprecatedOptions(cli.Config); err != nil {
  78. return err
  79. }
  80. if opts.Validate {
  81. // If config wasn't OK we wouldn't have made it this far.
  82. fmt.Fprintln(os.Stderr, "configuration OK")
  83. return nil
  84. }
  85. configureProxyEnv(cli.Config)
  86. configureDaemonLogs(cli.Config)
  87. logrus.Info("Starting up")
  88. cli.configFile = &opts.configFile
  89. cli.flags = opts.flags
  90. if cli.Config.Debug {
  91. debug.Enable()
  92. }
  93. if cli.Config.Experimental {
  94. logrus.Warn("Running experimental build")
  95. }
  96. if cli.Config.IsRootless() {
  97. logrus.Warn("Running in rootless mode. This mode has feature limitations.")
  98. }
  99. if rootless.RunningWithRootlessKit() {
  100. logrus.Info("Running with RootlessKit integration")
  101. if !cli.Config.IsRootless() {
  102. return fmt.Errorf("rootless mode needs to be enabled for running with RootlessKit")
  103. }
  104. }
  105. // return human-friendly error before creating files
  106. if runtime.GOOS == "linux" && os.Geteuid() != 0 {
  107. return fmt.Errorf("dockerd needs to be started with root privileges. To run dockerd in rootless mode as an unprivileged user, see https://docs.docker.com/go/rootless/")
  108. }
  109. if err := setDefaultUmask(); err != nil {
  110. return err
  111. }
  112. // Create the daemon root before we create ANY other files (PID, or migrate keys)
  113. // to ensure the appropriate ACL is set (particularly relevant on Windows)
  114. if err := daemon.CreateDaemonRoot(cli.Config); err != nil {
  115. return err
  116. }
  117. if err := system.MkdirAll(cli.Config.ExecRoot, 0700); err != nil {
  118. return err
  119. }
  120. potentiallyUnderRuntimeDir := []string{cli.Config.ExecRoot}
  121. if cli.Pidfile != "" {
  122. pf, err := pidfile.New(cli.Pidfile)
  123. if err != nil {
  124. return errors.Wrap(err, "failed to start daemon")
  125. }
  126. potentiallyUnderRuntimeDir = append(potentiallyUnderRuntimeDir, cli.Pidfile)
  127. defer func() {
  128. if err := pf.Remove(); err != nil {
  129. logrus.Error(err)
  130. }
  131. }()
  132. }
  133. if cli.Config.IsRootless() {
  134. // Set sticky bit if XDG_RUNTIME_DIR is set && the file is actually under XDG_RUNTIME_DIR
  135. if _, err := homedir.StickRuntimeDirContents(potentiallyUnderRuntimeDir); err != nil {
  136. // StickRuntimeDirContents returns nil error if XDG_RUNTIME_DIR is just unset
  137. logrus.WithError(err).Warn("cannot set sticky bit on files under XDG_RUNTIME_DIR")
  138. }
  139. }
  140. serverConfig, err := newAPIServerConfig(cli)
  141. if err != nil {
  142. return errors.Wrap(err, "failed to create API server")
  143. }
  144. cli.api = apiserver.New(serverConfig)
  145. hosts, err := loadListeners(cli, serverConfig)
  146. if err != nil {
  147. return errors.Wrap(err, "failed to load listeners")
  148. }
  149. ctx, cancel := context.WithCancel(context.Background())
  150. waitForContainerDShutdown, err := cli.initContainerD(ctx)
  151. if waitForContainerDShutdown != nil {
  152. defer waitForContainerDShutdown(10 * time.Second)
  153. }
  154. if err != nil {
  155. cancel()
  156. return err
  157. }
  158. defer cancel()
  159. stopc := make(chan bool)
  160. defer close(stopc)
  161. trap.Trap(func() {
  162. cli.stop()
  163. <-stopc // wait for daemonCli.start() to return
  164. }, logrus.StandardLogger())
  165. // Notify that the API is active, but before daemon is set up.
  166. preNotifyReady()
  167. pluginStore := plugin.NewStore()
  168. if err := cli.initMiddlewares(cli.api, serverConfig, pluginStore); err != nil {
  169. logrus.Fatalf("Error creating middlewares: %v", err)
  170. }
  171. d, err := daemon.NewDaemon(ctx, cli.Config, pluginStore)
  172. if err != nil {
  173. return errors.Wrap(err, "failed to start daemon")
  174. }
  175. d.StoreHosts(hosts)
  176. // validate after NewDaemon has restored enabled plugins. Don't change order.
  177. if err := validateAuthzPlugins(cli.Config.AuthorizationPlugins, pluginStore); err != nil {
  178. return errors.Wrap(err, "failed to validate authorization plugin")
  179. }
  180. cli.d = d
  181. if err := startMetricsServer(cli.Config.MetricsAddress); err != nil {
  182. return errors.Wrap(err, "failed to start metrics server")
  183. }
  184. c, err := createAndStartCluster(cli, d)
  185. if err != nil {
  186. logrus.Fatalf("Error starting cluster component: %v", err)
  187. }
  188. // Restart all autostart containers which has a swarm endpoint
  189. // and is not yet running now that we have successfully
  190. // initialized the cluster.
  191. d.RestartSwarmContainers()
  192. logrus.Info("Daemon has completed initialization")
  193. routerOptions, err := newRouterOptions(cli.Config, d)
  194. if err != nil {
  195. return err
  196. }
  197. routerOptions.api = cli.api
  198. routerOptions.cluster = c
  199. initRouter(routerOptions)
  200. go d.ProcessClusterNotifications(ctx, c.GetWatchStream())
  201. cli.setupConfigReloadTrap()
  202. // The serve API routine never exits unless an error occurs
  203. // We need to start it as a goroutine and wait on it so
  204. // daemon doesn't exit
  205. serveAPIWait := make(chan error)
  206. go cli.api.Wait(serveAPIWait)
  207. // after the daemon is done setting up we can notify systemd api
  208. notifyReady()
  209. // Daemon is fully initialized and handling API traffic
  210. // Wait for serve API to complete
  211. errAPI := <-serveAPIWait
  212. c.Cleanup()
  213. // notify systemd that we're shutting down
  214. notifyStopping()
  215. shutdownDaemon(d)
  216. // Stop notification processing and any background processes
  217. cancel()
  218. if errAPI != nil {
  219. return errors.Wrap(errAPI, "shutting down due to ServeAPI error")
  220. }
  221. logrus.Info("Daemon shutdown complete")
  222. return nil
  223. }
  224. type routerOptions struct {
  225. sessionManager *session.Manager
  226. buildBackend *buildbackend.Backend
  227. features *map[string]bool
  228. buildkit *buildkit.Builder
  229. daemon *daemon.Daemon
  230. api *apiserver.Server
  231. cluster *cluster.Cluster
  232. }
  233. func newRouterOptions(config *config.Config, d *daemon.Daemon) (routerOptions, error) {
  234. opts := routerOptions{}
  235. sm, err := session.NewManager()
  236. if err != nil {
  237. return opts, errors.Wrap(err, "failed to create sessionmanager")
  238. }
  239. manager, err := dockerfile.NewBuildManager(d.BuilderBackend(), d.IdentityMapping())
  240. if err != nil {
  241. return opts, err
  242. }
  243. cgroupParent := newCgroupParent(config)
  244. bk, err := buildkit.New(buildkit.Opt{
  245. SessionManager: sm,
  246. Root: filepath.Join(config.Root, "buildkit"),
  247. Dist: d.DistributionServices(),
  248. NetworkController: d.NetworkController(),
  249. DefaultCgroupParent: cgroupParent,
  250. RegistryHosts: d.RegistryHosts(),
  251. BuilderConfig: config.Builder,
  252. Rootless: d.Rootless(),
  253. IdentityMapping: d.IdentityMapping(),
  254. DNSConfig: config.DNSConfig,
  255. ApparmorProfile: daemon.DefaultApparmorProfile(),
  256. })
  257. if err != nil {
  258. return opts, err
  259. }
  260. bb, err := buildbackend.NewBackend(d.ImageService(), manager, bk, d.EventsService)
  261. if err != nil {
  262. return opts, errors.Wrap(err, "failed to create buildmanager")
  263. }
  264. return routerOptions{
  265. sessionManager: sm,
  266. buildBackend: bb,
  267. buildkit: bk,
  268. features: d.Features(),
  269. daemon: d,
  270. }, nil
  271. }
  272. func (cli *DaemonCli) reloadConfig() {
  273. reload := func(c *config.Config) {
  274. // Revalidate and reload the authorization plugins
  275. if err := validateAuthzPlugins(c.AuthorizationPlugins, cli.d.PluginStore); err != nil {
  276. logrus.Fatalf("Error validating authorization plugin: %v", err)
  277. return
  278. }
  279. cli.authzMiddleware.SetPlugins(c.AuthorizationPlugins)
  280. if err := cli.d.Reload(c); err != nil {
  281. logrus.Errorf("Error reconfiguring the daemon: %v", err)
  282. return
  283. }
  284. if c.IsValueSet("debug") {
  285. debugEnabled := debug.IsEnabled()
  286. switch {
  287. case debugEnabled && !c.Debug: // disable debug
  288. debug.Disable()
  289. case c.Debug && !debugEnabled: // enable debug
  290. debug.Enable()
  291. }
  292. }
  293. }
  294. if err := config.Reload(*cli.configFile, cli.flags, reload); err != nil {
  295. logrus.Error(err)
  296. }
  297. }
  298. func (cli *DaemonCli) stop() {
  299. cli.api.Close()
  300. }
  301. // shutdownDaemon just wraps daemon.Shutdown() to handle a timeout in case
  302. // d.Shutdown() is waiting too long to kill container or worst it's
  303. // blocked there
  304. func shutdownDaemon(d *daemon.Daemon) {
  305. shutdownTimeout := d.ShutdownTimeout()
  306. ch := make(chan struct{})
  307. go func() {
  308. d.Shutdown()
  309. close(ch)
  310. }()
  311. if shutdownTimeout < 0 {
  312. <-ch
  313. logrus.Debug("Clean shutdown succeeded")
  314. return
  315. }
  316. timeout := time.NewTimer(time.Duration(shutdownTimeout) * time.Second)
  317. defer timeout.Stop()
  318. select {
  319. case <-ch:
  320. logrus.Debug("Clean shutdown succeeded")
  321. case <-timeout.C:
  322. logrus.Error("Force shutdown daemon")
  323. }
  324. }
  325. func loadDaemonCliConfig(opts *daemonOptions) (*config.Config, error) {
  326. conf := opts.daemonConfig
  327. flags := opts.flags
  328. conf.Debug = opts.Debug
  329. conf.Hosts = opts.Hosts
  330. conf.LogLevel = opts.LogLevel
  331. if flags.Changed("graph") && flags.Changed("data-root") {
  332. return nil, errors.New(`cannot specify both "--graph" and "--data-root" option`)
  333. }
  334. if flags.Changed(FlagTLS) {
  335. conf.TLS = &opts.TLS
  336. }
  337. if flags.Changed(FlagTLSVerify) {
  338. conf.TLSVerify = &opts.TLSVerify
  339. v := true
  340. conf.TLS = &v
  341. }
  342. if opts.TLSOptions != nil {
  343. conf.CommonTLSOptions = config.CommonTLSOptions{
  344. CAFile: opts.TLSOptions.CAFile,
  345. CertFile: opts.TLSOptions.CertFile,
  346. KeyFile: opts.TLSOptions.KeyFile,
  347. }
  348. } else {
  349. conf.CommonTLSOptions = config.CommonTLSOptions{}
  350. }
  351. if conf.TrustKeyPath == "" {
  352. daemonConfDir, err := getDaemonConfDir(conf.Root)
  353. if err != nil {
  354. return nil, err
  355. }
  356. conf.TrustKeyPath = filepath.Join(daemonConfDir, defaultTrustKeyFile)
  357. }
  358. if opts.configFile != "" {
  359. c, err := config.MergeDaemonConfigurations(conf, flags, opts.configFile)
  360. if err != nil {
  361. if flags.Changed("config-file") || !os.IsNotExist(err) {
  362. return nil, errors.Wrapf(err, "unable to configure the Docker daemon with file %s", opts.configFile)
  363. }
  364. }
  365. // the merged configuration can be nil if the config file didn't exist.
  366. // leave the current configuration as it is if when that happens.
  367. if c != nil {
  368. conf = c
  369. }
  370. }
  371. if err := normalizeHosts(conf); err != nil {
  372. return nil, err
  373. }
  374. if err := config.Validate(conf); err != nil {
  375. return nil, err
  376. }
  377. if flags.Changed("graph") {
  378. logrus.Warnf(`The "-g / --graph" flag is deprecated. Please use "--data-root" instead`)
  379. }
  380. // Check if duplicate label-keys with different values are found
  381. newLabels, err := config.GetConflictFreeLabels(conf.Labels)
  382. if err != nil {
  383. return nil, err
  384. }
  385. conf.Labels = newLabels
  386. // Regardless of whether the user sets it to true or false, if they
  387. // specify TLSVerify at all then we need to turn on TLS
  388. if conf.IsValueSet(FlagTLSVerify) {
  389. v := true
  390. conf.TLS = &v
  391. }
  392. if conf.TLSVerify == nil && conf.TLS != nil {
  393. conf.TLSVerify = conf.TLS
  394. }
  395. err = validateCPURealtimeOptions(conf)
  396. if err != nil {
  397. return nil, err
  398. }
  399. return conf, nil
  400. }
  401. // normalizeHosts normalizes the configured config.Hosts and remove duplicates.
  402. // It returns an error if it fails to parse a host.
  403. func normalizeHosts(config *config.Config) error {
  404. if len(config.Hosts) == 0 {
  405. // if no hosts are configured, create a single entry slice, so that the
  406. // default is used.
  407. //
  408. // TODO(thaJeztah) implement a cleaner way for this; this depends on a
  409. // side-effect of how we parse empty/partial hosts.
  410. config.Hosts = make([]string, 1)
  411. }
  412. hosts := make([]string, 0, len(config.Hosts))
  413. seen := make(map[string]struct{}, len(config.Hosts))
  414. useTLS := DefaultTLSValue
  415. if config.TLS != nil {
  416. useTLS = *config.TLS
  417. }
  418. for _, h := range config.Hosts {
  419. host, err := dopts.ParseHost(useTLS, honorXDG, h)
  420. if err != nil {
  421. return err
  422. }
  423. if _, ok := seen[host]; ok {
  424. continue
  425. }
  426. seen[host] = struct{}{}
  427. hosts = append(hosts, host)
  428. }
  429. sort.Strings(hosts)
  430. config.Hosts = hosts
  431. return nil
  432. }
  433. func checkDeprecatedOptions(config *config.Config) error {
  434. // Overlay networks with external k/v stores have been deprecated
  435. if config.ClusterAdvertise != "" || len(config.ClusterOpts) > 0 || config.ClusterStore != "" {
  436. return errors.New("Host-discovery and overlay networks with external k/v stores are deprecated. The 'cluster-advertise', 'cluster-store', and 'cluster-store-opt' options have been removed")
  437. }
  438. return nil
  439. }
  440. func initRouter(opts routerOptions) {
  441. decoder := runconfig.ContainerDecoder{
  442. GetSysInfo: func() *sysinfo.SysInfo {
  443. return opts.daemon.RawSysInfo()
  444. },
  445. }
  446. routers := []router.Router{
  447. // we need to add the checkpoint router before the container router or the DELETE gets masked
  448. checkpointrouter.NewRouter(opts.daemon, decoder),
  449. container.NewRouter(opts.daemon, decoder, opts.daemon.RawSysInfo().CgroupUnified),
  450. image.NewRouter(opts.daemon.ImageService()),
  451. systemrouter.NewRouter(opts.daemon, opts.cluster, opts.buildkit, opts.features),
  452. volume.NewRouter(opts.daemon.VolumesService()),
  453. build.NewRouter(opts.buildBackend, opts.daemon, opts.features),
  454. sessionrouter.NewRouter(opts.sessionManager),
  455. swarmrouter.NewRouter(opts.cluster),
  456. pluginrouter.NewRouter(opts.daemon.PluginManager()),
  457. distributionrouter.NewRouter(opts.daemon.ImageService()),
  458. }
  459. grpcBackends := []grpcrouter.Backend{}
  460. for _, b := range []interface{}{opts.daemon, opts.buildBackend} {
  461. if b, ok := b.(grpcrouter.Backend); ok {
  462. grpcBackends = append(grpcBackends, b)
  463. }
  464. }
  465. if len(grpcBackends) > 0 {
  466. routers = append(routers, grpcrouter.NewRouter(grpcBackends...))
  467. }
  468. if opts.daemon.NetworkControllerEnabled() {
  469. routers = append(routers, network.NewRouter(opts.daemon, opts.cluster))
  470. }
  471. if opts.daemon.HasExperimental() {
  472. for _, r := range routers {
  473. for _, route := range r.Routes() {
  474. if experimental, ok := route.(router.ExperimentalRoute); ok {
  475. experimental.Enable()
  476. }
  477. }
  478. }
  479. }
  480. opts.api.InitRouter(routers...)
  481. }
  482. // TODO: remove this from cli and return the authzMiddleware
  483. func (cli *DaemonCli) initMiddlewares(s *apiserver.Server, cfg *apiserver.Config, pluginStore plugingetter.PluginGetter) error {
  484. v := cfg.Version
  485. exp := middleware.NewExperimentalMiddleware(cli.Config.Experimental)
  486. s.UseMiddleware(exp)
  487. vm := middleware.NewVersionMiddleware(v, api.DefaultVersion, api.MinVersion)
  488. s.UseMiddleware(vm)
  489. if cfg.CorsHeaders != "" {
  490. c := middleware.NewCORSMiddleware(cfg.CorsHeaders)
  491. s.UseMiddleware(c)
  492. }
  493. cli.authzMiddleware = authorization.NewMiddleware(cli.Config.AuthorizationPlugins, pluginStore)
  494. cli.Config.AuthzMiddleware = cli.authzMiddleware
  495. s.UseMiddleware(cli.authzMiddleware)
  496. return nil
  497. }
  498. func (cli *DaemonCli) getContainerdDaemonOpts() ([]supervisor.DaemonOpt, error) {
  499. opts, err := cli.getPlatformContainerdDaemonOpts()
  500. if err != nil {
  501. return nil, err
  502. }
  503. if cli.Config.Debug {
  504. opts = append(opts, supervisor.WithLogLevel("debug"))
  505. } else if cli.Config.LogLevel != "" {
  506. opts = append(opts, supervisor.WithLogLevel(cli.Config.LogLevel))
  507. }
  508. if !cli.Config.CriContainerd {
  509. opts = append(opts, supervisor.WithPlugin("cri", nil))
  510. }
  511. return opts, nil
  512. }
  513. func newAPIServerConfig(cli *DaemonCli) (*apiserver.Config, error) {
  514. serverConfig := &apiserver.Config{
  515. SocketGroup: cli.Config.SocketGroup,
  516. Version: dockerversion.Version,
  517. CorsHeaders: cli.Config.CorsHeaders,
  518. }
  519. if cli.Config.TLS != nil && *cli.Config.TLS {
  520. tlsOptions := tlsconfig.Options{
  521. CAFile: cli.Config.CommonTLSOptions.CAFile,
  522. CertFile: cli.Config.CommonTLSOptions.CertFile,
  523. KeyFile: cli.Config.CommonTLSOptions.KeyFile,
  524. ExclusiveRootPools: true,
  525. }
  526. if cli.Config.TLSVerify == nil || *cli.Config.TLSVerify {
  527. // server requires and verifies client's certificate
  528. tlsOptions.ClientAuth = tls.RequireAndVerifyClientCert
  529. }
  530. tlsConfig, err := tlsconfig.Server(tlsOptions)
  531. if err != nil {
  532. return nil, err
  533. }
  534. serverConfig.TLSConfig = tlsConfig
  535. }
  536. return serverConfig, nil
  537. }
  538. // checkTLSAuthOK checks basically for an explicitly disabled TLS/TLSVerify
  539. // Going forward we do not want to support a scenario where dockerd listens
  540. // on TCP without either TLS client auth (or an explicit opt-in to disable it)
  541. func checkTLSAuthOK(c *config.Config) bool {
  542. if c.TLS == nil {
  543. // Either TLS is enabled by default, in which case TLS verification should be enabled by default, or explicitly disabled
  544. // Or TLS is disabled by default... in any of these cases, we can just take the default value as to how to proceed
  545. return DefaultTLSValue
  546. }
  547. if !*c.TLS {
  548. // TLS is explicitly disabled, which is supported
  549. return true
  550. }
  551. if c.TLSVerify == nil {
  552. // this actually shouldn't happen since we set TLSVerify on the config object anyway
  553. // But in case it does get here, be cautious and assume this is not supported.
  554. return false
  555. }
  556. // Either TLSVerify is explicitly enabled or disabled, both cases are supported
  557. return true
  558. }
  559. func loadListeners(cli *DaemonCli, serverConfig *apiserver.Config) ([]string, error) {
  560. if len(cli.Config.Hosts) == 0 {
  561. return nil, errors.New("no hosts configured")
  562. }
  563. var hosts []string
  564. for i := 0; i < len(cli.Config.Hosts); i++ {
  565. protoAddr := cli.Config.Hosts[i]
  566. protoAddrParts := strings.SplitN(cli.Config.Hosts[i], "://", 2)
  567. if len(protoAddrParts) != 2 {
  568. return nil, fmt.Errorf("bad format %s, expected PROTO://ADDR", protoAddr)
  569. }
  570. proto, addr := protoAddrParts[0], protoAddrParts[1]
  571. // It's a bad idea to bind to TCP without tlsverify.
  572. authEnabled := serverConfig.TLSConfig != nil && serverConfig.TLSConfig.ClientAuth == tls.RequireAndVerifyClientCert
  573. if proto == "tcp" && !authEnabled {
  574. logrus.WithField("host", protoAddr).Warn("Binding to IP address without --tlsverify is insecure and gives root access on this machine to everyone who has access to your network.")
  575. logrus.WithField("host", protoAddr).Warn("Binding to an IP address, even on localhost, can also give access to scripts run in a browser. Be safe out there!")
  576. time.Sleep(time.Second)
  577. // If TLSVerify is explicitly set to false we'll take that as "Please let me shoot myself in the foot"
  578. // We do not want to continue to support a default mode where tls verification is disabled, so we do some extra warnings here and eventually remove support
  579. if !checkTLSAuthOK(cli.Config) {
  580. ipAddr, _, err := net.SplitHostPort(addr)
  581. if err != nil {
  582. return nil, errors.Wrap(err, "error parsing tcp address")
  583. }
  584. // shortcut all this extra stuff for literal "localhost"
  585. // -H supports specifying hostnames, since we want to bypass this on loopback interfaces we'll look it up here.
  586. if ipAddr != "localhost" {
  587. ip := net.ParseIP(ipAddr)
  588. if ip == nil {
  589. ipA, err := net.ResolveIPAddr("ip", ipAddr)
  590. if err != nil {
  591. logrus.WithError(err).WithField("host", ipAddr).Error("Error looking up specified host address")
  592. }
  593. if ipA != nil {
  594. ip = ipA.IP
  595. }
  596. }
  597. if ip == nil || !ip.IsLoopback() {
  598. logrus.WithField("host", protoAddr).Warn("Binding to an IP address without --tlsverify is deprecated. Startup is intentionally being slowed down to show this message")
  599. logrus.WithField("host", protoAddr).Warn("Please consider generating tls certificates with client validation to prevent exposing unauthenticated root access to your network")
  600. logrus.WithField("host", protoAddr).Warnf("You can override this by explicitly specifying '--%s=false' or '--%s=false'", FlagTLS, FlagTLSVerify)
  601. logrus.WithField("host", protoAddr).Warnf("Support for listening on TCP without authentication or explicit intent to run without authentication will be removed in the next release")
  602. time.Sleep(15 * time.Second)
  603. }
  604. }
  605. }
  606. }
  607. ls, err := listeners.Init(proto, addr, serverConfig.SocketGroup, serverConfig.TLSConfig)
  608. if err != nil {
  609. return nil, err
  610. }
  611. // If we're binding to a TCP port, make sure that a container doesn't try to use it.
  612. if proto == "tcp" {
  613. if err := allocateDaemonPort(addr); err != nil {
  614. return nil, err
  615. }
  616. }
  617. logrus.Debugf("Listener created for HTTP on %s (%s)", proto, addr)
  618. hosts = append(hosts, protoAddrParts[1])
  619. cli.api.Accept(addr, ls...)
  620. }
  621. return hosts, nil
  622. }
  623. func createAndStartCluster(cli *DaemonCli, d *daemon.Daemon) (*cluster.Cluster, error) {
  624. name, _ := os.Hostname()
  625. // Use a buffered channel to pass changes from store watch API to daemon
  626. // A buffer allows store watch API and daemon processing to not wait for each other
  627. watchStream := make(chan *swarmapi.WatchMessage, 32)
  628. c, err := cluster.New(cluster.Config{
  629. Root: cli.Config.Root,
  630. Name: name,
  631. Backend: d,
  632. VolumeBackend: d.VolumesService(),
  633. ImageBackend: d.ImageService(),
  634. PluginBackend: d.PluginManager(),
  635. NetworkSubnetsProvider: d,
  636. DefaultAdvertiseAddr: cli.Config.SwarmDefaultAdvertiseAddr,
  637. RaftHeartbeatTick: cli.Config.SwarmRaftHeartbeatTick,
  638. RaftElectionTick: cli.Config.SwarmRaftElectionTick,
  639. RuntimeRoot: cli.getSwarmRunRoot(),
  640. WatchStream: watchStream,
  641. })
  642. if err != nil {
  643. return nil, err
  644. }
  645. d.SetCluster(c)
  646. err = c.Start()
  647. return c, err
  648. }
  649. // validates that the plugins requested with the --authorization-plugin flag are valid AuthzDriver
  650. // plugins present on the host and available to the daemon
  651. func validateAuthzPlugins(requestedPlugins []string, pg plugingetter.PluginGetter) error {
  652. for _, reqPlugin := range requestedPlugins {
  653. if _, err := pg.Get(reqPlugin, authorization.AuthZApiImplements, plugingetter.Lookup); err != nil {
  654. return err
  655. }
  656. }
  657. return nil
  658. }
  659. func systemContainerdRunning(honorXDG bool) (string, bool, error) {
  660. addr := containerddefaults.DefaultAddress
  661. if honorXDG {
  662. runtimeDir, err := homedir.GetRuntimeDir()
  663. if err != nil {
  664. return "", false, err
  665. }
  666. addr = filepath.Join(runtimeDir, "containerd", "containerd.sock")
  667. }
  668. _, err := os.Lstat(addr)
  669. return addr, err == nil, nil
  670. }
  671. // configureDaemonLogs sets the logrus logging level and formatting. It expects
  672. // the passed configuration to already be validated, and ignores invalid options.
  673. func configureDaemonLogs(conf *config.Config) {
  674. if conf.LogLevel != "" {
  675. lvl, err := logrus.ParseLevel(conf.LogLevel)
  676. if err == nil {
  677. logrus.SetLevel(lvl)
  678. }
  679. } else {
  680. logrus.SetLevel(logrus.InfoLevel)
  681. }
  682. logrus.SetFormatter(&logrus.TextFormatter{
  683. TimestampFormat: jsonmessage.RFC3339NanoFixed,
  684. DisableColors: conf.RawLogs,
  685. FullTimestamp: true,
  686. })
  687. }
  688. func configureProxyEnv(conf *config.Config) {
  689. if p := conf.HTTPProxy; p != "" {
  690. overrideProxyEnv("HTTP_PROXY", p)
  691. overrideProxyEnv("http_proxy", p)
  692. }
  693. if p := conf.HTTPSProxy; p != "" {
  694. overrideProxyEnv("HTTPS_PROXY", p)
  695. overrideProxyEnv("https_proxy", p)
  696. }
  697. if p := conf.NoProxy; p != "" {
  698. overrideProxyEnv("NO_PROXY", p)
  699. overrideProxyEnv("no_proxy", p)
  700. }
  701. }
  702. func overrideProxyEnv(name, val string) {
  703. if oldVal := os.Getenv(name); oldVal != "" && oldVal != val {
  704. logrus.WithFields(logrus.Fields{
  705. "name": name,
  706. "old-value": config.MaskCredentials(oldVal),
  707. "new-value": config.MaskCredentials(val),
  708. }).Warn("overriding existing proxy variable with value from configuration")
  709. }
  710. _ = os.Setenv(name, val)
  711. }