Merge pull request #197 from fgiudici/file_name_option

Fix --name option in "store add file" command

README.md

@@ -1,24 +1,28 @@
 # Rancher Government Hauler
 
+![rancher-government-hauler-logo](/static/rgs-hauler-logo.png)
+
 ## Airgap Swiss Army Knife
 
-> ⚠️ This project is still in active development and *not* Generally Available (GA). Most of the core functionality and features are ready, but may have breaking changes. Please review the [Release Notes](https://github.com/rancherfederal/hauler/releases) for more information!
+> ⚠️ **Please Note:** Hauler and the Hauler Documentation are recently Generally Available (GA).
 
-`Rancher Government Hauler` simplifies the airgap experience without requiring users to adopt a specific workflow. **Hauler** simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow users to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line.
+`Rancher Government Hauler` simplifies the airgap experience without requiring operators to adopt a specific workflow. **Hauler** simplifies the airgapping process, by representing assets (images, charts, files, etc...) as content and collections to allow operators to easily fetch, store, package, and distribute these assets with declarative manifests or through the command line.
 
-`Hauler` does this by storing contents and collections as OCI Artifacts and allows users to serve contents and collections with an embedded registry and fileserver. Additionally, `Hauler` has the ability to store and inspect various non-image OCI Artifacts.
+`Hauler` does this by storing contents and collections as OCI Artifacts and allows operators to serve contents and collections with an embedded registry and fileserver. Additionally, `Hauler` has the ability to store and inspect various non-image OCI Artifacts.
 
 For more information, please review the **[Hauler Documentation](https://rancherfederal.github.io/hauler-docs)!**
 
 ## Installation
 
 ### Linux/Darwin
+
 ```bash
 # installs latest release
 curl -sfL https://get.hauler.dev | bash
 ```
 
 ### Homebrew
+
 ```bash
 # installs latest release
 brew tap rancherfederal/homebrew-tap
@@ -26,6 +30,7 @@ brew install hauler
 ```
 
 ### Windows
+
 ```bash
 # coming soon
 ```
@@ -33,11 +38,7 @@ brew install hauler
 ## Acknowledgements
 
 `Hauler` wouldn't be possible without the open-source community, but there are a few projects that stand out:
-* [go-containerregistry](https://github.com/google/go-containerregistry)
-* [oras cli](https://github.com/oras-project/oras)
-* [cosign](https://github.com/sigstore/cosign)
 
-## Notices
-**WARNING - Upcoming Deprecated Command(s):**
-
-`hauler download` (alternatively, `dl`) and `hauler serve` (_not_ `hauler store serve`) commands are deprecated and will be removed in a future release.
+- [oras cli](https://github.com/oras-project/oras)
+- [cosign](https://github.com/sigstore/cosign)
+- [go-containerregistry](https://github.com/google/go-containerregistry)

ROADMAP.md

@@ -1,50 +0,0 @@
-# Hauler Roadmap
-
-## \> v0.2.0
-
-- Leverage `referrers` api to robustly link content/collection
-- Support signing for all `artifact.OCI` contents
-- Support encryption for `artifact.OCI` layers
-- Support incremental updates to stores (some implementation of layer diffing)
-- Safely embed container runtime for user created `collections` creation and transformation
-- Better defaults/configuration/security around for long-lived embedded registry
-- Better support multi-platform content
-- Better leverage `oras` (`>=0.5.0`) for content relocation
-- Store git repos as CAS in OCI format
-
-## v0.2.0 - MVP 2
-
-- Re-focus on cli and framework for oci content fetching and delivery
-- Focus on initial key contents
-  - Files (local/remote)
-  - Charts (local/remote)
-  - Images
-- Establish framework for `content` and `collections`
-- Define initial `content` types (`file`, `chart`, `image`)
-- Define initial `collection` types (`thickchart`, `k3s`)
-- Define framework for manipulating OCI content (`artifact.OCI`, `artifact.Collection`)
-
-## v0.1.0 - MVP 1
-
-- Install single-node k3s cluster
-  - Support tarball and rpm installation methods
-  - Target narrow set of known Operating Systems to have OS-specific code if needed
-- Serve container images
-  - Collect images from image list file
-  - Collect images from image archives
-  - Deploy docker registry
-  - Populate registry with all images
-- Serve git repositories 
-  - Collect repos
-  - Deploy git server (Caddy? NGINX?)
-  - Populate git server with repos
-- Serve files
-  - Collect files from directory, including subdirectories
-  - Deploy caddy file server
-  - Populate file server with directory contents
-  - NOTE: "generic" option - most other use cases can be satisfied by a specially crafted file
-    server directory
-
-## v0.0.x
-
-- Install single-node k3s cluster into an Ubuntu machine using the tarball installation method

cmd/hauler/cli/cli.go

@@ -31,9 +31,8 @@ func New() *cobra.Command {
 	pf.StringVarP(&ro.logLevel, "log-level", "l", "info", "")
 
 	// Add subcommands
-	addDownload(cmd)
+	addLogin(cmd)
 	addStore(cmd)
-	addServe(cmd)
 	addVersion(cmd)
 	addCompletion(cmd)
 

cmd/hauler/cli/download.go

@@ -1,45 +0,0 @@
-package cli
-
-import (
-	"github.com/spf13/cobra"
-
-	"github.com/rancherfederal/hauler/cmd/hauler/cli/download"
-)
-
-func addDownload(parent *cobra.Command) {
-	o := &download.Opts{}
-
-	cmd := &cobra.Command{
-		Use:   "download",
-		Short: "Download OCI content from a registry and populate it on disk",
-		Long: `*** WARNING: Deprecated Command *** 
-The 'download (dl)' command is deprecated and will be removed in a future release of Hauler.
-
-Locate OCI content based on it's reference in a compatible registry and download the contents to disk.
-
-Note that the content type determines it's format on disk.  Hauler's built in content types act as follows:
-
-	- File: as a file named after the pushed contents source name (ex: my-file.yaml:latest --> my-file.yaml)
-	- Image: as a .tar named after the image (ex: alpine:latest --> alpine:latest.tar)
-	- Chart: as a .tar.gz named after the chart (ex: loki:2.0.2 --> loki-2.0.2.tar.gz)`,
-		Example: `
-# Download a file
-hauler dl localhost:5000/my-file.yaml:latest
-
-# Download an image
-hauler dl localhost:5000/rancher/k3s:v1.22.2-k3s2
-
-# Download a chart
-hauler dl localhost:5000/hauler/longhorn:1.2.0`,
-		Aliases: []string{"dl"},
-		Args:    cobra.ExactArgs(1),
-		RunE: func(cmd *cobra.Command, arg []string) error {
-			ctx := cmd.Context()
-
-			return download.Cmd(ctx, o, arg[0])
-		},
-	}
-	o.AddArgs(cmd)
-
-	parent.AddCommand(cmd)
-}

cmd/hauler/cli/download/download.go

@@ -1,87 +0,0 @@
-package download
-
-import (
-	"context"
-	"encoding/json"
-
-	"github.com/google/go-containerregistry/pkg/authn"
-	"github.com/google/go-containerregistry/pkg/v1/remote"
-	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
-	"github.com/spf13/cobra"
-	"oras.land/oras-go/pkg/content"
-	"oras.land/oras-go/pkg/oras"
-
-	"github.com/rancherfederal/hauler/pkg/consts"
-
-	"github.com/rancherfederal/hauler/internal/mapper"
-	"github.com/rancherfederal/hauler/pkg/log"
-	"github.com/rancherfederal/hauler/pkg/reference"
-)
-
-type Opts struct {
-	DestinationDir string
-
-	Username  string
-	Password  string
-	Insecure  bool
-	PlainHTTP bool
-}
-
-func (o *Opts) AddArgs(cmd *cobra.Command) {
-	f := cmd.Flags()
-
-	f.StringVarP(&o.DestinationDir, "output", "o", "", "Directory to save contents to (defaults to current directory)")
-	f.StringVarP(&o.Username, "username", "u", "", "Username when copying to an authenticated remote registry")
-	f.StringVarP(&o.Password, "password", "p", "", "Password when copying to an authenticated remote registry")
-	f.BoolVar(&o.Insecure, "insecure", false, "Toggle allowing insecure connections when copying to a remote registry")
-	f.BoolVar(&o.PlainHTTP, "plain-http", false, "Toggle allowing plain http connections when copying to a remote registry")
-}
-
-func Cmd(ctx context.Context, o *Opts, ref string) error {
-	l := log.FromContext(ctx)
-
-	ropts := content.RegistryOptions{
-		Username:  o.Username,
-		Password:  o.Password,
-		Insecure:  o.Insecure,
-		PlainHTTP: o.PlainHTTP,
-	}
-	rs, err := content.NewRegistry(ropts)
-	if err != nil {
-		return err
-	}
-
-	r, err := reference.Parse(ref)
-	if err != nil {
-		return err
-	}
-
-	desc, err := remote.Get(r, remote.WithAuthFromKeychain(authn.DefaultKeychain), remote.WithContext(ctx))
-	if err != nil {
-		return err
-	}
-
-	manifestData, err := desc.RawManifest()
-	if err != nil {
-		return err
-	}
-
-	var manifest ocispec.Manifest
-	if err := json.Unmarshal(manifestData, &manifest); err != nil {
-		return err
-	}
-
-	mapperStore, err := mapper.FromManifest(manifest, o.DestinationDir)
-	if err != nil {
-		return err
-	}
-
-	pushedDesc, err := oras.Copy(ctx, rs, r.Name(), mapperStore, "",
-		oras.WithAdditionalCachedMediaTypes(consts.DockerManifestSchema2))
-	if err != nil {
-		return err
-	}
-
-	l.Infof("downloaded [%s] with digest [%s]", pushedDesc.MediaType, pushedDesc.Digest.String())
-	return nil
-}

cmd/hauler/cli/login.go

@@ -0,0 +1,75 @@
+package cli
+
+import (
+	"context"
+	"strings"
+	"os"
+	"io"
+	"fmt"
+	"github.com/spf13/cobra"
+
+	"oras.land/oras-go/pkg/content"
+
+	"github.com/rancherfederal/hauler/pkg/cosign"
+)
+
+type Opts struct {
+	Username  string
+	Password  string
+	PasswordStdin bool
+}
+
+func (o *Opts) AddArgs(cmd *cobra.Command) {
+	f := cmd.Flags()
+	f.StringVarP(&o.Username, "username", "u", "", "Username")
+	f.StringVarP(&o.Password, "password", "p", "", "Password")
+	f.BoolVarP(&o.PasswordStdin, "password-stdin", "", false, "Take the password from stdin")
+}
+
+func addLogin(parent *cobra.Command) {
+	o := &Opts{}
+
+	cmd := &cobra.Command{
+		Use:   "login",
+		Short: "Log in to a registry",
+		Example: `
+# Log in to reg.example.com
+hauler login reg.example.com -u bob -p haulin`,
+		Args:    cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, arg []string) error {
+			ctx := cmd.Context()
+
+			if o.PasswordStdin {
+				contents, err := io.ReadAll(os.Stdin)
+				if err != nil {
+					return err
+				}
+				o.Password = strings.TrimSuffix(string(contents), "\n")
+				o.Password = strings.TrimSuffix(o.Password, "\r")
+			}
+			
+			if o.Username == "" && o.Password == "" {
+				return fmt.Errorf("username and password required")
+			}
+
+			return login(ctx, o, arg[0])
+		},
+	}
+	o.AddArgs(cmd)
+
+	parent.AddCommand(cmd)
+}
+
+func login(ctx context.Context, o *Opts, registry string) error {
+	ropts := content.RegistryOptions{
+		Username:  o.Username,
+		Password:  o.Password,
+	}
+
+	err := cosign.RegistryLogin(ctx, nil, registry, ropts)
+	if err != nil {
+		return err
+	}
+	
+	return nil
+}

cmd/hauler/cli/serve.go

@@ -1,57 +0,0 @@
-package cli
-
-import (
-	"github.com/spf13/cobra"
-
-	"github.com/rancherfederal/hauler/cmd/hauler/cli/serve"
-)
-
-func addServe(parent *cobra.Command) {
-	cmd := &cobra.Command{
-		Use:   "serve",
-		Short: "Run one or more of hauler's embedded servers types",
-		Long: `*** WARNING: Deprecated Command *** 
-The 'serve' command is deprecated and will be removed in a future release of Hauler.`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			return cmd.Help()
-		},
-	}
-
-	cmd.AddCommand(
-		addServeFiles(),
-		addServeRegistry(),
-	)
-
-	parent.AddCommand(cmd)
-}
-
-func addServeFiles() *cobra.Command {
-	o := &serve.FilesOpts{}
-	cmd := &cobra.Command{
-		Use:   "files",
-		Short: "Start a fileserver",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			ctx := cmd.Context()
-			return serve.FilesCmd(ctx, o)
-		},
-	}
-	o.AddFlags(cmd)
-
-	return cmd
-}
-
-func addServeRegistry() *cobra.Command {
-	o := &serve.RegistryOpts{}
-
-	cmd := &cobra.Command{
-		Use:   "registry",
-		Short: "Start a registry",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			ctx := cmd.Context()
-			return serve.RegistryCmd(ctx, o)
-		},
-	}
-	o.AddFlags(cmd)
-
-	return cmd
-}

cmd/hauler/cli/serve/files.go

@@ -1,37 +0,0 @@
-package serve
-
-import (
-	"context"
-
-	"github.com/spf13/cobra"
-
-	"github.com/rancherfederal/hauler/internal/server"
-)
-
-type FilesOpts struct {
-	Root string
-	Port int
-}
-
-func (o *FilesOpts) AddFlags(cmd *cobra.Command) {
-	f := cmd.Flags()
-	f.StringVarP(&o.Root, "root", "r", ".", "Path to root of the directory to serve")
-	f.IntVarP(&o.Port, "port", "p", 8080, "Port to listen on")
-}
-
-func FilesCmd(ctx context.Context, o *FilesOpts) error {
-	cfg := server.FileConfig{
-		Root: o.Root,
-		Port: o.Port,
-	}
-
-	s, err := server.NewFile(ctx, cfg)
-	if err != nil {
-		return err
-	}
-
-	if err := s.ListenAndServe(); err != nil {
-		return err
-	}
-	return nil
-}

cmd/hauler/cli/serve/registry.go

@@ -1,81 +0,0 @@
-package serve
-
-import (
-	"context"
-	"fmt"
-	"net/http"
-	"os"
-
-	"github.com/distribution/distribution/v3/configuration"
-	dcontext "github.com/distribution/distribution/v3/context"
-	"github.com/distribution/distribution/v3/version"
-	"github.com/spf13/cobra"
-
-	"github.com/rancherfederal/hauler/internal/server"
-)
-
-type RegistryOpts struct {
-	Root       string
-	Port       int
-	ConfigFile string
-}
-
-func (o *RegistryOpts) AddFlags(cmd *cobra.Command) {
-	f := cmd.Flags()
-	f.StringVarP(&o.Root, "root", "r", ".", "Path to root of the directory to serve")
-	f.IntVarP(&o.Port, "port", "p", 5000, "Port to listen on")
-	f.StringVarP(&o.ConfigFile, "config", "c", "", "Path to a config file, will override all other configs")
-}
-
-func RegistryCmd(ctx context.Context, o *RegistryOpts) error {
-	ctx = dcontext.WithVersion(ctx, version.Version)
-
-	cfg := o.defaultConfig()
-	if o.ConfigFile != "" {
-		ucfg, err := loadConfig(o.ConfigFile)
-		if err != nil {
-			return err
-		}
-		cfg = ucfg
-	}
-
-	s, err := server.NewRegistry(ctx, cfg)
-	if err != nil {
-		return err
-	}
-
-	if err := s.ListenAndServe(); err != nil {
-		return err
-	}
-	return nil
-}
-
-func loadConfig(filename string) (*configuration.Configuration, error) {
-	f, err := os.Open(filename)
-	if err != nil {
-		return nil, err
-	}
-
-	return configuration.Parse(f)
-}
-
-func (o *RegistryOpts) defaultConfig() *configuration.Configuration {
-	cfg := &configuration.Configuration{
-		Version: "0.1",
-		Storage: configuration.Storage{
-			"cache":      configuration.Parameters{"blobdescriptor": "inmemory"},
-			"filesystem": configuration.Parameters{"rootdirectory": o.Root},
-
-			// TODO: Ensure this is toggleable via cli arg if necessary
-			// "maintenance": configuration.Parameters{"readonly.enabled": false},
-		},
-	}
-	cfg.Log.Level = "info"
-	cfg.HTTP.Addr = fmt.Sprintf(":%d", o.Port)
-	cfg.HTTP.Headers = http.Header{
-		"X-Content-Type-Options": []string{"nosniff"},
-		"Accept": []string{"application/vnd.dsse.envelope.v1+json, application/json"},
-	}
-
-	return cfg
-}

cmd/hauler/cli/store.go

@@ -196,7 +196,7 @@ func addStoreSave() *cobra.Command {
 func addStoreInfo() *cobra.Command {
 	o := &store.InfoOpts{RootOpts: rootStoreOpts}
 
-	var allowedValues = []string{"image", "chart", "file", "all"}
+	var allowedValues = []string{"image", "chart", "file", "sigs", "atts", "sbom", "all"}
 
 	cmd := &cobra.Command{
 		Use:     "info",

cmd/hauler/cli/store/add.go

@@ -33,7 +33,9 @@ func AddFileCmd(ctx context.Context, o *AddFileOpts, s *store.Layout, reference
 	cfg := v1alpha1.File{
 		Path: reference,
 	}
-
+	if len(o.Name) > 0 {
+		cfg.Name = o.Name
+	}
 	return storeFile(ctx, s, cfg)
 }
 

cmd/hauler/cli/store/info.go

@@ -30,7 +30,7 @@ func (o *InfoOpts) AddFlags(cmd *cobra.Command) {
 	f := cmd.Flags()
 
 	f.StringVarP(&o.OutputFormat, "output", "o", "table", "Output format (table, json)")
-	f.StringVarP(&o.TypeFilter, "type", "t", "all", "Filter on type (image, chart, file)")
+	f.StringVarP(&o.TypeFilter, "type", "t", "all", "Filter on type (image, chart, file, sigs, atts, sbom)")
 
 	// TODO: Regex/globbing
 }
@@ -144,7 +144,8 @@ func buildTable(items ...item) {
 	table.SetHeaderAlignment(tablewriter.ALIGN_LEFT)
 	table.SetRowLine(false)
 	table.SetAutoMergeCellsByColumnIndex([]int{0})
-
+	
+	totalSize := int64(0)
 	for _, i := range items {
 		if i.Type != "" {
 			row := []string{
@@ -152,11 +153,14 @@ func buildTable(items ...item) {
 				i.Type,
 				i.Platform,
 				fmt.Sprintf("%d", i.Layers),
-				i.Size,
+				byteCountSI(i.Size),
 			}
+			totalSize += i.Size
 			table.Append(row)
 		}
 	}
+	table.SetFooter([]string{"", "", "", "Total", byteCountSI(totalSize)})
+
 	table.Render()
 }
 
@@ -173,7 +177,7 @@ type item struct {
 	Type         string
 	Platform     string
 	Layers       int
-	Size         string
+	Size         int64
 }
 
 type byReferenceAndArch []item
@@ -182,22 +186,24 @@ func (a byReferenceAndArch) Len() int      { return len(a) }
 func (a byReferenceAndArch) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
 func (a byReferenceAndArch) Less(i, j int) bool {
 	if a[i].Reference == a[j].Reference {
-		return a[i].Platform < a[j].Platform
+		if a[i].Type == "image" && a[j].Type == "image" {
+			return a[i].Platform < a[j].Platform
+		}
+		if a[i].Type == "image" {
+			return true
+		}
+		if a[j].Type == "image" {
+			return false
+		}
+		return a[i].Type < a[j].Type
 	}
 	return a[i].Reference < a[j].Reference
 }
 
 func newItem(s *store.Layout, desc ocispec.Descriptor, m ocispec.Manifest, plat string, o *InfoOpts) item {
-	// skip listing cosign items
-	if desc.Annotations["kind"] == "dev.cosignproject.cosign/atts" ||
-		desc.Annotations["kind"] == "dev.cosignproject.cosign/sigs" ||
-		desc.Annotations["kind"] == "dev.cosignproject.cosign/sboms" {
-		return item{}
-	}
-
 	var size int64 = 0
 	for _, l := range m.Layers {
-		size = +l.Size
+		size += l.Size
 	}
 
 	// Generate a human-readable content type
@@ -213,6 +219,15 @@ func newItem(s *store.Layout, desc ocispec.Descriptor, m ocispec.Manifest, plat
 		ctype = "image"
 	}
 
+	switch desc.Annotations["kind"] {
+	case "dev.cosignproject.cosign/sigs":
+		ctype = "sigs"
+	case "dev.cosignproject.cosign/atts":
+		ctype = "atts"
+	case "dev.cosignproject.cosign/sboms":
+		ctype = "sbom"
+	}
+	
 	ref, err := reference.Parse(desc.Annotations[ocispec.AnnotationRefName])
 	if err != nil {
 		return item{}
@@ -227,7 +242,7 @@ func newItem(s *store.Layout, desc ocispec.Descriptor, m ocispec.Manifest, plat
 		Type:         ctype,
 		Platform:     plat,
 		Layers:       len(m.Layers),
-		Size:         byteCountSI(size),
+		Size:         size,
 	}
 }
 

cmd/hauler/cli/store/sync.go

@@ -8,12 +8,11 @@ import (
 	"os"
 	"strings"
 
+	"github.com/mitchellh/go-homedir"
 	"github.com/spf13/cobra"
 	"helm.sh/helm/v3/pkg/action"
 	"k8s.io/apimachinery/pkg/util/yaml"
-	"github.com/mitchellh/go-homedir"
 
-	"github.com/rancherfederal/hauler/pkg/store"
 	"github.com/rancherfederal/hauler/pkg/apis/hauler.cattle.io/v1alpha1"
 	tchart "github.com/rancherfederal/hauler/pkg/collection/chart"
 	"github.com/rancherfederal/hauler/pkg/collection/imagetxt"
@@ -22,6 +21,8 @@ import (
 	"github.com/rancherfederal/hauler/pkg/content"
 	"github.com/rancherfederal/hauler/pkg/cosign"
 	"github.com/rancherfederal/hauler/pkg/log"
+	"github.com/rancherfederal/hauler/pkg/reference"
+	"github.com/rancherfederal/hauler/pkg/store"
 )
 
 type SyncOpts struct {
@@ -30,6 +31,7 @@ type SyncOpts struct {
 	Key          string
 	Products	 []string
 	Platform	 string
+	Registry	 string
 }
 
 func (o *SyncOpts) AddFlags(cmd *cobra.Command) {
@@ -39,6 +41,7 @@ func (o *SyncOpts) AddFlags(cmd *cobra.Command) {
 	f.StringVarP(&o.Key, "key", "k", "", "(Optional) Path to the key for signature verification")
 	f.StringSliceVar(&o.Products, "products", []string{}, "Used for RGS Carbide customers to supply a product and version and Hauler will retrieve the images. i.e. '--product rancher=v2.7.6'")
 	f.StringVarP(&o.Platform, "platform", "p", "", "(Optional) Specific platform to save. i.e. linux/amd64. Defaults to all if flag is omitted.")
+	f.StringVarP(&o.Registry, "registry", "r", "", "(Optional) Default pull registry for image refs that are not specifying a registry name.")
 }
 
 func SyncCmd(ctx context.Context, o *SyncOpts, s *store.Layout) error {
@@ -137,14 +140,44 @@ func processContent(ctx context.Context, fi *os.File, o *SyncOpts, s *store.Layo
 			if err := yaml.Unmarshal(doc, &cfg); err != nil {
 				return err
 			}
-
+			a := cfg.GetAnnotations()
 			for _, i := range cfg.Spec.Images {
+	
+				// Check if the user provided a registry.  If a registry is provided in the annotation, use it for the images that don't have a registry in their ref name.
+				if a[consts.ImageAnnotationRegistry] != "" || o.Registry != ""{
+					newRef,_ := reference.Parse(i.Name)
+					
+					newReg := o.Registry // cli flag
+					// if no cli flag but there was an annotation, use the annotation.
+					if o.Registry == "" && a[consts.ImageAnnotationRegistry] != "" {
+						newReg = a[consts.ImageAnnotationRegistry]
+					}
+					
+					if newRef.Context().RegistryStr() == "" {
+						newRef,err = reference.Relocate(i.Name, newReg)
+						if err != nil {
+							return err
+						}
+					}
+					i.Name = newRef.Name()
+				}
 
-				// Check if the user provided a key.
-				if o.Key != "" || i.Key != "" {
-					key := o.Key
+				// Check if the user provided a key.  The flag from the CLI takes precedence over the annotation.  The individual image key takes precedence over both.
+				if a[consts.ImageAnnotationKey] != "" || o.Key != "" || i.Key != "" {
+					key := o.Key // cli flag
+					// if no cli flag but there was an annotation, use the annotation.
+					if o.Key == "" && a[consts.ImageAnnotationKey] != "" {
+						key, err = homedir.Expand(a[consts.ImageAnnotationKey])
+						if err != nil {
+							return err
+						}
+					}
+					// the individual image key trumps all
 					if i.Key != "" {
 						key, err = homedir.Expand(i.Key)
+						if err != nil {
+							return err
+						}
 					}
 					l.Debugf("key for image [%s]", key)
 					
@@ -157,12 +190,18 @@ func processContent(ctx context.Context, fi *os.File, o *SyncOpts, s *store.Layo
 					l.Infof("signature verified for image [%s]", i.Name)
 				}
 
-				// Check if the user provided a platform.
-				platform := o.Platform
+				// Check if the user provided a platform.  The flag from the CLI takes precedence over the annotation.  The individual image platform takes precedence over both.
+				platform := o.Platform // cli flag
+				// if no cli flag but there was an annotation, use the annotation.
+				if o.Platform == "" && a[consts.ImageAnnotationPlatform] != "" {
+					platform = a[consts.ImageAnnotationPlatform]
+				}
+				// the individual image platform trumps all
 				if i.Platform != "" {
 					platform = i.Platform
 				}
-
+				l.Debugf("platform for image [%s]", platform)
+				
 				err = storeImage(ctx, s, i, platform)
 				if err != nil {
 					return err

cmd/hauler/main.go

@@ -2,8 +2,8 @@ package main
 
 import (
 	"context"
-	"os"
 	"embed"
+	"os"
 
 	"github.com/rancherfederal/hauler/cmd/hauler/cli"
 	"github.com/rancherfederal/hauler/pkg/cosign"
@@ -23,9 +23,12 @@ func main() {
 	// ensure cosign binary is available
 	if err := cosign.EnsureBinaryExists(ctx, binaries); err != nil {
 		logger.Errorf("%v", err)
+		os.Exit(1)
 	}
-	
+
 	if err := cli.New().ExecuteContext(ctx); err != nil {
 		logger.Errorf("%v", err)
+		cancel()
+		os.Exit(1)
 	}
 }

go.mod

@@ -21,7 +21,7 @@ require (
 	github.com/spf13/afero v1.10.0
 	github.com/spf13/cobra v1.8.0
 	golang.org/x/sync v0.6.0
-	helm.sh/helm/v3 v3.14.0
+	helm.sh/helm/v3 v3.14.2
 	k8s.io/apimachinery v0.29.0
 	k8s.io/client-go v0.29.0
 	oras.land/oras-go v1.2.5

go.sum

@@ -910,8 +910,8 @@ gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gotest.tools/v3 v3.4.0 h1:ZazjZUfuVeZGLAmlKKuyv3IKP5orXcwtOwDQH6YVr6o=
 gotest.tools/v3 v3.4.0/go.mod h1:CtbdzLSsqVhDgMtKsx03ird5YTGB3ar27v0u/yKBW5g=
-helm.sh/helm/v3 v3.14.0 h1:TaZIH6uOchn7L27ptwnnuHJiFrT/BsD4dFdp/HLT2nM=
-helm.sh/helm/v3 v3.14.0/go.mod h1:2itvvDv2WSZXTllknfQo6j7u3VVgMAvm8POCDgYH424=
+helm.sh/helm/v3 v3.14.2 h1:V71fv+NGZv0icBlr+in1MJXuUIHCiPG1hW9gEBISTIA=
+helm.sh/helm/v3 v3.14.2/go.mod h1:2itvvDv2WSZXTllknfQo6j7u3VVgMAvm8POCDgYH424=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

install.sh

@@ -2,62 +2,68 @@
 
 # Usage:
 #   - curl -sfL... | ENV_VAR=... bash
-#   - ENV_VAR=... bash ./install.sh
-#   - ./install.sh ENV_VAR=...
-
-# Example:
+#   - ENV_VAR=... ./install.sh
+#
+# Install Usage:
 #   Install Latest Release
 #     - curl -sfL https://get.hauler.dev | bash
+#     - ./install.sh
+#
 #   Install Specific Release
-#     - curl -sfL https://get.hauler.dev | HAULER_VERSION=0.4.2 bash
-
+#     - curl -sfL https://get.hauler.dev | HAULER_VERSION=1.0.0 bash
+#     - HAULER_VERSION=1.0.0 ./install.sh
+#
+# Uninstall Usage:
+#   - curl -sfL https://get.hauler.dev | HAULER_UNINSTALL=true bash
+#   - HAULER_UNINSTALL=true ./install.sh
+#
 # Documentation:
 #   - https://hauler.dev
 #   - https://github.com/rancherfederal/hauler
 
 # set functions for debugging/logging
-function info {
-    echo && echo "[INFO] Hauler: $1"
-}
-
 function verbose {
     echo "$1"
 }
 
+function info {
+    echo && echo "[INFO] Hauler: $1"
+}
+
 function warn {
     echo && echo "[WARN] Hauler: $1"
 }
 
 function fatal {
     echo && echo "[ERROR] Hauler: $1"
-    exit 1
+    exit 0
 }
 
 # check for required dependencies
-for cmd in curl sed awk openssl tar rm; do
+for cmd in sudo rm curl grep mkdir sed awk openssl tar; do
     if ! command -v "$cmd" &> /dev/null; then
         fatal "$cmd is not installed"
     fi
 done
 
-# start hauler installation
-info "Starting Installation..."
+# set version environment variable
+if [ -z "${HAULER_VERSION}" ]; then
+    version="${HAULER_VERSION:-$(curl -s https://api.github.com/repos/rancherfederal/hauler/releases/latest | grep '"tag_name":' | sed 's/.*"v\([^"]*\)".*/\1/')}"
+else
+    version="${HAULER_VERSION}"
+fi
 
-# set version with an environment variable
-version=${HAULER_VERSION:-$(curl -s https://api.github.com/repos/rancherfederal/hauler/releases/latest | grep '"tag_name":' | sed 's/.*"v\([^"]*\)".*/\1/')}
+# set uninstall environment variable from argument or environment
+if [ "${HAULER_UNINSTALL}" = "true" ]; then
+    # remove the hauler binary
+    sudo rm -f /usr/local/bin/hauler || fatal "Failed to Remove Hauler from /usr/local/bin"
 
-# set verision with an argument
-while [[ $# -gt 0 ]]; do
-  case "$1" in
-    HAULER_VERSION=*)
-      version="${1#*=}"
-      shift
-      ;;
-    *)
-      shift
-      ;;
-  esac
-done
+    # remove the installation directory
+    rm -rf "$HOME/.hauler" || fatal "Failed to Remove Directory: $HOME/.hauler"
+
+    info "Hauler Uninstalled Successfully"
+    exit 0
+fi
 
 # detect the operating system
 platform=$(uname -s | tr '[:upper:]' '[:lower:]')
@@ -87,25 +93,36 @@ case $arch in
         ;;
 esac
 
+# start hauler installation
+info "Starting Installation..."
+
 # display the version, platform, and architecture
 verbose "- Version: v$version"
 verbose "- Platform: $platform"
 verbose "- Architecture: $arch"
 
+# check if install directory exists, create it if not
+if [ ! -d "$HOME/.hauler" ]; then
+    mkdir -p "$HOME/.hauler" || fatal "Failed to Create Directory: ~/.hauler"
+fi
+
+# change to install directory
+cd "$HOME/.hauler" || fatal "Failed to Change Directory: ~/.hauler"
+
 # download the checksum file
-if ! curl -sOL "https://github.com/rancherfederal/hauler/releases/download/v${version}/hauler_${version}_checksums.txt"; then
+if ! curl -sfOL "https://github.com/rancherfederal/hauler/releases/download/v${version}/hauler_${version}_checksums.txt"; then
     fatal "Failed to Download: hauler_${version}_checksums.txt"
 fi
 
 # download the archive file
-if ! curl -sOL "https://github.com/rancherfederal/hauler/releases/download/v${version}/hauler_${version}_${platform}_${arch}.tar.gz"; then
+if ! curl -sfOL "https://github.com/rancherfederal/hauler/releases/download/v${version}/hauler_${version}_${platform}_${arch}.tar.gz"; then
     fatal "Failed to Download: hauler_${version}_${platform}_${arch}.tar.gz"
 fi
 
 # start hauler checksum verification
 info "Starting Checksum Verification..."
 
-# Verify the Hauler checksum
+# verify the Hauler checksum
 expected_checksum=$(awk -v version="$version" -v platform="$platform" -v arch="$arch" '$2 == "hauler_"version"_"platform"_"arch".tar.gz" {print $1}' "hauler_${version}_checksums.txt")
 determined_checksum=$(openssl dgst -sha256 "hauler_${version}_${platform}_${arch}.tar.gz" | awk '{print $2}')
 
@@ -127,24 +144,32 @@ tar -xzf "hauler_${version}_${platform}_${arch}.tar.gz" || fatal "Failed to Extr
 # install the binary
 case "$platform" in
     linux)
-        install hauler /usr/local/bin || fatal "Failed to Install Hauler to /usr/local/bin"
+        sudo install -m 755 hauler /usr/local/bin || fatal "Failed to Install Hauler to /usr/local/bin"
         ;;
     darwin)
-        install hauler /usr/local/bin || fatal "Failed to Install Hauler to /usr/local/bin"
+        sudo install -m 755 hauler /usr/local/bin || fatal "Failed to Install Hauler to /usr/local/bin"
         ;;
     *)
         fatal "Unsupported Platform or Architecture: $platform/$arch"
         ;;
 esac
 
-# clean up checksum(s)
-rm -rf "hauler_${version}_checksums.txt" || warn "Failed to Remove: hauler_${version}_checksums.txt"
-
-# clean up archive file(s)
-rm -rf "hauler_${version}_${platform}_${arch}.tar.gz" || warn "Failed to Remove: hauler_${version}_${platform}_${arch}.tar.gz"
-
-# clean up other files
-rm -rf LICENSE README.md hauler
+# add hauler to the path
+if [ -f "$HOME/.bashrc" ]; then
+    echo "export PATH=$PATH:/usr/local/bin/" >> "$HOME/.bashrc"
+    source "$HOME/.bashrc"
+elif [ -f "$HOME/.bash_profile" ]; then
+    echo "export PATH=$PATH:/usr/local/bin/" >> "$HOME/.bash_profile"
+    source "$HOME/.bash_profile"
+elif [ -f "$HOME/.zshrc" ]; then
+    echo "export PATH=$PATH:/usr/local/bin/" >> "$HOME/.zshrc"
+    source "$HOME/.zshrc"
+elif [ -f "$HOME/.profile" ]; then
+    echo "export PATH=$PATH:/usr/local/bin/" >> "$HOME/.profile"
+    source "$HOME/.profile"
+else
+    echo "Failed to add /usr/local/bin to PATH: Unsupported Shell"
+fi
 
 # display success message
 info "Successfully Installed at /usr/local/bin/hauler"

pkg/artifacts/file/getter/https.go

@@ -25,6 +25,11 @@ func (h Http) Name(u *url.URL) string {
 		return ""
 	}
 
+	name, _ := url.PathUnescape(u.String())
+	if err != nil {
+		return ""
+	}
+
 	contentType := resp.Header.Get("Content-Type")
 	for _, v := range strings.Split(contentType, ",") {
 		t, _, err := mime.ParseMediaType(v)
@@ -36,7 +41,7 @@ func (h Http) Name(u *url.URL) string {
 	}
 
 	// TODO: Not this
-	return filepath.Base(u.String())
+	return filepath.Base(name)
 }
 
 func (h Http) Open(ctx context.Context, u *url.URL) (io.ReadCloser, error) {

pkg/consts/consts.go

@@ -51,4 +51,7 @@ const (
 	KindAnnotation     = "dev.cosignproject.cosign/image"
 
 	CarbideRegistry = "rgcrprod.azurecr.us"
+	ImageAnnotationKey = "hauler.dev/key"
+	ImageAnnotationPlatform = "hauler.dev/platform"
+	ImageAnnotationRegistry = "hauler.dev/registry"
 )

pkg/cosign/cosign.go

@@ -43,6 +43,7 @@ func VerifySignature(ctx context.Context, s *store.Layout, keyPath string, ref s
 
 // SaveImage saves image and any signatures/attestations to the store.
 func SaveImage(ctx context.Context, s *store.Layout, ref string, platform string) error {
+	l := log.FromContext(ctx)
 	operation := func() error {
 		cosignBinaryPath, err := getCosignPath(ctx)
 		if err != nil {
@@ -58,6 +59,7 @@ func SaveImage(ctx context.Context, s *store.Layout, ref string, platform string
 		output, err := cmd.CombinedOutput()
 		if err != nil {
 			if strings.Contains(string(output), "specified reference is not a multiarch image") {
+				l.Debugf(fmt.Sprintf("specified image [%s] is not a multiarch image.  (choosing default)", ref))
 				// Rerun the command without the platform flag
 				cmd = exec.Command(cosignBinaryPath, "save", ref, "--dir", s.Root)
 				output, err = cmd.CombinedOutput()
@@ -138,17 +140,18 @@ func LoadImages(ctx context.Context, s *store.Layout, registry string, ropts con
 
 // RegistryLogin - performs cosign login
 func RegistryLogin(ctx context.Context, s *store.Layout, registry string, ropts content.RegistryOptions) error {
+	log := log.FromContext(ctx)
 	cosignBinaryPath, err := getCosignPath(ctx)
 	if err != nil {
 		return err
 	}
 
 	cmd := exec.Command(cosignBinaryPath, "login", registry, "-u", ropts.Username, "-p", ropts.Password)
-
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		return fmt.Errorf("error logging into registry: %v, output: %s", err, output)
 	}
+	log.Infof(strings.Trim(string(output), "\n"))
 
 	return nil
 }

pkg/reference/reference.go

@@ -25,6 +25,7 @@ type Reference interface {
 
 // NewTagged will create a new docker.NamedTagged given a path-component
 func NewTagged(n string, tag string) (gname.Reference, error) {
+	n = strings.Replace(strings.ToLower(n), "+", "-", -1)
 	repo, err := Parse(n)
 	if err != nil {
 		return nil, err

static/rgs-hauler-logo.svg

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 146.57 35.25">
+  <defs>
+    <style>
+      .cls-1 {
+        font-family: NasalizationRg-Regular, Nasalization;
+        font-size: 32px;
+      }
+
+      .cls-2 {
+        fill: #e92831;
+        letter-spacing: -.04em;
+      }
+
+      .cls-3, .cls-4 {
+        fill: #231f20;
+      }
+
+      .cls-4 {
+        letter-spacing: 0em;
+      }
+    </style>
+  </defs>
+  <text class="cls-1" transform="translate(0 26.8) scale(1.08 1)"><tspan class="cls-3" x="0" y="0">H</tspan><tspan class="cls-2" x="23.84" y="0">A</tspan><tspan class="cls-4" x="47.65" y="0">ULER</tspan></text>
+</svg>