diff options
| -rw-r--r-- | docs/Makefile.am | 2 | ||||
| -rw-r--r-- | docs/idevicedebug.1 | 34 | ||||
| -rw-r--r-- | tools/Makefile.am | 7 | ||||
| -rw-r--r-- | tools/idevicedebug.c | 518 |
4 files changed, 559 insertions, 2 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 826105a..e9fc21c 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 idevicebackup2.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 ideviceprovision.1 idevicedebugserverproxy.1 idevicediagnostics.1 idevicecrashreport.1 idevicename.1 +man_MANS = idevice_id.1 ideviceinfo.1 idevicesyslog.1 idevicebackup.1 idevicebackup2.1 ideviceimagemounter.1 idevicescreenshot.1 idevicepair.1 ideviceenterrecovery.1 idevicedate.1 ideviceprovision.1 idevicedebugserverproxy.1 idevicediagnostics.1 idevicecrashreport.1 idevicename.1 idevicedebug.1 EXTRA_DIST = $(man_MANS) diff --git a/docs/idevicedebug.1 b/docs/idevicedebug.1 new file mode 100644 index 0000000..aa9890a --- /dev/null +++ b/docs/idevicedebug.1 @@ -0,0 +1,34 @@ +.TH "idevicedebug" 1 +.SH NAME +idevicedebug \- Interact with the debugserver service of a device. +.SH SYNOPSIS +.B idevicedebug +[OPTIONS] COMMAND + +.SH DESCRIPTION + +Interact with the debug service of a device. Currently the only implemented +command is "run" and allows execution of developer apps and watch the +stdout/stderr of the process. + +.SH OPTIONS +.TP +.B \-e, \-\-env NAME=VALUE +set environment variable NAME to VALUE. +.TP +.B \-u, \-\-udid UDID +target specific device by its 40-digit device UDID. +.TP +.B \-d, \-\-debug +enable communication debugging. +.TP +.B \-h, \-\-help +prints usage information. + +.SH COMMANDS +.TP +.B run BUNDLEID [ARGS...] +run app with BUNDLEID and optional ARGS on device. + +.SH AUTHORS +Martin Szulecki diff --git a/tools/Makefile.am b/tools/Makefile.am index 5b743f8..8cda9f5 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -3,7 +3,7 @@ AM_CPPFLAGS = -I$(top_srcdir)/include -I$(top_srcdir) AM_CFLAGS = $(GLOBAL_CFLAGS) $(libgnutls_CFLAGS) $(libtasn1_CFLAGS) $(libgcrypt_CFLAGS) $(openssl_CFLAGS) $(libplist_CFLAGS) $(LFS_CFLAGS) AM_LDFLAGS = $(libgnutls_LIBS) $(libtasn1_LIBS) $(libgcrypt_LIBS) $(openssl_LIBS) $(libplist_LIBS) -bin_PROGRAMS = idevice_id ideviceinfo idevicename idevicepair idevicesyslog ideviceimagemounter idevicescreenshot ideviceenterrecovery idevicedate idevicebackup idevicebackup2 ideviceprovision idevicedebugserverproxy idevicediagnostics +bin_PROGRAMS = idevice_id ideviceinfo idevicename idevicepair idevicesyslog ideviceimagemounter idevicescreenshot ideviceenterrecovery idevicedate idevicebackup idevicebackup2 ideviceprovision idevicedebugserverproxy idevicediagnostics idevicedebug ideviceinfo_SOURCES = ideviceinfo.c ideviceinfo_CFLAGS = $(AM_CFLAGS) @@ -75,6 +75,11 @@ idevicediagnostics_CFLAGS = $(AM_CFLAGS) idevicediagnostics_LDFLAGS = $(AM_LDFLAGS) idevicediagnostics_LDADD = $(top_builddir)/src/libimobiledevice.la +idevicedebug_SOURCES = idevicedebug.c +idevicedebug_CFLAGS = $(AM_CFLAGS) +idevicedebug_LDFLAGS = $(top_builddir)/common/libinternalcommon.la $(AM_LDFLAGS) +idevicedebug_LDADD = $(top_builddir)/src/libimobiledevice.la + if !WIN32 bin_PROGRAMS += idevicecrashreport idevicecrashreport_SOURCES = idevicecrashreport.c diff --git a/tools/idevicedebug.c b/tools/idevicedebug.c new file mode 100644 index 0000000..784503a --- /dev/null +++ b/tools/idevicedebug.c @@ -0,0 +1,518 @@ +/* + * idevicedebug.c + * Interact with the debugserver service of a device. + * + * Copyright (c) 2014 Martin Szulecki All Rights Reserved. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include <signal.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <time.h> +#include <unistd.h> +#include <libgen.h> + +#include <libimobiledevice/installation_proxy.h> +#include <libimobiledevice/libimobiledevice.h> +#include <libimobiledevice/debugserver.h> +#include <plist/plist.h> +#include "common/debug.h" + +enum cmd_mode { + CMD_NONE = 0, + CMD_RUN +}; + +static int quit_flag = 0; + +static void on_signal(int sig) +{ + fprintf(stderr, "Exiting...\n"); + quit_flag++; +} + +static instproxy_error_t instproxy_client_get_object_by_key_from_info_directionary_for_bundle_identifier(instproxy_client_t client, const char* appid, const char* key, plist_t* node) +{ + if (!client || !appid || !key) + return INSTPROXY_E_INVALID_ARG; + + plist_t apps = NULL; + + // create client options for any application types + plist_t client_opts = instproxy_client_options_new(); + instproxy_client_options_add(client_opts, "ApplicationType", "Any", NULL); + + // only return attributes we need + plist_t return_attributes = plist_new_array(); + plist_array_append_item(return_attributes, plist_new_string("CFBundleIdentifier")); + plist_array_append_item(return_attributes, plist_new_string("CFBundleExecutable")); + plist_array_append_item(return_attributes, plist_new_string(key)); + instproxy_client_options_add(client_opts, "ReturnAttributes", return_attributes, NULL); + plist_free(return_attributes); + return_attributes = NULL; + + // query device for list of apps + instproxy_error_t ierr = instproxy_browse(client, client_opts, &apps); + instproxy_client_options_free(client_opts); + if (ierr != INSTPROXY_E_SUCCESS) { + return ierr; + } + + plist_t app_found = NULL; + uint32_t i; + for (i = 0; i < plist_array_get_size(apps); i++) { + char *appid_str = NULL; + plist_t app_info = plist_array_get_item(apps, i); + plist_t idp = plist_dict_get_item(app_info, "CFBundleIdentifier"); + if (idp) { + plist_get_string_val(idp, &appid_str); + } + if (appid_str && strcmp(appid, appid_str) == 0) { + app_found = app_info; + } + free(appid_str); + if (app_found) { + break; + } + } + + if (!app_found) { + if (apps) + plist_free(apps); + *node = NULL; + return INSTPROXY_E_OP_FAILED; + } + + plist_t object = plist_dict_get_item(app_found, key); + if (object) { + *node = plist_copy(object); + } else { + debug_info("key %s not found", key); + return INSTPROXY_E_OP_FAILED; + } + + plist_free(apps); + + return INSTPROXY_E_SUCCESS; +} + +static debugserver_error_t debugserver_client_handle_response(debugserver_client_t client, char** response, int send_reply) +{ + debugserver_error_t dres = DEBUGSERVER_E_SUCCESS; + debugserver_command_t command = NULL; + char* o = NULL; + char* r = *response; + + if (r[0] == 'O') { + /* stdout/stderr */ + debugserver_decode_string(r + 1, strlen(r) - 1, &o); + printf("%s", o); + fflush(stdout); + if (o != NULL) { + free(o); + o = NULL; + } + + free(*response); + *response = NULL; + + if (!send_reply) + return dres; + + /* send reply */ + debugserver_command_new("OK", 0, NULL, &command); + dres = debugserver_client_send_command(client, command, response); + debug_info("result: %d", dres); + debugserver_command_free(command); + command = NULL; + } else if (r[0] == 'T') { + /* thread stopped information */ + debug_info("Thread stopped. Details:\n%s", r + 1); + + free(*response); + *response = NULL; + + if (!send_reply) + return dres; + + dres = DEBUGSERVER_E_UNKNOWN_ERROR; + } else if (r[0] == 'E' || r[0] == 'W') { + printf("%s: %s\n", (r[0] == 'E' ? "ERROR": "WARNING") , r + 1); + + free(*response); + *response = NULL; + + if (!send_reply) + return dres; + + /* send reply */ + debugserver_command_new("OK", 0, NULL, &command); + dres = debugserver_client_send_command(client, command, response); + debug_info("result: %d", dres); + debugserver_command_free(command); + command = NULL; + } else if (r && strlen(r) == 0) { + if (!send_reply) + return dres; + + free(*response); + *response = NULL; + + /* no command */ + debugserver_command_new("OK", 0, NULL, &command); + dres = debugserver_client_send_command(client, command, response); + debug_info("result: %d", dres); + debugserver_command_free(command); + command = NULL; + } else { + debug_info("ERROR: unhandled response", r); + } + + return dres; +} + +static void print_usage(int argc, char **argv) +{ + char *name = NULL; + name = strrchr(argv[0], '/'); + printf("Usage: %s [OPTIONS] COMMAND\n", (name ? name + 1: argv[0])); + printf("Interact with the debugserver service of a device.\n\n"); + printf(" Where COMMAND is one of:\n"); + printf(" run BUNDLEID [ARGS...]\trun app with BUNDLEID and optional ARGS on device.\n"); + printf("\n"); + printf(" The following OPTIONS are accepted:\n"); + printf(" -e, --env NAME=VALUE\tset environment variable NAME to VALUE\n"); + printf(" -u, --udid UDID\ttarget specific device by its 40-digit device UDID\n"); + printf(" -d, --debug\t\tenable communication debugging\n"); + printf(" -h, --help\t\tprints usage information\n"); + printf("\n"); +} + +int main(int argc, char *argv[]) +{ + int res = -1; + idevice_t device = NULL; + idevice_error_t ret = IDEVICE_E_UNKNOWN_ERROR; + instproxy_client_t instproxy_client = NULL; + debugserver_client_t debugserver_client = NULL; + int i; + int debug_level = 0; + int cmd = CMD_NONE; + const char* udid = NULL; + const char* bundle_identifier = NULL; + char* path = NULL; + char* working_directory = NULL; + char **newlist = NULL; + char** environment = NULL; + int environment_count = 0; + char* response = NULL; + debugserver_command_t command = NULL; + debugserver_error_t dres = DEBUGSERVER_E_UNKNOWN_ERROR; + + /* map signals */ + signal(SIGINT, on_signal); + signal(SIGTERM, on_signal); +#ifndef WIN32 + signal(SIGQUIT, on_signal); + signal(SIGPIPE, SIG_IGN); +#endif + + /* parse command line arguments */ + for (i = 1; i < argc; i++) { + if (!strcmp(argv[i], "-d") || !strcmp(argv[i], "--debug")) { + debug_level++; + idevice_set_debug_level(debug_level); + continue; + } else if (!strcmp(argv[i], "-u") || !strcmp(argv[i], "--udid")) { + i++; + if (!argv[i] || (strlen(argv[i]) != 40)) { + print_usage(argc, argv); + res = 0; + goto cleanup; + } + udid = argv[i]; + continue; + } else if (!strcmp(argv[i], "-e") || !strcmp(argv[i], "--env")) { + i++; + if (!argv[i] || (strlen(argv[i]) <= 1) || strchr(argv[i], '=') == NULL) { + print_usage(argc, argv); + res = 0; + goto cleanup; + } + /* add environment variable */ + if (!newlist) + newlist = malloc((environment_count + 1) * sizeof(char*)); + else + newlist = realloc(environment, (environment_count + 1) * sizeof(char*)); + newlist[environment_count++] = strdup(argv[i]); + environment = newlist; + continue; + } else if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) { + print_usage(argc, argv); + res = 0; + goto cleanup; + } else if (!strcmp(argv[i], "run")) { + cmd = CMD_RUN; + + i++; + if (!argv[i]) { + /* make sure at least the bundle identifier was provided */ + printf("Please supply the bundle identifier of the app to run.\n"); + print_usage(argc, argv); + res = 0; + goto cleanup; + } + /* read bundle identifier */ + bundle_identifier = argv[i]; + break; + } else { + print_usage(argc, argv); + res = 0; + goto cleanup; + } + } + + if (environment) { + newlist = realloc(environment, (environment_count + 1) * sizeof(char*)); + newlist[environment_count] = NULL; + environment = newlist; + } + + /* verify options */ + if (cmd == CMD_NONE) { + print_usage(argc, argv); + goto cleanup; + } + + /* connect to the device */ + ret = idevice_new(&device, udid); + if (ret != IDEVICE_E_SUCCESS) { + if (udid) { + printf("No device found with udid %s, is it plugged in?\n", udid); + } else { + printf("No device found, is it plugged in?\n"); + } + goto cleanup; + } + + switch (cmd) { + case CMD_RUN: + default: + /* get the path to the app and it's working directory */ + if (instproxy_client_start_service(device, &instproxy_client, "idevicerun") != INSTPROXY_E_SUCCESS) { + fprintf(stderr, "Could not start installation proxy service.\n"); + goto cleanup; + } + plist_t container = NULL; + instproxy_client_get_object_by_key_from_info_directionary_for_bundle_identifier(instproxy_client, bundle_identifier, "Container", &container); + instproxy_client_get_path_for_bundle_identifier(instproxy_client, bundle_identifier, &path); + instproxy_client_free(instproxy_client); + instproxy_client = NULL; + if (container && plist_get_node_type(container) == PLIST_STRING) { + plist_get_string_val(container, &working_directory); + debug_info("working_directory: %s\n", working_directory); + } else { + fprintf(stderr, "Could not determine container path for bundle identifier %s.\n", bundle_identifier); + goto cleanup; + } + + /* start and connect to debugserver */ + if (debugserver_client_start_service(device, &debugserver_client, "idevicerun") != LOCKDOWN_E_SUCCESS) { + fprintf(stderr, + "Could not start com.apple.debugserver!\n" + "Please make sure to mount the developer disk image first:\n" + " 1) Get the iOS version from `ideviceinfo -k ProductVersion`.\n" + " 2) Find the matching iPhoneOS DeveloperDiskImage.dmg files.\n" + " 3) Run `ideviceimagemounter` with the above path.\n"); + goto cleanup; + } + + /* enable logging for the session in debug mode */ + if (debug_level) { + debug_info("Setting logging bitmask..."); + debugserver_command_new("QSetLogging:bitmask=LOG_ALL|LOG_RNB_REMOTE|LOG_RNB_PACKETS", 0, NULL, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + } + + /* set maximum packet size */ + debug_info("Setting maximum packet size..."); + const char* packet_size[2] = {"1024", NULL}; + debugserver_command_new("QSetMaxPacketSize:", 1, packet_size, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + + /* set working directory */ + debug_info("Setting working directory..."); + const char* working_dir[2] = {working_directory, NULL}; + debugserver_command_new("QSetWorkingDir:", 1, working_dir, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + + /* set environment */ + if (environment) { + debug_info("Setting environment..."); + int environment_index = 0; + for (environment_index = 0; environment_index < environment_count; environment_index++) { + debug_info("setting environment variable: %s", environment[environment_index]); + debugserver_client_set_environment_hex_encoded(debugserver_client, environment[environment_index], NULL); + environment_index++; + } + } + + /* set arguments and run app */ + debug_info("Setting argv..."); + int app_argc = (argc - i + 2); + debug_info("app_argc: %d", app_argc); + char **app_argv = (char**)malloc(sizeof(char*) * app_argc); + app_argv[0] = path; + debug_info("app_argv[%d] = %s", 0, app_argv[0]); + app_argc = 1; + while (i < argc && argv && argv[i]) { + debug_info("app_argv[%d] = argv[%d]: %s", app_argc, i, argv[i]); + app_argv[app_argc++] = argv[i]; + i++; + } + app_argv[app_argc] = NULL; + debugserver_client_set_argv(debugserver_client, app_argc, app_argv, NULL); + free(app_argv); + + /* check if launch succeeded */ + debug_info("Checking if launch succeeded..."); + debugserver_command_new("qLaunchSuccess", 0, NULL, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + + /* set thread */ + debug_info("Setting thread..."); + debugserver_command_new("Hc0", 0, NULL, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + + /* continue running process */ + debug_info("Continue running process..."); + debugserver_command_new("c", 0, NULL, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + + /* main loop which is parsing/handling packets during the run */ + debug_info("Entering run loop..."); + while (!quit_flag) { + if (dres != DEBUGSERVER_E_SUCCESS) { + debug_info("failed to receive response"); + break; + } + + if (response) { + debug_info("response: %s", response); + dres = debugserver_client_handle_response(debugserver_client, &response, 1); + } + + sleep(1); + } + + /* kill process after we finished */ + debug_info("Killing process..."); + debugserver_command_new("k", 0, NULL, &command); + dres = debugserver_client_send_command(debugserver_client, command, &response); + debugserver_command_free(command); + command = NULL; + if (response) { + if (strncmp(response, "OK", 2)) { + debugserver_client_handle_response(debugserver_client, &response, 0); + goto cleanup; + } + free(response); + response = NULL; + } + + res = (dres == DEBUGSERVER_E_SUCCESS) ? 0: -1; + break; + } + +cleanup: + /* cleanup the house */ + if (environment) { + int environment_index = 0; + for (environment_index = 0; environment_index < environment_count; environment_index++) { + free(environment[environment_index]); + environment_index++; + } + free(environment); + } + + if (path) + free(path); + + if (response) + free(response); + + if (debugserver_client) + debugserver_client_free(debugserver_client); + + if (device) + idevice_free(device); + + return res; +} |