binaryninja-api/python/scriptingprovider.py at dev · Vector35/binaryninja-api · GitHub

History

2144 lines (1739 loc) · 71.4 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

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

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to

# deal in the Software without restriction, including without limitation the

# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

# sell copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in

# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS

# IN THE SOFTWARE.

import abc

import code

import ctypes

import dataclasses

import importlib

import os

import re

import subprocess

import sys

import threading

import traceback

from collections.abc import Callable

from ctypes.util import find_library

from pathlib import Path

from typing import Generator, Optional, List, Tuple, Dict, Any

from typing import Type as TypeHintType

# Just windows things...

if sys.platform == "win32":

from pydoc import help

# Binary Ninja components

import binaryninja

from . import bncompleter

from . import _binaryninjacore as core

from . import settings

from . import binaryview

from . import basicblock

from . import function

from . import log

from .extensionmanager import RepositoryManager

from .requirementcheck import (pip_dependency_conflicts, pip_requirements_excluding_packages,

pip_requirements_from_dependency_metadata, pip_requirements_satisfied)

from .enums import ScriptingProviderExecuteResult, ScriptingProviderInputReadyState

from .settings import Settings

from .enums import SettingsScope

import json

_WARNING_REGEX = re.compile(r'^\S+:\d+: \w+Warning: ')

logger = log.Logger(0, "ScriptingProvider")

dependency_installer_logger = log.Logger(0, "DependencyInstaller")

class _ThreadActionContext:

_actions = []

def __init__(self, func):

self.func = func

self.interpreter = None

if hasattr(PythonScriptingInstance._interpreter, "value"):

self.interpreter = PythonScriptingInstance._interpreter.value

self.__class__._actions.append(self)

self.callback = ctypes.CFUNCTYPE(None, ctypes.c_void_p)(lambda ctxt: self.execute())

def execute(self):

old_interpreter = None

if hasattr(PythonScriptingInstance._interpreter, "value"):

old_interpreter = PythonScriptingInstance._interpreter.value

PythonScriptingInstance._interpreter.value = self.interpreter

try:

self.func()

finally:

PythonScriptingInstance._interpreter.value = old_interpreter

self.__class__._actions.remove(self)

class ScriptingOutputListener:

def _register(self, handle):

self._cb = core.BNScriptingOutputListener()

self._cb.context = 0

self._cb.output = self._cb.output.__class__(self._output)

self._cb.warning = self._cb.warning.__class__(self._warning)

self._cb.error = self._cb.error.__class__(self._error)

self._cb.inputReadyStateChanged = self._cb.inputReadyStateChanged.__class__(self._input_ready_state_changed)

core.BNRegisterScriptingInstanceOutputListener(handle, self._cb)

def _unregister(self, handle):

core.BNUnregisterScriptingInstanceOutputListener(handle, self._cb)

def _output(self, ctxt, text):

try:

self.notify_output(text)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingOutputListener._output")

def _warning(self, ctxt, text):

try:

self.notify_warning(text)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingOutputListener._warning")

def _error(self, ctxt, text):

try:

self.notify_error(text)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingOutputListener._error")

def _input_ready_state_changed(self, ctxt, state):

try:

self.notify_input_ready_state_changed(state)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingOutputListener._input_ready_state_changed")

def notify_output(self, text):

pass

def notify_warning(self, text):

pass

def notify_error(self, text):

pass

def notify_input_ready_state_changed(self, state):

pass

class ScriptingInstance:

_registered_instances = []

def __init__(self, provider, handle=None):

if handle is None:

self._cb = core.BNScriptingInstanceCallbacks()

self._cb.context = 0

self._cb.externalRefTaken = self._cb.externalRefTaken.__class__(self._external_ref_taken)

self._cb.externalRefReleased = self._cb.externalRefReleased.__class__(self._external_ref_released)

self._cb.executeScriptInput = self._cb.executeScriptInput.__class__(self._execute_script_input)

self._cb.executeScriptInputFromFilename = self._cb.executeScriptInputFromFilename.__class__(self._execute_script_input_from_filename)

self._cb.cancelScriptInput = self._cb.cancelScriptInput.__class__(self._cancel_script_input)

self._cb.releaseBinaryView = self._cb.releaseBinaryView.__class__(self._release_binary_view)

self._cb.setCurrentBinaryView = self._cb.setCurrentBinaryView.__class__(self._set_current_binary_view)

self._cb.setCurrentFunction = self._cb.setCurrentFunction.__class__(self._set_current_function)

self._cb.setCurrentBasicBlock = self._cb.setCurrentBasicBlock.__class__(self._set_current_basic_block)

self._cb.setCurrentAddress = self._cb.setCurrentAddress.__class__(self._set_current_address)

self._cb.setCurrentSelection = self._cb.setCurrentSelection.__class__(self._set_current_selection)

self._cb.completeInput = self._cb.completeInput.__class__(self._complete_input)

self._cb.canCompleteArguments = self._cb.canCompleteArguments.__class__(self._can_complete_arguments)

self._cb.completeArguments = self._cb.completeArguments.__class__(self._complete_arguments)

self._cb.stop = self._cb.stop.__class__(self._stop)

self._completed_input = None

self.handle = core.BNInitScriptingInstance(provider.handle, self._cb)

self.delimiters = ' \t\n`~!@#$%^&*()-=+{}\\|;:\'",<>/?'

else:

self.handle = core.handle_of_type(handle, core.BNScriptingInstance)

self.listeners = []

def __del__(self):

if core is not None:

core.BNFreeScriptingInstance(self.handle)

def _external_ref_taken(self, ctxt):

try:

self.__class__._registered_instances.append(self)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._external_ref_taken")

def _external_ref_released(self, ctxt):

try:

self.__class__._registered_instances.remove(self)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._external_ref_released")

def _execute_script_input(self, ctxt, text):

try:

return self.perform_execute_script_input(text)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._execute_script_input")

return ScriptingProviderExecuteResult.InvalidScriptInput

def _execute_script_input_from_filename(self, ctxt, filename):

try:

return self.perform_execute_script_input_from_filename(filename)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._execute_script_input_from_filename")

return ScriptingProviderExecuteResult.InvalidScriptInput

def _cancel_script_input(self, ctxt):

try:

return self.perform_cancel_script_input()

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._cancel_script_input")

return ScriptingProviderExecuteResult.ScriptExecutionCancelled

def _release_binary_view(self, ctxt, view):

try:

binaryview.BinaryView._cache_remove(view)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._release_binary_view")

def _set_current_binary_view(self, ctxt, view):

try:

if view:

view = binaryview.BinaryView(handle=core.BNNewViewReference(view))

binaryview.BinaryView._cache_insert(view)

else:

view = None

self.perform_set_current_binary_view(view)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._set_current_binary_view")

def _set_current_function(self, ctxt, func):

try:

if func:

func = function.Function(handle=core.BNNewFunctionReference(func))

else:

func = None

self.perform_set_current_function(func)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._set_current_function")

def _set_current_basic_block(self, ctxt, block):

try:

if block:

func = core.BNGetBasicBlockFunction(block)

if func is None:

block = None

else:

core_block = core.BNNewBasicBlockReference(block)

assert core_block is not None, "core.BNNewBasicBlockReference returned None"

block = basicblock.BasicBlock(

core_block, binaryview.BinaryView(handle=core.BNGetFunctionData(func))

)

core.BNFreeFunction(func)

else:

block = None

self.perform_set_current_basic_block(block)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._set_current_basic_block")

def _set_current_address(self, ctxt, addr):

try:

self.perform_set_current_address(addr)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._set_current_address")

def _set_current_selection(self, ctxt, begin, end):

try:

self.perform_set_current_selection(begin, end)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._set_current_selection")

def _complete_input(self, ctxt, text, state):

try:

if not isinstance(text, str):

text = text.decode("utf-8")

return core.BNAllocString(self.perform_complete_input(text, state))

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._complete_input")

return core.BNAllocString("")

def _can_complete_arguments(self, ctx, text):

try:

if not isinstance(text, str):

text = text.decode("utf-8")

return self.perform_can_complete_arguments(text)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._can_complete_arguments")

return False

def _complete_arguments(self, ctx, text, argument_start):

try:

if not isinstance(text, str):

text = text.decode("utf-8")

result, start = self.perform_complete_arguments(text)

argument_start[0] = start

if result is None:

return None

return core.BNAllocString(result)

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._complete_arguments")

argument_start[0] = 0

return None

def _stop(self, ctxt):

try:

self.perform_stop()

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingInstance._stop")

@abc.abstractmethod

def perform_execute_script_input(self, text):

return ScriptingProviderExecuteResult.InvalidScriptInput

@abc.abstractmethod

def perform_execute_script_input_from_filename(self, text):

return ScriptingProviderExecuteResult.InvalidScriptInput

@abc.abstractmethod

def perform_cancel_script_input(self):

return ScriptingProviderExecuteResult.ScriptExecutionCancelled

@abc.abstractmethod

def perform_set_current_binary_view(self, view):

return NotImplemented

@abc.abstractmethod

def perform_set_current_function(self, func):

return NotImplemented

@abc.abstractmethod

def perform_set_current_basic_block(self, block):

return NotImplemented

@abc.abstractmethod

def perform_set_current_address(self, addr):

return NotImplemented

@abc.abstractmethod

def perform_set_current_selection(self, begin, end):

return NotImplemented

@abc.abstractmethod

def perform_complete_input(self, text: str, state) -> str:

return NotImplemented

@abc.abstractmethod

def perform_can_complete_arguments(self, text: str) -> bool:

return NotImplemented

@abc.abstractmethod

def perform_complete_arguments(self, text: str) -> Tuple[Optional[str], int]:

return NotImplemented

@abc.abstractmethod

def perform_stop(self):

return NotImplemented

@property

def input_ready_state(self):

return core.BNGetScriptingInstanceInputReadyState(self.handle)

@input_ready_state.setter

def input_ready_state(self, value):

core.BNNotifyInputReadyStateForScriptingInstance(self.handle, value.value)

def output(self, text):

core.BNNotifyOutputForScriptingInstance(self.handle, text)

def warning(self, text):

core.BNNotifyWarningForScriptingInstance(self.handle, text)

def error(self, text):

core.BNNotifyErrorForScriptingInstance(self.handle, text)

def execute_script_input(self, text):

return core.BNExecuteScriptInput(self.handle, text)

def execute_script_input_from_filename(self, filename):

return core.BNExecuteScriptInputFromFilename(self.handle, filename)

def cancel_script_input(self, text):

return core.BNCancelScriptInput(self.handle)

def set_current_binary_view(self, view):

if view is not None:

view = view.handle

core.BNSetScriptingInstanceCurrentBinaryView(self.handle, view)

def set_current_function(self, func):

if func is not None:

func = func.handle

core.BNSetScriptingInstanceCurrentFunction(self.handle, func)

def set_current_basic_block(self, block):

if block is not None:

block = block.handle

core.BNSetScriptingInstanceCurrentBasicBlock(self.handle, block)

def set_current_address(self, addr):

core.BNSetScriptingInstanceCurrentAddress(self.handle, addr)

def set_current_selection(self, begin, end):

core.BNSetScriptingInstanceCurrentSelection(self.handle, begin, end)

def complete_input(self, text, state):

return core.BNScriptingInstanceCompleteInput(self.handle, text, state)

def can_complete_arguments(self, text):

return core.BNScriptingInstanceCanCompleteArguments(self.handle, text)

def complete_arguments(self, text):

argument_start = ctypes.c_ulonglong()

result = core.BNScriptingInstanceCompleteArguments(self.handle, text, argument_start)

return result, argument_start.value

def stop(self):

core.BNStopScriptingInstance(self.handle)

def register_output_listener(self, listener):

listener._register(self.handle)

self.listeners.append(listener)

def unregister_output_listener(self, listener):

if listener in self.listeners:

listener._unregister(self.handle)

self.listeners.remove(listener)

@property

def delimiters(self):

return core.BNGetScriptingInstanceDelimiters(self.handle)

@delimiters.setter

def delimiters(self, value):

core.BNSetScriptingInstanceDelimiters(self.handle, value)

class _ScriptingProviderMetaclass(type):

def __iter__(self) -> Generator['ScriptingProvider', None, None]:

binaryninja._init_plugins()

count = ctypes.c_ulonglong()

types = core.BNGetScriptingProviderList(count)

assert types is not None, "core.BNGetScriptingProviderList returned None"

try:

for i in range(0, count.value):

yield ScriptingProvider(types[i])

finally:

core.BNFreeScriptingProviderList(types)

def __getitem__(self, value) -> 'ScriptingProvider':

binaryninja._init_plugins()

provider = core.BNGetScriptingProviderByName(str(value))

if provider is None:

raise KeyError("'%s' is not a valid scripting provider" % str(value))

return ScriptingProvider(provider)

def __contains__(cls: '_ScriptingProviderMetaclass', name: object) -> bool:

if not isinstance(name, str):

return False

try:

cls[name]

return True

except KeyError:

return False

def get(cls: '_ScriptingProviderMetaclass', name: str, default: Any = None) -> Optional['ScriptingProvider']:

try:

return cls[name]

except KeyError:

if default is not None:

return default

return None

class ScriptingProvider(metaclass=_ScriptingProviderMetaclass):

_registered_providers = []

name = ''

apiName = ''

instance_class: Optional[TypeHintType[ScriptingInstance]] = None

def __init__(self, handle=None):

if handle is not None:

self.handle = core.handle_of_type(handle, core.BNScriptingProvider)

self.__dict__["name"] = core.BNGetScriptingProviderName(handle)

def register(self) -> None:

self._cb = core.BNScriptingProviderCallbacks()

self._cb.context = 0

self._cb.createInstance = self._cb.createInstance.__class__(self._create_instance)

self._cb.loadModule = self._cb.loadModule.__class__(self._load_module)

self._cb.installModules = self._cb.installModules.__class__(self._install_modules_for_callback)

self.handle = core.BNRegisterScriptingProvider(self.__class__.name, self.__class__.apiName, self._cb)

self._module_installed_cb = core.BNScriptingProviderModuleInstalledCallbacks()

self._module_installed_cb.context = None

self._module_installed_cb.moduleInstalled = self._module_installed_cb.moduleInstalled.__class__(self._module_installed)

core.BNSetScriptingProviderModuleInstalledCallback(self.handle, self._module_installed_cb)

self._install_modules_with_exclusions_cb = core.BNScriptingProviderInstallModulesWithExclusionsCallbacks()

self._install_modules_with_exclusions_cb.context = None

self._install_modules_with_exclusions_cb.installModulesWithExclusions = \

self._install_modules_with_exclusions_cb.installModulesWithExclusions.__class__(

self._install_modules_with_exclusions_for_callback)

core.BNSetScriptingProviderInstallModulesWithExclusionsCallback(

self.handle, self._install_modules_with_exclusions_cb)

self._dependency_conflict_cb = core.BNScriptingProviderDependencyConflictCallbacks()

self._dependency_conflict_cb.context = None

self._dependency_conflict_cb.getDependencyConflicts = self._dependency_conflict_cb.getDependencyConflicts.__class__(self._dependency_conflicts)

core.BNSetScriptingProviderDependencyConflictCallback(self.handle, self._dependency_conflict_cb)

self.__class__._registered_providers.append(self)

def _create_instance(self, ctxt):

try:

assert self.__class__.instance_class is not None

result = self.__class__.instance_class(self) # type: ignore

if result is None:

return None

script_instance = core.BNNewScriptingInstanceReference(result.handle)

assert script_instance is not None, "core.BNNewScriptingInstanceReference returned None"

return ctypes.cast(script_instance, ctypes.c_void_p).value

except Exception:

logger.log_error_for_exception("Unhandled Python exception in ScriptingProvider._create_instance")

return None

def create_instance(self) -> Optional[ScriptingInstance]:

result = core.BNCreateScriptingProviderInstance(self.handle)

if result is None:

return None

return ScriptingInstance(self, handle=result)

def _load_module(self, ctx, repo_path: bytes, plugin_path: bytes, force: bool) -> bool:

return False

def _install_modules(self, ctx, modules: bytes) -> bool:

return False

def _install_modules_with_exclusions(self, ctx, modules: bytes, excluded_package_names, excluded_package_name_count: int) -> bool:

exclusions = {

excluded_package_names[i].decode("utf-8") for i in range(excluded_package_name_count)

if excluded_package_names[i] is not None

}

filtered_modules = pip_requirements_excluding_packages(modules, exclusions)

return self._install_modules(ctx, "\n".join(filtered_modules).encode("utf-8"))

def _install_modules_with_exclusions_for_callback(

self, ctx, modules: bytes, excluded_package_names, excluded_package_name_count: int) -> bool:

try:

return self._install_modules_with_exclusions(

ctx, modules, excluded_package_names, excluded_package_name_count)

except Exception:

dependency_installer_logger.log_error_for_exception("Dependency installation failed")

return False

def _module_installed(self, ctx, modules: bytes) -> bool:

return False

def _dependency_conflicts(self, ctx, candidate, installed_plugins, installed_plugin_count):

return core.BNAllocString(json.dumps([{

"status": "unknown_compatibility",

"package_name": "<unknown>",

"candidate_requirements": [],

"installed_requirements": [],

}]))

class _PythonScriptingInstanceOutput:

def __init__(self, orig, is_error_output):

self.orig = orig

self.is_error_output = is_error_output

self.buffer = ""

self.encoding = 'UTF-8'

self.errors = None

self.mode = 'w'

self.name = 'PythonScriptingInstanceOutput'

self.newlines = None

def close(self):

pass

def closed(self):

return False

def flush(self):

pass

def isatty(self):

return False

def next(self):

raise IOError("File not open for reading")

def read(self):

raise IOError("File not open for reading")

def readinto(self):

raise IOError("File not open for reading")

def readlines(self):

raise IOError("File not open for reading")

def seek(self):

pass

def softspace(self):

return 0

def truncate(self):

pass

def tell(self):

return self.orig.tell()

def writelines(self, lines):

return self.write('\n'.join(lines))

def write(self, data):

interpreter = None

if hasattr(PythonScriptingInstance._interpreter, "value"):

interpreter = PythonScriptingInstance._interpreter.value

if interpreter is None:

if log.is_output_redirected_to_log():

self.buffer += data

while True:

i = self.buffer.find('\n')

if i == -1:

break

line = self.buffer[:i]

self.buffer = self.buffer[i + 1:]

if self.is_error_output:

if _WARNING_REGEX.match(line):

logger.log_warn(line)

else:

logger.log_error(line)

else:

logger.log_info(line)

else:

self.orig.write(data)

else:

PythonScriptingInstance._interpreter.value = None

try:

if self.is_error_output:

if _WARNING_REGEX.match(data):

interpreter.instance.warning(data)

else:

interpreter.instance.error(data)

else:

interpreter.instance.output(data)

finally:

PythonScriptingInstance._interpreter.value = interpreter

class _PythonScriptingInstanceInput:

def __init__(self, orig):

self.orig = orig

def isatty(self):

return False

def read(self, size):

interpreter = None

if hasattr(PythonScriptingInstance._interpreter, "value"):

interpreter = PythonScriptingInstance._interpreter.value

if interpreter is None:

return self.orig.read(size)

else:

PythonScriptingInstance._interpreter.value = None

try:

result = interpreter.read(size)

finally:

PythonScriptingInstance._interpreter.value = interpreter

return result

def readline(self):

interpreter = None

if hasattr(PythonScriptingInstance._interpreter, "value"):

interpreter = PythonScriptingInstance._interpreter.value

if interpreter is None:

return self.orig.readline()

else:

result = ""

while True:

data = interpreter.read(1)

result += data

if (len(data) == 0) or (data == "\n"):

break

return result

class BlacklistedDict(dict):

def __init__(self, blacklist, *args):

super().__init__(*args)

self.__blacklist = set(blacklist)

self._blacklist_enabled = True

def __setitem__(self, k, v):

if self.blacklist_enabled and k in self.__blacklist:

sys.stderr.write(

'Setting variable "{}" will have no affect as it is automatically controlled by the ScriptingProvider.\n'.

format(k)

)

super().__setitem__(k, v)

def enable_blacklist(self, enabled):

self.__enable_blacklist = enabled

def add_blacklist_item(self, item):

self.__blacklist.add(item)

def remove_blacklist_item(self, item):

self.__blacklist.remove(item)

def is_blacklisted_item(self, item):

return item in self.__blacklist

@property

def blacklist_enabled(self):

return self._blacklist_enabled

@blacklist_enabled.setter

def blacklist_enabled(self, value):

self._blacklist_enabled = value

def bninspect(code_, globals_, locals_):

"""

``bninspect`` prints documentation about a command that is about to be run

The interpreter will invoke this function if you input a line ending in `?` e.g. `bv?`

:param str code_: Python code to be evaluated

:param dict globals_: globals() from callsite

:param dict locals_: locals() from callsite

"""

try:

import inspect

value = eval(code_, globals_, locals_)

try:

if not (inspect.ismethod(value) or inspect.isclass(value)):

if isinstance(code_, bytes):

code_ = code_.decode("utf-8")

class_type_str = code_.split(".")[:-1]

class_value = eval("type(" + ".".join(class_type_str) + ")." + code_.split(".")[-1], globals_, locals_)

doc = inspect.getdoc(class_value)

if doc is None:

comments = inspect.getcomments(class_value)

if comments is None:

pass

else:

print(comments)

return

else:

print(doc)

return

except Exception:

pass

doc = inspect.getdoc(value)

if doc is None:

comments = inspect.getcomments(value)

if comments is None:

pass

else:

print(comments)

return

else:

print(doc)

return

print(f"No documentation found for {code_}")

except Exception:

# Hide exceptions so the normal execution can report them

pass

class PythonScriptingInstance(ScriptingInstance):

_interpreter = threading.local()

class InterpreterThread(threading.Thread):

def __init__(self, instance):

super(PythonScriptingInstance.InterpreterThread, self).__init__()

self.instance = instance

blacklisted_vars = {

"get_selected_data",

"write_at_cursor",

}

self.locals = BlacklistedDict(

blacklisted_vars, {"__name__": "__console__", "__doc__": None, "binaryninja": sys.modules[__name__]}

)

self.cached_locals = {}

self.interpreter = code.InteractiveConsole(self.locals)

self.event = threading.Event()

self.daemon = True

# Latest selections from UI

self.current_view = None

self.current_func = None

self.current_block = None

self.current_addr = 0

self.current_selection_begin = 0

self.current_selection_end = 0

# Selections that were current as of last issued command

self.active_view = None

self.active_func = None

self.active_block = None

self.active_addr = 0

self.active_selection_begin = 0

self.active_selection_end = 0

self.active_file_offset = None

self.active_il_index = 0

self.selection_start_il_index = 0

self.active_il_function = None

self.update_magic_variables()

self.locals.blacklist_enabled = False

self.locals["get_selected_data"] = self.get_selected_data

self.locals["write_at_cursor"] = self.write_at_cursor

self.locals.blacklist_enabled = True

self.exit = False

self.code = None

self.input = ""

self.completer = bncompleter.Completer(namespace=self.locals)

startup_file = os.path.join(binaryninja.user_directory(), "startup.py")

if not os.path.isfile(startup_file):

with open(startup_file, 'w') as f:

f.write(

"""# Commands in this file will be run in the interactive python console on startup

from binaryninja import *

"""

)

with open(startup_file, 'r') as f:

self.interpreter.runsource(f.read(), filename="startup.py", symbol="exec")

def update_magic_variables(self):

for (name, var) in PythonScriptingProvider.magic_variables.items():

if var.set_value is None:

self.locals.add_blacklist_item(name)

elif self.locals.is_blacklisted_item(name):

self.locals.remove_blacklist_item(name)

def execute(self, _code):

self.code = _code

self.event.set()

def add_input(self, data):

self.input = self.input + data.decode("utf-8")

self.event.set()

def end(self):

self.exit = True

self.event.set()

def read(self, size):

while not self.exit:

if len(self.input) > size:

result = self.input[:size]

self.input = self.input[size:]

return result

elif len(self.input) > 0:

result = self.input

self.input = ""

return result

self.instance.input_ready_state = ScriptingProviderInputReadyState.ReadyForScriptProgramInput

self.event.wait()

self.event.clear()

return ""

def run(self):

core.BNSetThreadName("PythonInterpreterThread")

while not self.exit:

self.event.wait()

self.event.clear()

if self.exit:

break

if self.code is not None:

self.instance.input_ready_state = ScriptingProviderInputReadyState.NotReadyForInput

_code = self.code

self.code = None

PythonScriptingInstance._interpreter.value = self

try:

self.update_locals()

except Exception:

traceback.print_exc()

if isinstance(_code, (lambda: 0).__code__.__class__):

self.interpreter.runcode(_code)

self.locals['__name__'] = '__console__'

del self.locals['__file__']

else:

# If a single-line command ends in ?, show docs as well

if _code[-2:] == b'?\n' and len(_code.split(b'\n')) < 3:

escaped_code = repr(_code[:-2])

self.interpreter.push(f'bninspect({escaped_code}, globals(), locals())\n')

# Strip ? from the evaluated input

_code = _code[:-2] + b'\n'

for line in _code.split(b'\n'):

self.interpreter.push(line.decode("utf-8"))

self.apply_locals()

if self.active_view is not None:

value, scope = Settings().get_bool_with_scope("python.updateAnalysisAfterCommand")

if scope == SettingsScope.SettingsInvalidScope or value:

self.active_view.update_analysis()

except Exception:

traceback.print_exc()

finally:

PythonScriptingInstance._interpreter.value = None

self.instance.input_ready_state = ScriptingProviderInputReadyState.ReadyForScriptExecution

def update_locals(self):

self.active_view = self.current_view

self.active_func = self.current_func

self.active_block = self.current_block

self.active_addr = self.current_addr

self.active_selection_begin = self.current_selection_begin

self.active_selection_end = self.current_selection_end

self.locals.blacklist_enabled = False

# Clear old values of magic variables first, so we don't update with stale data

for name in PythonScriptingProvider.magic_variables.keys():

if name in self.locals:

del self.locals[name]

# Apply registered magic variables

vars = list(PythonScriptingProvider.magic_variables.items())

used_vars = set()

while len(vars) > 0:

(name, var) = vars.pop(0)

# Vars depending on others should make sure their deps have loaded first

# TODO: Is this O(n^2)? Probably, but shouldn't be that big of a deal

needs_deps = False

for dep in var.depends_on:

if dep in PythonScriptingProvider.magic_variables.keys() and dep not in used_vars:

needs_deps = True

break

if needs_deps:

# Add to the end and we'll get to it later

vars.append((name, var))

continue

used_vars.add(name)

try:

value = var.get_value(self.instance)

except Exception:

value = None

self.locals[name] = value

self.cached_locals[name] = value

self.locals.blacklist_enabled = True

def apply_locals(self):

for (name, var) in PythonScriptingProvider.magic_variables.items():

if var.set_value is None:

continue

old_value = self.cached_locals[name]

new_value = self.locals[name]

if old_value == new_value:

continue

try:

var.set_value(self.instance, old_value, new_value)

except Exception:

sys.stderr.write(f"Exception thrown trying to update variable:\n")

traceback.print_exc(file=sys.stderr)

self.cached_locals.clear()

def get_selected_data(self):

if self.active_view is None:

return None

length = self.active_selection_end - self.active_selection_begin

return self.active_view.read(self.active_selection_begin, length)

def write_at_cursor(self, data):

if self.active_view is None:

return 0

selected_length = self.active_selection_end - self.active_selection_begin

if (len(data) == selected_length) or (selected_length == 0):

return self.active_view.write(self.active_selection_begin, data)

else:

self.active_view.remove(self.active_selection_begin, selected_length)

return self.active_view.insert(self.active_selection_begin, data)

def __init__(self, provider):

super().__init__(provider)

self.interpreter = PythonScriptingInstance.InterpreterThread(self)

self.interpreter.start()

self.queued_input = ""

self.input_ready_state = ScriptingProviderInputReadyState.ReadyForScriptExecution

self.debugger_imported = False

from binaryninja.settings import Settings

settings = Settings()

if settings.contains('corePlugins.view.sharedCache') and settings.get_bool('corePlugins.view.sharedCache'):

View remainder of file in raw view

binaryninja-api/python/scriptingprovider.py at dev · Vector35/binaryninja-api · GitHub

Uh oh!

Expand file tree

Breadcrumbs

scriptingprovider.py

Latest commit

History

Breadcrumbs

scriptingprovider.py

File metadata and controls