Skip to content

Commit 86606ef

Browse files
mvanhornclaude
andcommitted
fix: address Copilot review feedback for config scaffolding
- Validate manifest config shape (reject non-list/non-dict entries) - Add path traversal protection (reject .. segments and absolute paths) - Use is_file() check instead of exists() to reject directory templates - Return (deployed, skipped) tuple for richer CLI messaging - Add security tests for path traversal and directory rejection - Add test for malformed manifest config sections Co-Authored-By: Claude Opus 4.6 <[email protected]>
1 parent 3efbaf3 commit 86606ef

3 files changed

Lines changed: 89 additions & 14 deletions

File tree

‎src/specify_cli/__init__.py‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3667,13 +3667,13 @@ def extension_add(
36673667
console.print(f"\n[green]✓[/green] {len(reg_skills)} agent skill(s) auto-registered")
36683668

36693669
# Scaffold config templates automatically
3670-
deployed = manager.scaffold_config(manifest.id)
3670+
deployed, skipped = manager.scaffold_config(manifest.id)
36713671
if deployed:
36723672
console.print("\n[bold cyan]Config scaffolded:[/bold cyan]")
36733673
for cfg in deployed:
36743674
console.print(f" • .specify/{cfg}")
3675-
elif manifest.config:
3676-
console.print("\n[dim]Config files already exist (preserved).[/dim]")
3675+
if skipped:
3676+
console.print(f"\n[dim]Config files already exist (preserved): {', '.join(skipped)}[/dim]")
36773677

36783678
except ValidationError as e:
36793679
console.print(f"\n[red]Validation Error:[/red] {e}")
@@ -4477,11 +4477,13 @@ def extension_enable(
44774477
console.print(f"[green]✓[/green] Extension '{display_name}' enabled")
44784478

44794479
# Scaffold config templates on enable
4480-
deployed = manager.scaffold_config(extension_id)
4480+
deployed, skipped = manager.scaffold_config(extension_id)
44814481
if deployed:
44824482
console.print("\n[bold cyan]Config scaffolded:[/bold cyan]")
44834483
for cfg in deployed:
44844484
console.print(f" • .specify/{cfg}")
4485+
if skipped:
4486+
console.print(f"\n[dim]Config files already exist (preserved): {', '.join(skipped)}[/dim]")
44854487

44864488

44874489
@extension_app.command("disable")

‎src/specify_cli/extensions.py‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,10 @@ def hooks(self) -> Dict[str, Any]:
236236
@property
237237
def config(self) -> List[Dict[str, Any]]:
238238
"""Get list of provided config templates."""
239-
return self.data.get("provides", {}).get("config", [])
239+
raw = self.data.get("provides", {}).get("config", [])
240+
if not isinstance(raw, list):
241+
return []
242+
return [entry for entry in raw if isinstance(entry, dict)]
240243

241244
def get_hash(self) -> str:
242245
"""Calculate SHA256 hash of manifest file."""
@@ -1130,7 +1133,7 @@ def install_from_zip(
11301133
# Install from extracted directory
11311134
return self.install_from_directory(extension_dir, speckit_version, priority=priority)
11321135

1133-
def scaffold_config(self, extension_id: str) -> List[str]:
1136+
def scaffold_config(self, extension_id: str) -> tuple:
11341137
"""Deploy config templates from an installed extension to the project.
11351138
11361139
Reads the extension's manifest provides.config section and copies
@@ -1141,7 +1144,8 @@ def scaffold_config(self, extension_id: str) -> List[str]:
11411144
extension_id: ID of the installed extension
11421145
11431146
Returns:
1144-
List of deployed config file names (empty if all already existed)
1147+
Tuple of (deployed, skipped_existing) where each is a list of
1148+
config file names.
11451149
"""
11461150
ext_dir = self.extensions_dir / extension_id
11471151
manifest_path = ext_dir / "extension.yml"
@@ -1151,26 +1155,34 @@ def scaffold_config(self, extension_id: str) -> List[str]:
11511155
manifest = ExtensionManifest(manifest_path)
11521156
deployed = []
11531157

1158+
skipped_existing = []
1159+
11541160
for config_entry in manifest.config:
11551161
template_name = config_entry.get("template", "")
11561162
target_name = config_entry.get("name", template_name)
11571163
if not template_name:
11581164
continue
11591165

1166+
# Reject path traversal and absolute paths
1167+
if Path(template_name).is_absolute() or ".." in Path(template_name).parts:
1168+
continue
1169+
if Path(target_name).is_absolute() or ".." in Path(target_name).parts:
1170+
continue
1171+
11601172
template_path = ext_dir / template_name
1161-
if not template_path.exists():
1173+
if not template_path.exists() or not template_path.is_file():
11621174
continue
11631175

11641176
target_path = self.project_root / ".specify" / target_name
11651177
if target_path.exists():
1166-
# Never overwrite user-customized config
1178+
skipped_existing.append(target_name)
11671179
continue
11681180

11691181
target_path.parent.mkdir(parents=True, exist_ok=True)
11701182
shutil.copy2(template_path, target_path)
11711183
deployed.append(target_name)
11721184

1173-
return deployed
1185+
return deployed, skipped_existing
11741186

11751187
def remove(self, extension_id: str, keep_config: bool = False) -> bool:
11761188
"""Remove an installed extension.

‎tests/test_extensions.py‎

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -885,9 +885,10 @@ def test_scaffold_config_deploys_template(self, tmp_path):
885885
(ext_dir / "config-template.yml").write_text("setting: default")
886886

887887
manager = ExtensionManager(project)
888-
deployed = manager.scaffold_config("test-ext")
888+
deployed, skipped = manager.scaffold_config("test-ext")
889889

890890
assert deployed == ["test-config.yml"]
891+
assert skipped == []
891892
assert (specify_dir / "test-config.yml").exists()
892893
assert (specify_dir / "test-config.yml").read_text() == "setting: default"
893894

@@ -908,9 +909,10 @@ def test_scaffold_config_preserves_existing(self, tmp_path):
908909
(ext_dir / "config-template.yml").write_text("setting: default")
909910

910911
manager = ExtensionManager(project)
911-
deployed = manager.scaffold_config("test-ext")
912+
deployed, skipped = manager.scaffold_config("test-ext")
912913

913914
assert deployed == []
915+
assert skipped == ["test-config.yml"]
914916
assert (specify_dir / "test-config.yml").read_text() == "setting: custom"
915917

916918
def test_scaffold_config_no_config_section(self, tmp_path):
@@ -923,9 +925,10 @@ def test_scaffold_config_no_config_section(self, tmp_path):
923925
self._make_extension(ext_dir)
924926

925927
manager = ExtensionManager(project)
926-
deployed = manager.scaffold_config("test-ext")
928+
deployed, skipped = manager.scaffold_config("test-ext")
927929

928930
assert deployed == []
931+
assert skipped == []
929932

930933
def test_scaffold_config_missing_template_file(self, tmp_path):
931934
"""Missing template file should be silently skipped."""
@@ -941,9 +944,67 @@ def test_scaffold_config_missing_template_file(self, tmp_path):
941944
}])
942945

943946
manager = ExtensionManager(project)
944-
deployed = manager.scaffold_config("test-ext")
947+
deployed, skipped = manager.scaffold_config("test-ext")
945948

946949
assert deployed == []
950+
assert skipped == []
951+
952+
def test_scaffold_config_rejects_path_traversal(self, tmp_path):
953+
"""Config names with path traversal should be rejected."""
954+
from specify_cli.extensions import ExtensionManager
955+
project = tmp_path / "project"
956+
specify_dir = project / ".specify"
957+
specify_dir.mkdir(parents=True)
958+
ext_dir = specify_dir / "extensions" / "test-ext"
959+
self._make_extension(ext_dir, config_entries=[
960+
{"name": "../etc/passwd", "template": "config.yml"},
961+
{"name": "safe.yml", "template": "../../secrets.yml"},
962+
{"name": "/absolute/path.yml", "template": "config.yml"},
963+
])
964+
(ext_dir / "config.yml").write_text("safe: true")
965+
966+
manager = ExtensionManager(project)
967+
deployed, skipped = manager.scaffold_config("test-ext")
968+
969+
assert deployed == []
970+
assert skipped == []
971+
972+
def test_scaffold_config_rejects_directory_template(self, tmp_path):
973+
"""Directory templates should be rejected (must be regular files)."""
974+
from specify_cli.extensions import ExtensionManager
975+
project = tmp_path / "project"
976+
specify_dir = project / ".specify"
977+
specify_dir.mkdir(parents=True)
978+
ext_dir = specify_dir / "extensions" / "test-ext"
979+
self._make_extension(ext_dir, config_entries=[{
980+
"name": "test-config.yml",
981+
"template": "config-dir",
982+
}])
983+
(ext_dir / "config-dir").mkdir()
984+
985+
manager = ExtensionManager(project)
986+
deployed, skipped = manager.scaffold_config("test-ext")
987+
988+
assert deployed == []
989+
990+
def test_scaffold_config_malformed_manifest(self, tmp_path):
991+
"""Malformed config sections should not crash."""
992+
from specify_cli.extensions import ExtensionManifest
993+
import yaml
994+
project = tmp_path / "project"
995+
specify_dir = project / ".specify"
996+
specify_dir.mkdir(parents=True)
997+
ext_dir = specify_dir / "extensions" / "test-ext"
998+
ext_dir.mkdir(parents=True)
999+
manifest_data = {
1000+
"id": "test-ext",
1001+
"name": "Test Extension",
1002+
"version": "1.0.0",
1003+
"provides": {"config": "not-a-list"},
1004+
}
1005+
(ext_dir / "extension.yml").write_text(yaml.dump(manifest_data))
1006+
manifest = ExtensionManifest(ext_dir / "extension.yml")
1007+
assert manifest.config == []
9471008

9481009

9491010
# ===== CommandRegistrar Tests =====

0 commit comments

Comments
 (0)