daemon.go 25 KB

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