A cross-platform FOSS library written in C to communicate with iOS devices natively.
... and a bunch of libraries and command-line utilities.
Get StartedThe library implements the native protocols needed to communicate with services running on iOS devices. Due to the reimplemention it does not depend on using or bundling any existing libraries from Apple.
The C programming language enables cross-platform use of the library. It has already been built and run on Linux, Mac, Windows, Android and embedded ARM SoCs.
The architecture of the library and dependencies has been designed with an OOP approach in mind. Thus bindings for other programming languages are easier to create and allow an OOP based API.
Linux enthusiasts were not amused about great but incompatible hardware like the iPhone 2G. As iTunes was not available for Linux libiphone was born. This became libimobiledevice with the goal to bring freedom and "allow penguins to talk to fruits".
Many command-line utilities come bundled with the library that allow interacting with iOS device services already. This covers retrieving basic device information up to restoring official firmware images.
Devices that have "Wifi Sync" enabled can be accessed wirelessly and do not require a wired USB connection anymore with iOS 11 and later.
Due to being in development since 2007 the library supports the range from the first to the latest iOS device. This is an achievement of many years of research and development.
Being integrated by popular community projects as well as large implementations which interact with more than 10.000+ of devices provide a good reference point for high scalability and efficiency of this solution.
Native Protocols
The library has been architected for easy access to native device features using an object-oriented higher-level API.
This allows interacting with various native device service APIs to manage Apps, Backup, Filesystem, Debugging, Activation, Provisioning, SpringBoard, Syslog, Firmware Updates and much more.
You can also use the bundled command-line utilities for these if you do not actually develop an application.
Get Started...
#include <libimobiledevice/libimobiledevice.h>
/* Unique Device Identifier */
static char *udid = NULL;
/* Device Handle */
idevice_t device = NULL;
/* Try to connect to first USB device */
if (idevice_new_with_options(&device, NULL, IDEVICE_LOOKUP_USBMUX) != IDEVICE_E_SUCCESS) {
printf("ERROR: No device found!\n");
return -1;
}
/* Retrieve the udid of the connected device */
if (idevice_get_udid(device, &udid) != IDEVICE_E_SUCCESS) {
printf("ERROR: Unable to get the device UDID.\n");
idevice_free(device);
return -1;
}
/* Outputs device identifier */
printf("Connected with UDID: %s\n", udid);
/* Cleanup */
idevice_free(device);
free(udid);
......
#include <libimobiledevice/lockdown.h>
#include <plist/plist.h>
/* Lockdown Service Handle */
lockdownd_client_t lockdown = NULL;
/* Handshake with lockdownd */
lockdownd_client_new_with_handshake(device, &lockdown, "myapp");
/* Use the plist format */
plist_t node = NULL;
/* Our result */
char *value = NULL;
/* Retrieve "DeviceColor" setting value from device */
if(lockdownd_get_value(lockdown, NULL, "DeviceColor", &node) != LOCKDOWN_E_SUCCESS) {
lockdownd_client_free(lockdown);
idevice_free(device);
printf("ERROR: Unable to retrieve setting key DeviceColor from device.\n");
return -1;
}
/* Get string value from node */
plist_get_string_val(node, &value);
/* Output device color value */
printf("%s value is: %s\n", "DeviceColor", value);
/* Cleanup */
plist_free(node);
free(value);
lockdownd_client_free(lockdown);
...$ ideviceinfo -k ProductVersion
12.4
$ ideviceinfo -s
BasebandCertId: xxxxxxxxxx
BasebandKeyHashInformation:
AKeyStatus: 2
SKeyHash: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
SKeyStatus: 0
BasebandSerialNumber: xxxxxxxx
BasebandVersion: 7.80.04
BoardId: 4
BuildVersion: 16G77
ChipID: 28672
DeviceClass: iPhone
DeviceColor: #e1e4e3
DeviceName: iPhone 6 Plus
DieID: xxxxxxxxxxxxxxx
HardwareModel: N56AP
HasSiDP: true
PartitionType: GUID_partition_scheme
ProductName: iPhone OS
ProductType: iPhone7,1
ProductVersion: 12.4
ProductionSOC: true
ProtocolVersion: 2
TelephonyCapability: true
UniqueChipID: xxxxxxxxxxxxxxx
UniqueDeviceID: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
WiFiAddress: xx:xx:xx:xx:xx:xx
$ ideviceactivation state
ActivationState: Activated
$ idevicediagnostics restart
Restarting device.Please select a component to view download, release, and dependency information of the latest release.
A cross-platform protocol library to communicate with iOS devices
Download (tar.bz2) LGPL-2.1 LicenseDevelopment release. From now on, releases will be made more frequently.
idevicedevmodectl toolidevicebackup2property_list_client_get_service_client() and service_get_connection() functionsidevicebtlogger toolidevice_events_subscribe/unsubscribe APILIBIMOBILEDEVICE_API to public headersafc_strerror functionlibimobiledevice_version() functionidevice_strerror() to interfaceidevice_get_device_version() to interfaceos_trace_relay service implementationidevicesyslogafc_get_file_info_plist and afc_get_device_info_plist functions
... and several other internal changesMaintenance release.
ListListeners usbmux command handlingclock_gettime() instead of gettimeofday() to avoid timing issues when calculating packet timeoutsFirst official public release!
.shsh filesMaintenance release.
.DS_Store and hidden files when parsing ZIP files-n option to make waiting on install/uninstall notification optional--network and --version options to ideviceactivation toolSIGPIPE signalA client library to multiplex connections from and to iOS devices
Download (tar.bz2) LGPL-2.1 License
select() in case the network fd is higher than the usbmux fdLibrary and utility to talk to iBoot/iBSS via USB on Mac OS X, Windows, and Linux
Download (tar.bz2) LGPL-2.1 License
plist_new_unix_date, plist_get_unix_date_val, plist_set_unix_date_val functions
that work with int64_t values representing a UNIX timestamp instead of
using the 'MAC epoch'.
These new functions should be used instead of plist_new_date,
plist_get_date_val, and plist_set_date_val, which are now marked deprecated
and might be removed in a future version of libplist.plist_sort() on an empty dictionaryconst char*Maintenance release.
libideviceactivation-1.0--network and --version options to ideviceactivation toolSIGPIPE signalA library with common code used by libraries and tools around the libimobiledevice project
Download (tar.bz2) LGPL-2.1 License
extern "C" guards to public headersWSAAddressToStringA (ANSI version)inet_ntop instead of WSAAddressToStringA for >= VistaLibrary handling the communication with Apple's Tatsu Signing Server (TSS)
Download (tar.bz2) LGPL-2.1 License
extern "C" guards to public headersPlease choose your platform of choice below to see instructions on how to get started.
Open a command-line terminal on your machine.
Enter the commands provided below.
$ sudo apt-get install \
build-essential \
checkinstall \
git \
autoconf \
automake \
libtool-bin \
libplist-dev \
libimobiledevice-glue-dev \
libusbmuxd-dev \
libssl-dev \
usbmuxdEnter the commands provided below.
$ ./autogen.sh \
--prefix=/opt/local \
--enable-debug
$ makeEnter the commands provided below.
$ sudo make installOpen a command-line terminal on your machine.
Enter the commands provided below.
$ sudo apt-get install usbmuxd libimobiledevice6 libimobiledevice-utilsOpen a command-line terminal on your machine.
Enter the commands provided below.
$ sudo zypper install libimobiledevice6 usbmuxdThe provided build script will build the entire libimobiledevice stack with the least amount of external dependencies for macOS. Make sure to have Xcode Command Line Tools installed. It will build the latest code of every single libimobiledevice sub-project.
Open a terminal and type the following commands. During the process you will be asked for your user password which has the purpose of allowing the installation of the built libraries and tools to /usr/local/lib and /usr/local/bin via sudo.
$ mkdir -p limd-build
$ cd limd-build
$ curl -Ls -o limd-build-macos.sh https://is.gd/limdmacos
$ bash ./limd-build-macos.shThe script can be reviewed here.
Open a command-line terminal on your machine.
Enter the commands provided below.
$ sudo port install libimobiledeviceOpen a command-line terminal on your machine.
Enter the commands provided below.
$ brew install libimobiledeviceUsing MSYS2 is the official way of compiling this project on Windows. Download the MSYS2 installer and follow the installation steps.
The provided build script will build the entire libimobiledevice stack with the least amount of external dependencies for Windows.
It is recommended to use the MSYS2 MinGW 64-bit shell. Run it and make sure the required dependencies are installed:
pacman -S base-devel \
git \
mingw-w64-x86_64-gcc \
make \
libtool \
autoconf \
automake-wrapperNote that usbmuxd is currently not fully supported on Windows. To use this library you need to have Apple Mobile Device Support package installed (part of iTunes).
In the MSYS2 MinGW shell, type the following commands:
$ mkdir -p limd-build
$ cd limd-build
$ curl -Ls -o limd-build-msys2.sh https://is.gd/limdmsys2
$ bash ./limd-build-msys2.shThe script can be reviewed here.
Open a command-line terminal on your machine.
Enter the commands provided below.
$ sudo apt-get install \
build-essential \
checkinstall \
git \
autoconf \
automake \
libtool-bin \
libplist-dev \
libusbmuxd-dev \
libssl-dev \
usbmuxdEnter the commands provided below.
$ ./autogen.sh \
--prefix=/opt/local \
--enable-debug
$ makeEnter the commands provided below.
$ sudo make installOpen a command-line terminal on your machine.
Enter the commands provided below.
$ sudo apt-get install usbmuxd libimobiledevice6 libimobiledevice-utils
Want features to get implemented faster?
Want to thank us for our countless hours of work?
Want to help us to support newer devices and firmware versions?
... or help us to buy lightning cables that just break so fast?
ifuse 1.2.0 has been released.
libimobiledevice 1.4.0 has been released. Finally a new official release!
libirecovery 1.3.0 has been released.
Our growing community created a wide variety of applications, language bindings, binary builds, integrations and other resources that can be helpful. Below is a collection of links to some of the most popular resources and related people.
We are thrilled that you would like to contribute to this project. Your help is essential for keeping it great.
We'll miss you, Steve.
