Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,16 @@ components:

UpdateScrollRequest:
type: object
required: [artifact]
properties:
artifact:
type: string
description: Optional target artifact. If omitted, the daemon refreshes the runtime's current artifact.
pattern: '^[^@\s]+@sha256:[a-f0-9]{64}$'
description: Explicitly accepted immutable target. Missing or mutable tag references are rejected before stopping the runtime.
expected_installed_digest:
type: string
pattern: '^sha256:[a-f0-9]{64}$'
description: Optional precondition checked against the actual installed descriptor under the maintenance lock.
registry_credentials:
type: array
items:
Expand Down Expand Up @@ -482,6 +488,33 @@ paths:
'404':
description: Runtime scroll not found

/api/v1/scrolls/{id}/release:
get:
operationId: getInstalledRelease
tags: [scrolls]
summary: Read the installed release descriptor recorded by the last successful pull
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Installed canonical repository and last successful release digest
content:
application/json:
schema:
type: object
required: [repository, digest]
properties:
repository:
type: string
digest:
type: string
'404':
description: Runtime scroll not found

/api/v1/scrolls/{id}/start:
post:
operationId: startScroll
Expand Down Expand Up @@ -532,7 +565,7 @@ paths:
schema:
type: string
requestBody:
required: false
required: true
content:
application/json:
schema:
Expand All @@ -544,6 +577,10 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RuntimeScroll'
'400':
description: An explicitly accepted SHA256 artifact reference is required
'409':
description: Installed release changed since the update was checked
'404':
description: Runtime scroll not found

Expand Down
11 changes: 4 additions & 7 deletions apps/druid/adapters/cli/client/update.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,11 @@ package client
import "github.com/spf13/cobra"

var UpdateCommand = &cobra.Command{
Use: "update <name> [artifact]",
Short: "Update a daemon-managed scroll runtime",
Args: cobra.RangeArgs(1, 2),
Use: "update <name> <repository@sha256:digest>",
Short: "Apply an explicitly accepted immutable Scroll revision",
Args: cobra.ExactArgs(2),
RunE: func(cmd *cobra.Command, args []string) error {
artifact := ""
if len(args) == 2 {
artifact = args[1]
}
artifact := args[1]
daemon, err := runtimeDaemonClient()
if err != nil {
return err
Expand Down
4 changes: 3 additions & 1 deletion apps/druid/adapters/cli/pull.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
)

var pullNoData bool
var pullPreserveReleaseManifest bool

var PullCommand = &cobra.Command{
Use: "pull <artifact> [dir]",
Expand All @@ -21,7 +22,7 @@ var PullCommand = &cobra.Command{

registryClient := registry.NewOciClient(loadRegistryStore())

err := registryClient.PullSelective(dir, artifact, !pullNoData, nil)
err := registryClient.PullSelectiveWithOptions(dir, artifact, !pullNoData, nil, registry.TransferOptions{PreserveReleaseManifest: pullPreserveReleaseManifest})
if err != nil {
logger.Log().Error("Failed to pull from registry")
return err
Expand All @@ -35,4 +36,5 @@ var PullCommand = &cobra.Command{
func init() {
RootCmd.AddCommand(PullCommand)
PullCommand.Flags().BoolVar(&pullNoData, "no-data", false, "Skip scroll data files")
PullCommand.Flags().BoolVar(&pullPreserveReleaseManifest, "preserve-release-manifest", false, "Keep the release manifest.json stored in a backup artifact.")
}
23 changes: 22 additions & 1 deletion apps/druid/adapters/cli/push.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import (
"fmt"
"os"
"path/filepath"
"strconv"
"strings"
"time"

"github.com/highcard-dev/daemon/internal/core/domain"
"github.com/highcard-dev/daemon/internal/core/services/registry"
Expand All @@ -22,6 +24,7 @@ var pushScrollPorts []string
var pushPackMeta bool
var pushSmart bool
var pushCategory string
var pushPreserveReleaseManifest bool
var pushDisableTarReproducible bool

var PushCommand = &cobra.Command{
Expand Down Expand Up @@ -68,6 +71,9 @@ var PushCommand = &cobra.Command{
}

overrides := map[string]string{}
if err := reproducibleCreatedAnnotation(overrides, os.Getenv("SOURCE_DATE_EPOCH")); err != nil {
return err
}
if pushMinRAM != "" {
overrides["gg.druid.scroll.minRam"] = pushMinRAM
}
Expand Down Expand Up @@ -96,7 +102,7 @@ var PushCommand = &cobra.Command{
overrides[fmt.Sprintf("gg.druid.scroll.port.%s", name)] = port
}

_, err = ociClient.Push(fullPath, repo, tag, overrides, pushPackMeta, &scroll.File)
_, err = ociClient.PushWithOptions(fullPath, repo, tag, overrides, pushPackMeta, &scroll.File, registry.TransferOptions{PreserveReleaseManifest: pushPreserveReleaseManifest})
if err != nil {
return err
}
Expand All @@ -106,6 +112,20 @@ var PushCommand = &cobra.Command{
},
}

// ORAS otherwise stamps the current time, making an identical CI rebuild a
// different immutable revision. Only explicitly reproducible builds override it.
func reproducibleCreatedAnnotation(annotations map[string]string, epoch string) error {
if epoch == "" {
return nil
}
seconds, err := strconv.ParseInt(epoch, 10, 64)
if err != nil || seconds < 0 || seconds > 253402300799 {
return fmt.Errorf("SOURCE_DATE_EPOCH must be a nonnegative Unix timestamp before year 10000")
}
annotations["org.opencontainers.image.created"] = time.Unix(seconds, 0).UTC().Format(time.RFC3339)
return nil
}

func init() {
RootCmd.AddCommand(PushCommand)
PushCommand.Flags().StringVarP(&pushMinRAM, "min-ram", "r", pushMinRAM, "Minimum RAM required to run the application. (Will be added as a manifest annotation gg.druid.scroll.minRam)")
Expand All @@ -116,5 +136,6 @@ func init() {
PushCommand.Flags().StringVarP(&pushImage, "image", "i", pushImage, "Image to use for the scroll. (Will be added as a manifest annotation gg.druid.scroll.image)")
PushCommand.Flags().StringSliceVarP(&pushScrollPorts, "port", "p", pushScrollPorts, "Ports to expose. Format webserver=80, dns=53/udp or just minecraft (Will be added as a manifest annotation gg.druid.scroll.ports.<name>)")
PushCommand.Flags().BoolVarP(&pushPackMeta, "pack-meta", "m", pushPackMeta, "Pack the meta folder into the scroll.")
PushCommand.Flags().BoolVar(&pushPreserveReleaseManifest, "preserve-release-manifest", false, "Include the installed release manifest.json in this snapshot.")
PushCommand.PersistentFlags().BoolVar(&pushDisableTarReproducible, "no-tar-reproducible", false, "Preserve file timestamps in pushed tar layers.")
}
27 changes: 27 additions & 0 deletions apps/druid/adapters/cli/push_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package cli

import "testing"

func TestExplicitSourceDateMakesReleaseCreationDeterministic(t *testing.T) {
for i := 0; i < 2; i++ {
annotations := map[string]string{}
if err := reproducibleCreatedAnnotation(annotations, "0"); err != nil {
t.Fatal(err)
}
if annotations["org.opencontainers.image.created"] != "1970-01-01T00:00:00Z" {
t.Fatal("unstable creation annotation")
}
}
annotations := map[string]string{}
if err := reproducibleCreatedAnnotation(annotations, ""); err != nil {
t.Fatal(err)
}
if len(annotations) != 0 {
t.Fatal("ordinary pushes unexpectedly changed")
}
for _, invalid := range []string{"-1", "tomorrow", "253402300800"} {
if err := reproducibleCreatedAnnotation(annotations, invalid); err == nil {
t.Fatal("invalid source date accepted")
}
}
}
49 changes: 49 additions & 0 deletions apps/druid/adapters/cli/worker_glob_protection_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package cli

import (
"os"
"path/filepath"
"testing"
)

func TestWorkerUpdatePreservesGlobProtectedData(t *testing.T) {
for _, nested := range []bool{false, true} {
for _, declaration := range []string{"installed", "candidate"} {
t.Run(declaration+map[bool]string{false: "/flat", true: "/nested"}[nested], func(t *testing.T) {
root, candidate := t.TempDir(), t.TempDir()
chunks := "chunks:\n - name: config\n path: '*.cfg'\n skip_update: true\n"
directory := ""
if nested {
directory = "servers/one"
chunks = "chunks:\n - name: servers\n path: 'servers/*'\n chunks:\n - name: config\n path: '*.cfg'\n skip_update: true\n"
}
installedYAML, candidateYAML := "name: example\n", "name: example\n"
if declaration == "installed" {
installedYAML += chunks
} else {
candidateYAML += chunks
}
mustWrite(t, filepath.Join(root, "scroll.yaml"), installedYAML)
mustWrite(t, filepath.Join(candidate, "scroll.yaml"), candidateYAML)
mustWrite(t, filepath.Join(root, "data", directory, "edited.cfg"), "user edits")
mustWrite(t, filepath.Join(root, "data", directory, "removed.cfg"), "user save")
mustWrite(t, filepath.Join(root, "data", directory, "obsolete.txt"), "old release")
mustWrite(t, filepath.Join(candidate, "data", directory, "edited.cfg"), "new default")
mustWrite(t, filepath.Join(candidate, "data", directory, "absent.cfg"), "must not appear")
mustWrite(t, filepath.Join(candidate, "data", directory, "release.txt"), "new release")
if err := pullWorkerUpdate(root, candidate, nil, nil); err != nil {
t.Fatal(err)
}
assertFile(t, filepath.Join(root, "data", directory, "edited.cfg"), "user edits")
assertFile(t, filepath.Join(root, "data", directory, "removed.cfg"), "user save")
assertFile(t, filepath.Join(root, "data", directory, "release.txt"), "new release")
for _, name := range []string{"absent.cfg", "obsolete.txt"} {
if _, err := os.Stat(filepath.Join(root, "data", directory, name)); !os.IsNotExist(err) {
t.Fatalf("%s should be absent: %v", name, err)
}
}
assertFile(t, filepath.Join(root, "scroll.yaml"), candidateYAML)
})
}
}
}
84 changes: 84 additions & 0 deletions apps/druid/adapters/cli/worker_ownership.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package cli

import (
"fmt"
"os"
"os/user"
"path/filepath"
"strconv"
"strings"

"github.com/highcard-dev/daemon/internal/utils"
)

type workerDataOwner struct{ uid, gid int }

func ownershipID(value string) (int, error) {
id, err := strconv.ParseUint(value, 10, 32)
if err != nil || id == 1<<32-1 {
return 0, fmt.Errorf("invalid ownership ID %q", value)
}
return int(id), nil
}

// Match Docker user[:group] identity inside the worker image, including named
// users. Numeric users absent from passwd default to group 0, as Docker does.
func resolveWorkerDataOwner(value string) (*workerDataOwner, error) {
if value == "" {
return nil, nil
}
parts := strings.Split(value, ":")
if len(parts) > 2 || parts[0] == "" || len(parts) == 2 && parts[1] == "" {
return nil, fmt.Errorf("invalid new-data-owner %q", value)
}
owner := &workerDataOwner{}
uid, numericErr := ownershipID(parts[0])
var account *user.User
var err error
if numericErr == nil {
owner.uid = uid
account, _ = user.LookupId(parts[0])
} else {
account, err = user.Lookup(parts[0])
if err != nil {
return nil, fmt.Errorf("resolve new-data-owner: %w", err)
}
owner.uid, err = ownershipID(account.Uid)
if err != nil {
return nil, err
}
}
if account != nil {
owner.gid, err = ownershipID(account.Gid)
if err != nil {
return nil, err
}
}
if len(parts) == 2 {
owner.gid, err = ownershipID(parts[1])
if err != nil {
group, lookupErr := user.LookupGroup(parts[1])
if lookupErr != nil {
return nil, fmt.Errorf("resolve new-data-owner group: %w", lookupErr)
}
owner.gid, err = ownershipID(group.Gid)
if err != nil {
return nil, err
}
}
}
return owner, nil
}

func applyWorkerDataOwner(root string, owner *workerDataOwner) error {
if owner == nil {
return nil
}
return filepath.WalkDir(root, func(path string, entry os.DirEntry, err error) error {
if err != nil {
return err
}
// WalkDir and Lchown both avoid following symlinks outside the stage.
return utils.SetPathOwner(path, owner.uid, owner.gid)
})
}
48 changes: 48 additions & 0 deletions apps/druid/adapters/cli/worker_ownership_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package cli

import (
"os"
"os/user"
"path/filepath"
"testing"

"github.com/highcard-dev/daemon/internal/utils"
)

func TestWorkerOwnerResolution(t *testing.T) {
owner, err := resolveWorkerDataOwner("1234:2345")
if err != nil || owner.uid != 1234 || owner.gid != 2345 {
t.Fatalf("numeric owner: %+v %v", owner, err)
}
current, err := user.Current()
if err != nil {
t.Fatal(err)
}
owner, err = resolveWorkerDataOwner(current.Username)
if err != nil || owner.uid != os.Getuid() || owner.gid != os.Getgid() {
t.Fatalf("named owner: %+v %v", owner, err)
}
for _, invalid := range []string{"-1:0", ":0", "1000:", "1:2:3", "4294967295:0", "0:4294967295"} {
if _, err := resolveWorkerDataOwner(invalid); err == nil {
t.Errorf("accepted invalid owner %q", invalid)
}
}
}

func TestWorkerOwnershipDoesNotFollowSymlinks(t *testing.T) {
root := t.TempDir()
if err := os.Symlink(filepath.Join(t.TempDir(), "absent"), filepath.Join(root, "link")); err != nil {
t.Fatal(err)
}
if err := applyWorkerDataOwner(root, &workerDataOwner{os.Getuid(), os.Getgid()}); err != nil {
t.Fatal(err)
}
// A dangling target makes any accidental target dereference fail.
target := filepath.Join(t.TempDir(), "copy")
if err := utils.CopyPath(root, target, true); err != nil {
t.Fatal(err)
}
if _, err := os.Readlink(filepath.Join(target, "link")); err != nil {
t.Fatal(err)
}
}
Loading
Loading