mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
01f9227ec9
Commit e98e4a7111 implemented API version
negotiation using the `/_ping` endpoint. In that change, URL validation for the
maximum supported API version was removed from the API server (validation for
the _minimum_ version was kept in place).
With this feature, clients that support version negotiation would negotiate the
maximum version supported by the daemon, and downgrade to an older API version
if the client's default API version is not supported.
However, clients that do _not_ support version negotiation can call API versions
that are higher than the maximum supported version. Due to the missing version
check, this is silently ignored, and the daemon's default API version is used.
This is a problem, because the actual API version in use is non-deterministic;
for example, calling `/v9999.9999/version` on a daemon that runs API v1.34 will
use API v1.34, but calling the same URL on an older daemon may use API version
v1.24.
This patch reverts the removal of the API check for maximum supported versions.
The documentation has been updated accordingly
Before this patch is applied, the daemon returns a 200 (success):
$ curl -v --unix-socket /var/run/docker.sock http://localhost/v9999.9999/version
* Trying /var/run/docker.sock...
* Connected to localhost (/Users/sebastiaan/Library/Containers/com.dock) port 80 (#0)
> GET /v9999.9999/version HTTP/1.1
> Host: localhost
> User-Agent: curl/7.54.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Api-Version: 1.32
< Content-Length: 240
< Content-Type: application/json
< Date: Tue, 10 Oct 2017 09:11:29 GMT
< Docker-Experimental: true
< Ostype: linux
< Server: Docker/17.09.0-ce (linux)
<
{"Version":"17.09.0-ce","ApiVersion":"1.32","MinAPIVersion":"1.12","GitCommit":"afdb6d4","GoVersion":"go1.8.3","Os":"linux","Arch":"amd64","KernelVersion":"4.9.49-moby","Experimental":true,"BuildTime":"2017-09-26T22:45:38.000000000+00:00"}
* Connection #0 to host localhost left intact
After this patch is applied, a 400 (Bad Request) is returned:
$ curl -v --unix-socket /var/run/docker.sock http://localhost/v9999.9999/version
* Trying /var/run/docker.sock...
* Connected to localhost (/var/run/docker.sock) port 80 (#0)
> GET /v9999.9999/info HTTP/1.1
> Host: localhost
> User-Agent: curl/7.52.1
> Accept: */*
>
< HTTP/1.1 400 Bad Request
< Content-Type: application/json
< Date: Tue, 10 Oct 2017 08:08:34 GMT
< Content-Length: 89
<
{"message":"client version 9999.9999 is too new. Maximim supported API version is 1.34"}
* Curl_http_done: called premature == 0
* Connection #0 to host localhost left intact
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
82 lines
2.4 KiB
Go
82 lines
2.4 KiB
Go
package middleware
|
|
|
|
import (
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/docker/docker/api/server/httputils"
|
|
"golang.org/x/net/context"
|
|
)
|
|
|
|
func TestVersionMiddleware(t *testing.T) {
|
|
handler := func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
if httputils.VersionFromContext(ctx) == "" {
|
|
t.Fatal("Expected version, got empty string")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
defaultVersion := "1.10.0"
|
|
minVersion := "1.2.0"
|
|
m := NewVersionMiddleware(defaultVersion, defaultVersion, minVersion)
|
|
h := m.WrapHandler(handler)
|
|
|
|
req, _ := http.NewRequest("GET", "/containers/json", nil)
|
|
resp := httptest.NewRecorder()
|
|
ctx := context.Background()
|
|
if err := h(ctx, resp, req, map[string]string{}); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func TestVersionMiddlewareVersionTooOld(t *testing.T) {
|
|
handler := func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
if httputils.VersionFromContext(ctx) == "" {
|
|
t.Fatal("Expected version, got empty string")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
defaultVersion := "1.10.0"
|
|
minVersion := "1.2.0"
|
|
m := NewVersionMiddleware(defaultVersion, defaultVersion, minVersion)
|
|
h := m.WrapHandler(handler)
|
|
|
|
req, _ := http.NewRequest("GET", "/containers/json", nil)
|
|
resp := httptest.NewRecorder()
|
|
ctx := context.Background()
|
|
|
|
vars := map[string]string{"version": "0.1"}
|
|
err := h(ctx, resp, req, vars)
|
|
|
|
if !strings.Contains(err.Error(), "client version 0.1 is too old. Minimum supported API version is 1.2.0") {
|
|
t.Fatalf("Expected too old client error, got %v", err)
|
|
}
|
|
}
|
|
|
|
func TestVersionMiddlewareVersionTooNew(t *testing.T) {
|
|
handler := func(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
if httputils.VersionFromContext(ctx) == "" {
|
|
t.Fatal("Expected version, got empty string")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
defaultVersion := "1.10.0"
|
|
minVersion := "1.2.0"
|
|
m := NewVersionMiddleware(defaultVersion, defaultVersion, minVersion)
|
|
h := m.WrapHandler(handler)
|
|
|
|
req, _ := http.NewRequest("GET", "/containers/json", nil)
|
|
resp := httptest.NewRecorder()
|
|
ctx := context.Background()
|
|
|
|
vars := map[string]string{"version": "9999.9999"}
|
|
err := h(ctx, resp, req, vars)
|
|
|
|
if !strings.Contains(err.Error(), "client version 9999.9999 is too new. Maximum supported API version is 1.10.0") {
|
|
t.Fatalf("Expected too new client error, got %v", err)
|
|
}
|
|
}
|