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