api.go 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148
  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. job.Setenv("t", r.Form.Get("t"))
  524. if err := job.Run(); err != nil {
  525. return err
  526. }
  527. w.WriteHeader(http.StatusNoContent)
  528. return nil
  529. }
  530. func deleteContainers(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  531. if err := parseForm(r); err != nil {
  532. return err
  533. }
  534. if vars == nil {
  535. return fmt.Errorf("Missing parameter")
  536. }
  537. job := srv.Eng.Job("container_delete", vars["name"])
  538. job.Setenv("removeVolume", r.Form.Get("v"))
  539. job.Setenv("removeLink", r.Form.Get("link"))
  540. if err := job.Run(); err != nil {
  541. return err
  542. }
  543. w.WriteHeader(http.StatusNoContent)
  544. return nil
  545. }
  546. func deleteImages(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  547. if err := parseForm(r); err != nil {
  548. return err
  549. }
  550. if vars == nil {
  551. return fmt.Errorf("Missing parameter")
  552. }
  553. var job = srv.Eng.Job("image_delete", vars["name"])
  554. job.Stdout.Add(w)
  555. job.SetenvBool("autoPrune", version > 1.1)
  556. return job.Run()
  557. }
  558. func postContainersStart(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  559. if vars == nil {
  560. return fmt.Errorf("Missing parameter")
  561. }
  562. name := vars["name"]
  563. job := srv.Eng.Job("start", name)
  564. // allow a nil body for backwards compatibility
  565. if r.Body != nil {
  566. if matchesContentType(r.Header.Get("Content-Type"), "application/json") {
  567. if err := job.DecodeEnv(r.Body); err != nil {
  568. return err
  569. }
  570. }
  571. }
  572. if err := job.Run(); err != nil {
  573. return err
  574. }
  575. w.WriteHeader(http.StatusNoContent)
  576. return nil
  577. }
  578. func postContainersStop(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  579. if err := parseForm(r); err != nil {
  580. return err
  581. }
  582. if vars == nil {
  583. return fmt.Errorf("Missing parameter")
  584. }
  585. job := srv.Eng.Job("stop", vars["name"])
  586. job.Setenv("t", r.Form.Get("t"))
  587. if err := job.Run(); err != nil {
  588. return err
  589. }
  590. w.WriteHeader(http.StatusNoContent)
  591. return nil
  592. }
  593. func postContainersWait(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  594. if vars == nil {
  595. return fmt.Errorf("Missing parameter")
  596. }
  597. job := srv.Eng.Job("wait", vars["name"])
  598. var statusStr string
  599. job.Stdout.AddString(&statusStr)
  600. if err := job.Run(); err != nil {
  601. return err
  602. }
  603. // Parse a 16-bit encoded integer to map typical unix exit status.
  604. status, err := strconv.ParseInt(statusStr, 10, 16)
  605. if err != nil {
  606. return err
  607. }
  608. return writeJSON(w, http.StatusOK, &APIWait{StatusCode: int(status)})
  609. }
  610. func postContainersResize(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  611. if err := parseForm(r); err != nil {
  612. return err
  613. }
  614. if vars == nil {
  615. return fmt.Errorf("Missing parameter")
  616. }
  617. if err := srv.Eng.Job("resize", vars["name"], r.Form.Get("h"), r.Form.Get("w")).Run(); err != nil {
  618. return err
  619. }
  620. return nil
  621. }
  622. func postContainersAttach(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  623. if err := parseForm(r); err != nil {
  624. return err
  625. }
  626. if vars == nil {
  627. return fmt.Errorf("Missing parameter")
  628. }
  629. // TODO: replace the buffer by job.AddEnv()
  630. var (
  631. job = srv.Eng.Job("inspect", vars["name"], "container")
  632. buffer = bytes.NewBuffer(nil)
  633. c Container
  634. )
  635. job.Stdout.Add(buffer)
  636. if err := job.Run(); err != nil {
  637. return err
  638. }
  639. if err := json.Unmarshal(buffer.Bytes(), &c); err != nil {
  640. return err
  641. }
  642. inStream, outStream, err := hijackServer(w)
  643. if err != nil {
  644. return err
  645. }
  646. defer func() {
  647. if tcpc, ok := inStream.(*net.TCPConn); ok {
  648. tcpc.CloseWrite()
  649. } else {
  650. inStream.Close()
  651. }
  652. }()
  653. defer func() {
  654. if tcpc, ok := outStream.(*net.TCPConn); ok {
  655. tcpc.CloseWrite()
  656. } else if closer, ok := outStream.(io.Closer); ok {
  657. closer.Close()
  658. }
  659. }()
  660. var errStream io.Writer
  661. fmt.Fprintf(outStream, "HTTP/1.1 200 OK\r\nContent-Type: application/vnd.docker.raw-stream\r\n\r\n")
  662. if !c.Config.Tty && version >= 1.6 {
  663. errStream = utils.NewStdWriter(outStream, utils.Stderr)
  664. outStream = utils.NewStdWriter(outStream, utils.Stdout)
  665. } else {
  666. errStream = outStream
  667. }
  668. job = srv.Eng.Job("attach", vars["name"])
  669. job.Setenv("logs", r.Form.Get("logs"))
  670. job.Setenv("stream", r.Form.Get("stream"))
  671. job.Setenv("stdin", r.Form.Get("stdin"))
  672. job.Setenv("stdout", r.Form.Get("stdout"))
  673. job.Setenv("stderr", r.Form.Get("stderr"))
  674. job.Stdin.Add(inStream)
  675. job.Stdout.Add(outStream)
  676. job.Stderr.Set(errStream)
  677. if err := job.Run(); err != nil {
  678. fmt.Fprintf(outStream, "Error: %s\n", err)
  679. }
  680. return nil
  681. }
  682. func wsContainersAttach(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  683. if err := parseForm(r); err != nil {
  684. return err
  685. }
  686. if vars == nil {
  687. return fmt.Errorf("Missing parameter")
  688. }
  689. if err := srv.Eng.Job("inspect", vars["name"], "container").Run(); err != nil {
  690. return err
  691. }
  692. h := websocket.Handler(func(ws *websocket.Conn) {
  693. defer ws.Close()
  694. job := srv.Eng.Job("attach", vars["name"])
  695. job.Setenv("logs", r.Form.Get("logs"))
  696. job.Setenv("stream", r.Form.Get("stream"))
  697. job.Setenv("stdin", r.Form.Get("stdin"))
  698. job.Setenv("stdout", r.Form.Get("stdout"))
  699. job.Setenv("stderr", r.Form.Get("stderr"))
  700. job.Stdin.Add(ws)
  701. job.Stdout.Add(ws)
  702. job.Stderr.Set(ws)
  703. if err := job.Run(); err != nil {
  704. utils.Errorf("Error: %s", err)
  705. }
  706. })
  707. h.ServeHTTP(w, r)
  708. return nil
  709. }
  710. func getContainersByName(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  711. if vars == nil {
  712. return fmt.Errorf("Missing parameter")
  713. }
  714. var job = srv.Eng.Job("inspect", vars["name"], "container")
  715. job.Stdout.Add(w)
  716. job.SetenvBool("conflict", true) //conflict=true to detect conflict between containers and images in the job
  717. return job.Run()
  718. }
  719. func getImagesByName(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  720. if vars == nil {
  721. return fmt.Errorf("Missing parameter")
  722. }
  723. var job = srv.Eng.Job("inspect", vars["name"], "image")
  724. job.Stdout.Add(w)
  725. job.SetenvBool("conflict", true) //conflict=true to detect conflict between containers and images in the job
  726. return job.Run()
  727. }
  728. func postBuild(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  729. if version < 1.3 {
  730. return fmt.Errorf("Multipart upload for build is no longer supported. Please upgrade your docker client.")
  731. }
  732. var (
  733. authEncoded = r.Header.Get("X-Registry-Auth")
  734. authConfig = &auth.AuthConfig{}
  735. configFileEncoded = r.Header.Get("X-Registry-Config")
  736. configFile = &auth.ConfigFile{}
  737. job = srv.Eng.Job("build")
  738. )
  739. // This block can be removed when API versions prior to 1.9 are deprecated.
  740. // Both headers will be parsed and sent along to the daemon, but if a non-empty
  741. // ConfigFile is present, any value provided as an AuthConfig directly will
  742. // be overridden. See BuildFile::CmdFrom for details.
  743. if version < 1.9 && authEncoded != "" {
  744. authJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(authEncoded))
  745. if err := json.NewDecoder(authJson).Decode(authConfig); err != nil {
  746. // for a pull it is not an error if no auth was given
  747. // to increase compatibility with the existing api it is defaulting to be empty
  748. authConfig = &auth.AuthConfig{}
  749. }
  750. }
  751. if configFileEncoded != "" {
  752. configFileJson := base64.NewDecoder(base64.URLEncoding, strings.NewReader(configFileEncoded))
  753. if err := json.NewDecoder(configFileJson).Decode(configFile); 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. configFile = &auth.ConfigFile{}
  757. }
  758. }
  759. if version >= 1.8 {
  760. w.Header().Set("Content-Type", "application/json")
  761. job.SetenvBool("json", true)
  762. }
  763. job.Stdout.Add(utils.NewWriteFlusher(w))
  764. job.Stdin.Add(r.Body)
  765. job.Setenv("remote", r.FormValue("remote"))
  766. job.Setenv("t", r.FormValue("t"))
  767. job.Setenv("q", r.FormValue("q"))
  768. job.Setenv("nocache", r.FormValue("nocache"))
  769. job.Setenv("rm", r.FormValue("rm"))
  770. if err := job.Run(); err != nil {
  771. if !job.Stdout.Used() {
  772. return err
  773. }
  774. sf := utils.NewStreamFormatter(version >= 1.8)
  775. w.Write(sf.FormatError(err))
  776. }
  777. return nil
  778. }
  779. func postContainersCopy(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  780. if vars == nil {
  781. return fmt.Errorf("Missing parameter")
  782. }
  783. copyData := &APICopy{}
  784. contentType := r.Header.Get("Content-Type")
  785. if contentType == "application/json" {
  786. if err := json.NewDecoder(r.Body).Decode(copyData); err != nil {
  787. return err
  788. }
  789. } else {
  790. return fmt.Errorf("Content-Type not supported: %s", contentType)
  791. }
  792. if copyData.Resource == "" {
  793. return fmt.Errorf("Path cannot be empty")
  794. }
  795. if copyData.Resource[0] == '/' {
  796. copyData.Resource = copyData.Resource[1:]
  797. }
  798. job := srv.Eng.Job("container_copy", vars["name"], copyData.Resource)
  799. job.Stdout.Add(w)
  800. if err := job.Run(); err != nil {
  801. utils.Errorf("%s", err.Error())
  802. }
  803. return nil
  804. }
  805. func optionsHandler(srv *Server, version float64, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
  806. w.WriteHeader(http.StatusOK)
  807. return nil
  808. }
  809. func writeCorsHeaders(w http.ResponseWriter, r *http.Request) {
  810. w.Header().Add("Access-Control-Allow-Origin", "*")
  811. w.Header().Add("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept")
  812. w.Header().Add("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT, OPTIONS")
  813. }
  814. func makeHttpHandler(srv *Server, logging bool, localMethod string, localRoute string, handlerFunc HttpApiFunc, enableCors bool) http.HandlerFunc {
  815. return func(w http.ResponseWriter, r *http.Request) {
  816. // log the request
  817. utils.Debugf("Calling %s %s", localMethod, localRoute)
  818. if logging {
  819. log.Println(r.Method, r.RequestURI)
  820. }
  821. if strings.Contains(r.Header.Get("User-Agent"), "Docker-Client/") {
  822. userAgent := strings.Split(r.Header.Get("User-Agent"), "/")
  823. if len(userAgent) == 2 && userAgent[1] != VERSION {
  824. utils.Debugf("Warning: client and server don't have the same version (client: %s, server: %s)", userAgent[1], VERSION)
  825. }
  826. }
  827. version, err := strconv.ParseFloat(mux.Vars(r)["version"], 64)
  828. if err != nil {
  829. version = APIVERSION
  830. }
  831. if enableCors {
  832. writeCorsHeaders(w, r)
  833. }
  834. if version == 0 || version > APIVERSION {
  835. http.Error(w, fmt.Errorf("client and server don't have same version (client : %g, server: %g)", version, APIVERSION).Error(), http.StatusNotFound)
  836. return
  837. }
  838. if err := handlerFunc(srv, version, w, r, mux.Vars(r)); err != nil {
  839. utils.Errorf("Error: %s", err)
  840. httpError(w, err)
  841. }
  842. }
  843. }
  844. // Replicated from expvar.go as not public.
  845. func expvarHandler(w http.ResponseWriter, r *http.Request) {
  846. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  847. fmt.Fprintf(w, "{\n")
  848. first := true
  849. expvar.Do(func(kv expvar.KeyValue) {
  850. if !first {
  851. fmt.Fprintf(w, ",\n")
  852. }
  853. first = false
  854. fmt.Fprintf(w, "%q: %s", kv.Key, kv.Value)
  855. })
  856. fmt.Fprintf(w, "\n}\n")
  857. }
  858. func AttachProfiler(router *mux.Router) {
  859. router.HandleFunc("/debug/vars", expvarHandler)
  860. router.HandleFunc("/debug/pprof/", pprof.Index)
  861. router.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
  862. router.HandleFunc("/debug/pprof/profile", pprof.Profile)
  863. router.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
  864. router.HandleFunc("/debug/pprof/heap", pprof.Handler("heap").ServeHTTP)
  865. router.HandleFunc("/debug/pprof/goroutine", pprof.Handler("goroutine").ServeHTTP)
  866. router.HandleFunc("/debug/pprof/threadcreate", pprof.Handler("threadcreate").ServeHTTP)
  867. }
  868. func createRouter(srv *Server, logging, enableCors bool) (*mux.Router, error) {
  869. r := mux.NewRouter()
  870. if os.Getenv("DEBUG") != "" {
  871. AttachProfiler(r)
  872. }
  873. m := map[string]map[string]HttpApiFunc{
  874. "GET": {
  875. "/events": getEvents,
  876. "/info": getInfo,
  877. "/version": getVersion,
  878. "/images/json": getImagesJSON,
  879. "/images/viz": getImagesViz,
  880. "/images/search": getImagesSearch,
  881. "/images/{name:.*}/get": getImagesGet,
  882. "/images/{name:.*}/history": getImagesHistory,
  883. "/images/{name:.*}/json": getImagesByName,
  884. "/containers/ps": getContainersJSON,
  885. "/containers/json": getContainersJSON,
  886. "/containers/{name:.*}/export": getContainersExport,
  887. "/containers/{name:.*}/changes": getContainersChanges,
  888. "/containers/{name:.*}/json": getContainersByName,
  889. "/containers/{name:.*}/top": getContainersTop,
  890. "/containers/{name:.*}/attach/ws": wsContainersAttach,
  891. },
  892. "POST": {
  893. "/auth": postAuth,
  894. "/commit": postCommit,
  895. "/build": postBuild,
  896. "/images/create": postImagesCreate,
  897. "/images/{name:.*}/insert": postImagesInsert,
  898. "/images/load": postImagesLoad,
  899. "/images/{name:.*}/push": postImagesPush,
  900. "/images/{name:.*}/tag": postImagesTag,
  901. "/containers/create": postContainersCreate,
  902. "/containers/{name:.*}/kill": postContainersKill,
  903. "/containers/{name:.*}/restart": postContainersRestart,
  904. "/containers/{name:.*}/start": postContainersStart,
  905. "/containers/{name:.*}/stop": postContainersStop,
  906. "/containers/{name:.*}/wait": postContainersWait,
  907. "/containers/{name:.*}/resize": postContainersResize,
  908. "/containers/{name:.*}/attach": postContainersAttach,
  909. "/containers/{name:.*}/copy": postContainersCopy,
  910. },
  911. "DELETE": {
  912. "/containers/{name:.*}": deleteContainers,
  913. "/images/{name:.*}": deleteImages,
  914. },
  915. "OPTIONS": {
  916. "": optionsHandler,
  917. },
  918. }
  919. for method, routes := range m {
  920. for route, fct := range routes {
  921. utils.Debugf("Registering %s, %s", method, route)
  922. // NOTE: scope issue, make sure the variables are local and won't be changed
  923. localRoute := route
  924. localFct := fct
  925. localMethod := method
  926. // build the handler function
  927. f := makeHttpHandler(srv, logging, localMethod, localRoute, localFct, enableCors)
  928. // add the new route
  929. if localRoute == "" {
  930. r.Methods(localMethod).HandlerFunc(f)
  931. } else {
  932. r.Path("/v{version:[0-9.]+}" + localRoute).Methods(localMethod).HandlerFunc(f)
  933. r.Path(localRoute).Methods(localMethod).HandlerFunc(f)
  934. }
  935. }
  936. }
  937. return r, nil
  938. }
  939. // ServeRequest processes a single http request to the docker remote api.
  940. // FIXME: refactor this to be part of Server and not require re-creating a new
  941. // router each time. This requires first moving ListenAndServe into Server.
  942. func ServeRequest(srv *Server, apiversion float64, w http.ResponseWriter, req *http.Request) error {
  943. router, err := createRouter(srv, false, true)
  944. if err != nil {
  945. return err
  946. }
  947. // Insert APIVERSION into the request as a convenience
  948. req.URL.Path = fmt.Sprintf("/v%g%s", apiversion, req.URL.Path)
  949. router.ServeHTTP(w, req)
  950. return nil
  951. }
  952. // ServeFD creates an http.Server and sets it up to serve given a socket activated
  953. // argument.
  954. func ServeFd(addr string, handle http.Handler) error {
  955. ls, e := systemd.ListenFD(addr)
  956. if e != nil {
  957. return e
  958. }
  959. chErrors := make(chan error, len(ls))
  960. // Since ListenFD will return one or more sockets we have
  961. // to create a go func to spawn off multiple serves
  962. for i := range ls {
  963. listener := ls[i]
  964. go func() {
  965. httpSrv := http.Server{Handler: handle}
  966. chErrors <- httpSrv.Serve(listener)
  967. }()
  968. }
  969. for i := 0; i < len(ls); i += 1 {
  970. err := <-chErrors
  971. if err != nil {
  972. return err
  973. }
  974. }
  975. return nil
  976. }
  977. // ListenAndServe sets up the required http.Server and gets it listening for
  978. // each addr passed in and does protocol specific checking.
  979. func ListenAndServe(proto, addr string, srv *Server, logging, enableCors bool) error {
  980. r, err := createRouter(srv, logging, enableCors)
  981. if err != nil {
  982. return err
  983. }
  984. if proto == "fd" {
  985. return ServeFd(addr, r)
  986. }
  987. if proto == "unix" {
  988. if err := syscall.Unlink(addr); err != nil && !os.IsNotExist(err) {
  989. return err
  990. }
  991. }
  992. l, err := net.Listen(proto, addr)
  993. if err != nil {
  994. return err
  995. }
  996. // Basic error and sanity checking
  997. switch proto {
  998. case "tcp":
  999. if !strings.HasPrefix(addr, "127.0.0.1") {
  1000. log.Println("/!\\ DON'T BIND ON ANOTHER IP ADDRESS THAN 127.0.0.1 IF YOU DON'T KNOW WHAT YOU'RE DOING /!\\")
  1001. }
  1002. case "unix":
  1003. if err := os.Chmod(addr, 0660); err != nil {
  1004. return err
  1005. }
  1006. groups, err := ioutil.ReadFile("/etc/group")
  1007. if err != nil {
  1008. return err
  1009. }
  1010. re := regexp.MustCompile("(^|\n)docker:.*?:([0-9]+)")
  1011. if gidMatch := re.FindStringSubmatch(string(groups)); gidMatch != nil {
  1012. gid, err := strconv.Atoi(gidMatch[2])
  1013. if err != nil {
  1014. return err
  1015. }
  1016. utils.Debugf("docker group found. gid: %d", gid)
  1017. if err := os.Chown(addr, 0, gid); err != nil {
  1018. return err
  1019. }
  1020. }
  1021. default:
  1022. return fmt.Errorf("Invalid protocol format.")
  1023. }
  1024. httpSrv := http.Server{Addr: addr, Handler: r}
  1025. return httpSrv.Serve(l)
  1026. }