Merge pull request #237 from WaberZhuang/main

[feat] convertor: support cert & reproduce TurboOCI

cmd/convertor/builder/builder.go

@@ -18,8 +18,16 @@ package builder
 
 import (
 	"context"
+	"crypto/tls"
+	"crypto/x509"
 	"fmt"
+	"net"
+	"net/http"
+	"os"
+	"path/filepath"
+	"runtime"
 	"strings"
+	"time"
 
 	"github.com/containerd/accelerated-container-image/cmd/convertor/database"
 	"github.com/containerd/containerd/reference"
@@ -44,6 +52,7 @@ type BuilderOptions struct {
 	Mkfs      bool
 	DB        database.ConversionDatabase
 	Engine    BuilderEngineType
+	CertOption
 }
 
 type overlaybdBuilder struct {
@@ -53,6 +62,23 @@ type overlaybdBuilder struct {
 }
 
 func NewOverlayBDBuilder(ctx context.Context, opt BuilderOptions) (Builder, error) {
+	tlsConfig, err := loadTLSConfig(opt.CertOption)
+	if err != nil {
+		return nil, fmt.Errorf("failed to load certifications: %w", err)
+	}
+	transport := &http.Transport{
+		DialContext: (&net.Dialer{
+			Timeout:       30 * time.Second,
+			KeepAlive:     30 * time.Second,
+			FallbackDelay: 300 * time.Millisecond,
+		}).DialContext,
+		MaxConnsPerHost:       32, // max http concurrency
+		MaxIdleConns:          32,
+		IdleConnTimeout:       30 * time.Second,
+		TLSHandshakeTimeout:   10 * time.Second,
+		TLSClientConfig:       tlsConfig,
+		ExpectContinueTimeout: 5 * time.Second,
+	}
 	resolver := docker.NewResolver(docker.ResolverOptions{
 		Credentials: func(s string) (string, string, error) {
 			if i := strings.IndexByte(opt.Auth, ':'); i > 0 {
@@ -61,6 +87,9 @@ func NewOverlayBDBuilder(ctx context.Context, opt BuilderOptions) (Builder, erro
 			return "", "", nil
 		},
 		PlainHTTP: opt.PlainHTTP,
+		Client: &http.Client{
+			Transport: transport,
+		},
 	})
 	engineBase, err := getBuilderEngineBase(ctx, resolver, opt.Ref, opt.TargetRef)
 	if err != nil {
@@ -213,3 +242,77 @@ func waitForChannel(ctx context.Context, ch <-chan error) {
 	case <-ch:
 	}
 }
+
+// -------------------- certification --------------------
+type CertOption struct {
+	CertDirs    []string
+	RootCAs     []string
+	ClientCerts []string
+	Insecure    bool
+}
+
+func loadTLSConfig(opt CertOption) (*tls.Config, error) {
+	type clientCertPair struct {
+		certFile string
+		keyFile  string
+	}
+	var clientCerts []clientCertPair
+	// client certs from option `--client-cert`
+	for _, cert := range opt.ClientCerts {
+		s := strings.Split(cert, ":")
+		if len(s) != 2 {
+			return nil, fmt.Errorf("client cert %s: invalid format", cert)
+		}
+		clientCerts = append(clientCerts, clientCertPair{
+			certFile: s[0],
+			keyFile:  s[1],
+		})
+	}
+	// root CAs / client certs from option `--cert-dir`
+	for _, d := range opt.CertDirs {
+		fs, err := os.ReadDir(d)
+		if err != nil && !errors.Is(err, os.ErrNotExist) && !errors.Is(err, os.ErrPermission) {
+			return nil, fmt.Errorf("failed to read cert directory %q: %w", d, err)
+		}
+		for _, f := range fs {
+			if strings.HasSuffix(f.Name(), ".crt") {
+				opt.RootCAs = append(opt.RootCAs, filepath.Join(d, f.Name()))
+			}
+			if strings.HasSuffix(f.Name(), ".cert") {
+				clientCerts = append(clientCerts, clientCertPair{
+					certFile: filepath.Join(d, f.Name()),
+					keyFile:  filepath.Join(d, strings.TrimSuffix(f.Name(), ".cert")+".key"),
+				})
+			}
+		}
+	}
+	tlsConfig := &tls.Config{}
+	// root CAs from ENV ${SSL_CERT_FILE} and ${SSL_CERT_DIR}
+	systemPool, err := x509.SystemCertPool()
+	if err != nil {
+		if runtime.GOOS == "windows" {
+			systemPool = x509.NewCertPool()
+		} else {
+			return nil, fmt.Errorf("failed to get system cert pool: %w", err)
+		}
+	}
+	tlsConfig.RootCAs = systemPool
+	// root CAs from option `--root-ca`
+	for _, file := range opt.RootCAs {
+		b, err := os.ReadFile(file)
+		if err != nil {
+			return nil, fmt.Errorf("failed to read root CA file %q: %w", file, err)
+		}
+		tlsConfig.RootCAs.AppendCertsFromPEM(b)
+	}
+	// load client certs
+	for _, c := range clientCerts {
+		cert, err := tls.LoadX509KeyPair(c.certFile, c.keyFile)
+		if err != nil {
+			return nil, fmt.Errorf("failed to load client cert pair {%q, %q}: %w", c.certFile, c.keyFile, err)
+		}
+		tlsConfig.Certificates = append(tlsConfig.Certificates, cert)
+	}
+	tlsConfig.InsecureSkipVerify = opt.Insecure
+	return tlsConfig, nil
+}

cmd/convertor/builder/builder_utils.go

@@ -263,7 +263,13 @@ func addFileToArchive(ctx context.Context, ftar *tar.Writer, filepath string) er
 	if err != nil {
 		return err
 	}
-	if err = ftar.WriteHeader(header); err != nil {
+	// remove timestamp for consistency
+	if err = ftar.WriteHeader(&tar.Header{
+		Name:     header.Name,
+		Mode:     header.Mode,
+		Size:     header.Size,
+		Typeflag: header.Typeflag,
+	}); err != nil {
 		return err
 	}
 	_, err = io.Copy(ftar, file)

cmd/convertor/main.go

@@ -46,6 +46,12 @@ var (
 	dbstr     string
 	dbType    string
 
+	// certification
+	certDirs    []string
+	rootCAs     []string
+	clientCerts []string
+	insecure    bool
+
 	rootCmd = &cobra.Command{
 		Use:   "convertor",
 		Short: "An image conversion tool from oci image to overlaybd image.",
@@ -77,6 +83,12 @@ var (
 				WorkDir:   dir,
 				OCI:       oci,
 				Mkfs:      mkfs,
+				CertOption: builder.CertOption{
+					CertDirs:    certDirs,
+					RootCAs:     rootCAs,
+					ClientCerts: clientCerts,
+					Insecure:    insecure,
+				},
 			}
 			if overlaybd != "" {
 				logrus.Info("building [Overlaybd - Native]  image...")
@@ -148,6 +160,12 @@ func init() {
 	rootCmd.Flags().StringVar(&dbstr, "db-str", "", "db str for overlaybd conversion")
 	rootCmd.Flags().StringVar(&dbType, "db-type", "", "type of db to use for conversion deduplication. Available: mysql. Default none")
 
+	// certification
+	rootCmd.Flags().StringArrayVar(&certDirs, "cert-dir", nil, "In these directories, root CA should be named as *.crt and client cert should be named as *.cert, *.key")
+	rootCmd.Flags().StringArrayVar(&rootCAs, "root-ca", nil, "root CA certificates")
+	rootCmd.Flags().StringArrayVar(&clientCerts, "client-cert", nil, "client cert certificates, should form in ${cert-file}:${key-file}")
+	rootCmd.Flags().BoolVarP(&insecure, "insecure", "", false, "don't verify the server's certificate chain and host name")
+
 	rootCmd.MarkFlagRequired("repository")
 	rootCmd.MarkFlagRequired("input-tag")
 }

docs/USERSPACE_CONVERTOR.md

@@ -34,21 +34,25 @@ Usage:
   convertor [flags]
 
 Flags:
-  -r, --repository string   repository for converting image (required)
-  -u, --username string     user[:password] Registry user and password
-      --plain               connections using plain HTTP
-      --verbose             show debug log
-  -i, --input-tag string    tag for image converting from (required)
-  -o, --output-tag string   tag for image converting to
-  -d, --dir string          directory used for temporary data (default "tmp_conv")
-      --oci                 export image with oci spec
-      --mkfs                make ext4 fs in bottom layer (default true)
-      --fastoci string      build 'Overlaybd-Turbo OCIv1' format (old name of turboOCIv1. deprecated)
-      --turboOCI string     build 'Overlaybd-Turbo OCIv1' format
-      --overlaybd string    build overlaybd format
-      --db-str string       db str for overlaybd conversion
-      --db-type string      type of db to use for conversion deduplication. Available: mysql. Default none
-  -h, --help                help for convertor
+  -r, --repository string         repository for converting image (required)
+  -u, --username string           user[:password] Registry user and password
+      --plain                     connections using plain HTTP
+      --verbose                   show debug log
+  -i, --input-tag string          tag for image converting from (required)
+  -o, --output-tag string         tag for image converting to
+  -d, --dir string                directory used for temporary data (default "tmp_conv")
+      --oci                       export image with oci spec
+      --mkfs                      make ext4 fs in bottom layer (default true)
+      --fastoci string            build 'Overlaybd-Turbo OCIv1' format (old name of turboOCIv1. deprecated)
+      --turboOCI string           build 'Overlaybd-Turbo OCIv1' format
+      --overlaybd string          build overlaybd format
+      --db-str string             db str for overlaybd conversion
+      --db-type string            type of db to use for conversion deduplication. Available: mysql. Default none
+      --cert-dir stringArray      In these directories, root CA should be named as *.crt and client cert should be named as *.cert, *.key
+      --root-ca stringArray       root CA certificates
+      --client-cert stringArray   client cert certificates, should form in ${cert-file}:${key-file}
+      --insecure                  don't verify the server's certificate chain and host name
+  -h, --help                      help for convertor
 
 # examples
 $ bin/convertor -r docker.io/overlaybd/redis -u user:pass -i 6.2.6 -o 6.2.6_obd