Self-Activation Functions

Overview

The self-activation module enables maximum-privilege device operations without a computer, such as rebooting the device
All features in this module require self-activation setup first. See Advanced — Self-Activation Configuration

activeSelf.openLocalDevVpn Open LocalDevVpn

Open LocalDevVpn and connect VPN
The main app must be in the foreground
Available in EC standalone 6.1.0+
@returns {boolean} true on success, false on failure

1
function main() {
2
    // Open the external LocalDevVpn app and connect
3
    var data = activeSelf.openLocalDevVpn();
4
    logd(data);
5
    sleep(3000)
6
    activeSelf.disableLocalDevVpn();
7
}
8

9
main();

activeSelf.disableLocalDevVpn Disconnect LocalDevVpn

Disconnect LocalDevVpn VPN
The main app must be in the foreground
Available in EC standalone 6.1.0+
@returns {boolean} true on success, false on failure

1
function main() {
2
    // Open the external LocalDevVpn app and connect
3
    var data = activeSelf.disableLocalDevVpn();
4
    logd(data);
5
    sleep(3000)
6
    activeSelf.disableLocalDevVpn();
7
}
8

9
main();

activeSelf.mountImageOk Check Developer Image Mount

Whether the developer image was mounted successfully
Available in EC standalone 6.1.0+
@returns {boolean} true on success, false on failure

1
function main() {
2
    var data = activeSelf.mountImageOk();
3
    logd(data);
4
}
5

6
main();

activeSelf.startActiveMySelf Start Self-Activation

Start self-activation. See the self-activation configuration docs for details
Available in EC standalone 6.1.0+
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function testactive1_ext_vpn() {
2
    logd("testactive1_self_vpn")
3

4
    activeSelf.openSelfVpn();
5
    // Sleep briefly so VPN error messages can be captured
6
    sleep(3000)
7
    let ar = activeSelf.getOpenSelfVpnError()
8
    if (ar != "") {
9
        loge("Failed to open built-in VPN")
10
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
11
        return false;
12
    }
13
    sleep(2000)
14

15
    let acData = activeSelf.startActiveMySelf(30000);
16
    if (!acData) {
17

18
        loge("Self-activation failed, no response");
19
        return false;
20
    }
21
    if (acData["code"] != 0) {
22
        loge("Self-activation failed, err : " + acData["msg"]);
23
        return false;
24
    }
25
    logd("Self-activation succeeded!!")
26
    logd("mount -> " + activeSelf.mountImageOk())
27
    activeSelf.disableSelfVpn();
28
    return true;
29
}
30

31
function main() {
32
    testactive1_ext_vpn();
33
}
34

35
main();

activeSelf.openApp Open App

Open an app by bundleId
If opening a proxy IPA:
Call activeSelf.startActiveMySelf for self-activation first
Mount the developer image so the proxy IPA can start
Available in EC standalone 6.1.0+
@param bundleId bundle ID of the app to launch
@param start_suspended not very meaningful; use 0
@param kill_existing 1 = kill existing process (may not work); use 0
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information; data contains PID on success

1
function testOpenApp() {
2
    // If opening a proxy IPA:
3
    // Call activeSelf.startActiveMySelf for self-activation first
4
    // Mount the developer image so the proxy IPA can start
5
    logd("testOpenApp")
6
    activeSelf.openSelfVpn();
7
    // Sleep briefly so VPN error messages can be captured
8
    sleep(5000)
9
    let ar = activeSelf.getOpenSelfVpnError()
10
    if (ar != "") {
11
        loge("Failed to open built-in VPN")
12
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
13
        activeSelf.disableSelfVpn();
14
        return false;
15
    }
16
    sleep(2000)
17
    // Proxy IPA bundleId
18
    let runner = "com.cy.ceshi";
19

20
    let rsd = activeSelf.openApp(runner, 0, 0,30000)
21
    if (!rsd) {
22
        loge("Failed to open app")
23
        activeSelf.disableSelfVpn();
24
        return false;
25
    }
26
    if (rsd["code"] != 0) {
27
        loge("Failed to open app, err : " + rsd["msg"]);
28
        activeSelf.disableSelfVpn();
29
        return false;
30
    }
31
    logd(JSON.stringify(rsd))
32

33
    logd("App opened successfully")
34
    activeSelf.disableSelfVpn();
35
    return true;
36
}
37

38
function main() {
39
    testOpenApp();
40
}
41

42
main();

activeSelf.killApp Kill App

Kill an app by bundleId
Available in EC standalone 6.1.0+
@param bundleId bundle ID of the app to kill
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function testKillApp() {
2
    logd("testKillApp")
3
    activeSelf.openSelfVpn();
4
    // Sleep briefly so VPN error messages can be captured
5
    sleep(5000)
6
    let ar = activeSelf.getOpenSelfVpnError()
7
    if (ar != "") {
8
        loge("Failed to open built-in VPN")
9
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
10
        activeSelf.disableSelfVpn();
11
        return false;
12
    }
13
    sleep(2000)
14
    // Proxy IPA bundleId
15
    let runner = "com.cy.ceshi";
16
    let rsd = activeSelf.killApp(runner,30000)
17
    if (!rsd) {
18
        loge("Failed to kill process")
19
        activeSelf.disableSelfVpn();
20
        return false;
21
    }
22
    if (rsd["code"] != 0) {
23
        loge("Failed to kill process, err : " + rsd["msg"]);
24
        activeSelf.disableSelfVpn();
25
        return false;
26
    }
27
    logd(JSON.stringify(rsd))
28
    logd("App process killed successfully")
29
    activeSelf.disableSelfVpn();
30
    return true;
31
}
32

33
function main() {
34
    testKillApp();
35
}
36

37
main();

activeSelf.listApps Get App List

Get installed app list
Available in EC standalone 6.1.0+
Return field descriptions:
ApplicationType = app type
CFBundleIdentifier = bundleId (package name)
CFBundleDisplayName = app display name
CFBundleShortVersionString = version
CFBundleURLSchemes = URL schemes
@param type System = system apps, User = user-installed apps, Any = all apps
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information; data is the app list array

1
function testAppList() {
2
    logd("testAppList")
3
    activeSelf.openSelfVpn();
4
    // Sleep briefly so VPN error messages can be captured
5
    sleep(5000)
6
    let ar = activeSelf.getOpenSelfVpnError()
7
    if (ar != "") {
8
        loge("Failed to open built-in VPN")
9
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
10
        activeSelf.disableSelfVpn();
11
        return false;
12
    }
13
    sleep(2000)
14
    let rsd = activeSelf.listApps("User",30000)
15
    if (!rsd) {
16
        loge("Failed to get app list")
17
        activeSelf.disableSelfVpn();
18
        return false;
19
    }
20
    if (rsd["code"] != 0) {
21
        loge("Failed to get app list, err : " + rsd["msg"]);
22
        activeSelf.disableSelfVpn();
23
        return false;
24
    }
25
    logd("App list: " + JSON.stringify(rsd.data))
26
    activeSelf.disableSelfVpn();
27
    return true;
28
}
29

30
function main() {
31
    testAppList();
32
}
33

34
main();

activeSelf.listProcess Get Process List

Get process list
Available in EC standalone 6.1.0+
name = process name
isApplication = whether it is a visible application
realAppName = actual runtime path
pid = process ID
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information; data is the process list array

1
function testAppList() {
2
    logd("testAppList")
3
    activeSelf.openSelfVpn();
4
    // Sleep briefly so VPN error messages can be captured
5
    sleep(5000)
6
    let ar = activeSelf.getOpenSelfVpnError()
7
    if (ar != "") {
8
        loge("Failed to open built-in VPN")
9
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
10
        activeSelf.disableSelfVpn();
11
        return false;
12
    }
13
    sleep(2000)
14
    let rsd = activeSelf.listProcess(30000)
15
    if (!rsd) {
16
        loge("Failed to get process list")
17
        activeSelf.disableSelfVpn();
18
        return false;
19
    }
20
    if (rsd["code"] != 0) {
21
        loge("Failed to get process list, err : " + rsd["msg"]);
22
        activeSelf.disableSelfVpn();
23
        return false;
24
    }
25
    logd("Process list: " + JSON.stringify(rsd.data))
26
    activeSelf.disableSelfVpn();
27
    return true;
28
}
29

30
function main() {
31
    testAppList();
32
}
33

34
main();

activeSelf.reboot Reboot Device

Reboot the device
Available in EC standalone 6.1.0+
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function testReboot() {
2
    activeSelf.openSelfVpn();
3
    // Sleep briefly so VPN error messages can be captured
4
    sleep(5000)
5
    let ar = activeSelf.getOpenSelfVpnError()
6
    if (ar != "") {
7
        loge("Failed to open built-in VPN")
8
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
9
        activeSelf.disableSelfVpn();
10
        return false;
11
    }
12
    sleep(2000)
13
    let rsd = activeSelf.reboot(30000)
14
    if (!rsd) {
15
        loge("Reboot failed")
16
        activeSelf.disableSelfVpn();
17
        return false;
18
    }
19
    if (rsd["code"] != 0) {
20
        loge("Reboot failed, err : " + rsd["msg"]);
21
        activeSelf.disableSelfVpn();
22
        return false;
23
    }
24
    logd("Reboot: " + JSON.stringify(rsd.data))
25
    return true;
26
}
27

28
function main() {
29
    testReboot();
30
}
31

32
main();

activeSelf.killAppByPid Kill Process by PID

Kill an app/process by PID
Available in EC standalone 6.1.0+
@param pid process PID (integer)
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function test_killAppByPid() {
2
    activeSelf.openSelfVpn();
3
    // Sleep briefly so VPN error messages can be captured
4
    sleep(5000)
5
    let ar = activeSelf.getOpenSelfVpnError()
6
    if (ar != "") {
7
        loge("Failed to open built-in VPN")
8
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
9
        activeSelf.disableSelfVpn();
10
        return false;
11
    }
12
    sleep(2000)
13
    // PID from listProcess
14
    let rsd = activeSelf.killAppByPid(123,30000)
15
    if (!rsd) {
16
        loge("Failed to kill process")
17
        activeSelf.disableSelfVpn();
18
        return false;
19
    }
20
    if (rsd["code"] != 0) {
21
        loge("Failed to kill process, err : " + rsd["msg"]);
22
        activeSelf.disableSelfVpn();
23
        return false;
24
    }
25
    logd("Process killed: " + JSON.stringify(rsd.data))
26
    return true;
27
}
28

29
function main() {
30
    test_killAppByPid();
31
}
32

33
main();

activeSelf.installApp Install IPA

Install an application
Available in EC standalone 6.2.0+
@param path IPA file path
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function test_installApp() {
2
    activeSelf.openSelfVpn();
3
    // Sleep briefly so VPN error messages can be captured
4
    sleep(5000)
5
    let ar = activeSelf.getOpenSelfVpnError()
6
    if (ar != "") {
7
        loge("Failed to open built-in VPN")
8
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
9
        activeSelf.disableSelfVpn();
10
        return false;
11
    }
12
    sleep(2000)
13
    // Self-activate once first so the image can mount
14
    activeSelf.startActiveMySelf(30000)
15
    let filepath = file.getSandBoxFilePath("ddd.ipa")
16
    let rsd = activeSelf.installApp(filepath, 30000)
17
    if (!rsd) {
18
        loge("Installation failed")
19
        activeSelf.disableSelfVpn();
20
        return false;
21
    }
22
    if (rsd["code"] != 0) {
23
        loge("Installation failed, err : " + rsd["msg"]);
24
        activeSelf.disableSelfVpn();
25
        return false;
26
    }
27
    logd("Installation succeeded")
28
    return true;
29
}
30

31
function main() {
32
    test_installApp();
33
}
34

35
main();

activeSelf.uninstallApp Uninstall App

Uninstall an application
@param bundleId bundle ID to uninstall
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information

1
function test_uninstallApp() {
2
    activeSelf.openSelfVpn();
3
    // Sleep briefly so VPN error messages can be captured
4
    sleep(5000)
5
    let ar = activeSelf.getOpenSelfVpnError()
6
    if (ar != "") {
7
        loge("Failed to open built-in VPN")
8
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
9
        activeSelf.disableSelfVpn();
10
        return false;
11
    }
12
    sleep(2000)
13
    // Self-activate once first so the image can mount
14
    activeSelf.startActiveMySelf(30000)
15
    let bundleId="com.cy.ceshi"
16
    let rsd = activeSelf.uninstallApp(bundleId, 30000)
17
    if (!rsd) {
18
        loge("Uninstall failed")
19
        activeSelf.disableSelfVpn();
20
        return false;
21
    }
22
    if (rsd["code"] != 0) {
23
        loge("Uninstall failed, err : " + rsd["msg"]);
24
        activeSelf.disableSelfVpn();
25
        return false;
26
    }
27
    logd("Uninstall succeeded")
28
    return true;
29
}
30

31
function main() {
32
    test_uninstallApp();
33
}
34

35
main();

activeSelf.deviceOrientation Screen Orientation

Screen orientation
Available in EC standalone 6.5.0+
@param timeout timeout in milliseconds
@returns {JSON} code = 0 on success; msg contains error information; data is orientation — 1 = portrait, 2 = landscape, 0 = unknown

1
function test_active_screenshot() {
2
    let ss = activeSelf.deviceOrientation(10000)
3
    if (ss) {
4
        logd("Current screen orientation: " + ss["data"])
5
    }
6
    logd("Starting screenshot")
7
    console.time(1)
8
    let img = activeSelf.screenshot(10000)
9
    logd(img)
10
    if (img) {
11
        logd(img.getWidth() + "," + img.getHeight())
12
        let path = file.getSandBoxFilePath("test.png")
13
        logd("Save to path: " + path)
14
        img.saveTo(path)
15
        img.recycle()
16
    }
17
    logd("end, elapsed (ms) ", console.timeEnd(1))
18
    sleep(300000)
19
}
20

21

22

23
function start() {
24
    activeSelf.openSelfVpn();
25
    // Sleep briefly so VPN error messages can be captured
26
    sleep(5000)
27
    let ar = activeSelf.getOpenSelfVpnError()
28
    if (ar != "") {
29
        loge("Failed to open built-in VPN")
30
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
31
        activeSelf.disableSelfVpn();
32
        return false;
33
    }
34
    sleep(2000)
35
    // Self-activate once first so the image can mount
36
    activeSelf.startActiveMySelf(30000)
37
    test_active_screenshot()
38
    return true;
39
}
40

41
function main() {
42
    start();
43
}
44

45
main();

activeSelf.screenshot Screenshot

Take a screenshot
Available in EC standalone 6.5.0+
@param timeout timeout in milliseconds
@returns {AutoImage} null if screenshot failed

1
function test_active_screenshot() {
2
    let ss = activeSelf.deviceOrientation(10000)
3
    if (ss) {
4
        logd("Current screen orientation: " + ss["data"])
5
    }
6
    logd("Starting screenshot")
7
    console.time(1)
8
    let img = activeSelf.screenshot(10000)
9
    logd(img)
10
    if (img) {
11
        logd(img.getWidth() + "," + img.getHeight())
12
        let path = file.getSandBoxFilePath("test.png")
13
        logd("Save to path: " + path)
14
        img.saveTo(path)
15
        img.recycle()
16
    }
17
    logd("end, elapsed (ms) ", console.timeEnd(1))
18
    sleep(300000)
19
}
20

21

22

23
function start() {
24
    activeSelf.openSelfVpn();
25
    // Sleep briefly so VPN error messages can be captured
26
    sleep(5000)
27
    let ar = activeSelf.getOpenSelfVpnError()
28
    if (ar != "") {
29
        loge("Failed to open built-in VPN")
30
        loge("Error message: " + activeSelf.getOpenSelfVpnError())
31
        activeSelf.disableSelfVpn();
32
        return false;
33
    }
34
    sleep(2000)
35
    // Self-activate once first so the image can mount
36
    activeSelf.startActiveMySelf(30000)
37
    test_active_screenshot()
38
    return true;
39
}
40

41
function main() {
42
    start();
43
}
44

45
main();