api.go 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149
  1. package docker
  2. import (
  3. "bufio"
  4. "bytes"
  5. "code.google.com/p/go.net/websocket"
  6. "encoding/base64"
  7. "encoding/json"
  8. "expvar"
  9. "fmt"
  10. "github.com/dotcloud/docker/auth"
  11. "github.com/dotcloud/docker/engine"
  12. "github.com/dotcloud/docker/pkg/systemd"
  13. "github.com/dotcloud/docker/utils"
  14. "github.com/gorilla/mux"
  15. "io"
  16. "io/ioutil"
  17. "log"
  18. "mime"
  19. "net"
  20. "net/http"
  21. "net/http/pprof"
  22. "os"
  23. "regexp"
  24. "strconv"
  25. "strings"
  26. "syscall"
  27. )
  28. const (
  29. APIVERSION = 1.9
  30. DEFAULTHTTPHOST = "127.0.0.1"
  31. DEFAULTHTTPPORT = 4243
  32. DEFAULTUNIXSOCKET = "/var/run/docker.sock"
  33. )
  34. type HttpApiFunc func(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error
  35. func hijackServer(w http.ResponseWriter) (io.ReadCloser, io.Writer, error) {
  36. conn, _, err := w.(http.Hijacker).Hijack()
  37. if err != nil {
  38. return nil, nil, err
  39. }
  40. // Flush the options to make sure the client sets the raw mode
  41. conn.Write([]byte{})
  42. return conn, conn, nil
  43. }
  44. //If we don't do this, POST method without Content-type (even with empty body) will fail
  45. func parseForm(r *http.Request) error {
  46. if r == nil {
  47. return nil
  48. }
  49. if err := r.ParseForm(); err != nil && !strings.HasPrefix(err.Error(), "mime:") {
  50. return err
  51. }
  52. return nil
  53. }
  54. func parseMultipartForm(r *http.Request) error {
  55. if err := r.ParseMultipartForm(4096); err != nil && !strings.HasPrefix(err.Error(), "mime:") {
  56. return err
  57. }
  58. return nil
  59. }
  60. func httpError(w http.ResponseWriter, err error) {
  61. statusCode := http.StatusInternalServerError
  62. // FIXME: this is brittle and should not be necessary.
  63. // If we need to differentiate between different possible error types, we should
  64. // create appropriate error types with clearly defined meaning.
  65. if strings.Contains(err.Error(), "No such") {
  66. statusCode = http.StatusNotFound
  67. } else if strings.Contains(err.Error(), "Bad parameter") {
  68. statusCode = http.StatusBadRequest
  69. } else if strings.Contains(err.Error(), "Conflict") {
  70. statusCode = http.StatusConflict
  71. } else if strings.Contains(err.Error(), "Impossible") {
  72. statusCode = http.StatusNotAcceptable
  73. } else if strings.Contains(err.Error(), "Wrong login/password") {
  74. statusCode = http.StatusUnauthorized
  75. } else if strings.Contains(err.Error(), "hasn't been activated") {
  76. statusCode = http.StatusForbidden
  77. }
  78. if err != nil {
  79. utils.Errorf("HTTP Error: statusCode=%d %s", statusCode, err.Error())
  80. http.Error(w, err.Error(), statusCode)
  81. }
  82. }
  83. func writeJSON(w http.ResponseWriter, code int, v engine.Env) error {
  84. w.Header().Set("Content-Type", "application/json")
  85. w.WriteHeader(code)
  86. return v.Encode(w)
  87. }
  88. func getBoolParam(value string) (bool, error) {
  89. if value == "" {
  90. return false, nil
  91. }
  92. ret, err := strconv.ParseBool(value)
  93. if err != nil {
  94. return false, fmt.Errorf("Bad parameter")
  95. }
  96. return ret, nil
  97. }
  98. func matchesContentType(contentType, expectedType string) bool {
  99. mimetype, _, err := mime.ParseMediaType(contentType)
  100. if err != nil {
  101. utils.Errorf("Error parsing media type: %s error: %s", contentType, err.Error())
  102. }
  103. return err == nil && mimetype == expectedType
  104. }
  105. func postAuth(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  106. var (
  107. authConfig, err = ioutil.ReadAll(r.Body)
  108. job = srv.Eng.Job("auth")
  109. status string
  110. )
  111. if err != nil {
  112. return err
  113. }
  114. job.Setenv("authConfig", string(authConfig))
  115. job.Stdout.AddString(&status)
  116. if err = job.Run(); err != nil {
  117. return err
  118. }
  119. if status != "" {
  120. var env engine.Env
  121. env.Set("Status", status)
  122. return writeJSON(w, http.StatusOK, env)
  123. }
  124. w.WriteHeader(http.StatusNoContent)
  125. return nil
  126. }
  127. func getVersion(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  128. w.Header().Set("Content-Type", "application/json")
  129. srv.Eng.ServeHTTP(w, r)
  130. return nil
  131. }
  132. func postContainersKill(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  133. if vars == nil {
  134. return fmt.Errorf("Missing parameter")
  135. }
  136. if err := parseForm(r); err != nil {
  137. return err
  138. }
  139. job := srv.Eng.Job("kill", vars["name"])
  140. if sig := r.Form.Get("signal"); sig != "" {
  141. job.Args = append(job.Args, sig)
  142. }
  143. if err := job.Run(); err != nil {
  144. return err
  145. }
  146. w.WriteHeader(http.StatusNoContent)
  147. return nil
  148. }
  149. func getContainersExport(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  150. if vars == nil {
  151. return fmt.Errorf("Missing parameter")
  152. }
  153. job := srv.Eng.Job("export", vars["name"])
  154. job.Stdout.Add(w)
  155. if err := job.Run(); err != nil {
  156. return err
  157. }
  158. return nil
  159. }
  160. func getImagesJSON(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  161. if err := parseForm(r); err != nil {
  162. return err
  163. }
  164. var (
  165. err error
  166. outs *engine.Table
  167. job = srv.Eng.Job("images")
  168. )
  169. job.Setenv("filter", r.Form.Get("filter"))
  170. job.Setenv("all", r.Form.Get("all"))
  171. if version > 1.8 {
  172. job.Stdout.Add(w)
  173. } else if outs, err = job.Stdout.AddListTable(); err != nil {
  174. return err
  175. }
  176. if err := job.Run(); err != nil {
  177. return err
  178. }
  179. if version < 1.8 && outs != nil { // Convert to legacy format
  180. outsLegacy := engine.NewTable("Created", 0)
  181. for _, out := range outs.Data {
  182. for _, repoTag := range out.GetList("RepoTags") {
  183. parts := strings.Split(repoTag, ":")
  184. outLegacy := &engine.Env{}
  185. outLegacy.Set("Repository", parts[0])
  186. outLegacy.Set("Tag", parts[1])
  187. outLegacy.Set("ID", out.Get("ID"))
  188. outLegacy.SetInt64("Created", out.GetInt64("Created"))
  189. outLegacy.SetInt64("Size", out.GetInt64("Size"))
  190. outLegacy.SetInt64("VirtualSize", out.GetInt64("VirtualSize"))
  191. outsLegacy.Add(outLegacy)
  192. }
  193. }
  194. if _, err := outsLegacy.WriteListTo(w); err != nil {
  195. return err
  196. }
  197. }
  198. return nil
  199. }
  200. func getImagesViz(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  201. if version > 1.6 {
  202. w.WriteHeader(http.StatusNotFound)
  203. return fmt.Errorf("This is now implemented in the client.")
  204. }
  205. srv.Eng.ServeHTTP(w, r)
  206. return nil
  207. }
  208. func getInfo(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  209. w.Header().Set("Content-Type", "application/json")
  210. srv.Eng.ServeHTTP(w, r)
  211. return nil
  212. }
  213. func getEvents(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  214. if err := parseForm(r); err != nil {
  215. return err
  216. }
  217. w.Header().Set("Content-Type", "application/json")
  218. var job = srv.Eng.Job("events", r.RemoteAddr)
  219. job.Stdout.Add(utils.NewWriteFlusher(w))
  220. job.Setenv("since", r.Form.Get("since"))
  221. return job.Run()
  222. }
  223. func getImagesHistory(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  224. if vars == nil {
  225. return fmt.Errorf("Missing parameter")
  226. }
  227. var job = srv.Eng.Job("history", vars["name"])
  228. job.Stdout.Add(w)
  229. if err := job.Run(); err != nil {
  230. return err
  231. }
  232. return nil
  233. }
  234. func getContainersChanges(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  235. if vars == nil {
  236. return fmt.Errorf("Missing parameter")
  237. }
  238. var job = srv.Eng.Job("changes", vars["name"])
  239. job.Stdout.Add(w)
  240. return job.Run()
  241. }
  242. func getContainersTop(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  243. if version < 1.4 {
  244. return fmt.Errorf("top was improved a lot since 1.3, Please upgrade your docker client.")
  245. }
  246. if vars == nil {
  247. return fmt.Errorf("Missing parameter")
  248. }
  249. if err := parseForm(r); err != nil {
  250. return err
  251. }
  252. job := srv.Eng.Job("top", vars["name"], r.Form.Get("ps_args"))
  253. job.Stdout.Add(w)
  254. return job.Run()
  255. }
  256. func getContainersJSON(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  257. if err := parseForm(r); err != nil {
  258. return err
  259. }
  260. var (
  261. err error
  262. outs *engine.Table
  263. job = srv.Eng.Job("containers")
  264. )
  265. job.Setenv("all", r.Form.Get("all"))
  266. job.Setenv("size", r.Form.Get("size"))
  267. job.Setenv("since", r.Form.Get("since"))
  268. job.Setenv("before", r.Form.Get("before"))
  269. job.Setenv("limit", r.Form.Get("limit"))
  270. if version > 1.5 {
  271. job.Stdout.Add(w)
  272. } else if outs, err = job.Stdout.AddTable(); err != nil {
  273. return err
  274. }
  275. if err = job.Run(); err != nil {
  276. return err
  277. }
  278. if version < 1.5 { // Convert to legacy format
  279. for _, out := range outs.Data {
  280. ports := engine.NewTable("", 0)
  281. ports.ReadListFrom([]byte(out.Get("Ports")))
  282. out.Set("Ports", displayablePorts(ports))
  283. }
  284. if _, err = outs.WriteListTo(w); err != nil {
  285. return err
  286. }
  287. }
  288. return nil
  289. }
  290. func postImagesTag(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  291. if err := parseForm(r); err != nil {
  292. return err
  293. }
  294. if vars == nil {
  295. return fmt.Errorf("Missing parameter")
  296. }
  297. job := srv.Eng.Job("tag", vars["name"], r.Form.Get("repo"), r.Form.Get("tag"))
  298. job.Setenv("force", r.Form.Get("force"))
  299. if err := job.Run(); err != nil {
  300. return err
  301. }
  302. w.WriteHeader(http.StatusCreated)
  303. return nil
  304. }
  305. func postCommit(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  306. if err := parseForm(r); err != nil {
  307. return err
  308. }
  309. var (
  310. config engine.Env
  311. env engine.Env
  312. job = srv.Eng.Job("commit", r.Form.Get("container"))
  313. )
  314. if err := config.Import(r.Body); err != nil {
  315. utils.Errorf("%s", err)
  316. }
  317. job.Setenv("repo", r.Form.Get("repo"))
  318. job.Setenv("tag", r.Form.Get("tag"))
  319. job.Setenv("author", r.Form.Get("author"))
  320. job.Setenv("comment", r.Form.Get("comment"))
  321. job.SetenvSubEnv("config", &config)
  322. var id string
  323. job.Stdout.AddString(&id)
  324. if err := job.Run(); err != nil {
  325. return err
  326. }
  327. env.Set("Id", id)
  328. return writeJSON(w, http.StatusCreated, env)
  329. }
  330. // Creates an image from Pull or from Import
  331. func postImagesCreate(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  332. if err := parseForm(r); err != nil {
  333. return err
  334. }
  335. var (
  336. image = r.Form.Get("fromImage")
  337. tag = r.Form.Get("tag")
  338. job *engine.Job
  339. )
  340. authEncoded := r.Header.Get("X-Registry-Auth")
  341. authConfig := &auth.AuthConfig{}
  342. if authEncoded != "" {
  343. authJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authEncoded))
  344. if err := json.NewDecoder(authJson).Decode(authConfig); err != nil {
  345. // for a pull it is not an error if no auth was given
  346. // to increase compatibility with the existing api it is defaulting to be empty
  347. authConfig = &auth.AuthConfig{}
  348. }
  349. }
  350. if version > 1.0 {
  351. w.Header().Set("Content-Type", "application/json")
  352. }
  353. if image != "" { //pull
  354. metaHeaders := map[string][]string{}
  355. for k, v := range r.Header {
  356. if strings.HasPrefix(k, "X-Meta-") {
  357. metaHeaders[k] = v
  358. }
  359. }
  360. job = srv.Eng.Job("pull", r.Form.Get("fromImage"), tag)
  361. job.SetenvBool("parallel", version > 1.3)
  362. job.SetenvJson("metaHeaders", metaHeaders)
  363. job.SetenvJson("authConfig", authConfig)
  364. } else { //import
  365. job = srv.Eng.Job("import", r.Form.Get("fromSrc"), r.Form.Get("repo"), tag)
  366. job.Stdin.Add(r.Body)
  367. }
  368. job.SetenvBool("json", version > 1.0)
  369. job.Stdout.Add(utils.NewWriteFlusher(w))
  370. if err := job.Run(); err != nil {
  371. if !job.Stdout.Used() {
  372. return err
  373. }
  374. sf := utils.NewStreamFormatter(version > 1.0)
  375. w.Write(sf.FormatError(err))
  376. }
  377. return nil
  378. }
  379. func getImagesSearch(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  380. if err := parseForm(r); err != nil {
  381. return err
  382. }
  383. var (
  384. authEncoded = r.Header.Get("X-Registry-Auth")
  385. authConfig = &auth.AuthConfig{}
  386. metaHeaders = map[string][]string{}
  387. )
  388. if authEncoded != "" {
  389. authJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authEncoded))
  390. if err := json.NewDecoder(authJson).Decode(authConfig); err != nil {
  391. // for a search it is not an error if no auth was given
  392. // to increase compatibility with the existing api it is defaulting to be empty
  393. authConfig = &auth.AuthConfig{}
  394. }
  395. }
  396. for k, v := range r.Header {
  397. if strings.HasPrefix(k, "X-Meta-") {
  398. metaHeaders[k] = v
  399. }
  400. }
  401. var job = srv.Eng.Job("search", r.Form.Get("term"))
  402. job.SetenvJson("metaHeaders", metaHeaders)
  403. job.SetenvJson("authConfig", authConfig)
  404. job.Stdout.Add(w)
  405. return job.Run()
  406. }
  407. func postImagesInsert(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  408. if err := parseForm(r); err != nil {
  409. return err
  410. }
  411. if vars == nil {
  412. return fmt.Errorf("Missing parameter")
  413. }
  414. if version > 1.0 {
  415. w.Header().Set("Content-Type", "application/json")
  416. }
  417. job := srv.Eng.Job("insert", vars["name"], r.Form.Get("url"), r.Form.Get("path"))
  418. job.SetenvBool("json", version > 1.0)
  419. job.Stdout.Add(w)
  420. if err := job.Run(); err != nil {
  421. if !job.Stdout.Used() {
  422. return err
  423. }
  424. sf := utils.NewStreamFormatter(version > 1.0)
  425. w.Write(sf.FormatError(err))
  426. }
  427. return nil
  428. }
  429. func postImagesPush(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  430. if vars == nil {
  431. return fmt.Errorf("Missing parameter")
  432. }
  433. metaHeaders := map[string][]string{}
  434. for k, v := range r.Header {
  435. if strings.HasPrefix(k, "X-Meta-") {
  436. metaHeaders[k] = v
  437. }
  438. }
  439. if err := parseForm(r); err != nil {
  440. return err
  441. }
  442. authConfig := &auth.AuthConfig{}
  443. authEncoded := r.Header.Get("X-Registry-Auth")
  444. if authEncoded != "" {
  445. // the new format is to handle the authConfig as a header
  446. authJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authEncoded))
  447. if err := json.NewDecoder(authJson).Decode(authConfig); err != nil {
  448. // to increase compatibility to existing api it is defaulting to be empty
  449. authConfig = &auth.AuthConfig{}
  450. }
  451. } else {
  452. // the old format is supported for compatibility if there was no authConfig header
  453. if err := json.NewDecoder(r.Body).Decode(authConfig); err != nil {
  454. return err
  455. }
  456. }
  457. if version > 1.0 {
  458. w.Header().Set("Content-Type", "application/json")
  459. }
  460. job := srv.Eng.Job("push", vars["name"])
  461. job.SetenvJson("metaHeaders", metaHeaders)
  462. job.SetenvJson("authConfig", authConfig)
  463. job.SetenvBool("json", version > 1.0)
  464. job.Stdout.Add(utils.NewWriteFlusher(w))
  465. if err := job.Run(); err != nil {
  466. if !job.Stdout.Used() {
  467. return err
  468. }
  469. sf := utils.NewStreamFormatter(version > 1.0)
  470. w.Write(sf.FormatError(err))
  471. }
  472. return nil
  473. }
  474. func getImagesGet(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  475. if vars == nil {
  476. return fmt.Errorf("Missing parameter")
  477. }
  478. if version > 1.0 {
  479. w.Header().Set("Content-Type", "application/x-tar")
  480. }
  481. job := srv.Eng.Job("image_export", vars["name"])
  482. job.Stdout.Add(w)
  483. return job.Run()
  484. }
  485. func postImagesLoad(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  486. job := srv.Eng.Job("load")
  487. job.Stdin.Add(r.Body)
  488. return job.Run()
  489. }
  490. func postContainersCreate(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  491. if err := parseForm(r); err != nil {
  492. return nil
  493. }
  494. var (
  495. out engine.Env
  496. job = srv.Eng.Job("create", r.Form.Get("name"))
  497. outWarnings []string
  498. outId string
  499. warnings = bytes.NewBuffer(nil)
  500. )
  501. if err := job.DecodeEnv(r.Body); err != nil {
  502. return err
  503. }
  504. // Read container ID from the first line of stdout
  505. job.Stdout.AddString(&outId)
  506. // Read warnings from stderr
  507. job.Stderr.Add(warnings)
  508. if err := job.Run(); err != nil {
  509. return err
  510. }
  511. // Parse warnings from stderr
  512. scanner := bufio.NewScanner(warnings)
  513. for scanner.Scan() {
  514. outWarnings = append(outWarnings, scanner.Text())
  515. }
  516. out.Set("Id", outId)
  517. out.SetList("Warnings", outWarnings)
  518. return writeJSON(w, http.StatusCreated, out)
  519. }
  520. func postContainersRestart(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  521. if err := parseForm(r); err != nil {
  522. return err
  523. }
  524. if vars == nil {
  525. return fmt.Errorf("Missing parameter")
  526. }
  527. job := srv.Eng.Job("restart", vars["name"])
  528. job.Setenv("t", r.Form.Get("t"))
  529. if err := job.Run(); err != nil {
  530. return err
  531. }
  532. w.WriteHeader(http.StatusNoContent)
  533. return nil
  534. }
  535. func deleteContainers(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  536. if err := parseForm(r); err != nil {
  537. return err
  538. }
  539. if vars == nil {
  540. return fmt.Errorf("Missing parameter")
  541. }
  542. job := srv.Eng.Job("container_delete", vars["name"])
  543. job.Setenv("removeVolume", r.Form.Get("v"))
  544. job.Setenv("removeLink", r.Form.Get("link"))
  545. if err := job.Run(); err != nil {
  546. return err
  547. }
  548. w.WriteHeader(http.StatusNoContent)
  549. return nil
  550. }
  551. func deleteImages(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  552. if err := parseForm(r); err != nil {
  553. return err
  554. }
  555. if vars == nil {
  556. return fmt.Errorf("Missing parameter")
  557. }
  558. var job = srv.Eng.Job("image_delete", vars["name"])
  559. job.Stdout.Add(w)
  560. job.SetenvBool("autoPrune", version > 1.1)
  561. return job.Run()
  562. }
  563. func postContainersStart(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  564. if vars == nil {
  565. return fmt.Errorf("Missing parameter")
  566. }
  567. name := vars["name"]
  568. job := srv.Eng.Job("start", name)
  569. // allow a nil body for backwards compatibility
  570. if r.Body != nil {
  571. if matchesContentType(r.Header.Get("Content-Type"), "application/json") {
  572. if err := job.DecodeEnv(r.Body); err != nil {
  573. return err
  574. }
  575. }
  576. }
  577. if err := job.Run(); err != nil {
  578. return err
  579. }
  580. w.WriteHeader(http.StatusNoContent)
  581. return nil
  582. }
  583. func postContainersStop(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  584. if err := parseForm(r); err != nil {
  585. return err
  586. }
  587. if vars == nil {
  588. return fmt.Errorf("Missing parameter")
  589. }
  590. job := srv.Eng.Job("stop", vars["name"])
  591. job.Setenv("t", r.Form.Get("t"))
  592. if err := job.Run(); err != nil {
  593. return err
  594. }
  595. w.WriteHeader(http.StatusNoContent)
  596. return nil
  597. }
  598. func postContainersWait(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  599. if vars == nil {
  600. return fmt.Errorf("Missing parameter")
  601. }
  602. var (
  603. env engine.Env
  604. status string
  605. job = srv.Eng.Job("wait", vars["name"])
  606. )
  607. job.Stdout.AddString(&status)
  608. if err := job.Run(); err != nil {
  609. return err
  610. }
  611. // Parse a 16-bit encoded integer to map typical unix exit status.
  612. _, err := strconv.ParseInt(status, 10, 16)
  613. if err != nil {
  614. return err
  615. }
  616. env.Set("StatusCode", status)
  617. return writeJSON(w, http.StatusOK, env)
  618. }
  619. func postContainersResize(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  620. if err := parseForm(r); err != nil {
  621. return err
  622. }
  623. if vars == nil {
  624. return fmt.Errorf("Missing parameter")
  625. }
  626. if err := srv.Eng.Job("resize", vars["name"], r.Form.Get("h"), r.Form.Get("w")).Run(); err != nil {
  627. return err
  628. }
  629. return nil
  630. }
  631. func postContainersAttach(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  632. if err := parseForm(r); err != nil {
  633. return err
  634. }
  635. if vars == nil {
  636. return fmt.Errorf("Missing parameter")
  637. }
  638. var (
  639. job = srv.Eng.Job("inspect", vars["name"], "container")
  640. c, err = job.Stdout.AddEnv()
  641. )
  642. if err != nil {
  643. return err
  644. }
  645. if err = job.Run(); err != nil {
  646. return err
  647. }
  648. inStream, outStream, err := hijackServer(w)
  649. if err != nil {
  650. return err
  651. }
  652. defer func() {
  653. if tcpc, ok := inStream.(*net.TCPConn); ok {
  654. tcpc.CloseWrite()
  655. } else {
  656. inStream.Close()
  657. }
  658. }()
  659. defer func() {
  660. if tcpc, ok := outStream.(*net.TCPConn); ok {
  661. tcpc.CloseWrite()
  662. } else if closer, ok := outStream.(io.Closer); ok {
  663. closer.Close()
  664. }
  665. }()
  666. var errStream io.Writer
  667. fmt.Fprintf(outStream, "HTTP/1.1 200 OK\r\nContent-Type: application/vnd.docker.raw-stream\r\n\r\n")
  668. if c.GetSubEnv("Config") != nil && !c.GetSubEnv("Config").GetBool("Tty") && version >= 1.6 {
  669. errStream = utils.NewStdWriter(outStream, utils.Stderr)
  670. outStream = utils.NewStdWriter(outStream, utils.Stdout)
  671. } else {
  672. errStream = outStream
  673. }
  674. job = srv.Eng.Job("attach", vars["name"])
  675. job.Setenv("logs", r.Form.Get("logs"))
  676. job.Setenv("stream", r.Form.Get("stream"))
  677. job.Setenv("stdin", r.Form.Get("stdin"))
  678. job.Setenv("stdout", r.Form.Get("stdout"))
  679. job.Setenv("stderr", r.Form.Get("stderr"))
  680. job.Stdin.Add(inStream)
  681. job.Stdout.Add(outStream)
  682. job.Stderr.Set(errStream)
  683. if err := job.Run(); err != nil {
  684. fmt.Fprintf(outStream, "Error: %s\n", err)
  685. }
  686. return nil
  687. }
  688. func wsContainersAttach(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  689. if err := parseForm(r); err != nil {
  690. return err
  691. }
  692. if vars == nil {
  693. return fmt.Errorf("Missing parameter")
  694. }
  695. if err := srv.Eng.Job("inspect", vars["name"], "container").Run(); err != nil {
  696. return err
  697. }
  698. h := websocket.Handler(func(ws *websocket.Conn) {
  699. defer ws.Close()
  700. job := srv.Eng.Job("attach", vars["name"])
  701. job.Setenv("logs", r.Form.Get("logs"))
  702. job.Setenv("stream", r.Form.Get("stream"))
  703. job.Setenv("stdin", r.Form.Get("stdin"))
  704. job.Setenv("stdout", r.Form.Get("stdout"))
  705. job.Setenv("stderr", r.Form.Get("stderr"))
  706. job.Stdin.Add(ws)
  707. job.Stdout.Add(ws)
  708. job.Stderr.Set(ws)
  709. if err := job.Run(); err != nil {
  710. utils.Errorf("Error: %s", err)
  711. }
  712. })
  713. h.ServeHTTP(w, r)
  714. return nil
  715. }
  716. func getContainersByName(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  717. if vars == nil {
  718. return fmt.Errorf("Missing parameter")
  719. }
  720. var job = srv.Eng.Job("inspect", vars["name"], "container")
  721. job.Stdout.Add(w)
  722. job.SetenvBool("conflict", true) //conflict=true to detect conflict between containers and images in the job
  723. return job.Run()
  724. }
  725. func getImagesByName(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  726. if vars == nil {
  727. return fmt.Errorf("Missing parameter")
  728. }
  729. var job = srv.Eng.Job("inspect", vars["name"], "image")
  730. job.Stdout.Add(w)
  731. job.SetenvBool("conflict", true) //conflict=true to detect conflict between containers and images in the job
  732. return job.Run()
  733. }
  734. func postBuild(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  735. if version < 1.3 {
  736. return fmt.Errorf("Multipart upload for build is no longer supported. Please upgrade your docker client.")
  737. }
  738. var (
  739. authEncoded = r.Header.Get("X-Registry-Auth")
  740. authConfig = &auth.AuthConfig{}
  741. configFileEncoded = r.Header.Get("X-Registry-Config")
  742. configFile = &auth.ConfigFile{}
  743. job = srv.Eng.Job("build")
  744. )
  745. // This block can be removed when API versions prior to 1.9 are deprecated.
  746. // Both headers will be parsed and sent along to the daemon, but if a non-empty
  747. // ConfigFile is present, any value provided as an AuthConfig directly will
  748. // be overridden. See BuildFile::CmdFrom for details.
  749. if version < 1.9 && authEncoded != "" {
  750. authJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authEncoded))
  751. if err := json.NewDecoder(authJson).Decode(authConfig); err != nil {
  752. // for a pull it is not an error if no auth was given
  753. // to increase compatibility with the existing api it is defaulting to be empty
  754. authConfig = &auth.AuthConfig{}
  755. }
  756. }
  757. if configFileEncoded != "" {
  758. configFileJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(configFileEncoded))
  759. if err := json.NewDecoder(configFileJson).Decode(configFile); err != nil {
  760. // for a pull it is not an error if no auth was given
  761. // to increase compatibility with the existing api it is defaulting to be empty
  762. configFile = &auth.ConfigFile{}
  763. }
  764. }
  765. if version >= 1.8 {
  766. w.Header().Set("Content-Type", "application/json")
  767. job.SetenvBool("json", true)
  768. }
  769. job.Stdout.Add(utils.NewWriteFlusher(w))
  770. job.Stdin.Add(r.Body)
  771. job.Setenv("remote", r.FormValue("remote"))
  772. job.Setenv("t", r.FormValue("t"))
  773. job.Setenv("q", r.FormValue("q"))
  774. job.Setenv("nocache", r.FormValue("nocache"))
  775. job.Setenv("rm", r.FormValue("rm"))
  776. if err := job.Run(); err != nil {
  777. if !job.Stdout.Used() {
  778. return err
  779. }
  780. sf := utils.NewStreamFormatter(version >= 1.8)
  781. w.Write(sf.FormatError(err))
  782. }
  783. return nil
  784. }
  785. func postContainersCopy(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  786. if vars == nil {
  787. return fmt.Errorf("Missing parameter")
  788. }
  789. var copyData engine.Env
  790. if contentType := r.Header.Get("Content-Type"); contentType == "application/json" {
  791. if err := copyData.Decode(r.Body); err != nil {
  792. return err
  793. }
  794. } else {
  795. return fmt.Errorf("Content-Type not supported: %s", contentType)
  796. }
  797. if copyData.Get("Resource") == "" {
  798. return fmt.Errorf("Path cannot be empty")
  799. }
  800. if copyData.Get("Resource")[0] == '/' {
  801. copyData.Set("Resource", copyData.Get("Resource")[1:])
  802. }
  803. job := srv.Eng.Job("container_copy", vars["name"], copyData.Get("Resource"))
  804. job.Stdout.Add(w)
  805. if err := job.Run(); err != nil {
  806. utils.Errorf("%s", err.Error())
  807. }
  808. return nil
  809. }
  810. func optionsHandler(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  811. w.WriteHeader(http.StatusOK)
  812. return nil
  813. }
  814. func writeCorsHeaders(w http.ResponseWriter, r *http.Request) {
  815. w.Header().Add("Access-Control-Allow-Origin", "*")
  816. w.Header().Add("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept")
  817. w.Header().Add("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT, OPTIONS")
  818. }
  819. func makeHttpHandler(srv *Server, logging bool, localMethod string, localRoute string, handlerFunc HttpApiFunc, enableCors bool) http.HandlerFunc {
  820. return func(w http.ResponseWriter, r *http.Request) {
  821. // log the request
  822. utils.Debugf("Calling %s %s", localMethod, localRoute)
  823. if logging {
  824. log.Println(r.Method, r.RequestURI)
  825. }
  826. if strings.Contains(r.Header.Get("User-Agent"), "Docker-Client/") {
  827. userAgent := strings.Split(r.Header.Get("User-Agent"), "/")
  828. if len(userAgent) == 2 && userAgent[1] != VERSION {
  829. utils.Debugf("Warning: client and server don't have the same version (client: %s, server: %s)", userAgent[1], VERSION)
  830. }
  831. }
  832. version, err := strconv.ParseFloat(mux.Vars(r)["version"], 64)
  833. if err != nil {
  834. version = APIVERSION
  835. }
  836. if enableCors {
  837. writeCorsHeaders(w, r)
  838. }
  839. if version == 0 || version > APIVERSION {
  840. http.Error(w, fmt.Errorf("client and server don't have same version (client : %g, server: %g)", version, APIVERSION).Error(), http.StatusNotFound)
  841. return
  842. }
  843. if err := handlerFunc(srv, version, w, r, mux.Vars(r)); err != nil {
  844. utils.Errorf("Error: %s", err)
  845. httpError(w, err)
  846. }
  847. }
  848. }
  849. // Replicated from expvar.go as not public.
  850. func expvarHandler(w http.ResponseWriter, r *http.Request) {
  851. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  852. fmt.Fprintf(w, "{\n")
  853. first := true
  854. expvar.Do(func(kv expvar.KeyValue) {
  855. if !first {
  856. fmt.Fprintf(w, ",\n")
  857. }
  858. first = false
  859. fmt.Fprintf(w, "%q: %s", kv.Key, kv.Value)
  860. })
  861. fmt.Fprintf(w, "\n}\n")
  862. }
  863. func AttachProfiler(router *mux.Router) {
  864. router.HandleFunc("/debug/vars", expvarHandler)
  865. router.HandleFunc("/debug/pprof/", pprof.Index)
  866. router.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
  867. router.HandleFunc("/debug/pprof/profile", pprof.Profile)
  868. router.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
  869. router.HandleFunc("/debug/pprof/heap", pprof.Handler("heap").ServeHTTP)
  870. router.HandleFunc("/debug/pprof/goroutine", pprof.Handler("goroutine").ServeHTTP)
  871. router.HandleFunc("/debug/pprof/threadcreate", pprof.Handler("threadcreate").ServeHTTP)
  872. }
  873. func createRouter(srv *Server, logging, enableCors bool) (*mux.Router, error) {
  874. r := mux.NewRouter()
  875. if os.Getenv("DEBUG") != "" {
  876. AttachProfiler(r)
  877. }
  878. m := map[string]map[string]HttpApiFunc{
  879. "GET": {
  880. "/events": getEvents,
  881. "/info": getInfo,
  882. "/version": getVersion,
  883. "/images/json": getImagesJSON,
  884. "/images/viz": getImagesViz,
  885. "/images/search": getImagesSearch,
  886. "/images/{name:.*}/get": getImagesGet,
  887. "/images/{name:.*}/history": getImagesHistory,
  888. "/images/{name:.*}/json": getImagesByName,
  889. "/containers/ps": getContainersJSON,
  890. "/containers/json": getContainersJSON,
  891. "/containers/{name:.*}/export": getContainersExport,
  892. "/containers/{name:.*}/changes": getContainersChanges,
  893. "/containers/{name:.*}/json": getContainersByName,
  894. "/containers/{name:.*}/top": getContainersTop,
  895. "/containers/{name:.*}/attach/ws": wsContainersAttach,
  896. },
  897. "POST": {
  898. "/auth": postAuth,
  899. "/commit": postCommit,
  900. "/build": postBuild,
  901. "/images/create": postImagesCreate,
  902. "/images/{name:.*}/insert": postImagesInsert,
  903. "/images/load": postImagesLoad,
  904. "/images/{name:.*}/push": postImagesPush,
  905. "/images/{name:.*}/tag": postImagesTag,
  906. "/containers/create": postContainersCreate,
  907. "/containers/{name:.*}/kill": postContainersKill,
  908. "/containers/{name:.*}/restart": postContainersRestart,
  909. "/containers/{name:.*}/start": postContainersStart,
  910. "/containers/{name:.*}/stop": postContainersStop,
  911. "/containers/{name:.*}/wait": postContainersWait,
  912. "/containers/{name:.*}/resize": postContainersResize,
  913. "/containers/{name:.*}/attach": postContainersAttach,
  914. "/containers/{name:.*}/copy": postContainersCopy,
  915. },
  916. "DELETE": {
  917. "/containers/{name:.*}": deleteContainers,
  918. "/images/{name:.*}": deleteImages,
  919. },
  920. "OPTIONS": {
  921. "": optionsHandler,
  922. },
  923. }
  924. for method, routes := range m {
  925. for route, fct := range routes {
  926. utils.Debugf("Registering %s, %s", method, route)
  927. // NOTE: scope issue, make sure the variables are local and won't be changed
  928. localRoute := route
  929. localFct := fct
  930. localMethod := method
  931. // build the handler function
  932. f := makeHttpHandler(srv, logging, localMethod, localRoute, localFct, enableCors)
  933. // add the new route
  934. if localRoute == "" {
  935. r.Methods(localMethod).HandlerFunc(f)
  936. } else {
  937. r.Path("/v{version:[0-9.]+}" + localRoute).Methods(localMethod).HandlerFunc(f)
  938. r.Path(localRoute).Methods(localMethod).HandlerFunc(f)
  939. }
  940. }
  941. }
  942. return r, nil
  943. }
  944. // ServeRequest processes a single http request to the docker remote api.
  945. // FIXME: refactor this to be part of Server and not require re-creating a new
  946. // router each time. This requires first moving ListenAndServe into Server.
  947. func ServeRequest(srv *Server, apiversion float64, w http.ResponseWriter, req *http.Request) error {
  948. router, err := createRouter(srv, false, true)
  949. if err != nil {
  950. return err
  951. }
  952. // Insert APIVERSION into the request as a convenience
  953. req.URL.Path = fmt.Sprintf("/v%g%s", apiversion, req.URL.Path)
  954. router.ServeHTTP(w, req)
  955. return nil
  956. }
  957. // ServeFD creates an http.Server and sets it up to serve given a socket activated
  958. // argument.
  959. func ServeFd(addr string, handle http.Handler) error {
  960. ls, e := systemd.ListenFD(addr)
  961. if e != nil {
  962. return e
  963. }
  964. chErrors := make(chan error, len(ls))
  965. // Since ListenFD will return one or more sockets we have
  966. // to create a go func to spawn off multiple serves
  967. for i := range ls {
  968. listener := ls[i]
  969. go func() {
  970. httpSrv := http.Server{Handler: handle}
  971. chErrors <- httpSrv.Serve(listener)
  972. }()
  973. }
  974. for i := 0; i < len(ls); i += 1 {
  975. err := <-chErrors
  976. if err != nil {
  977. return err
  978. }
  979. }
  980. return nil
  981. }
  982. // ListenAndServe sets up the required http.Server and gets it listening for
  983. // each addr passed in and does protocol specific checking.
  984. func ListenAndServe(proto, addr string, srv *Server, logging, enableCors bool) error {
  985. r, err := createRouter(srv, logging, enableCors)
  986. if err != nil {
  987. return err
  988. }
  989. if proto == "fd" {
  990. return ServeFd(addr, r)
  991. }
  992. if proto == "unix" {
  993. if err := syscall.Unlink(addr); err != nil && !os.IsNotExist(err) {
  994. return err
  995. }
  996. }
  997. l, err := net.Listen(proto, addr)
  998. if err != nil {
  999. return err
  1000. }
  1001. // Basic error and sanity checking
  1002. switch proto {
  1003. case "tcp":
  1004. if !strings.HasPrefix(addr, "127.0.0.1") {
  1005. log.Println("/!\\ DON'T BIND ON ANOTHER IP ADDRESS THAN 127.0.0.1 IF YOU DON'T KNOW WHAT YOU'RE DOING /!\\")
  1006. }
  1007. case "unix":
  1008. if err := os.Chmod(addr, 0660); err != nil {
  1009. return err
  1010. }
  1011. groups, err := ioutil.ReadFile("/etc/group")
  1012. if err != nil {
  1013. return err
  1014. }
  1015. re := regexp.MustCompile("(^|\n)docker:.*?:([0-9]+)")
  1016. if gidMatch := re.FindStringSubmatch(string(groups)); gidMatch != nil {
  1017. gid, err := strconv.Atoi(gidMatch[2])
  1018. if err != nil {
  1019. return err
  1020. }
  1021. utils.Debugf("docker group found. gid: %d", gid)
  1022. if err := os.Chown(addr, 0, gid); err != nil {
  1023. return err
  1024. }
  1025. }
  1026. default:
  1027. return fmt.Errorf("Invalid protocol format.")
  1028. }
  1029. httpSrv := http.Server{Addr: addr, Handler: r}
  1030. return httpSrv.Serve(l)
  1031. }