heartbeat: Implement basic "network heartbeat" service protocol

5 files changed, 333 insertions, 0 deletions

diff --git a/include/Makefile.am b/include/Makefile.am
index c69ad04..a697453 100644
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -16,4 +16,5 @@ nobase_include_HEADERS = libimobiledevice/libimobiledevice.h \
 			 libimobiledevice/misagent.h \
 			 libimobiledevice/restore.h\
 			 libimobiledevice/webinspector.h\
+			 libimobiledevice/heartbeat.h\
 			 libimobiledevice/diagnostics_relay.h
diff --git a/include/libimobiledevice/heartbeat.h b/include/libimobiledevice/heartbeat.h
new file mode 100644
index 0000000..e5adb0d
--- /dev/null
+++ b/include/libimobiledevice/heartbeat.h
@@ -0,0 +1,64 @@
+/**
+ * @file libimobiledevice/heartbeat.h
+ * @brief Send "heartbeat" to device to allow service connections over network.
+ * \internal
+ *
+ * Copyright (c) 2013 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
+ */
+
+#ifndef IHEARTBEAT_H
+#define IHEARTBEAT_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <libimobiledevice/libimobiledevice.h>
+#include <libimobiledevice/lockdown.h>
+
+#define HEARTBEAT_SERVICE_NAME "com.apple.mobile.heartbeat"
+
+/** @name Error Codes */
+/*@{*/
+#define HEARTBEAT_E_SUCCESS                0
+#define HEARTBEAT_E_INVALID_ARG           -1
+#define HEARTBEAT_E_PLIST_ERROR           -2
+#define HEARTBEAT_E_MUX_ERROR             -3
+#define HEARTBEAT_E_SSL_ERROR             -4
+#define HEARTBEAT_E_UNKNOWN_ERROR       -256
+/*@}*/
+
+/** Represents an error code. */
+typedef int16_t heartbeat_error_t;
+
+typedef struct heartbeat_client_private heartbeat_client_private;
+typedef heartbeat_client_private *heartbeat_client_t; /**< The client handle. */
+
+heartbeat_error_t heartbeat_client_new(idevice_t device, lockdownd_service_descriptor_t service, heartbeat_client_t * client);
+heartbeat_error_t heartbeat_client_free(heartbeat_client_t client);
+
+heartbeat_error_t heartbeat_start_service(idevice_t device, heartbeat_client_t * client);
+
+heartbeat_error_t heartbeat_send(heartbeat_client_t client, plist_t plist);
+heartbeat_error_t heartbeat_receive(heartbeat_client_t client, plist_t * plist);
+heartbeat_error_t heartbeat_receive_with_timeout(heartbeat_client_t client, plist_t * plist, uint32_t timeout_ms);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/src/Makefile.am b/src/Makefile.am
index 4b1c56c..136baf4 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -26,6 +26,7 @@ libimobiledevice_la_SOURCES = idevice.c idevice.h \
 		       misagent.c misagent.h\
 		       restore.c restore.h\
 		       diagnostics_relay.c diagnostics_relay.h\
+		       heartbeat.c heartbeat.h\
 		       webinspector.c webinspector.h
 
 if WIN32
diff --git a/src/heartbeat.c b/src/heartbeat.c
new file mode 100644
index 0000000..c97c178
--- /dev/null
+++ b/src/heartbeat.c
@@ -0,0 +1,235 @@
+/*
+ * heartbeat.c 
+ * com.apple.mobile.heartbeat service implementation.
+ * 
+ * Copyright (c) 2013 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 
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+#include <string.h>
+#include <stdlib.h>
+#include <plist/plist.h>
+
+#include "heartbeat.h"
+#include "lockdown.h"
+#include "debug.h"
+
+/**
+ * Convert a property_list_service_error_t value to a heartbeat_error_t value.
+ * Used internally to get correct error codes.
+ *
+ * @param err An property_list_service_error_t error code
+ *
+ * @return A matching heartbeat_error_t error code,
+ *     HEARTBEAT_E_UNKNOWN_ERROR otherwise.
+ */
+static heartbeat_error_t heartbeat_error(property_list_service_error_t err)
+{
+	switch (err) {
+		case PROPERTY_LIST_SERVICE_E_SUCCESS:
+			return HEARTBEAT_E_SUCCESS;
+		case PROPERTY_LIST_SERVICE_E_INVALID_ARG:
+			return HEARTBEAT_E_INVALID_ARG;
+		case PROPERTY_LIST_SERVICE_E_PLIST_ERROR:
+			return HEARTBEAT_E_PLIST_ERROR;
+		case PROPERTY_LIST_SERVICE_E_MUX_ERROR:
+			return HEARTBEAT_E_MUX_ERROR;
+		case PROPERTY_LIST_SERVICE_E_SSL_ERROR:
+			return HEARTBEAT_E_SSL_ERROR;
+		default:
+			break;
+	}
+	return HEARTBEAT_E_UNKNOWN_ERROR;
+}
+
+/**
+ * Connects to the heartbeat service on the specified device.
+ *
+ * @param device The device to connect to.
+ * @param service The service descriptor returned by lockdownd_start_service.
+ * @param client Pointer that will point to a newly allocated
+ *     heartbeat_client_t upon successful return. Must be freed using
+ *     heartbeat_client_free() after use.
+ *
+ * @return HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when
+ *     client is NULL, or an HEARTBEAT_E_* error code otherwise.
+ */
+heartbeat_error_t heartbeat_client_new(idevice_t device, lockdownd_service_descriptor_t service, heartbeat_client_t * client)
+{
+	*client = NULL;
+
+	debug_info("Creating heartbeat_client, port = %d.", service->port);
+
+	if (!device || service->port == 0 || !client || *client) {
+		debug_info("Incorrect parameter passed to heartbeat_client_new.");
+		return HEARTBEAT_E_INVALID_ARG;
+	}
+
+	property_list_service_client_t plclient = NULL;
+	heartbeat_error_t ret = heartbeat_error(property_list_service_client_new(device, service, &plclient));
+	if (ret != HEARTBEAT_E_SUCCESS) {
+		debug_info("Creating a property list client failed. Error: %i", ret);
+		return ret;
+	}
+
+	heartbeat_client_t client_loc = (heartbeat_client_t) malloc(sizeof(struct heartbeat_client_private));
+	client_loc->parent = plclient;
+
+	*client = client_loc;
+
+	debug_info("heartbeat_client successfully created.");
+	return 0;
+}
+
+/**
+ * Starts a new heartbeat service on the specified device and connects to it.
+ *
+ * @param device The device to connect to.
+ * @param client Pointer that will point to a newly allocated
+ *     heartbeat_client_t upon successful return. Must be freed using
+ *     heartbeat_client_free() after use.
+ *
+ * @return HEARTBEAT_E_SUCCESS on success, or an HEARTBEAT_E_* error
+ *     code otherwise.
+ */
+heartbeat_error_t heartbeat_start_service(idevice_t device, heartbeat_client_t * client)
+{
+	*client = NULL;
+
+	lockdownd_client_t lckd = NULL;
+	if (LOCKDOWN_E_SUCCESS != lockdownd_client_new_with_handshake(device, &lckd, NULL)) {
+		idevice_free(device);
+		debug_info("Could not create a lockdown client.");
+		return HEARTBEAT_E_UNKNOWN_ERROR;
+	}
+
+	lockdownd_service_descriptor_t service = NULL;
+	lockdownd_start_service(lckd, HEARTBEAT_SERVICE_NAME, &service);
+	lockdownd_client_free(lckd);
+
+	if (service->port <= 0) {
+		debug_info("Could not start heartbeat service!");
+		return HEARTBEAT_E_UNKNOWN_ERROR;
+	}
+
+	heartbeat_error_t res = heartbeat_client_new(device, service, client);
+	if (res != HEARTBEAT_E_SUCCESS) {
+		debug_info("Could not connect to heartbeat! Port: %i, error: %i", service->port, res);
+		return res;
+	}
+
+	if (service) {
+		lockdownd_service_descriptor_free(service);
+		service = NULL;
+	}
+
+	return HEARTBEAT_E_SUCCESS;
+}
+
+/**
+ * Disconnects a heartbeat client from the device and frees up the
+ * heartbeat client data.
+ *
+ * @param client The heartbeat client to disconnect and free.
+ *
+ * @return HEARTBEAT_E_SUCCESS on success, HEARTBEAT_E_INVALID_ARG when
+ *     client is NULL, or an HEARTBEAT_E_* error code otherwise.
+ */
+heartbeat_error_t heartbeat_client_free(heartbeat_client_t client)
+{
+	if (!client)
+		return HEARTBEAT_E_INVALID_ARG;
+
+	heartbeat_error_t err = heartbeat_error(property_list_service_client_free(client->parent));
+	free(client);
+
+	return err;
+}
+
+/**
+ * Sends a plist to the service.
+ *
+ * @param client The heartbeat client
+ * @param plist The plist to send
+ *
+ * @return DIAGNOSTICS_RELAY_E_SUCCESS on success,
+ *  DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL
+ */
+heartbeat_error_t heartbeat_send(heartbeat_client_t client, plist_t plist)
+{
+	heartbeat_error_t res = HEARTBEAT_E_UNKNOWN_ERROR;
+
+	res = heartbeat_error(property_list_service_send_binary_plist(client->parent, plist));
+	if (res != HEARTBEAT_E_SUCCESS) {
+		debug_info("Sending plist failed with error %d", res);
+		return res;
+	}
+
+	debug_plist(plist);
+
+	return res;
+}
+
+/**
+ * Receives a plist from the service.
+ *
+ * @param client The heartbeat client
+ * @param plist The plist to store the received data
+ *
+ * @return DIAGNOSTICS_RELAY_E_SUCCESS on success,
+ *  DIAGNOSTICS_RELAY_E_INVALID_ARG when client or plist is NULL
+ */
+heartbeat_error_t heartbeat_receive(heartbeat_client_t client, plist_t * plist)
+{
+	return heartbeat_receive_with_timeout(client, plist, 1000);
+}
+
+/**
+ * Receives a plist using the given heartbeat client.
+ *
+ * @param client The heartbeat client to use for receiving
+ * @param plist pointer to a plist_t that will point to the received plist
+ *      upon successful return
+ * @param timeout Maximum time in milliseconds to wait for data.
+ *
+ * @return HEARTBEAT_E_SUCCESS on success,
+ *      HEARTBEAT_E_INVALID_ARG when client or *plist is NULL,
+ *      HEARTBEAT_E_PLIST_ERROR when the received data cannot be
+ *      converted to a plist, HEARTBEAT_E_MUX_ERROR when a
+ *      communication error occurs, or HEARTBEAT_E_UNKNOWN_ERROR
+ *      when an unspecified error occurs.
+ */
+heartbeat_error_t heartbeat_receive_with_timeout(heartbeat_client_t client, plist_t * plist, uint32_t timeout_ms)
+{
+	heartbeat_error_t res = HEARTBEAT_E_UNKNOWN_ERROR;
+	plist_t outplist = NULL;
+
+	res = heartbeat_error(property_list_service_receive_plist_with_timeout(client->parent, &outplist, timeout_ms));
+	if (res != HEARTBEAT_E_SUCCESS || !outplist) {
+		debug_info("Could not receive plist, error %d", res);
+		plist_free(outplist);
+		return HEARTBEAT_E_MUX_ERROR;
+	}
+
+	*plist = outplist;
+
+	debug_plist(*plist);
+
+	return res;
+}
diff --git a/src/heartbeat.h b/src/heartbeat.h
new file mode 100644
index 0000000..f2e9aa3
--- /dev/null
+++ b/src/heartbeat.h
@@ -0,0 +1,32 @@
+/*
+ * heartbeat.h
+ * com.apple.mobile.heartbeat service header file.
+ * 
+ * Copyright (c) 2013 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 
+ */
+
+#ifndef HEARTBEAT_H
+#define HEARTBEAT_H
+
+#include "libimobiledevice/heartbeat.h"
+#include "property_list_service.h"
+
+struct heartbeat_client_private {
+	property_list_service_client_t parent;
+};
+
+#endif