pkg/stringid: deprecate ValidateID

thaJeztah · thaJeztah · commit e19e6cf7f452 · 2024-06-15T15:34:38.000+02:00
This function is only used for the legacy v1 image format.

Deprecate the function, and make image/v1 self-contained.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/image/v1/imagev1.go b/image/v1/imagev1.go
@@ -3,20 +3,27 @@ package v1 // import "github.com/docker/docker/image/v1"
 import (
 	"context"
 	"encoding/json"
+	"errors"
+	"regexp"
 	"strings"
 
 	"github.com/containerd/log"
 	"github.com/docker/docker/api/types/versions"
 	"github.com/docker/docker/image"
 	"github.com/docker/docker/layer"
-	"github.com/docker/docker/pkg/stringid"
 	"github.com/opencontainers/go-digest"
 )
 
-// noFallbackMinVersion is the minimum version for which v1compatibility
-// information will not be marshaled through the Image struct to remove
-// blank fields.
-const noFallbackMinVersion = "1.8.3"
+const (
+	// noFallbackMinVersion is the minimum version for which v1compatibility
+	// information will not be marshaled through the Image struct to remove
+	// blank fields.
+	noFallbackMinVersion = "1.8.3"
+
+	fullLen = 64
+)
+
+var validHex = regexp.MustCompile(`^[a-f0-9]{64}$`)
 
 // HistoryFromConfig creates a History struct from v1 configuration JSON
 func HistoryFromConfig(imageJSON []byte, emptyLayer bool) (image.History, error) {
@@ -116,5 +123,11 @@ func rawJSON(value interface{}) *json.RawMessage {
 
 // ValidateID checks whether an ID string is a valid image ID.
 func ValidateID(id string) error {
-	return stringid.ValidateID(id)
+	if len(id) != fullLen {
+		return errors.New("image ID '" + id + "' is invalid")
+	}
+	if !validHex.MatchString(id) {
+		return errors.New("image ID '" + id + "' is invalid")
+	}
+	return nil
 }
diff --git a/pkg/stringid/stringid.go b/pkg/stringid/stringid.go
@@ -62,6 +62,8 @@ func GenerateRandomID() string {
 }
 
 // ValidateID checks whether an ID string is a valid, full-length image ID.
+//
+// Deprecated: use [github.com/docker/docker/image/v1.ValidateID] instead. Will be removed in the next release.
 func ValidateID(id string) error {
 	if len(id) != fullLen {
 		return errors.New("image ID '" + id + "' is invalid")

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,8 @@ func GenerateRandomID() string {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`// ValidateID checks whether an ID string is a valid, full-length image ID.`
	`65`	`+//`
	`66`	`+// Deprecated: use [github.com/docker/docker/image/v1.ValidateID] instead. Will be removed in the next release.`
`65`	`67`	`func ValidateID(id string) error {`
`66`	`68`	`if len(id) != fullLen {`
`67`	`69`	`return errors.New("image ID '" + id + "' is invalid")`