Cycript fork powered by Frida.
Clone or download
Latest commit d352f73 May 27, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bindings/node/cylang Also ship prebuild for Node.js 7.x. Oct 26, 2016
docs Clean up the repository layout. Sep 6, 2016
ext Port to Meson Jun 3, 2018
scripts Port to Meson Jun 3, 2018
src Port to Meson Jun 3, 2018
subprojects Port to Meson Jun 3, 2018
test Fix the “test” script. Sep 6, 2016
.gitignore Port to Meson Jun 3, 2018
.gitmodules Port to Meson Jun 3, 2018
COPYING Update copyright for 2014 and relicense to AGPLv3. Oct 11, 2014
README.md Port to Meson Jun 3, 2018
config.h.in Port to Meson Jun 3, 2018
meson.build Port to Meson Jun 3, 2018
meson_options.txt Port to Meson Jun 3, 2018

README.md

frida-cycript

This is a fork of [Cycript] 1 in which we replaced its runtime with a brand new runtime called [Mjølner] 3 powered by [Frida] 4. This enables frida-cycript to run on all the platforms and architectures maintained by [frida-core] 8.

Motivation

[Cycript] 1 is an awesome interactive console for exploring and modifying running applications on iOS, Mac, and Android. It was created by [@saurik] 2 and essentially consists of four parts:

  1. Its readline-based user interface;
  2. Compiler that takes cylang as input and produces plain JavaScript as output;
  3. A runtime that executes the plain JavaScript on JavaScriptCore, providing a set of APIs expected by the compiled scripts, plus some facilities for injecting itself into remote processes;
  4. A couple of "user-space" modules written in cylang.

We didn't touch any other aspects of Cycript or did so with minimal changes.

We went out of our way to avoid touching the compiler, and also left the user interface mostly untouched, only adding extra CLI switches for things like device selection. We did, however, mostly rewrite the Cydia Substrate module so existing scripts relying on this will get the portability and [performance boost] 5 offered by Frida's instrumentation core.

We will be maintaining this fork and intend to stay in sync with user interface and language improvements made upstream.

FAQ

What are some advantages of this fork?

WE believe the main advantage is portability, but also think you should consider:

  • Ability to attach to sandboxed apps on Mac, without touching /usr or modifying the system in any way;
  • Instead of crashing the process if you make a mistake and access a bad pointer, you will get a JavaScript exception;
  • Frida's function hooking is able to hook many functions not supported by Cydia Substrate.

What are some disadvantages?

Our runtime doesn't yet support all the features that upstream's runtime does, but we are working hard to close this gap. Please file issues if something you rely on isn't working as expected.

Is Windows support planned?

Yes. You should already be able to do this by running frida-server on Windows and connecting to it with Cycript on your UNIX system. (We didn't try this yet so please tell us if and how it works for you.)

How does this benefit existing Frida-users building their own tools?

We have improved [frida-compile] 7 to support cylang by integrating the Cycript compiler. Sources with a .cy extension get compiled transparently, and this "just works" as long as [our runtime] 3 is also included in the compiled agent.

Status

Please see [our test-suite] 6 to get an overview of what we currently support.

Building

Mac

Install Meson and Ninja:

pip3 install meson
brew install ninja

Clone this repo:

git clone https://github.com/nowsecure/frida-cycript.git
cd frida-cycript
git submodule init
git submodule update

Generate the build system:

meson build

Build:

ninja -C build

Run Cycript:

./build/src/cycript

Run the test-suite:

cd test && npm install && npm run test