In sandboxed macOS runtimes (e.g. Codex App), `security` / Keychain APIs are blocked, so `keyring.Get`/`Set` for the DEK fails on every token read/write. Add an opt-in env var that switches the macOS implementation to the same file-based DEK scheme already used on Linux. Default behavior is unchanged. - Extract shared `fileDEK(service)` into `file_dek.go` (darwin || linux) - Linux `getDEK` now delegates to `fileDEK` - Darwin `getDEK` short-circuits to `fileDEK` when DWS_DISABLE_KEYCHAIN=1 - Document the tradeoff in reference.md (DEK and ciphertext co-located) - Add darwin-only tests covering fallback path + overwrite
108 lines
3.0 KiB
Go
108 lines
3.0 KiB
Go
// Copyright 2026 Alibaba Group
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//go:build darwin
|
|
|
|
package keychain
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
)
|
|
|
|
// TestDisableKeychainFallback verifies that setting DWS_DISABLE_KEYCHAIN
|
|
// routes the DEK to a local file (same scheme as Linux) and the full
|
|
// Set/Get/Remove cycle works without touching the system Keychain.
|
|
// This is the support path for sandboxed runtimes such as Codex App.
|
|
func TestDisableKeychainFallback(t *testing.T) {
|
|
tmp := t.TempDir()
|
|
t.Setenv(StorageDirEnv, tmp)
|
|
t.Setenv(DisableKeychainEnv, "1")
|
|
|
|
service := "test-disable-keychain"
|
|
account := "auth-token"
|
|
payload := `{"access_token":"abc","refresh_token":"def"}`
|
|
|
|
if err := Set(service, account, payload); err != nil {
|
|
t.Fatalf("Set() error = %v", err)
|
|
}
|
|
|
|
// File DEK must materialize on disk.
|
|
dekPath := filepath.Join(tmp, service, "dek")
|
|
info, err := os.Stat(dekPath)
|
|
if err != nil {
|
|
t.Fatalf("file DEK not created at %s: %v", dekPath, err)
|
|
}
|
|
if mode := info.Mode().Perm(); mode != 0600 {
|
|
t.Fatalf("DEK file perm = %o, want 0600", mode)
|
|
}
|
|
|
|
got, err := Get(service, account)
|
|
if err != nil {
|
|
t.Fatalf("Get() error = %v", err)
|
|
}
|
|
if got != payload {
|
|
t.Fatalf("Get() = %q, want %q", got, payload)
|
|
}
|
|
|
|
// A second Get must reuse the same DEK (no regeneration).
|
|
dek1, err := os.ReadFile(dekPath)
|
|
if err != nil {
|
|
t.Fatalf("ReadFile(dek) error = %v", err)
|
|
}
|
|
if _, err := Get(service, account); err != nil {
|
|
t.Fatalf("second Get() error = %v", err)
|
|
}
|
|
dek2, err := os.ReadFile(dekPath)
|
|
if err != nil {
|
|
t.Fatalf("ReadFile(dek) second error = %v", err)
|
|
}
|
|
if string(dek1) != string(dek2) {
|
|
t.Fatal("DEK rotated between calls; want stable")
|
|
}
|
|
|
|
if err := Remove(service, account); err != nil {
|
|
t.Fatalf("Remove() error = %v", err)
|
|
}
|
|
if Exists(service, account) {
|
|
t.Fatal("Exists() = true after Remove(), want false")
|
|
}
|
|
}
|
|
|
|
// TestDisableKeychainOverwrite verifies the fallback path supports
|
|
// overwriting an existing token entry.
|
|
func TestDisableKeychainOverwrite(t *testing.T) {
|
|
tmp := t.TempDir()
|
|
t.Setenv(StorageDirEnv, tmp)
|
|
t.Setenv(DisableKeychainEnv, "1")
|
|
|
|
service := "test-disable-keychain-overwrite"
|
|
account := "auth-token"
|
|
|
|
if err := Set(service, account, "initial"); err != nil {
|
|
t.Fatalf("Set() initial error = %v", err)
|
|
}
|
|
if err := Set(service, account, "overwritten"); err != nil {
|
|
t.Fatalf("Set() overwrite error = %v", err)
|
|
}
|
|
|
|
got, err := Get(service, account)
|
|
if err != nil {
|
|
t.Fatalf("Get() error = %v", err)
|
|
}
|
|
if got != "overwritten" {
|
|
t.Fatalf("Get() = %q, want %q", got, "overwritten")
|
|
}
|
|
}
|