pwnlib.adb
— Android Debug Bridge¶
Provides utilities for interacting with Android devices via the Android Debug Bridge.
Using Android Devices with Pwntools¶
Pwntools tries to be as easy as possible to use with Android devices.
If you have only one device attached, everything “just works”.
If you have multiple devices, you have a handful of options to select one, or iterate over the devices.
First and most important is the context.device
property, which declares the “currently”
selected device in any scope. It can be set manually to a serial number, or to a Device
instance.
# Take the first available device
context.device = adb.wait_for_device()
# Set a device by serial number
context.device = 'ZX1G22LH8S'
# Set a device by its product name
for device in adb.devices():
if device.product == 'shamu':
break
else:
error("Could not find any shamus!")
Once a device is selected, you can operate on it with any of the functions in
the pwnlib.adb
module.
# Get a process listing
print adb.process(['ps']).recvall()
# Fetch properties
print adb.properties.ro.build.fingerprint
# Read and write files
print adb.read('/proc/version')
adb.write('/data/local/tmp/foo', 'my data')
-
class
pwnlib.adb.adb.
AdbDevice
(serial, type, port=None, product='unknown', model='unknown', device='unknown', features=None, **kw)[源代码]¶ Encapsulates information about a connected device.
Example
>>> device = adb.wait_for_device() >>> device.arch 'arm' >>> device.bits 32 >>> device.os 'android' >>> device.product 'sdk_phone_armv7' >>> device.serial 'emulator-5554'
-
pwnlib.adb.adb.
adb
(argv, *a, **kw)[源代码]¶ Returns the output of an ADB subcommand.
>>> adb.adb(['get-serialno']) 'emulator-5554\n'
-
pwnlib.adb.adb.
boot_time
() → int[源代码]¶ 返回: Boot time of the device, in Unix time, rounded to the nearest second.
-
pwnlib.adb.adb.
current_device
(any=False)[源代码]¶ Returns an
AdbDevice
instance for the currently-selected device (viacontext.device
).Example
>>> device = adb.current_device(any=True) >>> device AdbDevice(serial='emulator-5554', type='device', port='emulator', product='sdk_phone_armv7', model='sdk phone armv7', device='generic') >>> device.port 'emulator'
-
pwnlib.adb.adb.
devices
(*a, **kw)[源代码]¶ Returns a list of
Device
objects corresponding to the connected devices.
-
pwnlib.adb.adb.
exists
(*a, **kw)[源代码]¶ Return
True
ifpath
exists on the target device.Examples
>>> adb.exists('/') True >>> adb.exists('/init') True >>> adb.exists('/does/not/exist') False
-
pwnlib.adb.adb.
find_ndk_project_root
(source)[源代码]¶ Given a directory path, find the topmost project root.
tl;dr “foo/bar/jni/baz.cpp” ==> “foo/bar”
-
pwnlib.adb.adb.
getprop
(*a, **kw)[源代码]¶ Reads a properties from the system property store.
参数: name (str) – Optional, read a single property. 返回: If name
is not specified, adict
of all properties is returned. Otherwise, a string is returned with the contents of the named property.
-
pwnlib.adb.adb.
install
(apk, *arguments)[源代码]¶ Install an APK onto the device.
This is a wrapper around ‘pm install’, which backs ‘adb install’.
参数: - apk (str) – Path to the APK to intall (e.g.
'foo.apk'
) - arguments – Supplementary arguments to ‘pm install’,
e.g.
'-l', '-g'
.
- apk (str) – Path to the APK to intall (e.g.
-
pwnlib.adb.adb.
isdir
(*a, **kw)[源代码]¶ Return
True
ifpath
is a on the target device.Examples
>>> adb.isdir('/') True >>> adb.isdir('/init') False >>> adb.isdir('/does/not/exist') False
-
pwnlib.adb.adb.
listdir
(*a, **kw)[源代码]¶ Returns a list containing the entries in the provided directory.
注解
This uses the SYNC LIST functionality, which runs in the adbd SELinux context. If adbd is running in the su domain (‘adb root’), this behaves as expected.
Otherwise, less files may be returned due to restrictive SELinux policies on adbd.
-
pwnlib.adb.adb.
logcat
(*a, **kw)[源代码]¶ Reads the system log file.
By default, causes logcat to exit after reading the file.
参数: stream (bool) – If True
, the contents are streamed rather than read in a one-shot manner. Default isFalse
.返回: If stream
isFalse
, returns a string containing the log data. Otherwise, it returns apwnlib.tubes.tube.tube
connected to the log output.
-
pwnlib.adb.adb.
makedirs
(*a, **kw)[源代码]¶ Create a directory and all parent directories on the target device.
注解
Silently succeeds if the directory already exists.
Examples
>>> adb.makedirs('/data/local/tmp/this/is/a/directory/heirarchy') >>> adb.listdir('/data/local/tmp/this/is/a/directory') ['heirarchy']
-
pwnlib.adb.adb.
mkdir
(*a, **kw)[源代码]¶ Create a directory on the target device.
注解
Silently succeeds if the directory already exists.
参数: path (str) – Directory to create. Examples
>>> adb.mkdir('/')
>>> path = '/data/local/tmp/mkdir_test' >>> adb.exists(path) False >>> adb.mkdir(path) >>> adb.exists(path) True
>>> adb.mkdir('/init') Traceback (most recent call last): ... PwnlibException: mkdir failed for /init, File exists
-
pwnlib.adb.adb.
proc_exe
(*a, **kw)[源代码]¶ Returns the full path of the executable for the provided PID.
-
pwnlib.adb.adb.
process
(*a, **kw)[源代码]¶ Execute a process on the device.
See
pwnlib.tubes.process.process
documentation for more info.返回: A pwnlib.tubes.process.process
tube.Examples
>>> adb.root() >>> print adb.process(['cat','/proc/version']).recvall() Linux version ...
-
pwnlib.adb.adb.
pull
(*a, **kw)[源代码]¶ Download a file from the device.
参数: 返回: The contents of the file.
Example
>>> _=adb.pull('/proc/version', './proc-version') >>> print read('./proc-version') Linux version ...
-
pwnlib.adb.adb.
push
(*a, **kw)[源代码]¶ Upload a file to the device.
参数: 返回: Remote path of the file.
Example
>>> write('./filename', 'contents') >>> adb.push('./filename', '/data/local/tmp') '/data/local/tmp/filename' >>> adb.read('/data/local/tmp/filename') 'contents' >>> adb.push('./filename', '/does/not/exist') Traceback (most recent call last): ... PwnlibException: Could not stat '/does/not/exist'
-
pwnlib.adb.adb.
read
(*a, **kw)[源代码]¶ Download a file from the device, and extract its contents.
参数: Examples
>>> print adb.read('/proc/version') Linux version ... >>> adb.read('/does/not/exist') Traceback (most recent call last): ... PwnlibException: Could not stat '/does/not/exist'
-
pwnlib.adb.adb.
uninstall
(package, *arguments)[源代码]¶ Uninstall an APK from the device.
This is a wrapper around ‘pm uninstall’, which backs ‘adb uninstall’.
参数: - package (str) – Name of the package to uninstall (e.g.
'com.foo.MyPackage'
) - arguments – Supplementary arguments to
'pm install'
, e.g.'-k'
.
- package (str) – Name of the package to uninstall (e.g.
-
pwnlib.adb.adb.
unlink
(*a, **kw)[源代码]¶ Unlinks a file or directory on the target device.
Examples
>>> adb.unlink("/does/not/exist") Traceback (most recent call last): ... PwnlibException: Could not unlink '/does/not/exist': Does not exist
>>> filename = '/data/local/tmp/unlink-test' >>> adb.write(filename, 'hello') >>> adb.exists(filename) True >>> adb.unlink(filename) >>> adb.exists(filename) False
>>> adb.mkdir(filename) >>> adb.write(filename + '/contents', 'hello') >>> adb.unlink(filename) Traceback (most recent call last): ... PwnlibException: Cannot delete non-empty directory '/data/local/tmp/unlink-test' without recursive=True
>>> adb.unlink(filename, recursive=True) >>> adb.exists(filename) False
-
pwnlib.adb.adb.
unlock_bootloader
(*a, **kw)[源代码]¶ Unlocks the bootloader of the device.
注解
This requires physical interaction with the device.
-
pwnlib.adb.adb.
wait_for_device
(*a, **kw)[源代码]¶ Waits for a device to be connected.
By default, waits for the currently-selected device (via
context.device
). To wait for a specific device, setcontext.device
. To wait for any device, clearcontext.device
.返回: An AdbDevice
instance for the device.Examples
>>> device = adb.wait_for_device()
-
pwnlib.adb.adb.
which
(*a, **kw)[源代码]¶ Retrieves the full path to a binary in
$PATH
on the device参数: - name (str) – Binary name
- all (bool) – Whether to return all paths, or just the first
- *a – Additional arguments for
adb.process()
- **kw – Additional arguments for
adb.process()
返回: Either a path, or list of paths
Example
>>> adb.which('sh') '/system/bin/sh' >>> adb.which('sh', all=True) ['/system/bin/sh']
>>> adb.which('foobar') is None True >>> adb.which('foobar', all=True) []
This file exists only for backward compatibility