Transfer: Registry: Enable plain HTTP

ktock · ktock · commit 433279438425 · 2024-04-03T10:46:10.000+09:00
Currenlty transfer service doesn't handle plain HTTP connection.
This commit fixes this issue by propagating
`(core/remotes/docker/config).HostOptions.DefaultScheme` from client to the
transfer service.
This commit also fixes ctr to use this feature for "--plain-http" flag.

Signed-off-by: Kohei Tokunaga &lt;ktokunaga.mail@gmail.com&gt;
diff --git a/api/next.pb.txt b/api/next.pb.txt
@@ -7468,6 +7468,13 @@ file {
       type: TYPE_STRING
       json_name: "hostDir"
     }
+    field {
+      name: "default_scheme"
+      number: 4
+      label: LABEL_OPTIONAL
+      type: TYPE_STRING
+      json_name: "defaultScheme"
+    }
     nested_type {
       name: "HeadersEntry"
       field {
diff --git a/api/types/transfer/registry.pb.go b/api/types/transfer/registry.pb.go
diff --git a/api/types/transfer/registry.proto b/api/types/transfer/registry.proto
@@ -36,8 +36,9 @@ message RegistryResolver {
 	map<string, string> headers = 2;
 
 	string host_dir = 3;
+
+	string default_scheme = 4;
 	// Force skip verify
-	// Force HTTP
 	// CA callback? Client TLS callback?
 }
 
diff --git a/cmd/ctr/commands/images/pull.go b/cmd/ctr/commands/images/pull.go
@@ -132,7 +132,11 @@ command. As part of this process, we do the following:
 				sopts = append(sopts, image.WithAllMetadata)
 			}
 
-			reg, err := registry.NewOCIRegistry(ctx, ref, registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir")))
+			opts := []registry.Opt{registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir"))}
+			if context.Bool("plain-http") {
+				opts = append(opts, registry.WithDefaultScheme("http"))
+			}
+			reg, err := registry.NewOCIRegistry(ctx, ref, opts...)
 			if err != nil {
 				return err
 			}
diff --git a/cmd/ctr/commands/images/push.go b/cmd/ctr/commands/images/push.go
@@ -104,7 +104,11 @@ var pushCommand = &cli.Command{
 			if local == "" {
 				local = ref
 			}
-			reg, err := registry.NewOCIRegistry(ctx, ref, registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir")))
+			opts := []registry.Opt{registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir"))}
+			if context.Bool("plain-http") {
+				opts = append(opts, registry.WithDefaultScheme("http"))
+			}
+			reg, err := registry.NewOCIRegistry(ctx, ref, opts...)
 			if err != nil {
 				return err
 			}
diff --git a/core/transfer/registry/registry.go b/core/transfer/registry/registry.go
@@ -44,9 +44,10 @@ func init() {
 }
 
 type registryOpts struct {
-	headers http.Header
-	creds   CredentialHelper
-	hostDir string
+	headers       http.Header
+	creds         CredentialHelper
+	hostDir       string
+	defaultScheme string
 }
 
 // Opt sets registry-related configurations.
@@ -76,6 +77,14 @@ func WithHostDir(hostDir string) Opt {
 	}
 }
 
+// WithDefaultScheme specifies the default scheme for registry configuration
+func WithDefaultScheme(s string) Opt {
+	return func(o *registryOpts) error {
+		o.defaultScheme = s
+		return nil
+	}
+}
+
 // NewOCIRegistry initializes with hosts, authorizer callback, and headers
 func NewOCIRegistry(ctx context.Context, ref string, opts ...Opt) (*OCIRegistry, error) {
 	var ropts registryOpts
@@ -99,16 +108,20 @@ func NewOCIRegistry(ctx context.Context, ref string, opts ...Opt) (*OCIRegistry,
 			return c.Username, c.Secret, nil
 		}
 	}
+	if ropts.defaultScheme != "" {
+		hostOptions.DefaultScheme = ropts.defaultScheme
+	}
 	resolver := docker.NewResolver(docker.ResolverOptions{
 		Hosts:   config.ConfigureHosts(ctx, hostOptions),
 		Headers: ropts.headers,
 	})
 	return &OCIRegistry{
-		reference: ref,
-		headers:   ropts.headers,
-		creds:     ropts.creds,
-		resolver:  resolver,
-		hostDir:   ropts.hostDir,
+		reference:     ref,
+		headers:       ropts.headers,
+		creds:         ropts.creds,
+		resolver:      resolver,
+		hostDir:       ropts.hostDir,
+		defaultScheme: ropts.defaultScheme,
 	}, nil
 }
 
@@ -135,6 +148,8 @@ type OCIRegistry struct {
 
 	hostDir string
 
+	defaultScheme string
+
 	// This could be an interface which returns resolver?
 	// Resolver could also be a plug-able interface, to call out to a program to fetch?
 }
@@ -234,6 +249,7 @@ func (r *OCIRegistry) MarshalAny(ctx context.Context, sm streaming.StreamCreator
 		res.AuthStream = sid
 	}
 	res.HostDir = r.hostDir
+	res.DefaultScheme = r.defaultScheme
 	s := &transfertypes.OCIRegistry{
 		Reference: r.reference,
 		Resolver:  res,
@@ -253,6 +269,9 @@ func (r *OCIRegistry) UnmarshalAny(ctx context.Context, sm streaming.StreamGette
 		if s.Resolver.HostDir != "" {
 			hostOptions.HostDir = config.HostDirFromRoot(s.Resolver.HostDir)
 		}
+		if s.Resolver.DefaultScheme != "" {
+			hostOptions.DefaultScheme = s.Resolver.DefaultScheme
+		}
 		if sid := s.Resolver.AuthStream; sid != "" {
 			stream, err := sm.Get(ctx, sid)
 			if err != nil {

Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,9 @@ message RegistryResolver {`
`36`	`36`	`map<string, string> headers = 2;`
`37`	`37`
`38`	`38`	`string host_dir = 3;`
	`39`	`+`
	`40`	`+ string default_scheme = 4;`
`39`	`41`	`// Force skip verify`
`40`		`- // Force HTTP`
`41`	`42`	`// CA callback? Client TLS callback?`
`42`	`43`	`}`
`43`	`44`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,11 @@ command. As part of this process, we do the following:`
`132`	`132`	`sopts = append(sopts, image.WithAllMetadata)`
`133`	`133`	`}`
`134`	`134`
`135`		`- reg, err := registry.NewOCIRegistry(ctx, ref, registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir")))`
	`135`	`+ opts := []registry.Opt{registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir"))}`
	`136`	`+ if context.Bool("plain-http") {`
	`137`	`+ opts = append(opts, registry.WithDefaultScheme("http"))`
	`138`	`+ }`
	`139`	`+ reg, err := registry.NewOCIRegistry(ctx, ref, opts...)`
`136`	`140`	`if err != nil {`
`137`	`141`	`return err`
`138`	`142`	`}`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,11 @@ var pushCommand = &cli.Command{`
`104`	`104`	`if local == "" {`
`105`	`105`	`local = ref`
`106`	`106`	`}`
`107`		`- reg, err := registry.NewOCIRegistry(ctx, ref, registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir")))`
	`107`	`+ opts := []registry.Opt{registry.WithCredentials(ch), registry.WithHostDir(context.String("hosts-dir"))}`
	`108`	`+ if context.Bool("plain-http") {`
	`109`	`+ opts = append(opts, registry.WithDefaultScheme("http"))`
	`110`	`+ }`
	`111`	`+ reg, err := registry.NewOCIRegistry(ctx, ref, opts...)`
`108`	`112`	`if err != nil {`
`109`	`113`	`return err`
`110`	`114`	`}`