solidity/test/solc/CommandLineInterfaceAllowPaths.cpp at develop · electrocipher/solidity · GitHub

History

571 lines (468 loc) · 30.6 KB

Raw

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

This file is part of solidity.

solidity is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

solidity is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with solidity. If not, see <http://www.gnu.org/licenses/>.

// SPDX-License-Identifier: GPL-3.0

/// Unit tests for solc/CommandLineInterface.h

#include <solc/CommandLineInterface.h>

#include <test/solc/Common.h>

#include <test/Common.h>

#include <test/FilesystemUtils.h>

#include <test/libsolidity/util/SoltestErrors.h>

#include <libsolutil/TemporaryDirectory.h>

#include <boost/algorithm/string/predicate.hpp>

#include <fstream>

#include <regex>

#include <string>

#include <vector>

using namespace std;

using namespace solidity::frontend;

using namespace solidity::util;

using namespace solidity::test;

#define TEST_CASE_NAME (boost::unit_test::framework::current_test_case().p_name)

namespace

{

struct ImportCheck

{

enum class Result

{

Unknown, ///< Status is unknown due to a failure of the status check.

OK, ///< Passed compilation without errors.

FileNotFound, ///< Error was reported: file not found.

PathDisallowed, ///< Error was reported: file not allowed paths.

};

bool operator==(ImportCheck const& _other) const { return result == _other.result && message == _other.message; }

bool operator!=(ImportCheck const& _other) const { return !(*this == _other); }

operator bool() const { return this->result == Result::OK; }

static ImportCheck const OK() { return {Result::OK, ""}; }

static ImportCheck const FileNotFound() { return {Result::FileNotFound, ""}; }

static ImportCheck const PathDisallowed() { return {Result::PathDisallowed, ""}; }

static ImportCheck const Unknown(const string& _message) { return {Result::Unknown, _message}; }

Result result;

std::string message;

};

ImportCheck checkImport(

string const& _import,

vector<string> const& _cliOptions

)

{

soltestAssert(regex_match(_import, regex{R"(import '[^']*')"}), "");

for (string const& option: _cliOptions)

soltestAssert(

boost::starts_with(option, "--base-path") ||

boost::starts_with(option, "--include-path") ||

boost::starts_with(option, "--allow-paths") ||

!boost::starts_with(option, "--"),

);

vector<string> commandLine = {

"solc",

"-",

"--no-color",

"--error-codes",

};

commandLine += _cliOptions;

string standardInputContent =

"// SPDX-License-Identifier: GPL-3.0\n"

"pragma solidity >=0.0;\n" +

_import + ";";

test::OptionsReaderAndMessages cliResult = test::runCLI(commandLine, standardInputContent);

if (cliResult.success)

return ImportCheck::OK();

static regex const sourceNotFoundErrorRegex{

R"(^Error $6275$: Source "[^"]+" not found: (.*)\.\n)"

R"(\s*--> .*<stdin>:\d+:\d+:\n)"

R"(\s*\|\n)"

R"(\d+\s*\| import '.+';\n)"

R"(\s*\| \^+\n\s*$)"

};

smatch submatches;

if (!regex_match(cliResult.stderrContent, submatches, sourceNotFoundErrorRegex))

return ImportCheck::Unknown("Unexpected stderr content: '" + cliResult.stderrContent + "'");

if (submatches[1] != "File not found" && !boost::starts_with(string(submatches[1]), "File outside of allowed directories"))

return ImportCheck::Unknown("Unexpected error message: '" + cliResult.stderrContent + "'");

if (submatches[1] == "File not found")

return ImportCheck::FileNotFound();

else if (boost::starts_with(string(submatches[1]), "File outside of allowed directories"))

return ImportCheck::PathDisallowed();

else

return ImportCheck::Unknown("Unexpected error message '" + submatches[1].str() + "'");

}

class AllowPathsFixture

{

protected:

AllowPathsFixture():

m_tempDir({"code/", "work/"}, TEST_CASE_NAME),

m_tempWorkDir(m_tempDir.path() / "work"),

m_codeDir(m_tempDir.path() / "code"),

m_workDir(m_tempDir.path() / "work"),

m_portablePrefix(("/" / boost::filesystem::canonical(m_codeDir).relative_path()).generic_string())

{

createFilesWithParentDirs(

{

m_codeDir / "a/b/c/d.sol",

m_codeDir / "a/b/c.sol",

m_codeDir / "a/b/X.sol",

m_codeDir / "a/X/c.sol",

m_codeDir / "X/b/c.sol",

m_codeDir / "a/bc/d.sol",

m_codeDir / "X/bc/d.sol",

m_codeDir / "x/y/z.sol",

m_codeDir / "1/2/3.sol",

m_codeDir / "contract.sol",

m_workDir / "a/b/c/d.sol",

m_workDir / "a/b/c.sol",

m_workDir / "a/b/X.sol",

m_workDir / "a/X/c.sol",

m_workDir / "X/b/c.sol",

m_workDir / "contract.sol",

"// SPDX-License-Identifier: GPL-3.0\npragma solidity >=0.0;"

);

if (

!createSymlinkIfSupportedByFilesystem("b", m_codeDir / "a/b_sym", true) ||

!createSymlinkIfSupportedByFilesystem("../x/y", m_codeDir / "a/y_sym", true) ||

!createSymlinkIfSupportedByFilesystem("../../a/b/c.sol", m_codeDir / "a/b/c_sym.sol", false) ||

!createSymlinkIfSupportedByFilesystem("../../x/y/z.sol", m_codeDir / "a/b/z_sym.sol", false)

)

return;

m_caseSensitiveFilesystem = boost::filesystem::create_directories(m_codeDir / "A/B/C");

soltestAssert(boost::filesystem::equivalent(m_codeDir / "a/b/c", m_codeDir / "A/B/C") != m_caseSensitiveFilesystem, "");

}

TemporaryDirectory m_tempDir;

TemporaryWorkingDirectory m_tempWorkDir;

boost::filesystem::path const m_codeDir;

boost::filesystem::path const m_workDir;

string m_portablePrefix;

bool m_caseSensitiveFilesystem = true;

};

ostream& operator<<(ostream& _out, ImportCheck const& _value)

{

switch (_value.result)

{

case ImportCheck::Result::Unknown: _out << "Unknown"; break;

case ImportCheck::Result::OK: _out << "OK"; break;

case ImportCheck::Result::FileNotFound: _out << "FileNotFound"; break;

case ImportCheck::Result::PathDisallowed: _out << "PathDisallowed"; break;

}

if (_value.message != "")

_out << "(" << _value.message << ")";

return _out;

}

} // namespace

namespace boost::test_tools::tt_detail

{

// Boost won't find the << operator unless we put it in the std namespace which is illegal.

// The recommended solution is to overload print_log_value<> struct and make it use our operator.

template<>

struct print_log_value<ImportCheck>

{

void operator()(std::ostream& _out, ImportCheck const& _value) { ::operator<<(_out, _value); }

};

} // namespace boost::test_tools::tt_detail

namespace solidity::frontend::test

{

BOOST_AUTO_TEST_SUITE(CommandLineInterfaceAllowPathsTest)

BOOST_FIXTURE_TEST_CASE(allow_path_multiple_paths, AllowPathsFixture)

{

string allowedPaths =

m_codeDir.generic_string() + "/a/b/X.sol," +

m_codeDir.generic_string() + "/X/," +

m_codeDir.generic_string() + "/z," +

m_codeDir.generic_string() + "/a/b";

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", allowedPaths}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"--allow-paths", allowedPaths}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"--allow-paths", allowedPaths}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"--allow-paths", allowedPaths}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_should_work_with_various_path_forms, AllowPathsFixture)

{

string import = "import '" + m_portablePrefix + "/a/b/c.sol'";

// Without --allow-path

BOOST_TEST(checkImport(import, {}) == ImportCheck::PathDisallowed());

// Absolute paths allowed

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string()}));

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string() + "/a/"}));

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string() + "/a/b"}));

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string() + "/a/b/c.sol"}));

// Relative paths allowed

BOOST_TEST(checkImport(import, {"--allow-paths=../code/a"}));

BOOST_TEST(checkImport(import, {"--allow-paths=../code/a/"}));

BOOST_TEST(checkImport(import, {"--allow-paths=../code/a/b"}));

BOOST_TEST(checkImport(import, {"--allow-paths=../code/a/b/c.sol"}));

// Non-normalized paths allowed

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/."}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/./"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/.."}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/../"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/b"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/./b"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/../a/b"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a///b"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/b//"}));

BOOST_TEST(checkImport(import, {"--allow-paths", "./../code/a/b///"}));

// Root path allowed

BOOST_TEST(checkImport(import, {"--allow-paths=/"}));

BOOST_TEST(checkImport(import, {"--allow-paths=///"}));

// UNC paths should be treated differently from normal paths

soltestAssert(FileReader::isUNCPath("/" + m_portablePrefix), "");

BOOST_TEST(checkImport(import, {"--allow-paths=//"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport(import, {"--allow-paths=/" + m_portablePrefix}) == ImportCheck::PathDisallowed());

// Paths going beyond root allowed

BOOST_TEST(checkImport(import, {"--allow-paths=/../../"}));

BOOST_TEST(checkImport(import, {"--allow-paths=/../.."}));

BOOST_TEST(checkImport(import, {"--allow-paths=/../../a/../"}));

BOOST_TEST(checkImport(import, {"--allow-paths=/../../" + m_portablePrefix}));

// File named like a directory

BOOST_TEST(checkImport(import, {"--allow-paths", m_codeDir.string() + "/a/b/c.sol/"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_should_handle_empty_paths, AllowPathsFixture)

{

// Work dir is base path

BOOST_TEST(checkImport("import 'a/../../work/a/b/c.sol'", {"--allow-paths", ""}));

BOOST_TEST(checkImport("import 'a/../../work/a/b/c.sol'", {"--allow-paths", "x,,y"}));

BOOST_TEST(checkImport("import 'a/../../code/a/b/c.sol'", {"--allow-paths", ""}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'a/../../code/a/b/c.sol'", {"--allow-paths", "x,,y"}) == ImportCheck::PathDisallowed());

// Work dir is not base path

BOOST_TEST(checkImport("import 'a/../../work/a/b/c.sol'", {"--allow-paths", "", "--base-path=../code/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'a/../../work/a/b/c.sol'", {"--allow-paths", "x,,y", "--base-path=../code/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'a/../../code/a/b/c.sol'", {"--allow-paths", "", "--base-path=../code/"}));

BOOST_TEST(checkImport("import 'a/../../code/a/b/c.sol'", {"--allow-paths", "x,,y", "--base-path=../code/"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_case_sensitive, AllowPathsFixture)

{

// Allowed paths are case-sensitive even on case-insensitive filesystems

BOOST_TEST(

checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", m_codeDir.string() + "/A/B/"}) ==

ImportCheck::PathDisallowed()

);

}

BOOST_FIXTURE_TEST_CASE(allow_path_should_work_with_various_import_forms, AllowPathsFixture)

{

// Absolute import paths

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"--allow-paths", "../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", "../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"--allow-paths", "../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"--allow-paths", "../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"--allow-paths", "../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", "../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"--allow-paths", "../code/a/b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"--allow-paths", "../code/a/b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"--allow-paths", "../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths", "../code/a"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"--allow-paths", "../code/a"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"--allow-paths", "../code/a"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"--allow-paths", "../code/a"}));

// Relative import paths

// NOTE: Base path is whitelisted by default so we need the 'a/../../code/' part to get

// outside of it. And it can't be just '../code/' because that would not be a direct import.

BOOST_TEST(checkImport("import 'a/../../code/a/b/c.sol'", {"--allow-paths", "../code/a/b"}));

BOOST_TEST(checkImport("import 'a/../../code/X/b/c.sol'", {"--allow-paths", "../code/a/b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'a/../../code/a/X/c.sol'", {"--allow-paths", "../code/a/b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'a/../../code/a/b/X.sol'", {"--allow-paths", "../code/a/b"}));

// Non-normalized relative import paths

BOOST_TEST(checkImport("import 'a/../../code/a/./b/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import 'a/../../code/a/../a/b/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import 'a/../../code/a///b/c.sol'", {"--allow-paths", "../code/a/b/c.sol"}));

#if !defined(_WIN32)

// UNC paths in imports.

// Unfortunately can't test it on Windows without having an existing UNC path. On Linux we can

// at least rely on the fact that `//` works like `/`.

string uncImportPath = "/" + m_portablePrefix + "/a/b/c.sol";

soltestAssert(FileReader::isUNCPath(uncImportPath), "");

BOOST_TEST(checkImport("import '" + uncImportPath + "'", {"--allow-paths", "../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

#endif

}

BOOST_FIXTURE_TEST_CASE(allow_path_automatic_whitelisting_input_files, AllowPathsFixture)

{

// By default none of the files is whitelisted

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c/d.sol'", {}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {}) == ImportCheck::PathDisallowed());

// Compiling a file whitelists its directory and subdirectories

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {m_codeDir.string() + "/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c/d.sol'", {m_codeDir.string() + "/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {m_codeDir.string() + "/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {m_codeDir.string() + "/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {m_codeDir.string() + "/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {m_codeDir.string() + "/a/b/c.sol"}) == ImportCheck::PathDisallowed());

// If only file name is specified, its parent dir path is empty. This should be equivalent to

// whitelisting the work dir.

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/contract.sol'", {"contract.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'contract.sol'", {"contract.sol"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_automatic_whitelisting_remappings, AllowPathsFixture)

{

// Adding a remapping whitelists target's parent directory and subdirectories

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c/d.sol'", {"x=../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"x=../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {"x=../code/a/b/c.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=/contract.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=/contract.sol/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {m_portablePrefix + "/a/b=../code/X/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {m_portablePrefix + "/a/b/=../code/X/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {m_portablePrefix + "/a/b=../code/X/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {m_portablePrefix + "/a/b/=../code/X/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {m_portablePrefix + "/a/b:y/z=x/w"}) == ImportCheck::PathDisallowed());

// Adding a remapping whitelists the target and subdirectories when the target is a directory

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c/d.sol'", {"x=../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"x=../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {"x=../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {"x=../code/a/c/"}) == ImportCheck::PathDisallowed());

// Adding a remapping whitelists target's parent directory and subdirectories when the target

// is a directory but does not have a trailing slash

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c/d.sol'", {"x=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/X.sol'", {"x=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {"x=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/bc/d.sol'", {"x=../code/a/c"}));

// Adding a remapping to a relative target at VFS root whitelists the work dir

BOOST_TEST(checkImport("import '/../../x/y/z.sol'", {"x=contract.sol", "--base-path=../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '/../../../work/a/b/c.sol'", {"x=contract.sol", "--base-path=../code/a/b/"}));

BOOST_TEST(checkImport("import '/../../x/y/z.sol'", {"x=contract.sol/", "--base-path=../code/a/b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '/../../../work/a/b/c.sol'", {"x=contract.sol/", "--base-path=../code/a/b/"}) == ImportCheck::PathDisallowed());

// Adding a remapping with an empty target does not whitelist anything

BOOST_TEST(checkImport("import '" + m_portablePrefix + m_portablePrefix + "/a/b/c.sol'", {m_portablePrefix + "="}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"../code/="}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '/../work/a/b/c.sol'", {"../code/=", "--base-path", m_portablePrefix}) == ImportCheck::PathDisallowed());

// Adding a remapping that includes .. or . segments whitelists the parent dir and subdirectories

// of the resolved target

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=."}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=."}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=./"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=./"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=.."}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=.."}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/./.."}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/./.."}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/./.."}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/./../"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/./../"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/./../"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/./../b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/./../b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/./../b"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"x=../code/a/b/./../b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/X/c.sol'", {"x=../code/a/b/./../b/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/X/b/c.sol'", {"x=../code/a/b/./../b/"}) == ImportCheck::PathDisallowed());

// If the target is just a file name, its parent dir path is empty. This should be equivalent to

// whitelisting the work dir.

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/contract.sol'", {"x=contract.sol"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import 'contract.sol'", {"x=contract.sol"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_automatic_whitelisting_base_path, AllowPathsFixture)

{

// Relative base path whitelists its content

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path=../code/a"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=../code/a/"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path=../code/a/"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path=../code/a/"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path=../code/a/"}));

BOOST_TEST(checkImport("import 'a/b/c.sol'", {"--base-path=../code/."}));

BOOST_TEST(checkImport("import 'a/b/c.sol'", {"--base-path=../code/./"}));

BOOST_TEST(checkImport("import 'code/a/b/c.sol'", {"--base-path=.."}));

BOOST_TEST(checkImport("import 'code/a/b/c.sol'", {"--base-path=../"}));

// Absolute base path whitelists its content

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path", m_codeDir.string() + "/a"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_automatic_whitelisting_work_dir, AllowPathsFixture)

{

// Work dir is only automatically whitelisted if it matches base path

BOOST_TEST(checkImport("import 'b/../../../work/a/b/c.sol'", {"--base-path=../code/a/"}) == ImportCheck::PathDisallowed());

// Compiling a file in the work dir whitelists it even if it's not in base path

BOOST_TEST(checkImport("import 'b/../../../work/a/b/c.sol'", {"--base-path", "../code/a/", "a/b/c.sol"}));

// Work dir can also be whitelisted manually

BOOST_TEST(checkImport("import 'b/../../../work/a/b/c.sol'", {"--base-path", "../code/a/", "--allow-paths=."}));

// Not setting base path whitelists the working directory

BOOST_TEST(checkImport("import 'a/b/c.sol'", {}));

BOOST_TEST(checkImport("import 'a/b/c/d.sol'", {}));

BOOST_TEST(checkImport("import 'a/b/X.sol'", {}));

BOOST_TEST(checkImport("import 'a/X/c.sol'", {}));

// Setting base path to an empty value whitelists the working directory

BOOST_TEST(checkImport("import 'a/b/c.sol'", {"--base-path", ""}));

BOOST_TEST(checkImport("import 'a/b/c/d.sol'", {"--base-path", ""}));

BOOST_TEST(checkImport("import 'a/b/X.sol'", {"--base-path", ""}));

BOOST_TEST(checkImport("import 'a/X/c.sol'", {"--base-path", ""}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_automatic_whitelisting_include_paths, AllowPathsFixture)

{

// Relative include path whitelists its content

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path=a/b/c", "--include-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path=a/b/c", "--include-path=../code/a"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path=a/b/c", "--include-path=../code/a"}));

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/a/"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path=a/b/c", "--include-path=../code/a/"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path=a/b/c", "--include-path=../code/a/"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path=a/b/c", "--include-path=../code/a/"}));

BOOST_TEST(checkImport("import 'a/b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/."}));

BOOST_TEST(checkImport("import 'a/b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/./"}));

BOOST_TEST(checkImport("import 'code/a/b/c.sol'", {"--base-path=a/b/c", "--include-path=.."}));

BOOST_TEST(checkImport("import 'code/a/b/c.sol'", {"--base-path=a/b/c", "--include-path=../"}));

// Absolute include path whitelists its content

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=a/b/c", "--include-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'b/c/d.sol'", {"--base-path=a/b/c", "--include-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'b/X.sol'", {"--base-path=a/b/c", "--include-path", m_codeDir.string() + "/a"}));

BOOST_TEST(checkImport("import 'X/c.sol'", {"--base-path=a/b/c", "--include-path", m_codeDir.string() + "/a"}));

// If there are multiple include paths, all of them get whitelisted

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/a", "--include-path=../code/1"}));

BOOST_TEST(checkImport("import '2/3.sol'", {"--base-path=a/b/c", "--include-path=../code/a", "--include-path=../code/1"}));

BOOST_TEST(checkImport("import 'b/c.sol'", {"--base-path=a/b/c", "--include-path=../code/1", "--include-path=../code/a"}));

BOOST_TEST(checkImport("import '2/3.sol'", {"--base-path=a/b/c", "--include-path=../code/1", "--include-path=../code/a"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_symlinks_within_whitelisted_dir, AllowPathsFixture)

{

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b_sym/c.sol'", {"--allow-paths=../code/a/b/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths=../code/a/b_sym/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b_sym/c.sol'", {"--allow-paths=../code/a/b_sym/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b_sym/c.sol'", {"--allow-paths=../code/a/b"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths=../code/a/b_sym"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b_sym/c.sol'", {"--allow-paths=../code/a/b_sym"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c_sym.sol'", {"--allow-paths=../code/a/b/c.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c.sol'", {"--allow-paths=../code/a/b/c_sym.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/c_sym.sol'", {"--allow-paths=../code/a/b/c_sym.sol"}));

}

BOOST_FIXTURE_TEST_CASE(allow_path_symlinks_outside_whitelisted_dir, AllowPathsFixture)

{

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/y_sym/z.sol'", {"--allow-paths=../code/a/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/y_sym/z.sol'", {"--allow-paths=../code/x/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/z_sym.sol'", {"--allow-paths=../code/a/"}) == ImportCheck::PathDisallowed());

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/z_sym.sol'", {"--allow-paths=../code/x/"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/z_sym.sol'", {"--allow-paths=../code/a/b/z_sym.sol"}));

BOOST_TEST(checkImport("import '" + m_portablePrefix + "/a/b/z_sym.sol'", {"--allow-paths=../code/x/y/z.sol"}));

}

BOOST_AUTO_TEST_SUITE_END()

} // namespace solidity::frontend::test

solidity/test/solc/CommandLineInterfaceAllowPaths.cpp at develop · electrocipher/solidity · GitHub

Expand file tree

Breadcrumbs

CommandLineInterfaceAllowPaths.cpp

Latest commit

History

Breadcrumbs

CommandLineInterfaceAllowPaths.cpp

File metadata and controls