Skip to content

armgit / kiln

Public Imported from GitHub
0

Build and revise procedural 3D assets with your coding agent. Local MCP server, CLI and TypeScript engine with rendered review, editable source and GLB export.

Document security reporting and complete plugin maintenance metadata (#182)

Matthew Kissingerf2afa3704268
diff --git a/.codex-plugin/plugin.json b/.codex-plugin/plugin.json
index 8593b3f8..78248e7f 100644
--- a/.codex-plugin/plugin.json
+++ b/.codex-plugin/plugin.json
@@ -5,12 +5,23 @@
"author": {
"name": "Matthew Kissinger"
},
+ "homepage": "https://kilnstudio.tools",
+ "repository": "https://github.com/instruktlabs/kiln",
+ "keywords": [
+ "3d",
+ "glb",
+ "gltf",
+ "asset-generation",
+ "three.js",
+ "gamedev"
+ ],
"skills": "./skills/",
"interface": {
"displayName": "Kiln",
"shortDescription": "Build and collect editable 3D assets",
"longDescription": "Author JavaScript, inspect camera views, and save GLBs with source revisions for later refinement.",
"developerName": "Instrukt Labs",
+ "websiteURL": "https://kilnstudio.tools",
"category": "Developer Tools",
"capabilities": [
"Read",
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 00000000..10944d56
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,46 @@
+version: 2
+
+updates:
+ - package-ecosystem: github-actions
+ directory: "/"
+ schedule:
+ interval: monthly
+ open-pull-requests-limit: 1
+ groups:
+ actions-minor-and-patch:
+ patterns:
+ - "*"
+ update-types:
+ - minor
+ - patch
+
+ - package-ecosystem: bun
+ directories:
+ - "/"
+ - "/site"
+ - "/scenes"
+ schedule:
+ interval: monthly
+ open-pull-requests-limit: 1
+ groups:
+ bun-minor-and-patch:
+ patterns:
+ - "*"
+ update-types:
+ - minor
+ - patch
+
+ - package-ecosystem: npm
+ directories:
+ - "/render-service"
+ - "/scripts/research-discovery"
+ schedule:
+ interval: monthly
+ open-pull-requests-limit: 1
+ groups:
+ npm-minor-and-patch:
+ patterns:
+ - "*"
+ update-types:
+ - minor
+ - patch
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0623b456..dc085da1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ does not publish a package.
## Unreleased
+- Document private security reporting, include the policy in distributed
+ packages, complete Codex plugin website and repository metadata, and
+ configure monthly dependency update proposals.
+
## 1.3.0 (2026-10-16)
- Add optional game delivery roles, colliders, anchors, kit ports, surface bakes,
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 69e04fc9..2bdc0546 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -5,6 +5,10 @@ For a behavior bug, include a minimal `.kiln.js` program, the command or tool ca
and the error or image you saw. Include your OS, Node version and whether rendering
used CPU or GPU. Remove credentials and private paths from shared logs.
+For suspected vulnerabilities, follow the [security policy](SECURITY.md)
+and report privately to [email protected]. Keep exploit details,
+credentials and private assets out of public issues.
+
## Work on the engine
Read [AGENTS.md](AGENTS.md) and the [README](README.md). Contributor checks use Bun
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..a5fb38b5
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,43 @@
+# Security policy
+
+## Scope and supported versions
+
+This policy covers the Kiln engine, CLI, MCP server, local render service,
+and plugin packages maintained in this repository.
+
+Security fixes target the latest stable engine and plugin releases.
+Older releases do not have separately maintained security branches.
+Reports affecting any version are welcome; resolving an issue may
+require upgrading to a current release.
+
+## Report a vulnerability
+
+Email [email protected] with the subject "Kiln security report".
+
+Include, where available:
+
+- The affected engine and plugin versions.
+- Your operating system and Node version.
+- The affected command, tool, or integration.
+- A small, sanitized reproduction.
+- The observed behavior and potential impact.
+
+Do not include credentials, private assets, or unrelated personal data.
+Do not post exploit details or sensitive reports in public GitHub issues.
+We will coordinate investigation and disclosure with the reporter.
+This project does not promise a fixed response or resolution time.
+
+For ordinary bugs and feature requests, use:
+https://github.com/instruktlabs/kiln/issues
+
+## Local execution boundaries
+
+Kiln evaluates authored JavaScript. The packaged CLI and MCP server
+use a subprocess with execution and output limits by default.
+That subprocess is not a complete security sandbox.
+
+Do not treat Kiln's evaluator as sufficient isolation for running
+untrusted programs with access to sensitive host resources.
+
+See the runtime documentation for execution modes and limits:
+https://github.com/instruktlabs/kiln/blob/main/docs/runtime.md
diff --git a/package.json b/package.json
index 9cf7f270..7f770470 100644
--- a/package.json
+++ b/package.json
@@ -309,6 +309,7 @@
"docs/tools-operations.md",
"README.md",
"CONTRIBUTING.md",
+ "SECURITY.md",
"LICENSE",
"THIRD_PARTY_NOTICES.md",
"CHANGELOG.md"
diff --git a/plugins/kiln-engine/README.md b/plugins/kiln-engine/README.md
index 845fa2a4..0414ca8c 100644
--- a/plugins/kiln-engine/README.md
+++ b/plugins/kiln-engine/README.md
@@ -106,5 +106,5 @@ sanitized reproduction at [GitHub issues](https://github.com/instruktlabs/kiln/i
If setup fails, retain the error, check Node/npm and network access, and follow the
setup guide. Do not delete an unfamiliar runtime or another installer's lock.
-[Local privacy notice](PRIVACY.md) · [MIT license](LICENSE) ·
+[Security policy](SECURITY.md) · [Local privacy notice](PRIVACY.md) · [MIT license](LICENSE) ·
[Source](https://github.com/instruktlabs/kiln)
diff --git a/plugins/kiln-engine/SECURITY.md b/plugins/kiln-engine/SECURITY.md
new file mode 100644
index 00000000..a5fb38b5
--- /dev/null
+++ b/plugins/kiln-engine/SECURITY.md
@@ -0,0 +1,43 @@
+# Security policy
+
+## Scope and supported versions
+
+This policy covers the Kiln engine, CLI, MCP server, local render service,
+and plugin packages maintained in this repository.
+
+Security fixes target the latest stable engine and plugin releases.
+Older releases do not have separately maintained security branches.
+Reports affecting any version are welcome; resolving an issue may
+require upgrading to a current release.
+
+## Report a vulnerability
+
+Email [email protected] with the subject "Kiln security report".
+
+Include, where available:
+
+- The affected engine and plugin versions.
+- Your operating system and Node version.
+- The affected command, tool, or integration.
+- A small, sanitized reproduction.
+- The observed behavior and potential impact.
+
+Do not include credentials, private assets, or unrelated personal data.
+Do not post exploit details or sensitive reports in public GitHub issues.
+We will coordinate investigation and disclosure with the reporter.
+This project does not promise a fixed response or resolution time.
+
+For ordinary bugs and feature requests, use:
+https://github.com/instruktlabs/kiln/issues
+
+## Local execution boundaries
+
+Kiln evaluates authored JavaScript. The packaged CLI and MCP server
+use a subprocess with execution and output limits by default.
+That subprocess is not a complete security sandbox.
+
+Do not treat Kiln's evaluator as sufficient isolation for running
+untrusted programs with access to sensitive host resources.
+
+See the runtime documentation for execution modes and limits:
+https://github.com/instruktlabs/kiln/blob/main/docs/runtime.md
diff --git a/plugins/kiln-engine/package-provenance.json b/plugins/kiln-engine/package-provenance.json
index 655f7c9f..b6baf802 100644
--- a/plugins/kiln-engine/package-provenance.json
+++ b/plugins/kiln-engine/package-provenance.json
@@ -13,8 +13,9 @@
"LICENSE": "sha256:cdba278ebf1d6de618869936226bf03be4887179c128efc7aaa13d22034826a5",
"plugin.json": "sha256:425bcd358ed757c1a805bec8ae6f2cd2c57688d6e438e7f7a06b7e750df7805b",
"PRIVACY.md": "sha256:5f58d981667e40441e21c2dec411f269a9a67a6141cec61976d27088fb12573b",
- "README.md": "sha256:b759c4ec60dc6440441a6a7e9eefc453455b810cbe31363c47078a48e88bda2b",
+ "README.md": "sha256:d8be7621db5b864df5242f9dc3cd8ddbef51ebbada3afcfd7043840f9e8006f2",
"runtime.json": "sha256:b6ed859e3a27c6275a740f11abdd53e0753228919574cca92a15453a870dfa1c",
+ "SECURITY.md": "sha256:8e238d3985deff828efd71bc3354a5b0275613a4921f369fc971f760ca249606",
"skills/kiln-setup-workspace/references/plugin-install.md": "sha256:c338fb792e7fad0364c3e1a13c94c506afa1395489ec1b6e83b36d04728935fb",
"skills/kiln-setup-workspace/references/renderer-setup.md": "sha256:b743b1b2827fa814385990e1e5b849391cb427413e9c016d273aa19cebd46031",
"skills/kiln-setup-workspace/SKILL.md": "sha256:65ed926b3503a33f4fe793e84e4a045ce36e3967f0e6b340e456a15dd010ce54"
diff --git a/scripts/package-local-plugin.mjs b/scripts/package-local-plugin.mjs
index 6c30d34c..fe4481e4 100644
--- a/scripts/package-local-plugin.mjs
+++ b/scripts/package-local-plugin.mjs
@@ -99,6 +99,7 @@ async function expectedFiles() {
}),
],
['LICENSE', await readFile(join(repo, 'LICENSE'))],
+ ['SECURITY.md', await readFile(join(repo, 'SECURITY.md'))],
['PRIVACY.md', await readFile(join(repo, 'docs/local-plugin-privacy.md'))],
[executable, await readFile(join(repo, 'scripts/setup-plugin-workspace.mjs'))],
]);
@@ -223,7 +224,7 @@ sanitized reproduction at [GitHub issues](https://github.com/instruktlabs/kiln/i
If setup fails, retain the error, check Node/npm and network access, and follow the
setup guide. Do not delete an unfamiliar runtime or another installer's lock.
-[Local privacy notice](PRIVACY.md) · [MIT license](LICENSE) ·
+[Security policy](SECURITY.md) · [Local privacy notice](PRIVACY.md) · [MIT license](LICENSE) ·
[Source](https://github.com/instruktlabs/kiln)
`,
),
diff --git a/scripts/package-local-plugin.test.mjs b/scripts/package-local-plugin.test.mjs
index e3500f6e..edee2e38 100644
--- a/scripts/package-local-plugin.test.mjs
+++ b/scripts/package-local-plugin.test.mjs
@@ -86,6 +86,9 @@ test('bundle registers setup alone and keeps its complete maintained reference a
expect(await readFile(join(directory, 'PRIVACY.md'), 'utf8')).toBe(
await readFile(resolve('docs/local-plugin-privacy.md'), 'utf8'),
);
+ expect(await readFile(join(directory, 'SECURITY.md'), 'utf8')).toBe(
+ await readFile(resolve('SECURITY.md'), 'utf8'),
+ );
const entries = await readdir(directory);
for (const excluded of [
'src',
diff --git a/scripts/package-plugin.mjs b/scripts/package-plugin.mjs
index 70548293..9bc31c11 100644
--- a/scripts/package-plugin.mjs
+++ b/scripts/package-plugin.mjs
@@ -27,6 +27,7 @@ export async function packagePlugin(destination, appId) {
);
await cp(join(repo, 'skills'), join(directory, 'skills'), { recursive: true });
await cp(join(repo, 'LICENSE'), join(directory, 'LICENSE'));
+ await cp(join(repo, 'SECURITY.md'), join(directory, 'SECURITY.md'));
if (appId)
await writeFile(
join(directory, '.app.json'),
diff --git a/scripts/smoke-package.mjs b/scripts/smoke-package.mjs
index 8716cb92..7d31cc08 100644
--- a/scripts/smoke-package.mjs
+++ b/scripts/smoke-package.mjs
@@ -196,6 +196,8 @@ try {
assert(pack.files.some((entry) => entry.path === 'scripts/create-workspace.mjs'));
assert(pack.files.some((entry) => entry.path === 'plugin.json'));
assert(pack.files.some((entry) => entry.path === '.claude-plugin/plugin.json'));
+ assert(pack.files.some((entry) => entry.path === 'SECURITY.md'));
+ assert(pack.files.some((entry) => entry.path === 'plugins/kiln-engine/SECURITY.md'));
// The MCP server tells every model that a GPU renderer "ships as render-service/
// in this installation". That sentence was false for anyone installing from npm
// until this line existed, and the on-demand start has nothing to start without it.
diff --git a/scripts/test-plugin-package.mjs b/scripts/test-plugin-package.mjs
index 932354d7..89aaad07 100644
--- a/scripts/test-plugin-package.mjs
+++ b/scripts/test-plugin-package.mjs
@@ -11,6 +11,21 @@ try {
assert.equal(manifest.apps, './.app.json');
assert.equal(manifest.mcpServers, undefined);
assert.equal(manifest.name, 'kiln-chatgpt');
+ assert.equal(manifest.homepage, 'https://kilnstudio.tools');
+ assert.equal(manifest.repository, 'https://github.com/instruktlabs/kiln');
+ assert.equal(manifest.interface.websiteURL, manifest.homepage);
+ assert.deepEqual(manifest.keywords, [
+ '3d',
+ 'glb',
+ 'gltf',
+ 'asset-generation',
+ 'three.js',
+ 'gamedev',
+ ]);
+ assert.equal(
+ await readFile(join(result.directory, 'SECURITY.md'), 'utf8'),
+ await readFile(new URL('../SECURITY.md', import.meta.url), 'utf8'),
+ );
const mapping = JSON.parse(await readFile(join(result.directory, '.app.json')));
assert.equal(mapping.apps.kiln.id, 'plugin_asdk_app_test');
assert.match(