mirror of
https://github.com/moby/moby.git
synced 2026-07-11 18:13:57 +00:00
329b2a26f3
In situations where an empty ID was passed, the client would construct an
invalid API endpoint URL, which either resulted in the "not found" handler
being hit (resulting in a "page not found" error), or even the wrong endpoint
being hit if the client follows redirects.
For example, `/containers/<empty id>/json` (inspect) redirects to `/containers/json`
(docker ps))
Given that empty IDs should never be expected (especially if they're part of
the API URL path), we can validate these and return early.
Its worth noting that a few methods already had an error in place; those
methods were related to the situation mentioned above, where (e.g.) an
"inspect" would redirect to a "list" endpoint. The existing errors, for
convenience, mimicked a "not found" error; this patch changes such errors
to an "Invalid Parameter" instead, which is more correct, but it could be
a breaking change for some edge cases where users parsed the output;
git grep 'objectNotFoundError{'
client/config_inspect.go: return swarm.Config{}, nil, objectNotFoundError{object: "config", id: id}
client/container_inspect.go: return container.InspectResponse{}, nil, objectNotFoundError{object: "container", id: containerID}
client/container_inspect.go: return container.InspectResponse{}, objectNotFoundError{object: "container", id: containerID}
client/distribution_inspect.go: return distributionInspect, objectNotFoundError{object: "distribution", id: imageRef}
client/image_inspect.go: return image.InspectResponse{}, nil, objectNotFoundError{object: "image", id: imageID}
client/network_inspect.go: return network.Inspect{}, nil, objectNotFoundError{object: "network", id: networkID}
client/node_inspect.go: return swarm.Node{}, nil, objectNotFoundError{object: "node", id: nodeID}
client/plugin_inspect.go: return nil, nil, objectNotFoundError{object: "plugin", id: name}
client/secret_inspect.go: return swarm.Secret{}, nil, objectNotFoundError{object: "secret", id: id}
client/service_inspect.go: return swarm.Service{}, nil, objectNotFoundError{object: "service", id: serviceID}
client/task_inspect.go: return swarm.Task{}, nil, objectNotFoundError{object: "task", id: taskID}
client/volume_inspect.go: return volume.Volume{}, nil, objectNotFoundError{object: "volume", id: volumeID}
Two such errors are still left, as "ID or name" would probably be confusing,
but perhaps we can use a more generic error to include those as well (e.g.
"invalid <object> reference: value is empty");
client/distribution_inspect.go: return distributionInspect, objectNotFoundError{object: "distribution", id: imageRef}
client/image_inspect.go: return image.InspectResponse{}, nil, objectNotFoundError{object: "image", id: imageID}
Before this patch:
docker container start ""
Error response from daemon: page not found
Error: failed to start containers:
docker container start " "
Error response from daemon: No such container:
Error: failed to start containers:
With this patch:
docker container start ""
invalid container name or ID: value is empty
Error: failed to start containers:
docker container start " "
invalid container name or ID: value is empty
Error: failed to start containers:
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
97 lines
2.4 KiB
Go
97 lines
2.4 KiB
Go
package client // import "github.com/docker/docker/client"
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
|
|
"github.com/docker/docker/api/types/filters"
|
|
"github.com/docker/docker/errdefs"
|
|
"github.com/docker/docker/internal/lazyregexp"
|
|
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
|
|
)
|
|
|
|
var headerRegexp = lazyregexp.New(`\ADocker/.+\s\((.+)\)\z`)
|
|
|
|
type emptyIDError string
|
|
|
|
func (e emptyIDError) InvalidParameter() {}
|
|
|
|
func (e emptyIDError) Error() string {
|
|
return "invalid " + string(e) + " name or ID: value is empty"
|
|
}
|
|
|
|
// trimID trims the given object-ID / name, returning an error if it's empty.
|
|
func trimID(objType, id string) (string, error) {
|
|
id = strings.TrimSpace(id)
|
|
if len(id) == 0 {
|
|
return "", emptyIDError(objType)
|
|
}
|
|
return id, nil
|
|
}
|
|
|
|
// getDockerOS returns the operating system based on the server header from the daemon.
|
|
func getDockerOS(serverHeader string) string {
|
|
var osType string
|
|
matches := headerRegexp.FindStringSubmatch(serverHeader)
|
|
if len(matches) > 0 {
|
|
osType = matches[1]
|
|
}
|
|
return osType
|
|
}
|
|
|
|
// getFiltersQuery returns a url query with "filters" query term, based on the
|
|
// filters provided.
|
|
func getFiltersQuery(f filters.Args) (url.Values, error) {
|
|
query := url.Values{}
|
|
if f.Len() > 0 {
|
|
filterJSON, err := filters.ToJSON(f)
|
|
if err != nil {
|
|
return query, err
|
|
}
|
|
query.Set("filters", filterJSON)
|
|
}
|
|
return query, nil
|
|
}
|
|
|
|
// encodePlatforms marshals the given platform(s) to JSON format, to
|
|
// be used for query-parameters for filtering / selecting platforms.
|
|
func encodePlatforms(platform ...ocispec.Platform) ([]string, error) {
|
|
if len(platform) == 0 {
|
|
return []string{}, nil
|
|
}
|
|
if len(platform) == 1 {
|
|
p, err := encodePlatform(&platform[0])
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return []string{p}, nil
|
|
}
|
|
|
|
seen := make(map[string]struct{}, len(platform))
|
|
out := make([]string, 0, len(platform))
|
|
for i := range platform {
|
|
p, err := encodePlatform(&platform[i])
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if _, ok := seen[p]; !ok {
|
|
out = append(out, p)
|
|
seen[p] = struct{}{}
|
|
}
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// encodePlatform marshals the given platform to JSON format, to
|
|
// be used for query-parameters for filtering / selecting platforms. It
|
|
// is used as a helper for encodePlatforms,
|
|
func encodePlatform(platform *ocispec.Platform) (string, error) {
|
|
p, err := json.Marshal(platform)
|
|
if err != nil {
|
|
return "", errdefs.InvalidParameter(fmt.Errorf("invalid platform: %v", err))
|
|
}
|
|
return string(p), nil
|
|
}
|