|
| 1 | +// .ado/scripts/build.js |
| 2 | +// BinSkim security validation for React Native Windows. |
| 3 | +// |
| 4 | +// Can be run locally or in the Azure DevOps pipeline. |
| 5 | +// Usage: node .ado/scripts/build.js --binskim [--platform x64] [--configuration Release] [--target desktop|universal] |
| 6 | + |
| 7 | +import { execSync } from "node:child_process"; |
| 8 | +import fs from "node:fs"; |
| 9 | +import path from "node:path"; |
| 10 | +import { parseArgs } from "node:util"; |
| 11 | +import { fileURLToPath } from "node:url"; |
| 12 | + |
| 13 | +const __filename = fileURLToPath(import.meta.url); |
| 14 | +const __dirname = path.dirname(__filename); |
| 15 | +const sourcesPath = path.resolve(__dirname, "..", ".."); |
| 16 | + |
| 17 | +const binskimPackageName = "Microsoft.CodeAnalysis.BinSkim"; |
| 18 | +const binskimVersion = "4.4.9"; |
| 19 | +const binskimNuGetSource = "https://api.nuget.org/v3/index.json"; |
| 20 | + |
| 21 | +const options = { |
| 22 | + help: { type: "boolean", default: false }, |
| 23 | + binskim: { type: "boolean", default: false }, |
| 24 | + platform: { type: "string", default: "x64" }, |
| 25 | + configuration: { type: "string", default: "Release" }, |
| 26 | + target: { type: "string", default: "" }, // "desktop", "universal", or "" for both |
| 27 | +}; |
| 28 | + |
| 29 | +const args = parseArgs({ options, allowPositionals: false }).values; |
| 30 | +if (args.help) { printHelp(); process.exit(0); } |
| 31 | + |
| 32 | +main(); |
| 33 | + |
| 34 | +function main() { |
| 35 | + if (!args.binskim) { |
| 36 | + console.log("No action specified. Use --binskim to run BinSkim analysis."); |
| 37 | + console.log("Run with --help for usage details."); |
| 38 | + return; |
| 39 | + } |
| 40 | + |
| 41 | + const toolsPath = path.join(sourcesPath, "tools"); |
| 42 | + const targetRoot = path.join(sourcesPath, "vnext", "target"); |
| 43 | + const plat = args.platform; |
| 44 | + const config = args.configuration; |
| 45 | + |
| 46 | + // Collect binaries based on --target flag. |
| 47 | + const candidates = []; |
| 48 | + if (!args.target || args.target === "desktop") { |
| 49 | + candidates.push( |
| 50 | + path.join(targetRoot, plat, config, "React.Windows.Desktop.DLL", "react-native-win32.dll") |
| 51 | + ); |
| 52 | + } |
| 53 | + if (!args.target || args.target === "universal") { |
| 54 | + candidates.push( |
| 55 | + path.join(targetRoot, plat, config, "Microsoft.ReactNative", "Microsoft.ReactNative.dll") |
| 56 | + ); |
| 57 | + } |
| 58 | + |
| 59 | + runBinSkim({ toolsPath, candidates }); |
| 60 | +} |
| 61 | + |
| 62 | +function printHelp() { |
| 63 | + console.log(` |
| 64 | +Usage: node build.js --binskim [options] |
| 65 | +
|
| 66 | +Options: |
| 67 | + --binskim Run BinSkim security analysis on shipped DLLs |
| 68 | + --platform <arch> Build platform (default: x64) |
| 69 | + --configuration <cfg> Build configuration (default: Release) |
| 70 | + --target <type> Target to scan: desktop, universal, or omit for both |
| 71 | + --help Show this help message |
| 72 | +`); |
| 73 | +} |
| 74 | + |
| 75 | +function ensureDir(dirPath) { |
| 76 | + if (!fs.existsSync(dirPath)) { |
| 77 | + fs.mkdirSync(dirPath, { recursive: true }); |
| 78 | + } |
| 79 | +} |
| 80 | + |
| 81 | +function ensureNuGet(toolsPath) { |
| 82 | + // Check if nuget.exe is already in the tools directory. |
| 83 | + const localNuGet = path.join(toolsPath, "nuget.exe"); |
| 84 | + if (fs.existsSync(localNuGet)) { |
| 85 | + return localNuGet; |
| 86 | + } |
| 87 | + |
| 88 | + // Check if nuget.exe is in PATH. |
| 89 | + try { |
| 90 | + const result = execSync("where nuget.exe", { encoding: "utf8" }).trim(); |
| 91 | + if (result) { |
| 92 | + const firstLine = result.split(/\r?\n/)[0]; |
| 93 | + console.log(`Found nuget.exe in PATH: ${firstLine}`); |
| 94 | + return firstLine; |
| 95 | + } |
| 96 | + } catch { |
| 97 | + // Not in PATH, download it. |
| 98 | + } |
| 99 | + |
| 100 | + // Download nuget.exe from the official distribution. |
| 101 | + ensureDir(toolsPath); |
| 102 | + console.log(`Downloading nuget.exe to: ${localNuGet}`); |
| 103 | + execSync( |
| 104 | + `powershell.exe -NoLogo -NoProfile -Command ` + |
| 105 | + `"[Net.ServicePointManager]::SecurityProtocol = ` + |
| 106 | + `[Net.SecurityProtocolType]::Tls12; ` + |
| 107 | + `Invoke-WebRequest -Uri 'https://dist.nuget.org/win-x86-commandline/latest/nuget.exe' ` + |
| 108 | + `-OutFile '${localNuGet}' -UseBasicParsing"`, |
| 109 | + { stdio: "inherit" }, |
| 110 | + ); |
| 111 | + |
| 112 | + if (!fs.existsSync(localNuGet)) { |
| 113 | + throw new Error("Failed to download nuget.exe"); |
| 114 | + } |
| 115 | + return localNuGet; |
| 116 | +} |
| 117 | + |
| 118 | +function runBinSkim({ toolsPath, candidates }) { |
| 119 | + // Determine BinSkim.exe path within the NuGet package. |
| 120 | + const binskimDir = path.join(toolsPath, "binskim"); |
| 121 | + const binskimPkgDir = path.join( |
| 122 | + binskimDir, |
| 123 | + `${binskimPackageName}.${binskimVersion}`, |
| 124 | + ); |
| 125 | + |
| 126 | + // Find BinSkim.exe under the package tools directory. The runtime folder |
| 127 | + // name varies by package version (e.g. netcoreapp3.1, net9.0). |
| 128 | + function findBinskimExe() { |
| 129 | + const toolsDir = path.join(binskimPkgDir, "tools"); |
| 130 | + if (!fs.existsSync(toolsDir)) return null; |
| 131 | + for (const runtime of fs.readdirSync(toolsDir)) { |
| 132 | + const candidate = path.join(toolsDir, runtime, "win-x64", "BinSkim.exe"); |
| 133 | + if (fs.existsSync(candidate)) return candidate; |
| 134 | + } |
| 135 | + return null; |
| 136 | + } |
| 137 | + |
| 138 | + let binskimExe = findBinskimExe(); |
| 139 | + |
| 140 | + // Install BinSkim NuGet package if not already present. |
| 141 | + if (!binskimExe) { |
| 142 | + ensureDir(binskimDir); |
| 143 | + const nuget = ensureNuGet(toolsPath); |
| 144 | + console.log( |
| 145 | + `Installing ${binskimPackageName} ${binskimVersion} from ${binskimNuGetSource}...`, |
| 146 | + ); |
| 147 | + execSync( |
| 148 | + `"${nuget}" install ${binskimPackageName}` + |
| 149 | + ` -Version ${binskimVersion}` + |
| 150 | + ` -Source "${binskimNuGetSource}"` + |
| 151 | + ` -OutputDirectory "${binskimDir}"`, |
| 152 | + { stdio: "inherit" }, |
| 153 | + ); |
| 154 | + binskimExe = findBinskimExe(); |
| 155 | + if (!binskimExe) { |
| 156 | + throw new Error( |
| 157 | + `BinSkim.exe not found after install in: ${binskimPkgDir}`, |
| 158 | + ); |
| 159 | + } |
| 160 | + } |
| 161 | + |
| 162 | + // Filter to binaries that exist on disk. |
| 163 | + const binaries = candidates.filter((f) => fs.existsSync(f)); |
| 164 | + |
| 165 | + if (binaries.length === 0) { |
| 166 | + console.warn("BinSkim: No binaries found to scan. Skipping."); |
| 167 | + return; |
| 168 | + } |
| 169 | + |
| 170 | + console.log(`\nRunning BinSkim ${binskimVersion} on ${binaries.length} binaries:`); |
| 171 | + for (const b of binaries) { |
| 172 | + console.log(` ${path.basename(b)}`); |
| 173 | + } |
| 174 | + |
| 175 | + const fileArgs = binaries.map((b) => `"${b}"`).join(" "); |
| 176 | + try { |
| 177 | + execSync( |
| 178 | + `"${binskimExe}" analyze` + |
| 179 | + ` --config default` + |
| 180 | + ` --ignorePdbLoadError` + |
| 181 | + ` --ignorePELoadErrors True` + |
| 182 | + ` --hashes` + |
| 183 | + ` --statistics` + |
| 184 | + ` --disable-telemetry True` + |
| 185 | + ` ${fileArgs}`, |
| 186 | + { stdio: "inherit" }, |
| 187 | + ); |
| 188 | + console.log("\nBinSkim: All rules passed."); |
| 189 | + } catch (error) { |
| 190 | + console.error( |
| 191 | + `\nBinSkim failed with exit code: ${error.status || "unknown"}`, |
| 192 | + ); |
| 193 | + process.exit(error.status || 1); |
| 194 | + } |
| 195 | +} |
0 commit comments