diff options
Diffstat (limited to 'src/property_list_service.c')
| -rw-r--r-- | src/property_list_service.c | 346 |
1 files changed, 346 insertions, 0 deletions
diff --git a/src/property_list_service.c b/src/property_list_service.c new file mode 100644 index 0000000..852ed9c --- /dev/null +++ b/src/property_list_service.c @@ -0,0 +1,346 @@ +/* + * property_list_service.c + * PropertyList service implementation. + * + * Copyright (c) 2010 Nikias Bassen. 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 <stdlib.h> +#include <string.h> +#include <errno.h> +#include <arpa/inet.h> + +#include "property_list_service.h" +#include "iphone.h" +#include "debug.h" + +/** + * Convert an iphone_error_t value to an property_list_service_error_t value. + * Used internally to get correct error codes. + * + * @param err An iphone_error_t error code + * + * @return A matching property_list_service_error_t error code, + * PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR otherwise. + */ +static property_list_service_error_t iphone_to_property_list_service_error(iphone_error_t err) +{ + switch (err) { + case IPHONE_E_SUCCESS: + return PROPERTY_LIST_SERVICE_E_SUCCESS; + case IPHONE_E_INVALID_ARG: + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + case IPHONE_E_SSL_ERROR: + return PROPERTY_LIST_SERVICE_E_SSL_ERROR; + default: + break; + } + return PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR; +} + +/** + * Creates a new property list service for the specified port. + * + * @param device The device to connect to. + * @param port The port on the device to connect to, usually opened by a call to + * lockdownd_start_service. + * @param client Pointer that will be set to a newly allocated + * property_list_service_client_t upon successful return. + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when one of the arguments is invalid, + * or PROPERTY_LIST_SERVICE_E_MUX_ERROR when connecting to the device failed. + */ +property_list_service_error_t property_list_service_client_new(iphone_device_t device, uint16_t port, property_list_service_client_t *client) +{ + if (!device || port == 0 || !client || *client) + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + + /* Attempt connection */ + iphone_connection_t connection = NULL; + if (iphone_device_connect(device, port, &connection) != IPHONE_E_SUCCESS) { + return PROPERTY_LIST_SERVICE_E_MUX_ERROR; + } + + /* create client object */ + property_list_service_client_t client_loc = (property_list_service_client_t)malloc(sizeof(struct property_list_service_client_int)); + client_loc->connection = connection; + + *client = client_loc; + + return PROPERTY_LIST_SERVICE_E_SUCCESS; +} + +/** + * Frees a PropertyList service. + * + * @param client The property list service to free. + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when client is invalid, or a + * PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when another error occured. + */ +property_list_service_error_t property_list_service_client_free(property_list_service_client_t client) +{ + if (!client) + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + + property_list_service_error_t err = iphone_to_property_list_service_error(iphone_device_disconnect(client->connection)); + free(client); + return err; +} + +/** + * Sends a plist using the given property list service client. + * Internally used generic plist send function. + * + * @param client The property list service client to use for sending. + * @param plist plist to send + * @param binary 1 = send binary plist, 0 = send xml plist + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when one or more parameters are + * invalid, PROPERTY_LIST_SERVICE_E_PLIST_ERROR when dict is not a valid + * plist, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified + * error occurs. + */ +static property_list_service_error_t internal_plist_send(property_list_service_client_t client, plist_t plist, int binary) +{ + property_list_service_error_t res = PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR; + char *content = NULL; + uint32_t length = 0; + uint32_t nlen = 0; + int bytes = 0; + + if (!client || (client && !client->connection) || !plist) { + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + } + + if (binary) { + plist_to_bin(plist, &content, &length); + } else { + plist_to_xml(plist, &content, &length); + } + + if (!content || length == 0) { + return PROPERTY_LIST_SERVICE_E_PLIST_ERROR; + } + + nlen = htonl(length); + debug_info("sending %d bytes", length); + iphone_device_send(client->connection, (const char*)&nlen, sizeof(nlen), (uint32_t*)&bytes); + if (bytes == sizeof(nlen)) { + iphone_device_send(client->connection, content, length, (uint32_t*)&bytes); + if (bytes > 0) { + debug_info("sent %d bytes", bytes); + debug_plist(plist); + if ((uint32_t)bytes == length) { + res = PROPERTY_LIST_SERVICE_E_SUCCESS; + } else { + debug_info("ERROR: Could not send all data (%d of %d)!", bytes, length); + } + } + } + if (bytes <= 0) { + debug_info("ERROR: sending to device failed."); + } + + free(content); + + return res; +} + +/** + * Sends an XML plist. + * + * @param client The property list service client to use for sending. + * @param plist plist to send + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or plist is NULL, + * PROPERTY_LIST_SERVICE_E_PLIST_ERROR when dict is not a valid plist, + * or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs. + */ +property_list_service_error_t property_list_service_send_xml_plist(property_list_service_client_t client, plist_t plist) +{ + return internal_plist_send(client, plist, 0); +} + +/** + * Sends a binary plist. + * + * @param client The property list service client to use for sending. + * @param plist plist to send + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or plist is NULL, + * PROPERTY_LIST_SERVICE_E_PLIST_ERROR when dict is not a valid plist, + * or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when an unspecified error occurs. + */ +property_list_service_error_t property_list_service_send_binary_plist(property_list_service_client_t client, plist_t plist) +{ + return internal_plist_send(client, plist, 1); +} + +/** + * Receives a plist using the given property list service client. + * Internally used generic plist receive function. + * + * @param client The property list service 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 PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or *plist is NULL, + * PROPERTY_LIST_SERVICE_E_PLIST_ERROR when the received data cannot be + * converted to a plist, PROPERTY_LIST_SERVICE_E_MUX_ERROR when a + * communication error occurs, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR + * when an unspecified error occurs. + */ +static property_list_service_error_t internal_plist_recv_timeout(property_list_service_client_t client, plist_t *plist, unsigned int timeout) +{ + property_list_service_error_t res = PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR; + uint32_t pktlen = 0; + uint32_t bytes = 0; + + if (!client || (client && !client->connection) || !plist) { + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + } + + iphone_device_recv_timeout(client->connection, (char*)&pktlen, sizeof(pktlen), &bytes, timeout); + debug_info("initial read=%i", bytes); + if (bytes < 4) { + debug_info("initial read failed!"); + return PROPERTY_LIST_SERVICE_E_MUX_ERROR; + } else { + if ((char)pktlen == 0) { /* prevent huge buffers */ + uint32_t curlen = 0; + char *content = NULL; + pktlen = ntohl(pktlen); + debug_info("%d bytes following", pktlen); + content = (char*)malloc(pktlen); + + while (curlen < pktlen) { + iphone_device_recv(client->connection, content+curlen, pktlen-curlen, &bytes); + if (bytes <= 0) { + res = PROPERTY_LIST_SERVICE_E_MUX_ERROR; + break; + } + debug_info("received %d bytes", bytes); + curlen += bytes; + } + if (!memcmp(content, "bplist00", 8)) { + plist_from_bin(content, pktlen, plist); + } else { + plist_from_xml(content, pktlen, plist); + } + if (*plist) { + debug_plist(*plist); + res = PROPERTY_LIST_SERVICE_E_SUCCESS; + } else { + res = PROPERTY_LIST_SERVICE_E_PLIST_ERROR; + } + free(content); + content = NULL; + } else { + res = PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR; + } + } + return res; +} + +/** + * Receives a plist using the given property list service client with specified + * timeout. + * Binary or XML plists are automatically handled. + * + * @param client The property list service 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 PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when connection or *plist is NULL, + * PROPERTY_LIST_SERVICE_E_PLIST_ERROR when the received data cannot be + * converted to a plist, PROPERTY_LIST_SERVICE_E_MUX_ERROR when a + * communication error occurs, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when + * an unspecified error occurs. + */ +property_list_service_error_t property_list_service_receive_plist_with_timeout(property_list_service_client_t client, plist_t *plist, unsigned int timeout) +{ + return internal_plist_recv_timeout(client, plist, timeout); +} + +/** + * Receives a plist using the given property list service client. + * Binary or XML plists are automatically handled. + * + * This function is like property_list_service_receive_plist_with_timeout + * using a timeout of 10 seconds. + * @see property_list_service_receive_plist_with_timeout + * + * @param client The property list service client to use for receiving + * @param plist pointer to a plist_t that will point to the received plist + * upon successful return + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG when client or *plist is NULL, + * PROPERTY_LIST_SERVICE_E_PLIST_ERROR when the received data cannot be + * converted to a plist, PROPERTY_LIST_SERVICE_E_MUX_ERROR when a + * communication error occurs, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR when + * an unspecified error occurs. + */ +property_list_service_error_t property_list_service_receive_plist(property_list_service_client_t client, plist_t *plist) +{ + return internal_plist_recv_timeout(client, plist, 10000); +} + +/** + * Enable SSL for the given property list service client. + * + * @param client The connected property list service client for which SSL + * should be enabled. + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG if client or client->connection is + * NULL, PROPERTY_LIST_SERVICE_E_SSL_ERROR when SSL could not be enabled, + * or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR otherwise. + */ +property_list_service_error_t property_list_service_enable_ssl(property_list_service_client_t client) +{ + if (!client || !client->connection) + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + return iphone_to_property_list_service_error(iphone_connection_enable_ssl(client->connection)); +} + +/** + * Disable SSL for the given property list service client. + * + * @param client The connected property list service client for which SSL + * should be disabled. + * + * @return PROPERTY_LIST_SERVICE_E_SUCCESS on success, + * PROPERTY_LIST_SERVICE_E_INVALID_ARG if client or client->connection is + * NULL, or PROPERTY_LIST_SERVICE_E_UNKNOWN_ERROR otherwise. + */ +property_list_service_error_t property_list_service_disable_ssl(property_list_service_client_t client) +{ + if (!client || !client->connection) + return PROPERTY_LIST_SERVICE_E_INVALID_ARG; + return iphone_to_property_list_service_error(iphone_connection_disable_ssl(client->connection)); +} + |