api.go 34 KB

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