containerify 3.0.0 → 3.0.1

package/lib/cli.js

@@ -235,7 +235,7 @@ function run(options) {
         const todir = yield (0, fileutil_1.ensureEmptyDir)(path.join(tmpdir, "to"));
         const allowInsecure = options.allowInsecureRegistries ? types_1.InsecureRegistrySupport.YES : types_1.InsecureRegistrySupport.NO;
         const fromRegistryUrl = (_a = options.fromRegistry) !== null && _a !== void 0 ? _a : registry_1.DEFAULT_DOCKER_REGISTRY;
-        const fromRegistry = (0, registry_1.createRegistry)(fromRegistryUrl, yield (0, registry_1.processToken)(fromRegistryUrl, allowInsecure, options.fromImage, options.fromToken), allowInsecure);
+        const fromRegistry = yield (0, registry_1.createRegistry)(fromRegistryUrl, options.fromImage, allowInsecure, options.fromToken);
         const originalManifest = yield fromRegistry.download(options.fromImage, fromdir, (0, utils_1.getPreferredPlatform)(options.platform), options.layerCacheFolder);
         yield appLayerCreator_1.default.addLayers(tmpdir, fromdir, todir, options);
         if (options.toDocker) {
@@ -250,7 +250,10 @@ function run(options) {
             yield tarExporter_1.default.saveToTar(todir, tmpdir, options.toTar, [options.toImage], options);
         }
         if (options.toRegistry) {
-            const toRegistry = (0, registry_1.createRegistry)(options.toRegistry, yield (0, registry_1.processToken)(options.toRegistry, allowInsecure, options.toImage, options.toToken), allowInsecure, options.optimisticToRegistryCheck);
+            if (!options.token && allowInsecure == types_1.InsecureRegistrySupport.NO) {
+                throw new Error("Need auth token to upload to " + options.toRegistry);
+            }
+            const toRegistry = yield (0, registry_1.createRegistry)(options.toRegistry, options.toImage, allowInsecure, options.toToken, options.optimisticToRegistryCheck);
             yield toRegistry.upload(options.toImage, todir, options.doCrossMount, originalManifest, options.fromImage);
         }
         logger_1.default.debug("Deleting " + tmpdir + " ...");

package/lib/registry.d.ts

@@ -1,6 +1,5 @@
 import { InsecureRegistrySupport, Registry } from "./types";
-export declare function processToken(registryBaseUrl: string, allowInsecure: InsecureRegistrySupport, imagePath: string, token?: string): Promise<string>;
-export declare function createRegistry(registryBaseUrl: string, auth: string, allowInsecure: InsecureRegistrySupport, optimisticToRegistryCheck?: boolean): Registry;
+export declare function createRegistry(registryBaseUrl: string, imagePath: string, allowInsecure: InsecureRegistrySupport, auth?: string, optimisticToRegistryCheck?: boolean): Promise<Registry>;
 export declare const DEFAULT_DOCKER_REGISTRY = "https://registry-1.docker.io/v2/";
 export declare function parseFullImageUrl(imageStr: string): {
     registry: string;

package/lib/registry.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseFullImageUrl = exports.DEFAULT_DOCKER_REGISTRY = exports.createRegistry = exports.processToken = void 0;
+exports.parseFullImageUrl = exports.DEFAULT_DOCKER_REGISTRY = exports.createRegistry = void 0;
 const URL = require("url");
 const fss = require("fs");
 const fs_1 = require("fs");
@@ -140,7 +140,7 @@ function processToken(registryBaseUrl, allowInsecure, imagePath, token) {
             return `Bearer ${resp.token}`;
         }
         if (!token)
-            throw new Error("Needs auth token to upload to " + registryBaseUrl);
+            return ""; //We allow to pull from tokenless registries
         if (token.startsWith("Basic "))
             return token;
         if (token.startsWith("ghp_"))
@@ -148,181 +148,183 @@ function processToken(registryBaseUrl, allowInsecure, imagePath, token) {
         return "Bearer " + token;
     });
 }
-exports.processToken = processToken;
-function createRegistry(registryBaseUrl, auth, allowInsecure, optimisticToRegistryCheck = false) {
-    function exists(image, layer) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `${registryBaseUrl}${image.path}/blobs/${layer.digest}`;
-            return yield checkIfLayerExists(url, (0, httpRequest_1.buildHeaders)(layer.mediaType, auth), allowInsecure, optimisticToRegistryCheck, 0);
-        });
-    }
-    function uploadLayerContent(uploadUrl, layer, dir) {
-        return __awaiter(this, void 0, void 0, function* () {
-            logger_1.default.info(layer.digest);
-            const file = path.join(dir, (0, utils_1.getHash)(layer.digest) + (0, utils_1.getLayerTypeFileEnding)(layer));
-            yield uploadContent(uploadUrl, file, layer, allowInsecure, auth);
-        });
-    }
-    function getUploadUrl(image, mountParameters = undefined) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new Promise((resolve, reject) => {
-                const parameters = new URLSearchParams(mountParameters);
-                const url = `${registryBaseUrl}${image.path}/blobs/uploads/${parameters.size > 0 ? "?" + parameters : ""}`;
-                const options = URL.parse(url);
-                options.method = "POST";
-                options.headers = { authorization: auth };
-                (0, httpRequest_1.request)(options, allowInsecure, (res) => {
-                    logger_1.default.debug("POST", `${url}`, res.statusCode);
-                    if (res.statusCode == 202) {
-                        const { location } = res.headers;
-                        if (location) {
-                            if (location.startsWith("http")) {
-                                resolve({ uploadUrl: location });
+function createRegistry(registryBaseUrl, imagePath, allowInsecure, auth, optimisticToRegistryCheck = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const token = yield processToken(registryBaseUrl, allowInsecure, imagePath, auth);
+        function exists(image, layer) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const url = `${registryBaseUrl}${image.path}/blobs/${layer.digest}`;
+                return yield checkIfLayerExists(url, (0, httpRequest_1.buildHeaders)(layer.mediaType, token), allowInsecure, optimisticToRegistryCheck, 0);
+            });
+        }
+        function uploadLayerContent(uploadUrl, layer, dir) {
+            return __awaiter(this, void 0, void 0, function* () {
+                logger_1.default.info(layer.digest);
+                const file = path.join(dir, (0, utils_1.getHash)(layer.digest) + (0, utils_1.getLayerTypeFileEnding)(layer));
+                yield uploadContent(uploadUrl, file, layer, allowInsecure, token);
+            });
+        }
+        function getUploadUrl(image, mountParameters = undefined) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return new Promise((resolve, reject) => {
+                    const parameters = new URLSearchParams(mountParameters);
+                    const url = `${registryBaseUrl}${image.path}/blobs/uploads/${parameters.size > 0 ? "?" + parameters : ""}`;
+                    const options = URL.parse(url);
+                    options.method = "POST";
+                    options.headers = { authorization: auth };
+                    (0, httpRequest_1.request)(options, allowInsecure, (res) => {
+                        logger_1.default.debug("POST", `${url}`, res.statusCode);
+                        if (res.statusCode == 202) {
+                            const { location } = res.headers;
+                            if (location) {
+                                if (location.startsWith("http")) {
+                                    resolve({ uploadUrl: location });
+                                }
+                                else {
+                                    const regURL = URL.parse(registryBaseUrl);
+                                    resolve({
+                                        uploadUrl: `${regURL.protocol}//${regURL.hostname}${regURL.port ? ":" + regURL.port : ""}${location}`,
+                                    });
+                                }
                             }
-                            else {
-                                const regURL = URL.parse(registryBaseUrl);
-                                resolve({
-                                    uploadUrl: `${regURL.protocol}//${regURL.hostname}${regURL.port ? ":" + regURL.port : ""}${location}`,
-                                });
+                            reject("Missing location for 202");
+                        }
+                        else if (mountParameters && res.statusCode == 201) {
+                            const returnedDigest = res.headers["docker-content-digest"];
+                            if (returnedDigest && returnedDigest != mountParameters.mount) {
+                                reject(`ERROR: Layer mounted with wrong digest: Expected ${mountParameters.mount} but got ${returnedDigest}`);
                             }
+                            resolve({ mountSuccess: true });
                         }
-                        reject("Missing location for 202");
-                    }
-                    else if (mountParameters && res.statusCode == 201) {
-                        const returnedDigest = res.headers["docker-content-digest"];
-                        if (returnedDigest && returnedDigest != mountParameters.mount) {
-                            reject(`ERROR: Layer mounted with wrong digest: Expected ${mountParameters.mount} but got ${returnedDigest}`);
+                        else {
+                            (0, httpRequest_1.waitForResponseEnd)(res, (data) => {
+                                reject(`Error getting upload URL from ${url}. Got ${res.statusCode} ${res.statusMessage}:\n${data.toString()}`);
+                            });
                         }
-                        resolve({ mountSuccess: true });
-                    }
-                    else {
-                        (0, httpRequest_1.waitForResponseEnd)(res, (data) => {
-                            reject(`Error getting upload URL from ${url}. Got ${res.statusCode} ${res.statusMessage}:\n${data.toString()}`);
-                        });
-                    }
-                }).end();
+                    }).end();
+                });
             });
-        });
-    }
-    function dlManifest(image, preferredPlatform, allowInsecure) {
-        return __awaiter(this, void 0, void 0, function* () {
-            // Accept both manifests and index/manifest lists
-            const res = yield (0, httpRequest_1.dlJson)(`${registryBaseUrl}${image.path}/manifests/${image.tag}`, (0, httpRequest_1.buildHeaders)(`${MIMETypes_1.OCI.index}, ${MIMETypes_1.OCI.manifest}, ${MIMETypes_1.DockerV2.index}, ${MIMETypes_1.DockerV2.manifest}`, auth), allowInsecure);
-            // We've received an OCI Index or Docker Manifest List and need to find which manifest we want
-            if (res.mediaType === MIMETypes_1.OCI.index || res.mediaType === MIMETypes_1.DockerV2.index) {
-                const availableManifests = res.manifests;
-                const adequateManifest = pickManifest(availableManifests, preferredPlatform);
-                return dlManifest(Object.assign(Object.assign({}, image), { tag: adequateManifest.digest }), preferredPlatform, allowInsecure);
+        }
+        function dlManifest(image, preferredPlatform, allowInsecure) {
+            return __awaiter(this, void 0, void 0, function* () {
+                // Accept both manifests and index/manifest lists
+                const res = yield (0, httpRequest_1.dlJson)(`${registryBaseUrl}${image.path}/manifests/${image.tag}`, (0, httpRequest_1.buildHeaders)(`${MIMETypes_1.OCI.index}, ${MIMETypes_1.OCI.manifest}, ${MIMETypes_1.DockerV2.index}, ${MIMETypes_1.DockerV2.manifest}`, token), allowInsecure);
+                // We've received an OCI Index or Docker Manifest List and need to find which manifest we want
+                if (res.mediaType === MIMETypes_1.OCI.index || res.mediaType === MIMETypes_1.DockerV2.index) {
+                    const availableManifests = res.manifests;
+                    const adequateManifest = pickManifest(availableManifests, preferredPlatform);
+                    return dlManifest(Object.assign(Object.assign({}, image), { tag: adequateManifest.digest }), preferredPlatform, allowInsecure);
+                }
+                return res;
+            });
+        }
+        function pickManifest(manifests, preferredPlatform) {
+            const matchingArchitectures = new Set();
+            const matchingOSes = new Set();
+            // Find sets of matching architecture and os
+            for (const manifest of manifests) {
+                if (manifest.platform.architecture === preferredPlatform.architecture) {
+                    matchingArchitectures.add(manifest);
+                }
+                if (manifest.platform.os === preferredPlatform.os) {
+                    matchingOSes.add(manifest);
+                }
             }
-            return res;
-        });
-    }
-    function pickManifest(manifests, preferredPlatform) {
-        const matchingArchitectures = new Set();
-        const matchingOSes = new Set();
-        // Find sets of matching architecture and os
-        for (const manifest of manifests) {
-            if (manifest.platform.architecture === preferredPlatform.architecture) {
-                matchingArchitectures.add(manifest);
+            // If the intersection of matching architectures and OS is one we've found our optimal match
+            const intersection = new Set([...matchingArchitectures].filter((x) => matchingOSes.has(x)));
+            if (intersection.size == 1) {
+                return intersection.values().next().value;
             }
-            if (manifest.platform.os === preferredPlatform.os) {
-                matchingOSes.add(manifest);
+            // If we don't have a perfect match we give a warning and try the first matching architecture
+            if (matchingArchitectures.size >= 1) {
+                const matchingArch = matchingArchitectures.values().next().value;
+                logger_1.default.info(`[WARN] Preferred OS '${preferredPlatform.os}' not available.`);
+                logger_1.default.info("[WARN] Using closest available manifest:", JSON.stringify(matchingArch.platform));
+                return matchingArch;
             }
+            // If there's no image matching the wanted architecture we bail
+            logger_1.default.error(`No image matching requested architecture: '${preferredPlatform.architecture}'`);
+            logger_1.default.error("Available platforms:", JSON.stringify(manifests.map((m) => m.platform)));
+            throw new Error("No image matching requested architecture");
         }
-        // If the intersection of matching architectures and OS is one we've found our optimal match
-        const intersection = new Set([...matchingArchitectures].filter((x) => matchingOSes.has(x)));
-        if (intersection.size == 1) {
-            return intersection.values().next().value;
+        function dlConfig(image, config, allowInsecure) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return yield (0, httpRequest_1.dlJson)(`${registryBaseUrl}${image.path}/blobs/${config.digest}`, (0, httpRequest_1.buildHeaders)("*/*", token), allowInsecure);
+            });
         }
-        // If we don't have a perfect match we give a warning and try the first matching architecture
-        if (matchingArchitectures.size >= 1) {
-            const matchingArch = matchingArchitectures.values().next().value;
-            logger_1.default.info(`[WARN] Preferred OS '${preferredPlatform.os}' not available.`);
-            logger_1.default.info("[WARN] Using closest available manifest:", JSON.stringify(matchingArch.platform));
-            return matchingArch;
+        function dlLayer(image, layer, folder, allowInsecure, cacheFolder) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const file = (0, utils_1.getHash)(layer.digest) + (0, utils_1.getLayerTypeFileEnding)(layer);
+                yield dlToFile(`${registryBaseUrl}${image.path}/blobs/${layer.digest}`, path.join(folder, file), (0, httpRequest_1.buildHeaders)(layer.mediaType, token), allowInsecure, cacheFolder);
+                return file;
+            });
         }
-        // If there's no image matching the wanted architecture we bail
-        logger_1.default.error(`No image matching requested architecture: '${preferredPlatform.architecture}'`);
-        logger_1.default.error("Available platforms:", JSON.stringify(manifests.map((m) => m.platform)));
-        throw new Error("No image matching requested architecture");
-    }
-    function dlConfig(image, config, allowInsecure) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield (0, httpRequest_1.dlJson)(`${registryBaseUrl}${image.path}/blobs/${config.digest}`, (0, httpRequest_1.buildHeaders)("*/*", auth), allowInsecure);
-        });
-    }
-    function dlLayer(image, layer, folder, allowInsecure, cacheFolder) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const file = (0, utils_1.getHash)(layer.digest) + (0, utils_1.getLayerTypeFileEnding)(layer);
-            yield dlToFile(`${registryBaseUrl}${image.path}/blobs/${layer.digest}`, path.join(folder, file), (0, httpRequest_1.buildHeaders)(layer.mediaType, auth), allowInsecure, cacheFolder);
-            return file;
-        });
-    }
-    function upload(imageStr, folder, doCrossMount, originalManifest, originalRepository) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const image = (0, utils_1.parseImage)(imageStr);
-            const manifestFile = path.join(folder, "manifest.json");
-            const manifest = (yield fse.readJson(manifestFile));
-            logger_1.default.info("Checking layer status...");
-            const layerStatus = yield Promise.all(manifest.layers.map((l) => __awaiter(this, void 0, void 0, function* () {
-                return { layer: l, exists: yield exists(image, l) };
-            })));
-            const layersForUpload = layerStatus.filter((l) => !l.exists);
-            logger_1.default.debug("Needs upload:", layersForUpload.map((l) => l.layer.digest));
-            logger_1.default.info("Uploading layers...");
-            yield Promise.all(layersForUpload.map((l) => __awaiter(this, void 0, void 0, function* () {
-                if (doCrossMount && originalManifest.layers.find((x) => x.digest == l.layer.digest)) {
-                    const mount = yield getUploadUrl(image, { mount: l.layer.digest, from: originalRepository });
-                    if ("mountSuccess" in mount) {
-                        logger_1.default.info(`Cross mounted layer ${l.layer.digest} from '${originalRepository}'`);
-                        return;
+        function upload(imageStr, folder, doCrossMount, originalManifest, originalRepository) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const image = (0, utils_1.parseImage)(imageStr);
+                const manifestFile = path.join(folder, "manifest.json");
+                const manifest = (yield fse.readJson(manifestFile));
+                logger_1.default.info("Checking layer status...");
+                const layerStatus = yield Promise.all(manifest.layers.map((l) => __awaiter(this, void 0, void 0, function* () {
+                    return { layer: l, exists: yield exists(image, l) };
+                })));
+                const layersForUpload = layerStatus.filter((l) => !l.exists);
+                logger_1.default.debug("Needs upload:", layersForUpload.map((l) => l.layer.digest));
+                logger_1.default.info("Uploading layers...");
+                yield Promise.all(layersForUpload.map((l) => __awaiter(this, void 0, void 0, function* () {
+                    if (doCrossMount && originalManifest.layers.find((x) => x.digest == l.layer.digest)) {
+                        const mount = yield getUploadUrl(image, { mount: l.layer.digest, from: originalRepository });
+                        if ("mountSuccess" in mount) {
+                            logger_1.default.info(`Cross mounted layer ${l.layer.digest} from '${originalRepository}'`);
+                            return;
+                        }
+                        yield uploadLayerContent(mount.uploadUrl, l.layer, folder);
+                    }
+                    else {
+                        const url = yield getUploadUrl(image);
+                        if ("mountSuccess" in url)
+                            throw new Error("Mounting not supported for this upload");
+                        yield uploadLayerContent(url.uploadUrl, l.layer, folder);
                     }
-                    yield uploadLayerContent(mount.uploadUrl, l.layer, folder);
+                })));
+                logger_1.default.info("Uploading config...");
+                const configUploadUrl = yield getUploadUrl(image);
+                if ("mountSuccess" in configUploadUrl)
+                    throw new Error("Mounting not supported for config upload");
+                const configFile = path.join(folder, (0, utils_1.getHash)(manifest.config.digest) + ".json");
+                yield uploadContent(configUploadUrl.uploadUrl, configFile, manifest.config, allowInsecure, token);
+                logger_1.default.info("Uploading manifest...");
+                const manifestSize = yield fileutil.sizeOf(manifestFile);
+                yield uploadContent(`${registryBaseUrl}${image.path}/manifests/${image.tag}`, manifestFile, { mediaType: manifest.mediaType, size: manifestSize }, allowInsecure, token, manifest.mediaType);
+            });
+        }
+        function download(imageStr, folder, preferredPlatform, cacheFolder) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const image = (0, utils_1.parseImage)(imageStr);
+                logger_1.default.info("Downloading manifest...");
+                const manifest = yield dlManifest(image, preferredPlatform, allowInsecure);
+                yield fs_1.promises.writeFile(path.join(folder, "manifest.json"), JSON.stringify(manifest));
+                logger_1.default.info("Downloading config...");
+                const config = yield dlConfig(image, manifest.config, allowInsecure);
+                if (config.architecture != preferredPlatform.architecture) {
+                    logger_1.default.info(`[WARN] Image architecture (${config.architecture}) does not match preferred architecture (${preferredPlatform.architecture}).`);
                 }
-                else {
-                    const url = yield getUploadUrl(image);
-                    if ("mountSuccess" in url)
-                        throw new Error("Mounting not supported for this upload");
-                    yield uploadLayerContent(url.uploadUrl, l.layer, folder);
+                if (config.os != preferredPlatform.os) {
+                    logger_1.default.info(`[WARN] Image OS (${config.os}) does not match preferred OS (${preferredPlatform.os}).`);
                 }
-            })));
-            logger_1.default.info("Uploading config...");
-            const configUploadUrl = yield getUploadUrl(image);
-            if ("mountSuccess" in configUploadUrl)
-                throw new Error("Mounting not supported for config upload");
-            const configFile = path.join(folder, (0, utils_1.getHash)(manifest.config.digest) + ".json");
-            yield uploadContent(configUploadUrl.uploadUrl, configFile, manifest.config, allowInsecure, auth);
-            logger_1.default.info("Uploading manifest...");
-            const manifestSize = yield fileutil.sizeOf(manifestFile);
-            yield uploadContent(`${registryBaseUrl}${image.path}/manifests/${image.tag}`, manifestFile, { mediaType: manifest.mediaType, size: manifestSize }, allowInsecure, auth, manifest.mediaType);
-        });
-    }
-    function download(imageStr, folder, preferredPlatform, cacheFolder) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const image = (0, utils_1.parseImage)(imageStr);
-            logger_1.default.info("Downloading manifest...");
-            const manifest = yield dlManifest(image, preferredPlatform, allowInsecure);
-            yield fs_1.promises.writeFile(path.join(folder, "manifest.json"), JSON.stringify(manifest));
-            logger_1.default.info("Downloading config...");
-            const config = yield dlConfig(image, manifest.config, allowInsecure);
-            if (config.architecture != preferredPlatform.architecture) {
-                logger_1.default.info(`[WARN] Image architecture (${config.architecture}) does not match preferred architecture (${preferredPlatform.architecture}).`);
-            }
-            if (config.os != preferredPlatform.os) {
-                logger_1.default.info(`[WARN] Image OS (${config.os}) does not match preferred OS (${preferredPlatform.os}).`);
-            }
-            yield fs_1.promises.writeFile(path.join(folder, "config.json"), JSON.stringify(config));
-            logger_1.default.info("Downloading layers...");
-            yield Promise.all(manifest.layers.map((layer) => dlLayer(image, layer, folder, allowInsecure, cacheFolder)));
-            logger_1.default.info("Image downloaded.");
-            return manifest;
-        });
-    }
-    return {
-        download: download,
-        upload: upload,
-        registryBaseUrl,
-    };
+                yield fs_1.promises.writeFile(path.join(folder, "config.json"), JSON.stringify(config));
+                logger_1.default.info("Downloading layers...");
+                yield Promise.all(manifest.layers.map((layer) => dlLayer(image, layer, folder, allowInsecure, cacheFolder)));
+                logger_1.default.info("Image downloaded.");
+                return manifest;
+            });
+        }
+        return {
+            download: download,
+            upload: upload,
+            registryBaseUrl,
+        };
+    });
 }
 exports.createRegistry = createRegistry;
 exports.DEFAULT_DOCKER_REGISTRY = "https://registry-1.docker.io/v2/";

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.0.0";
+export declare const VERSION = "3.0.1";

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "3.0.0";
+exports.VERSION = "3.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "containerify",
-	"version": "3.0.0",
+	"version": "3.0.1",
 	"description": "Build node.js docker images without docker",
 	"main": "./lib/cli.js",
 	"scripts": {