api.go 33 KB

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