cyanoacrylate
- Analysis
- AnalysisOptions
- AndroidPermission
- App
- AppAnalysis
- AppAnalysisResult
- DeviceAttribute
- GetDeviceAttributeOptions
- IosPermission
- MitmproxyCertificate
- MitmproxyClient
- MitmproxyConnection
- MitmproxyEvent
- MitmproxyServer
- MitmproxyServerSpec
- MitmproxyTlsData
- PlatformApi
- RunTargetOptions
- SupportedCapability
- SupportedPlatform
- SupportedRunTarget
- TrafficCollectionOptions
Ƭ Analysis<Platform, RunTarget, Capabilities>: Object
Functions that can be used to instrument the device and analyze apps.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
RunTarget |
extends SupportedRunTarget<Platform> |
Capabilities |
extends SupportedCapability<Platform>[] |
| Name | Type | Description |
|---|---|---|
ensureDevice |
(options?: { killExisting?: boolean }) => Promise<void> |
Assert that the selected device is connected and ready to be used with the selected capabilities. Will start an emulator and wait for it to boot if necessary and a name was provided in targetOptions.startEmulatorOptions.emulatorName. On Android, installs and configures WireGuard on the target and the frida-server, if the frida capability is chosen. |
ensureTrackingDomainResolution |
() => Promise<void> |
Assert that a few tracking domains can be resolved. This is useful to ensure that no DNS tracking blocker is interfering with the results. |
platform |
PlatformApi<Platform, RunTarget, Capabilities> |
A raw platform API object as returned by appstraction. |
resetDevice |
() => Promise<void> |
Reset the specified device to the snapshot specified in targetOptions.snapshotName. |
startAppAnalysis |
(appIdOrPath: string | AppPath<Platform>, options?: { noSigint?: boolean ; resetApp?: boolean }) => Promise<AppAnalysis<Platform, RunTarget, Capabilities>> |
Start an app analysis. The app analysis is controlled through the returned object. Remember to call stop() on the object when you are done with the app to clean up and retrieve the analysis data. |
startTrafficCollection |
(options?: Platform extends "android" ? TrafficCollectionOptions : never) => Promise<void> |
Start collecting the device's traffic. On Android, this will start a WireGuard proxy on the host computer on port 51820. It will automatically configure the target to use the WireGuard proxy and trust the mitmproxy TLS certificate. You can configure which apps to include using the options parameter. On iOS, this will start a mitmproxy HTTP(S) proxy on the host computer on port 8080. It will automatically configure the target to use the proxy and trust the mitmproxy TLS certificate. You can not restrict the traffic collection to specific apps. Only one traffic collection can be active at a time. |
stop |
() => Promise<void> |
Stop the analysis. This is important for clean up, e.g. stopping the emulator if it is managed by this library. |
stopTrafficCollection |
() => Promise<Har> |
Stop collecting the device's traffic. This will stop the proxy on the host computer. |
Ƭ AnalysisOptions<Platform, RunTarget, Capabilities>: { capabilities: Capabilities ; platform: Platform ; runTarget: RunTarget } & RunTargetOptions[Platform][RunTarget] extends object ? { targetOptions: RunTargetOptions[Platform][RunTarget] } : { targetOptions?: Record<string, never> }
The options for the startAnalysis() function.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
RunTarget |
extends SupportedRunTarget<Platform> |
Capabilities |
extends SupportedCapability<Platform>[] |
Ƭ AndroidPermission: typeof androidPermissions[number]
An ID of a known permission on Android.
node_modules/appstraction/dist/index.d.ts:68
Ƭ App: Object
Metadata about an app.
| Name | Type | Description |
|---|---|---|
id |
string |
The app's ID. |
version? |
string |
The app's version. |
Ƭ AppAnalysis<Platform, RunTarget, Capabilities>: Object
Functions that can be used to control an app analysis.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
RunTarget |
extends SupportedRunTarget<Platform> |
Capabilities |
extends SupportedCapability<Platform>[] |
| Name | Type | Description |
|---|---|---|
app |
App |
The app's metadata. |
installApp |
() => Promise<void> |
Install the specified app. This is only available if the app analysis was started with an app path, but not if it was started with an app ID. See PlatformApi |
setAppPermissions |
(permissions?: Parameters<PlatformApi<Platform, RunTarget, Capabilities>["setAppPermissions"]>[1]) => Promise<void> |
Set the permissions for the app with the given app ID. By default, it will grant all known permissions (including dangerous permissions on Android) and set the location permission on iOS to always. You can specify which permissions to grant/deny using the permissions argument. Requires the ssh and frida capabilities on iOS. See PlatformApi |
startApp |
() => Promise<void> |
Start the app. See PlatformApi |
startTrafficCollection |
(name?: string) => Promise<void> |
Start collecting the traffic of only this app on Android and of the whole device on iOS. On Android, this will start a WireGuard proxy on the host computer on port 51820. It will automatically configure the target to use the WireGuard proxy and trust the mitmproxy TLS certificate. On iOS, this will start a mitmproxy HTTP(S) proxy on the host computer on port 8080. It will automatically configure the target to use the proxy and trust the mitmproxy TLS certificate. Only one traffic collection can be active at a time. |
stop |
(options?: { uninstallApp?: boolean }) => Promise<AppAnalysisResult> |
Stop the app analysis and return the collected data. |
stopApp |
() => Promise<void> |
Force-stop the app. See PlatformApi |
stopTrafficCollection |
() => Promise<void> |
Stop collecting the app's (or, on iOS, the device's) traffic. This will stop the proxy on the host computer. The collected traffic is available from the traffic property of the object returned by stop(). |
uninstallApp |
() => Promise<void> |
Uninstall the app. See PlatformApi |
Ƭ AppAnalysisResult: Object
The result of an app analysis.
| Name | Type | Description |
|---|---|---|
app |
App |
The app's metadata. |
mitmproxyEvents |
MitmproxyEvent[] |
The mitmproxy events that were observed during the traffic collection. Note that this is not a stable API. |
traffic |
Record<string, Har> |
The collected traffic, accessible by the specified name. The traffic is available as a JSON object in the HAR format (https://w3c.github.io/web-performance/specs/HAR/Overview.html). |
Ƭ DeviceAttribute<Platform>: Platform extends "android" ? never : Platform extends "ios" ? "idfv" : never
A supported attribute for the getDeviceAttribute() function, depending on the platform.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
node_modules/appstraction/dist/index.d.ts:418
Ƭ GetDeviceAttributeOptions: Object
The options for each attribute available through the getDeviceAttribute() function.
| Name | Type | Description |
|---|---|---|
idfv |
{ appId: string } |
The options for the idfv attribute. |
idfv.appId |
string |
The app ID of the app to get the identifierForVendor for. |
node_modules/appstraction/dist/index.d.ts:420
Ƭ IosPermission: typeof iosPermissions[number]
An ID of a known permission on iOS.
node_modules/appstraction/dist/index.d.ts:72
Ƭ MitmproxyCertificate: Object
A mitmproxy certificate object representing a TLS certificate.
See
https://docs.mitmproxy.org/stable/api/mitmproxy/certs.html#Cert
| Name | Type | Description |
|---|---|---|
altnames |
string[] |
The certificate's alternate names (SubjectAlternativeName). |
cn |
string | null |
The certificate's common name. |
issuer |
[string, string][] |
The issuer information of the certificate, as an array of key-value pairs. Example ts [ ['C', 'US'], ['O', 'DigiCert Inc'], ['OU', 'www.digicert.com'], ['CN', 'GeoTrust TLS RSA CA G1'], ]; |
keyinfo |
[string, number] |
The key information of the certificate, consisting of the algorithm and the bit size. Example ts ['RSA', 2048]; |
notafter |
number |
The timestamp when the certificate expires. |
notbefore |
number |
The timestamp when the certificate becomes valid. |
organization |
string | null |
The organization name of the certificate owner. |
serial |
number |
The certificate's serial number. |
subject |
[string, string][] |
The subject information of the certificate, as an array of key-value pairs. Example ts [ ['C', 'US'], ['O', 'DigiCert Inc'], ['OU', 'www.digicert.com'], ['CN', 'GeoTrust TLS RSA CA G1'], ]; |
Ƭ MitmproxyClient: MitmproxyConnection & { mitmCertificate: MitmproxyCertificate | null ; proxyMode: string }
A mitmproxy client object, represents a connection between a client and mitmproxy.
See
https://docs.mitmproxy.org/stable/api/mitmproxy/connection.html#Client
Ƭ MitmproxyConnection: Object
A mitmproxy connection object.
See
https://docs.mitmproxy.org/stable/api/mitmproxy/connection.html#Connection
| Name | Type | Description |
|---|---|---|
certificateList |
MitmproxyCertificate[] |
The TLS certificate list as sent by the peer. The first certificate is the end-entity certificate. |
cipher |
string |
The active cipher name as returned by OpenSSL's SSL_CIPHER_get_name. |
cipherList |
string[] |
Ciphers accepted by the proxy server on this connection. |
connected |
boolean |
true if MitmproxyConnection.state is OPEN, false otherwise. |
error |
string | null |
A string describing a general error with connections to this address. The purpose of this property is to signal that new connections to the particular endpoint should not be attempted, for example because it uses an untrusted TLS certificate. Regular (unexpected) disconnects do not set the error property. This property is only reused per client connection. |
id |
string |
The connection's unique ID. |
peername |
[string, number] | null |
The remote's [ip, port] tuple for this connection. |
sni |
string | null |
The Server Name Indication (SNI) sent in the ClientHello. |
sockname |
[string, number] | null |
The local's [ip, port] tuple for this connection. |
state |
"CLOSED" | "CAN_READ" | "CAN_WRITE" | "OPEN" |
The connection's state. |
timestampEnd |
number | null |
Timestamp of when the connection has been closed. |
timestampStart |
number | null |
Timestamp of when the TCP SYN was received (client) or sent (server). |
timestampTlsSetup |
number | null |
Timestamp of when the TLS handshake has been completed successfully. |
tls |
boolean |
true if TLS should be established, false otherwise. Note that this property only describes if a connection should eventually be protected using TLS. To check if TLS has already been established, use MitmproxyConnection.tlsEstablished. |
tlsEstablished |
boolean |
true if TLS has been established, false otherwise. |
tlsVersion |
string | null |
The active TLS version. |
transportProtocol |
"tcp" | "udp" |
The connection's protocol. |
Ƭ MitmproxyEvent: { status: "running" | "done" } | { context: { address: [string, number] ; client: MitmproxyClient } ; status: "clientConnected" | "clientDisconnected" } | { context: MitmproxyTlsData & { error: string | null } ; status: "tlsFailed" } | { context: MitmproxyTlsData ; status: "tlsEstablished" } | { context: { isRunning: boolean ; servers: MitmproxyServerSpec<"wireguard" | "regular" | string>[] } ; status: "proxyChanged" }
The events sent by the mitmproxy IPC events addon.
Ƭ MitmproxyServer: MitmproxyConnection & { address: [string, number] | null ; timestampTcpSetup: number | null ; via: ["http" | "https" | "tls" | "dtls" | "tcp" | "udp" | "dns", string | number] | null }
A mitmproxy server object, representing a connection between mitmproxy and an upstream server.
See
https://docs.mitmproxy.org/stable/api/mitmproxy/connection.html#Server
Ƭ MitmproxyServerSpec<Type>: Object
A mitmproxy.proxy.mode_servers.ServerInstance object.
See
| Name | Type |
|---|---|
Type |
extends "wireguard" | "regular" | string |
| Name | Type |
|---|---|
description |
string |
fullSpec |
string |
isRunning |
boolean |
lastException |
string | null |
listenAddrs |
[string, number][] |
type |
Type |
wireguardConf |
Type extends "wireguard" ? string | null : null |
Ƭ MitmproxyTlsData: Object
Mitmproxy's event data for the tls_start_client, tls_start_server, and tls_handshake event hooks.
See
https://docs.mitmproxy.org/stable/api/mitmproxy/tls.html#TlsData
| Name | Type | Description |
|---|---|---|
client |
MitmproxyClient |
The client connection. |
clientAddress |
string |
Convenience alias for the client address in human-readable format (<address>:<port>). |
isDtls |
boolean |
If set to true, indicates that it is a DTLS event. |
server |
MitmproxyServer |
The server connection. |
serverAddress |
string |
Convenience alias for the server address in human-readable format (SNI hostname or <address>:<port>). |
Ƭ PlatformApi<Platform, RunTarget, Capabilities, Capability>: Object
Functions that are available for the platforms.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
RunTarget |
extends SupportedRunTarget<Platform> |
Capabilities |
extends SupportedCapability<"android" | "ios">[] |
Capability |
Capabilities[number] |
| Name | Type | Description |
|---|---|---|
clearStuckModals |
Platform extends "android" ? () => Promise<void> : never |
Clear any potential stuck modals by pressing the back button followed by the home button. This is currently broken on iOS (see tweaselORG/appstraction#12). Requires the ssh capability on iOS. |
ensureDevice |
() => Promise<void> |
Assert that the selected device is connected and ready to be used with the selected capabilities, performing necessary setup steps. This should always be the first function you call. Note that depending on the capabilities you set, the setup steps may make permanent changes to your device. For Android, you can set the url to the WireGuard APK which should be installed in the WIREGUARD_APK_URL environment variable. Note that it is only used if WireGuard isn’t installed already. |
getDeviceAttribute |
<Attribute>(attribute: Attribute, ...options: Attribute extends keyof GetDeviceAttributeOptions ? [options: GetDeviceAttributeOptions[Attribute]] : [options?: undefined]) => Promise<string> |
Get the value of the given attribute of the device. Requires the frida capability on iOS. |
getForegroundAppId |
() => Promise<string | undefined> |
Get the app ID of the running app that is currently in the foreground. Requires the frida capability on iOS. |
getPidForAppId |
(appId: string) => Promise<number | undefined> |
Get the PID of the app with the given app ID if it is currently running. Requires the frida capability on iOS. |
getPrefs |
(appId: string) => Promise<Record<string, unknown> | undefined> |
Get the preferences (SharedPreferences on Android, NSUserDefaults on iOS) of the app with the given app ID. Requires the frida capability on Android and iOS. |
installApp |
(appPath: AppPath<Platform>, obbPaths?: Platform extends "android" ? ObbInstallSpec[] : never) => Promise<void> |
Install the app at the given path. |
installCertificateAuthority |
(path: string) => Promise<void> |
Install the certificate authority with the given path as a trusted CA on the device. This allows you to intercept and modify traffic from apps on the device. On Android, this installs the CA as a system CA. As this is normally not possible on Android 10 and above, it overlays the /system/etc/security/cacerts directory with a tmpfs and installs the CA there. This means that the changes are not persistent across reboots. On iOS, the CA is installed permanently as a root certificate in the Certificate Trust Store. It persists across reboots.\ Currently, you need to manually trust any CA at least once on the device, CAs can be added but not automatically marked as trusted (see: tweaselORG/appstraction#44 (comment)). Requires the root capability on Android, and the ssh capability on iOS. |
isAppInstalled |
(appId: string) => Promise<boolean> |
Check whether the app with the given app ID is installed. |
listApps |
(options?: { includeSystem?: boolean }) => Promise<string[]> |
Get a list of the app IDs of all installed apps. |
removeCertificateAuthority |
(path: string) => Promise<void> |
Remove the certificate authority with the given path from the trusted CAs on the device. On Android, this works for system CAs, including those pre-installed with the OS. As this is normally not possible on Android 10 and above, it overlays the /system/etc/security/cacerts directory with a tmpfs and removes the CA there. This means that the changes are not persistent across reboots. On iOS, this only works for CAs in the Certificate Trust Store. It does not work for pre-installed OS CAs. The changes are persistent across reboots. Requires the root capability on Android, and the ssh capability on iOS. |
resetDevice |
Platform extends "android" ? RunTarget extends "emulator" ? (snapshotName: string) => Promise<void> : never : never |
Reset the device to the specified snapshot (only available for emulators). Param The name of the snapshot to reset to. |
setAppBackgroundBatteryUsage |
Platform extends "android" ? (appId: string, state: "unrestricted" | "optimized" | "restricted") => Promise<void> : never |
Configure whether the app's background battery usage should be restricted. Currently only supported on Android. Param The app ID of the app to configure the background battery usage settings for. Param The state to set the background battery usage to. On Android, the possible values are: - unrestricted: "Allow battery usage in background without restrictions. May use more battery." - optimized: "Optimize based on your usage. Recommended for most apps." (default after installation) - restricted: "Restrict battery usage while in background. Apps may not work as expected. Notifications may be delayed." |
setAppPermissions |
(appId: string, permissions?: Platform extends "ios" ? { [p in IosPermission]?: "unset" | "allow" | "deny" } & { location?: "ask" | "never" | "always" | "while-using" } : Partial<Record<LiteralUnion<AndroidPermission, string>, "allow" | "deny">>) => Promise<void> |
Set the permissions for the app with the given app ID. By default, it will grant all known permissions (including dangerous permissions on Android) and set the location permission on iOS to always. You can specify which permissions to grant/deny using the permissions argument. Requires the ssh and frida capabilities on iOS. |
setClipboard |
(text: string) => Promise<void> |
Set the clipboard to the given text. Requires the frida capability on Android and iOS. |
setProxy |
Platform extends "android" ? (proxy: "wireguard" extends Capability ? WireGuardConfig : Proxy | null) => Promise<void> : Platform extends "ios" ? (proxy: Proxy | null) => Promise<void> : never |
Set or disable the proxy on the device. If you have enabled the wireguard capability, this will start or stop a WireGuard tunnel. Otherwise, it will set the global proxy on the device. On iOS, the proxy is set for the current WiFi network. It won't apply for other networks or for cellular data connections. WireGuard is currently only supported on Android. Enabling a WireGuard tunnel requires the root capability. Remarks The WireGuard integration will create a new tunnel in the app called appstraction and delete it when the proxy is stopped. If you have an existing tunnel with the same name, it will be overridden. Param The proxy to set, or null to disable the proxy. If you have enabled the wireguard capability, this is a string of the full WireGuard configuration to use. |
startApp |
(appId: string) => Promise<void> |
Start the app with the given app ID. Doesn't wait for the app to be ready. Also enables the certificate pinning bypass if enabled. Requires the frida or ssh capability on iOS. On Android, this will start the app with or without a certificate pinning bypass depending on the certificate-pinning-bypass capability. |
stopApp |
(appId: string) => Promise<void> |
Force-stop the app with the given app ID. |
target |
{ platform: Platform ; runTarget: RunTarget } |
An indicator for what platform and run target this instance of PlatformApi is configured for. This is useful mostly to write typeguards. |
target.platform |
Platform |
The platform this instance is configured for, i.e. ios or android. |
target.runTarget |
RunTarget |
The run target this instance is configured for, i.e. device or emulator. |
uninstallApp |
(appId: string) => Promise<void> |
Uninstall the app with the given app ID. Will not fail if the app is not installed. This also removes any data stored by the app. |
waitForDevice |
(tries?: number) => Promise<void> |
Wait until the device or emulator has been connected and has booted up completely. |
node_modules/appstraction/dist/index.d.ts:95
Ƭ RunTargetOptions: Object
The options for a specific platform/run target combination.
| Name | Type | Description |
|---|---|---|
android |
{ device: unknown ; emulator: { snapshotName?: string ; startEmulatorOptions?: { audio?: boolean ; emulatorName?: string ; ephemeral?: boolean ; headless?: boolean } } } |
The options for the Android platform. |
android.device |
unknown |
The options for the Android physical device run target. |
android.emulator |
{ snapshotName?: string ; startEmulatorOptions?: { audio?: boolean ; emulatorName?: string ; ephemeral?: boolean ; headless?: boolean } } |
The options for the Android emulator run target. |
android.emulator.snapshotName? |
string |
The name of a snapshot to use when resetting the emulator. |
android.emulator.startEmulatorOptions? |
{ audio?: boolean ; emulatorName?: string ; ephemeral?: boolean ; headless?: boolean } |
Options for the emulator if you want it to be automatically started and stopped by this library. |
android.emulator.startEmulatorOptions.audio? |
boolean |
Whether to start the emulator with audio (default: false). |
android.emulator.startEmulatorOptions.emulatorName? |
string |
The name of the emulator to start. |
android.emulator.startEmulatorOptions.ephemeral? |
boolean |
Whether to discard all changes when exiting the emulator (default: true). |
android.emulator.startEmulatorOptions.headless? |
boolean |
Whether to start the emulator in headless mode (default: false). |
ios |
{ device: { ip?: string ; password?: string ; port?: number ; proxyIp: string ; username?: "mobile" | "root" } ; emulator: never } |
The options for the iOS platform. |
ios.device |
{ ip?: string ; password?: string ; port?: number ; proxyIp: string ; username?: "mobile" | "root" } |
The options for the iOS physical device run target. |
ios.device.ip? |
string |
The device's IP address. If none is given, a connection via USB port forwarding is attempted. |
ios.device.password? |
string |
The password of the user to log into the device, defaults to alpine if not set. |
ios.device.port? |
number |
The port where the SSH server is running on the device. Defaults to 22. |
ios.device.proxyIp |
string |
The IP address of the host running the proxy to set up on the device. |
ios.device.username? |
"mobile" | "root" |
The username to use when logging into the device. Make sure the user is set up for login via SSH. If the mobile user is chosen, all commands are prepended with sudo. Defaults to mobile |
ios.emulator |
never |
The options for the iOS emulator run target. |
Ƭ SupportedCapability<Platform>: Platform extends "android" ? "frida" | "certificate-pinning-bypass" : Platform extends "ios" ? "certificate-pinning-bypass" : never
A capability supported by this library.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
Ƭ SupportedPlatform: "android" | "ios"
A platform that is supported by this library.
node_modules/appstraction/dist/index.d.ts:74
Ƭ SupportedRunTarget<Platform>: Platform extends "android" ? "emulator" | "device" : Platform extends "ios" ? "device" : never
A run target that is supported by this library for the given platform.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
node_modules/appstraction/dist/index.d.ts:76
Ƭ TrafficCollectionOptions: { mode: "all-apps" } | { apps: string[] ; mode: "allowlist" | "denylist" }
Options for a traffic collection that specifies which apps to collect traffic from.
mode: 'all-apps': Collect traffic from all apps.mode: 'allowlist': Collect traffic only from the apps with the app IDs in theappsarray.mode: 'denylist': Collect traffic from all apps except the apps with the app IDs in theappsarray.
• Const androidPermissions: readonly ["android.permission.ACCEPT_HANDOVER", "android.permission.ACCESS_BACKGROUND_LOCATION", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_LOCATION_EXTRA_COMMANDS", "android.permission.ACCESS_MEDIA_LOCATION", "android.permission.ACCESS_NETWORK_STATE", "android.permission.ACCESS_NOTIFICATION_POLICY", "android.permission.ACCESS_WIFI_STATE", "android.permission.ACTIVITY_RECOGNITION", "android.permission.ANSWER_PHONE_CALLS", "android.permission.AUTHENTICATE_ACCOUNTS", "android.permission.BLUETOOTH_ADMIN", "android.permission.BLUETOOTH_ADVERTISE", "android.permission.BLUETOOTH_CONNECT", "android.permission.BLUETOOTH_SCAN", "android.permission.BLUETOOTH", "android.permission.BODY_SENSORS_BACKGROUND", "android.permission.BODY_SENSORS", "android.permission.BROADCAST_STICKY", "android.permission.CALL_COMPANION_APP", "android.permission.CALL_PHONE", "android.permission.CAMERA", "android.permission.CHANGE_NETWORK_STATE", "android.permission.CHANGE_WIFI_MULTICAST_STATE", "android.permission.CHANGE_WIFI_STATE", "android.permission.DELIVER_COMPANION_MESSAGES", "android.permission.DISABLE_KEYGUARD", "android.permission.EXPAND_STATUS_BAR", "android.permission.FLASHLIGHT", "android.permission.FOREGROUND_SERVICE", "android.permission.GET_ACCOUNTS", "android.permission.GET_PACKAGE_SIZE", "android.permission.GET_TASKS", "android.permission.HIDE_OVERLAY_WINDOWS", "android.permission.HIGH_SAMPLING_RATE_SENSORS", "android.permission.INTERNET", "android.permission.KILL_BACKGROUND_PROCESSES", "android.permission.MANAGE_ACCOUNTS", "android.permission.MANAGE_OWN_CALLS", "android.permission.MODIFY_AUDIO_SETTINGS", "android.permission.NEARBY_WIFI_DEVICES", "android.permission.NFC_PREFERRED_PAYMENT_INFO", "android.permission.NFC_TRANSACTION_EVENT", "android.permission.NFC", "android.permission.PERSISTENT_ACTIVITY", "android.permission.POST_NOTIFICATIONS", "android.permission.PROCESS_OUTGOING_CALLS", "android.permission.QUERY_ALL_PACKAGES", "android.permission.READ_BASIC_PHONE_STATE", "android.permission.READ_CALENDAR", "android.permission.READ_CALL_LOG", "android.permission.READ_CELL_BROADCASTS", "android.permission.READ_CONTACTS", "android.permission.READ_EXTERNAL_STORAGE", "android.permission.READ_INSTALL_SESSIONS", "android.permission.READ_MEDIA_AUDIO", "android.permission.READ_MEDIA_IMAGES", "android.permission.READ_MEDIA_VIDEO", "android.permission.READ_NEARBY_STREAMING_POLICY", "android.permission.READ_PHONE_NUMBERS", "android.permission.READ_PHONE_STATE", "android.permission.READ_PROFILE", "android.permission.READ_SMS", "android.permission.READ_SOCIAL_STREAM", "android.permission.READ_SYNC_SETTINGS", "android.permission.READ_SYNC_STATS", "android.permission.READ_USER_DICTIONARY", "android.permission.RECEIVE_BOOT_COMPLETED", "android.permission.RECEIVE_MMS", "android.permission.RECEIVE_SMS", "android.permission.RECEIVE_WAP_PUSH", "android.permission.RECORD_AUDIO", "android.permission.REORDER_TASKS", "android.permission.REQUEST_COMPANION_PROFILE_WATCH", "android.permission.REQUEST_COMPANION_RUN_IN_BACKGROUND", "android.permission.REQUEST_COMPANION_START_FOREGROUND_SERVICES_FROM_BACKGROUND", "android.permission.REQUEST_COMPANION_USE_DATA_IN_BACKGROUND", "android.permission.REQUEST_DELETE_PACKAGES", "android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS", "android.permission.REQUEST_OBSERVE_COMPANION_DEVICE_PRESENCE", "android.permission.REQUEST_PASSWORD_COMPLEXITY", "android.permission.RESTART_PACKAGES", "android.permission.SCHEDULE_EXACT_ALARM", "android.permission.SEND_SMS", "android.permission.SET_WALLPAPER_HINTS", "android.permission.SET_WALLPAPER", "android.permission.SUBSCRIBED_FEEDS_READ", "android.permission.SUBSCRIBED_FEEDS_WRITE", "android.permission.TRANSMIT_IR", "android.permission.UPDATE_PACKAGES_WITHOUT_USER_ACTION", "android.permission.USE_BIOMETRIC", "android.permission.USE_CREDENTIALS", "android.permission.USE_EXACT_ALARM", "android.permission.USE_FINGERPRINT", "android.permission.USE_FULL_SCREEN_INTENT", "android.permission.USE_SIP", "android.permission.UWB_RANGING", "android.permission.VIBRATE", "android.permission.WAKE_LOCK", "android.permission.WRITE_CALENDAR", "android.permission.WRITE_CALL_LOG", "android.permission.WRITE_CONTACTS", "android.permission.WRITE_EXTERNAL_STORAGE", "android.permission.WRITE_PROFILE", "android.permission.WRITE_SMS", "android.permission.WRITE_SOCIAL_STREAM", "android.permission.WRITE_SYNC_SETTINGS", "android.permission.WRITE_USER_DICTIONARY", "com.android.alarm.permission.SET_ALARM", "com.android.browser.permission.READ_HISTORY_BOOKMARKS", "com.android.browser.permission.WRITE_HISTORY_BOOKMARKS", "com.android.launcher.permission.INSTALL_SHORTCUT", "com.android.launcher.permission.UNINSTALL_SHORTCUT", "com.android.voicemail.permission.ADD_VOICEMAIL", "com.google.android.gms.dck.permission.DIGITAL_KEY_READ", "com.google.android.gms.dck.permission.DIGITAL_KEY_WRITE", "com.google.android.gms.permission.ACTIVITY_RECOGNITION", "com.google.android.gms.permission.AD_ID_NOTIFICATION", "com.google.android.gms.permission.AD_ID", "com.google.android.gms.permission.CAR_FUEL", "com.google.android.gms.permission.CAR_MILEAGE", "com.google.android.gms.permission.CAR_SPEED", "com.google.android.gms.permission.CAR_VENDOR_EXTENSION", "com.google.android.gms.permission.REQUEST_SCREEN_LOCK_COMPLEXITY", "com.google.android.gms.permission.TRANSFER_WIFI_CREDENTIAL", "com.google.android.ims.providers.ACCESS_DATA", "com.google.android.providers.gsf.permission.READ_GSERVICES"]
The IDs of known permissions on Android.
node_modules/appstraction/dist/index.d.ts:66
• Const iosPermissions: readonly ["kTCCServiceLiverpool", "kTCCServiceUbiquity", "kTCCServiceCalendar", "kTCCServiceAddressBook", "kTCCServiceReminders", "kTCCServicePhotos", "kTCCServiceMediaLibrary", "kTCCServiceBluetoothAlways", "kTCCServiceMotion", "kTCCServiceWillow", "kTCCServiceExposureNotification", "kTCCServiceCamera", "kTCCServiceMicrophone", "kTCCServiceUserTracking"]
The IDs of known permissions on iOS.
node_modules/appstraction/dist/index.d.ts:70
▸ pause(durationInMs): Promise<unknown>
Pause for a given duration.
| Name | Type | Description |
|---|---|---|
durationInMs |
number |
The duration to pause for, in milliseconds. |
Promise<unknown>
node_modules/appstraction/dist/index.d.ts:18
▸ startAnalysis<Platform, RunTarget, Capabilities>(analysisOptions): Promise<Analysis<Platform, RunTarget, Capabilities>>
Initialize an analysis for the given platform and run target. Remember to call stop() on the returned object when
you want to end the analysis.
| Name | Type |
|---|---|
Platform |
extends SupportedPlatform |
RunTarget |
extends "emulator" | "device" |
Capabilities |
extends SupportedCapability<Platform>[] |
| Name | Type | Description |
|---|---|---|
analysisOptions |
AnalysisOptions<Platform, RunTarget, Capabilities> |
The options for the analysis. |
Promise<Analysis<Platform, RunTarget, Capabilities>>
An object that can be used to instrument the device and analyze apps.