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
117 changes: 117 additions & 0 deletions archivestore/credentials_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"os"
"path/filepath"
"strings"
"sync/atomic"
"testing"
"time"
)
Expand Down Expand Up @@ -130,3 +131,119 @@ func TestArchiveIncompleteCredentialOverride(t *testing.T) {
}
}
}

// The server removes the AWS credential variables from its environment once the
// store is built, so that child processes do not inherit them. The SDK must have
// captured by then everything it needs to sign: the static keys, and for the
// container and web-identity providers the endpoint, token and file path they
// fetch credentials from later (their first fetch happens after the scrub here).
func TestReview318CredentialsSurviveEnvScrub(t *testing.T) {
scrubbed := []string{
"AWS_ACCESS_KEY_ID", "AWS_ACCESS_KEY", "AWS_SECRET_ACCESS_KEY", "AWS_SECRET_KEY", "AWS_SESSION_TOKEN",
"AWS_CONTAINER_CREDENTIALS_FULL_URI", "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI", "AWS_CONTAINER_AUTHORIZATION_TOKEN", "AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE",
"AWS_WEB_IDENTITY_TOKEN_FILE", "AWS_ROLE_ARN",
}
for _, mode := range []string{"environment", "environment-alternate-names", "container", "web-identity"} {
t.Run(mode, func(t *testing.T) {
isolateAWSCredentials(t)
for _, key := range append([]string{
"ARTEX_ARCHIVE_S3_ACCESS_KEY_ID", "ARTEX_ARCHIVE_S3_SECRET_ACCESS_KEY", "ARTEX_ARCHIVE_S3_SESSION_TOKEN",
"ARTEX_ARCHIVE_S3_SSE", "ARTEX_ARCHIVE_S3_KMS_KEY_ID", "ARTEX_ARCHIVE_S3_PREFIX", "AWS_ENDPOINT_URL_STS",
}, scrubbed...) {
t.Setenv(key, "")
}
var envScrubbed atomic.Bool
var fetchedAfterScrub atomic.Int32
provider := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if envScrubbed.Load() {
fetchedAfterScrub.Add(1)
}
expiration := time.Now().Add(time.Hour).UTC().Format(time.RFC3339)
if mode == "container" {
if r.Header.Get("Authorization") != "fixture-container-token" {
t.Error("missing container authorization token")
}
_ = json.NewEncoder(w).Encode(map[string]any{
"AccessKeyId": "fixture-key", "SecretAccessKey": "fixture-secret",
"Token": "fixture-session", "Expiration": expiration,
})
return
}
if err := r.ParseForm(); err != nil || r.PostForm.Get("Action") != "AssumeRoleWithWebIdentity" ||
r.PostForm.Get("WebIdentityToken") != "fixture-web-identity-token" ||
r.PostForm.Get("RoleArn") != "arn:aws:iam::123456789012:role/archive" {
t.Errorf("unexpected STS request: %v %v", err, r.PostForm)
}
w.Header().Set("Content-Type", "text/xml")
fmt.Fprintf(w, `<AssumeRoleWithWebIdentityResponse xmlns="https://sts.amazonaws.com/doc/2011-06-15/"><AssumeRoleWithWebIdentityResult><Credentials><AccessKeyId>fixture-key</AccessKeyId><SecretAccessKey>fixture-secret</SecretAccessKey><SessionToken>fixture-session</SessionToken><Expiration>%s</Expiration></Credentials></AssumeRoleWithWebIdentityResult></AssumeRoleWithWebIdentityResponse>`, expiration)
}))
defer provider.Close()
switch mode {
case "environment":
t.Setenv("AWS_ACCESS_KEY_ID", "fixture-key")
t.Setenv("AWS_SECRET_ACCESS_KEY", "fixture-secret")
t.Setenv("AWS_SESSION_TOKEN", "fixture-session")
case "environment-alternate-names":
t.Setenv("AWS_ACCESS_KEY", "fixture-key")
t.Setenv("AWS_SECRET_KEY", "fixture-secret")
t.Setenv("AWS_SESSION_TOKEN", "fixture-session")
case "container":
t.Setenv("AWS_CONTAINER_CREDENTIALS_FULL_URI", provider.URL+"/credentials")
t.Setenv("AWS_CONTAINER_AUTHORIZATION_TOKEN", "fixture-container-token")
case "web-identity":
tokenFile := filepath.Join(t.TempDir(), "token")
if err := os.WriteFile(tokenFile, []byte("fixture-web-identity-token"), 0600); err != nil {
t.Fatal(err)
}
t.Setenv("AWS_WEB_IDENTITY_TOKEN_FILE", tokenFile)
t.Setenv("AWS_ROLE_ARN", "arn:aws:iam::123456789012:role/archive")
t.Setenv("AWS_ENDPOINT_URL_STS", provider.URL)
}
var authorization, sessionToken atomic.Value
objects := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodHead {
t.Errorf("unexpected S3 operation: %s", r.Method)
}
authorization.Store(r.Header.Get("Authorization"))
sessionToken.Store(r.Header.Get("X-Amz-Security-Token"))
w.WriteHeader(http.StatusNotFound)
}))
defer objects.Close()
t.Setenv("ARTEX_ARCHIVE_STORAGE", "s3")
t.Setenv("ARTEX_ARCHIVE_S3_ENDPOINT", objects.URL)
t.Setenv("ARTEX_ARCHIVE_S3_REGION", "us-east-1")
t.Setenv("ARTEX_ARCHIVE_S3_BUCKET", "fixture")
t.Setenv("ARTEX_ARCHIVE_S3_PATH_STYLE", "true")
store, err := FromEnv()
if err != nil || store == nil {
t.Fatalf("store from environment: %v", err)
}
for _, key := range scrubbed {
if err := os.Unsetenv(key); err != nil {
t.Fatal(err)
}
}
envScrubbed.Store(true)

// HEAD is the first request of a download. The fixture answers 404, so
// the call fails; only the signature of the request matters here.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
checksum := strings.Repeat("a", 64)
err = store.Download(ctx, store.URI(1, 2, checksum), filepath.Join(t.TempDir(), "probe"), checksum, 1)
if err == nil {
t.Fatal("the fixture has no object: the download must fail")
}
got, _ := authorization.Load().(string)
if !strings.Contains(got, "Credential=fixture-key/") || !strings.Contains(got, "Signature=") {
t.Fatalf("request not signed with the captured key after the scrub: Authorization=%q (%v)", got, err)
}
if token, _ := sessionToken.Load().(string); token != "fixture-session" {
t.Fatalf("session token lost after the scrub: %q", token)
}
if lazy := mode == "container" || mode == "web-identity"; lazy && fetchedAfterScrub.Load() == 0 {
t.Fatal("the provider was expected to fetch its credentials after the scrub")
}
})
}
}
12 changes: 11 additions & 1 deletion db/task_archives.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ type TaskArchive struct {
Warnings json.RawMessage `json:"warnings"`
FormatVersion int `json:"format_version"`
ArchivePath string `json:"-"`
Storage string `json:"storage,omitempty"`
SHA256 string `json:"sha256,omitempty"`
OriginalSize int64 `json:"original_size"`
CompressedSize int64 `json:"compressed_size"`
Expand Down Expand Up @@ -161,6 +162,12 @@ func scanTaskArchive(sc interface{ Scan(...any) error }) (*TaskArchive, error) {
if err != nil {
return nil, err
}
if item.ArchivePath != "" {
item.Storage = "local"
if strings.HasPrefix(item.ArchivePath, "s3://") {
item.Storage = "s3"
}
}
if err := json.Unmarshal([]byte(sources), &item.SourceTaskIDs); err != nil {
return nil, err
}
Expand Down Expand Up @@ -449,7 +456,10 @@ func (d *DB) FailTaskArchiveJob(id int64, activeState string, cause error) error
if cause != nil {
message = cause.Error()
}
_, err := d.Exec(`UPDATE task_archives SET state=$2,phase='failed',error=$3 WHERE id=$1`, id, failed, message)
// Only a job still in its active state fails. The worker also reports a panic
// it recovered after the job committed: a ready archive marked archive_failed
// could be neither restored nor deleted.
_, err := d.Exec(`UPDATE task_archives SET state=$2,phase='failed',error=$3 WHERE id=$1 AND state=$4`, id, failed, message, activeState)
return err
}

Expand Down
51 changes: 50 additions & 1 deletion db/task_archives_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,13 @@ VALUES($1,$2,0,'quota_exhausted','balance exhausted',$3,$4,$3)`, task.ID, llmPro
if err != nil {
t.Fatal(err)
}
if archive.Storage != "" {
t.Fatalf("queued archive without a location has storage %q", archive.Storage)
}
encoded, err := json.Marshal(archive)
if err != nil || bytes.Contains(encoded, []byte(`"storage"`)) {
t.Fatalf("unknown storage must be omitted from JSON: %s, %v", encoded, err)
}
claimed, err := d.ClaimTaskArchiveJob(t.Context())
if err != nil || claimed == nil || claimed.ID != archive.ID || claimed.State != Archiving {
t.Fatalf("claim = %+v, %v", claimed, err)
Expand Down Expand Up @@ -242,7 +249,7 @@ VALUES($1,$2,0,'quota_exhausted','balance exhausted',$3,$4,$3)`, task.ID, llmPro
t.Fatalf("hot compaction left nodes=%d assets=%d usage=%d", nodes, assets, usage)
}
ready, err := d.GetTaskArchive(archive.ID)
if err != nil || ready == nil || ready.State != ArchiveReady {
if err != nil || ready == nil || ready.State != ArchiveReady || ready.Storage != "local" {
t.Fatalf("ready archive = %+v, %v", ready, err)
}
var stats map[string]any
Expand Down Expand Up @@ -517,3 +524,45 @@ func TestFillArchiveDefaults(t *testing.T) {
t.Fatalf("activity changed: %s err=%v", out, err)
}
}

// FailTaskArchiveJob fails a job that is still running. A failure reported after
// the archive committed (the worker recovers a panic in the cleanup that follows
// the commit) must not turn a ready archive into archive_failed: it could then
// be neither restored nor deleted.
func TestFailTaskArchiveJobKeepsCommittedState(t *testing.T) {
d, err := Open(testDSN(t))
if err != nil {
SkipPGUnavailable(t, err)
}
defer d.Close()
task, err := d.CreateTaskWithOptions("late archive failure", "must stay ready", TaskCreateOptions{})
if err != nil {
t.Fatal(err)
}
defer func() {
_, _ = d.Exec(`DELETE FROM task_archives WHERE task_id=$1`, task.ID)
_ = d.DeleteTask(task.ID)
}()
if err := d.SetPaused(task.ID, true); err != nil {
t.Fatal(err)
}
queued, err := d.QueueTaskArchive(task.ID)
if err != nil {
t.Fatal(err)
}
for _, c := range []struct{ state, want string }{{Archiving, ArchiveFailed}, {ArchiveReady, ArchiveReady}} {
if _, err := d.Exec(`UPDATE task_archives SET state=$2,error='' WHERE id=$1`, queued.ID, c.state); err != nil {
t.Fatal(err)
}
if err := d.FailTaskArchiveJob(queued.ID, Archiving, errors.New("late failure")); err != nil {
t.Fatal(err)
}
item, err := d.GetTaskArchive(queued.ID)
if err != nil || item == nil {
t.Fatalf("archive %d: %v", queued.ID, err)
}
if item.State != c.want || (c.want == ArchiveFailed) != (item.Error == "late failure") {
t.Fatalf("failing a job in state %s: state=%s error=%q, want state %s", c.state, item.State, item.Error, c.want)
}
}
}
16 changes: 13 additions & 3 deletions server/env_scrub.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,23 @@ import "os"
// secretEnv lists the credentials read from the environment only at startup:
// ARTEX_PG_DSN and ARTEX_SECRET_KEY by NewManager, the API keys by agent.FromEnv inside New.
// agent.FromEnv also reads ARTEX_LLM_PROXY and ARTEX_LLM_BASE_URL: both are URLs that
// can carry credentials in their userinfo (http://user:pass@proxy:3128). The ARTEX_ARCHIVE_S3_*
// keys are not read by the server, but the container may carry them and the agent's
// shells would inherit them.
// can carry credentials in their userinfo (http://user:pass@proxy:3128). The archive
// store also captures ARTEX_ARCHIVE_S3_* credentials during New, before the scrub,
// so the client can use them without passing them to agent child processes.
//
// Without that override the AWS SDK's default chain reads the AWS_* names below
// while the store is built (LoadDefaultConfig) and keeps what it needs: the static
// keys, or the container endpoint and token and the web-identity role and token
// file path it fetches credentials from later. Credentials that come from a shared
// credentials or config file, or from the instance metadata service, are not in
// the environment: the scrub does not hide them from child processes.
var secretEnv = []string{
"ARTEX_PG_DSN", "ARTEX_SECRET_KEY", "ANTHROPIC_API_KEY", "OPENAI_API_KEY",
"ARTEX_LLM_PROXY", "ARTEX_LLM_BASE_URL",
"ARTEX_ARCHIVE_S3_ACCESS_KEY_ID", "ARTEX_ARCHIVE_S3_SECRET_ACCESS_KEY", "ARTEX_ARCHIVE_S3_SESSION_TOKEN",
"AWS_ACCESS_KEY_ID", "AWS_ACCESS_KEY", "AWS_SECRET_ACCESS_KEY", "AWS_SECRET_KEY", "AWS_SESSION_TOKEN",
"AWS_CONTAINER_CREDENTIALS_FULL_URI", "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI", "AWS_CONTAINER_AUTHORIZATION_TOKEN", "AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE",
"AWS_WEB_IDENTITY_TOKEN_FILE", "AWS_ROLE_ARN",
}

// ScrubSecretEnv removes secretEnv from the process environment once startup has
Expand Down
12 changes: 12 additions & 0 deletions server/envseal_linux_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,18 @@ func TestSealedEnvironmentHandoff(t *testing.T) {
"ARTEX_ARCHIVE_S3_ACCESS_KEY_ID": "AKIATESTONLY",
"ARTEX_ARCHIVE_S3_SECRET_ACCESS_KEY": "s3-secret-test",
"ARTEX_ARCHIVE_S3_SESSION_TOKEN": "",
// Ambient AWS credentials the archive store reads when it has no override.
"AWS_ACCESS_KEY_ID": "AKIAAMBIENTTEST",
"AWS_ACCESS_KEY": "AKIAALTERNATETEST",
"AWS_SECRET_ACCESS_KEY": "ambient-secret-test",
"AWS_SECRET_KEY": "alternate-secret-test",
"AWS_SESSION_TOKEN": "",
"AWS_CONTAINER_CREDENTIALS_FULL_URI": "http://127.0.0.1:8080/credentials?id=1",
"AWS_CONTAINER_CREDENTIALS_RELATIVE_URI": "/v2/credentials/test",
"AWS_CONTAINER_AUTHORIZATION_TOKEN": "container-token-test",
"AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE": "/var/run/secrets/token-file",
"AWS_WEB_IDENTITY_TOKEN_FILE": "/var/run/secrets/token",
"AWS_ROLE_ARN": "arn:aws:iam::123456789012:role/test",
}
env := os.Environ()
for k, v := range want {
Expand Down
15 changes: 10 additions & 5 deletions server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"time"

"github.com/Autumn-27/artex/agent"
"github.com/Autumn-27/artex/archivestore"
"github.com/Autumn-27/artex/db"
"github.com/Autumn-27/artex/egress"
"github.com/Autumn-27/artex/intercept"
Expand Down Expand Up @@ -158,9 +159,11 @@ type Server struct {

// Cold task archives run through one persistent FIFO worker. The buffered wake
// channel coalesces enqueue bursts; the database remains the source of truth.
archiveWake chan struct{}
archiveWG sync.WaitGroup
side *sideQuestionState
archiveWake chan struct{}
archiveWG sync.WaitGroup
archiveStore *archivestore.Store
archiveStoreErr error
side *sideQuestionState
}

// provEntry is a cached provider + its config for one LLM profile id.
Expand Down Expand Up @@ -302,8 +305,10 @@ func New(ctx context.Context, m *Manager, skillDir string, dataDir string, keyDi
} else {
log.Printf("[engine] no LLM provider configured — engine idle until set via /api/llm or env")
}
// Both env readers have now run (NewManager for the DSN, FromEnv above for the
// keys). Drop the secrets before anything below can spawn a child process:
s.initTaskArchiveStore()
// Startup env readers have now run (NewManager for the DSN, the LLM provider
// and archive store for their credentials). Drop the secrets before anything
// below can spawn a child process:
// restoring runtimes resumes workers that run shells, and MCP discovery starts
// stdio servers.
if s.scrubSecrets {
Expand Down
8 changes: 8 additions & 0 deletions server/sync_dir_other.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//go:build !unix

package server

// syncDir does nothing here: Windows does not support fsync on a directory
// handle (FlushFileBuffers fails on it), and the contents of the file written in
// the directory are already synced by the caller.
func syncDir(path string) error { return nil }
18 changes: 18 additions & 0 deletions server/sync_dir_unix.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//go:build unix

package server

import (
"errors"
"os"
)

// syncDir flushes a directory, so that an entry just created or renamed in it
// survives a crash.
func syncDir(path string) error {
d, err := os.Open(path)
if err != nil {
return err
}
return errors.Join(d.Sync(), d.Close())
}
18 changes: 18 additions & 0 deletions server/sync_dir_unix_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//go:build unix

package server

import (
"path/filepath"
"testing"
)

func TestSyncDir(t *testing.T) {
dir := t.TempDir()
if err := syncDir(dir); err != nil {
t.Fatalf("sync of an existing directory: %v", err)
}
if err := syncDir(filepath.Join(dir, "missing")); err == nil {
t.Fatal("sync of a missing directory must fail")
}
}
Loading
Loading