Device - Dexcalibur code documentation

Device

This class represents a device

Constructor

new Device(config)

Source:

Device.js, line 47

Author:

Georges-B MICHEL

Parameters:

Name	Type	Default	Description
`config`	*	`null`

Members

authorized

Source:

Device.js, line 96

TRUE if debugging is authorized, else FALSE

bridge

Source:

Device.js, line 65

Default bridge for this devices

bridges :Array.<AdbWrapper>

Source:

Device.js, line 159

Hold all bridges (adb+usb, adb+tcp, sdb+usb, ssh, jtag, ...) configured for this device

Type:

Array.<AdbWrapper>

connected

Source:

Device.js, line 58

Flag. TRUE if currently connected, else FALSE

enrolled

Source:

Device.js, line 165

Flag. TRUE is the device is enrolled, else FALSE

frida :Object

Source:

Device.js, line 149

Hold frida configuration specfic to the device

Type:

Object

id

Source:

Device.js, line 90

Real device ID

isEmulated

Source:

Device.js, line 78

Deprecated:

model

Source:

Device.js, line 102

Device model

offline

Source:

Device.js, line 171

Flag. TRUE is the device is offline, else FALSE

platform :DeviceProfile

Source:

Device.js, line 142

Device profile built by DeviceProfiler

Type:

DeviceProfile

product

Source:

Device.js, line 108

Device product name

profile :DeviceProfile

Source:

Device.js, line 135

Device profile built by DeviceProfiler

Type:

DeviceProfile

selected

Source:

Device.js, line 72

Deprecated:

Flag. TRUE if this devices is default device for instrumentation

transportId

Source:

Device.js, line 119

Deprecated:

Transport ID

type

Source:

Device.js, line 51

uid

Source:

Device.js, line 84

Device internal UID

usbQualifier

Source:

Device.js, line 128

USB qualifier. Change when computer-side USB port change. It help to differentiate several devices with same DeviceID

Methods

(static) fromJsonObject(pJsonObject, pOverride) → {String}

Source:

Device.js, line 652

To unserialize a Device from JSON string

Parameters:

Name	Type	Description
`pJsonObject`	*
`pOverride`	*

Returns:

JSON-serialized object

Type: String

addBridge(pBridge)

Source:

Device.js, line 186

To add a bridge to the device

A bridge a way to send command or interact with the device.

Parameters:

Name	Type	Description
`pBridge`	AdbWrapper

disconnect()

Source:

Device.js, line 263

To disconnect "logically" a device.

This flag is involved into connected device monitoring.

getFridaServerPath()

Source:

Device.js, line 278

getUID() → {String}

Source:

Device.js, line 313

To get device UID

TODO : fix typo

Warning : Device UID is the Dexcalibur internal UID. It is not the DeviceID as returned by the device.

Returns:

Internal device UID

Type: String

hasFile(file) → {boolean}

Source:

Device.js, line 622

To check if the given file path exists on the device

Parameters:

Name	Type	Description
`file`	string	The file path to check

Returns:

Returns TRUE if the file exists on the device, else FALSE

Type: boolean

isAuthorized() → {Boolean}

Source:

Device.js, line 252

To get authorized status

Returns:

TRUE if the device is authorized, else FALSE

Type: Boolean

isConnected() → {Boolean}

Source:

Device.js, line 239

To get device status : connected / disconnected

Returns:

TRUE if the device is connected, else FALSE

Type: Boolean

isFridaReady() → {Boolean}

Source:

Device.js, line 229

To get enrollment status

Returns:

Enrollement status : TRUE if the device is enrolled and frida ready, else FALSE

Type: Boolean

pull(pRemotePath, pLocalPath)

Source:

Device.js, line 477

Parameters:

Name	Type	Description
`pRemotePath`	Path \| String
`pLocalPath`	Path \| String

pullPackage(pPkgIdentifier, pLocalPath) → {Boolean}

Source:

Device.js, line 525

Parameters:

Name	Type	Description
`pPkgIdentifier`	*
`pLocalPath`	*

Throws:

BridgeException

Returns:

Return TRUE if file has been successfully downloaded, else FALSE

Type: Boolean

pullTemp(pRemotePath)

Source:

Device.js, line 489

To pull a fil from a device and store it into temporary folder

Parameters:

Name	Type	Description
`pRemotePath`	String

pushBinary(pLocalPath, pRemotePath)

Source:

Device.js, line 509

To push an executable binary

Parameters:

Name	Type	Description
`pLocalPath`	Path \| String
`pRemotePath`	Path \| String

(async) retrieveUIDfromDevice()

Source:

Device.js, line 699

To retrieve UID from device through shell

sendIntent(data, callbacks, pIntentFilter, force)

Source:

Device.js, line 547

Deprecated:

Parameters:

Name	Type	Default	Description
`data`	Object
`callbacks`	Object	`null`
`pIntentFilter`	IntentFilter	`null`	An intance of the intent filter
`force`	Boolean	`false`

setFridaServer(pPath)

Source:

Device.js, line 271

Parameters:

Name	Type	Description
`pPath`	*

setUID(deviceID, qualifier)

Source:

Device.js, line 294

To setup internal device UID

Since several device can have the same DeviceID value, UID is built by mixing several DeviceID with several data from qualifier array

Parameters:

Name	Type	Description
`deviceID`	String	Value of DeviceID as returned by the device
`qualifier`	Array.<String>	Additional data

toJsonObject(pOverride) → {JsonObject}

Source:

Device.js, line 727

To serialize the Device to JSON string

Parameters:

Name	Type	Description
`pOverride`	Object	A collection overrided field

Returns:

JSON-serialized object

Type: JsonObject