File size: 7,497 Bytes
064bfd6 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 | import type { ContentBlockParam } from '@anthropic-ai/sdk/resources/index.mjs'
import { constants as fsConstants } from 'fs'
import { mkdir, open } from 'fs/promises'
import { dirname, isAbsolute, join, normalize, sep as pathSep } from 'path'
import type { ToolUseContext } from '../Tool.js'
import type { Command } from '../types/command.js'
import { logForDebugging } from '../utils/debug.js'
import { getBundledSkillsRoot } from '../utils/permissions/filesystem.js'
import type { HooksSettings } from '../utils/settings/types.js'
/**
* Definition for a bundled skill that ships with the CLI.
* These are registered programmatically at startup.
*/
export type BundledSkillDefinition = {
name: string
description: string
aliases?: string[]
whenToUse?: string
argumentHint?: string
allowedTools?: string[]
model?: string
disableModelInvocation?: boolean
userInvocable?: boolean
isEnabled?: () => boolean
hooks?: HooksSettings
context?: 'inline' | 'fork'
agent?: string
/**
* Additional reference files to extract to disk on first invocation.
* Keys are relative paths (forward slashes, no `..`), values are content.
* When set, the skill prompt is prefixed with a "Base directory for this
* skill: <dir>" line so the model can Read/Grep these files on demand —
* same contract as disk-based skills.
*/
files?: Record<string, string>
getPromptForCommand: (
args: string,
context: ToolUseContext,
) => Promise<ContentBlockParam[]>
}
// Internal registry for bundled skills
const bundledSkills: Command[] = []
/**
* Register a bundled skill that will be available to the model.
* Call this at module initialization or in an init function.
*
* Bundled skills are compiled into the CLI binary and available to all users.
* They follow the same pattern as registerPostSamplingHook() for internal features.
*/
export function registerBundledSkill(definition: BundledSkillDefinition): void {
const { files } = definition
let skillRoot: string | undefined
let getPromptForCommand = definition.getPromptForCommand
if (files && Object.keys(files).length > 0) {
skillRoot = getBundledSkillExtractDir(definition.name)
// Closure-local memoization: extract once per process.
// Memoize the promise (not the result) so concurrent callers await
// the same extraction instead of racing into separate writes.
let extractionPromise: Promise<string | null> | undefined
const inner = definition.getPromptForCommand
getPromptForCommand = async (args, ctx) => {
extractionPromise ??= extractBundledSkillFiles(definition.name, files)
const extractedDir = await extractionPromise
const blocks = await inner(args, ctx)
if (extractedDir === null) return blocks
return prependBaseDir(blocks, extractedDir)
}
}
const command: Command = {
type: 'prompt',
name: definition.name,
description: definition.description,
aliases: definition.aliases,
hasUserSpecifiedDescription: true,
allowedTools: definition.allowedTools ?? [],
argumentHint: definition.argumentHint,
whenToUse: definition.whenToUse,
model: definition.model,
disableModelInvocation: definition.disableModelInvocation ?? false,
userInvocable: definition.userInvocable ?? true,
contentLength: 0, // Not applicable for bundled skills
source: 'bundled',
loadedFrom: 'bundled',
hooks: definition.hooks,
skillRoot,
context: definition.context,
agent: definition.agent,
isEnabled: definition.isEnabled,
isHidden: !(definition.userInvocable ?? true),
progressMessage: 'running',
getPromptForCommand,
}
bundledSkills.push(command)
}
/**
* Get all registered bundled skills.
* Returns a copy to prevent external mutation.
*/
export function getBundledSkills(): Command[] {
return [...bundledSkills]
}
/**
* Clear bundled skills registry (for testing).
*/
export function clearBundledSkills(): void {
bundledSkills.length = 0
}
/**
* Deterministic extraction directory for a bundled skill's reference files.
*/
export function getBundledSkillExtractDir(skillName: string): string {
return join(getBundledSkillsRoot(), skillName)
}
/**
* Extract a bundled skill's reference files to disk so the model can
* Read/Grep them on demand. Called lazily on first skill invocation.
*
* Returns the directory written to, or null if write failed (skill
* continues to work, just without the base-directory prefix).
*/
async function extractBundledSkillFiles(
skillName: string,
files: Record<string, string>,
): Promise<string | null> {
const dir = getBundledSkillExtractDir(skillName)
try {
await writeSkillFiles(dir, files)
return dir
} catch (e) {
logForDebugging(
`Failed to extract bundled skill '${skillName}' to ${dir}: ${e instanceof Error ? e.message : String(e)}`,
)
return null
}
}
async function writeSkillFiles(
dir: string,
files: Record<string, string>,
): Promise<void> {
// Group by parent dir so we mkdir each subtree once, then write.
const byParent = new Map<string, [string, string][]>()
for (const [relPath, content] of Object.entries(files)) {
const target = resolveSkillFilePath(dir, relPath)
const parent = dirname(target)
const entry: [string, string] = [target, content]
const group = byParent.get(parent)
if (group) group.push(entry)
else byParent.set(parent, [entry])
}
await Promise.all(
[...byParent].map(async ([parent, entries]) => {
await mkdir(parent, { recursive: true, mode: 0o700 })
await Promise.all(entries.map(([p, c]) => safeWriteFile(p, c)))
}),
)
}
// The per-process nonce in getBundledSkillsRoot() is the primary defense
// against pre-created symlinks/dirs. Explicit 0o700/0o600 modes keep the
// nonce subtree owner-only even on umask=0, so an attacker who learns the
// nonce via inotify on the predictable parent still can't write into it.
// O_NOFOLLOW|O_EXCL is belt-and-suspenders (O_NOFOLLOW only protects the
// final component); we deliberately do NOT unlink+retry on EEXIST — unlink()
// follows intermediate symlinks too.
const O_NOFOLLOW = fsConstants.O_NOFOLLOW ?? 0
// On Windows, use string flags — numeric O_EXCL can produce EINVAL through libuv.
const SAFE_WRITE_FLAGS =
process.platform === 'win32'
? 'wx'
: fsConstants.O_WRONLY |
fsConstants.O_CREAT |
fsConstants.O_EXCL |
O_NOFOLLOW
async function safeWriteFile(p: string, content: string): Promise<void> {
const fh = await open(p, SAFE_WRITE_FLAGS, 0o600)
try {
await fh.writeFile(content, 'utf8')
} finally {
await fh.close()
}
}
/** Normalize and validate a skill-relative path; throws on traversal. */
function resolveSkillFilePath(baseDir: string, relPath: string): string {
const normalized = normalize(relPath)
if (
isAbsolute(normalized) ||
normalized.split(pathSep).includes('..') ||
normalized.split('/').includes('..')
) {
throw new Error(`bundled skill file path escapes skill dir: ${relPath}`)
}
return join(baseDir, normalized)
}
function prependBaseDir(
blocks: ContentBlockParam[],
baseDir: string,
): ContentBlockParam[] {
const prefix = `Base directory for this skill: ${baseDir}\n\n`
if (blocks.length > 0 && blocks[0]!.type === 'text') {
return [
{ type: 'text', text: prefix + blocks[0]!.text },
...blocks.slice(1),
]
}
return [{ type: 'text', text: prefix }, ...blocks]
}
|