@mcesystems/apple-kit 1.0.24 → 1.0.26

package/resources/lib/include/libimobiledevice/companion_proxy.h

@@ -1,212 +0,0 @@
-/**
- * @file libimobiledevice/companion_proxy.h
- * @brief Companion proxy support.
- * \internal
- *
- * Copyright (c) 2019-2020 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
- */
-
-#ifndef ICOMPANION_PROXY_H
-#define ICOMPANION_PROXY_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include <libimobiledevice/libimobiledevice.h>
-#include <libimobiledevice/lockdown.h>
-
-/** Service identifier passed to lockdownd_start_service() to start the companion proxy service */
-#define COMPANION_PROXY_SERVICE_NAME "com.apple.companion_proxy"
-
-/** Error Codes */
-typedef enum {
-	COMPANION_PROXY_E_SUCCESS         =  0,
-	COMPANION_PROXY_E_INVALID_ARG     = -1,
-	COMPANION_PROXY_E_PLIST_ERROR     = -2,
-	COMPANION_PROXY_E_MUX_ERROR       = -3,
-	COMPANION_PROXY_E_SSL_ERROR       = -4,
-	COMPANION_PROXY_E_NOT_ENOUGH_DATA = -5,
-	COMPANION_PROXY_E_TIMEOUT         = -6,
-	COMPANION_PROXY_E_OP_IN_PROGRESS  = -7,
-	COMPANION_PROXY_E_NO_DEVICES      = -100,
-	COMPANION_PROXY_E_UNSUPPORTED_KEY = -101,
-	COMPANION_PROXY_E_TIMEOUT_REPLY   = -102,
-	COMPANION_PROXY_E_UNKNOWN_ERROR   = -256
-} companion_proxy_error_t;
-
-typedef struct companion_proxy_client_private companion_proxy_client_private; /**< \private */
-typedef companion_proxy_client_private *companion_proxy_client_t; /**< The client handle. */
-
-/** Callback for companion device events */
-typedef void (*companion_proxy_device_event_cb_t) (plist_t event, void* userdata);
-
-/**
- * Connects to the companion_proxy 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
- *     companion_proxy_client_t upon successful return. Must be freed using
- *     companion_proxy_client_free() after use.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success, COMPANION_PROXY_E_INVALID_ARG when
- *     the arguments are invalid, or an COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_client_new(idevice_t device, lockdownd_service_descriptor_t service, companion_proxy_client_t* client);
-
-/**
- * Starts a new companion_proxy 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
- *     companion_proxy_client_t upon successful return. Must be freed using
- *     companion_proxy_client_free() after use.
- * @param label The label to use for communication. Usually the program name.
- *  Pass NULL to disable sending the label in requests to lockdownd.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success, or an COMPANION_PROXY_E_* error
- *     code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_client_start_service(idevice_t device, companion_proxy_client_t* client, const char* label);
-
-/**
- * Disconnects a companion_proxy client from the device and frees up the
- * companion_proxy client data.
- *
- * @param client The companion_proxy client to disconnect and free.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success, COMPANION_PROXY_E_INVALID_ARG when
- *     client is NULL, or an COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_client_free(companion_proxy_client_t client);
-
-/**
- * Sends a plist to the service.
- *
- * @param client The companion_proxy client
- * @param plist The plist to send
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  COMPANION_PROXY_E_INVALID_ARG when client or plist is NULL
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_send(companion_proxy_client_t client, plist_t plist);
-
-/**
- * Receives a plist from the service.
- *
- * @param client The companion_proxy client
- * @param plist The plist to store the received data
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  COMPANION_PROXY_E_INVALID_ARG when client or plist is NULL
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_receive(companion_proxy_client_t client, plist_t * plist);
-
-/**
- * Retrieves a list of paired devices.
- *
- * @param client The companion_proxy client
- * @param paired_devices Point that will receive a PLIST_ARRAY with paired device UDIDs
- *
- * @note The device closes the connection after sending the reply.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  COMPANION_PROXY_E_NO_DEVICES if no devices are paired,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_get_device_registry(companion_proxy_client_t client, plist_t* paired_devices);
-
-/**
- * Starts listening for paired devices.
- *
- * @param client The companion_proxy client
- * @param callback Callback function that will be called when a new device is detected
- * @param userdata Pointer that that will be passed to the callback function
- *
- * @note The event parameter that gets passed to the callback function is
- *  freed internally after returning from the callback. The consumer needs
- *  to make a copy if required.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_start_listening_for_devices(companion_proxy_client_t client, companion_proxy_device_event_cb_t callback, void* userdata);
-
-/**
- * Stops listening for paired devices
- *
- * @param client The companion_proxy client
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_stop_listening_for_devices(companion_proxy_client_t client);
-
-/**
- * Returns a value for the given key.
- *
- * @param client The companion_proxy client
- * @param companion_udid UDID of the (paired) companion device
- * @param key The key to retrieve the value for
- * @param value A pointer to a plist_t that will receive the value for the given key.
- *   The consumer is responsible for freeing the value with plist_free() when no longer needed.
- *
- * @note The device closes the connection after sending the reply.
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  COMPANION_PROXY_E_INVALID_ARG when client or paired_devices is invalid,
- *  COMPANION_PROXY_E_UNSUPPORTED_KEY if the companion device doesn't support the given key,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_get_value_from_registry(companion_proxy_client_t client, const char* companion_udid, const char* key, plist_t* value);
-
-/**
- * Start forwarding a service port on the companion device to a port on the idevice.
- *
- * @see companion_proxy_stop_forwarding_service_port
- *
- * @param client The companion_proxy client
- * @param remote_port remote port
- * @param service_name The name of the service that shall be forwarded
- * @param forward_port Pointer that will receive the newly-assigned port accessible via USB/Network on the idevice
- * @param options PLIST_DICT with additional options. Currently known are
- *    IsServiceLowPriority (boolean) and PreferWifi (boolean).
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_start_forwarding_service_port(companion_proxy_client_t client, uint16_t remote_port, const char* service_name, uint16_t* forward_port, plist_t options);
-
-/**
- * Stop forwarding a service port between companion device and idevice.
- *
- * @see companion_proxy_start_forwarding_service_port
- *
- * @param client The companion_proxy client
- * @param remote_port remote port
- *
- * @return COMPANION_PROXY_E_SUCCESS on success,
- *  or a COMPANION_PROXY_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API companion_proxy_error_t companion_proxy_stop_forwarding_service_port(companion_proxy_client_t client, uint16_t remote_port);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

package/resources/lib/include/libimobiledevice/debugserver.h

@@ -1,272 +0,0 @@
-/**
- * @file libimobiledevice/debugserver.h
- * @brief Communicate with debugserver on the device.
- * \internal
- *
- * 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
- */
-
-#ifndef IDEBUGSERVER_H
-#define IDEBUGSERVER_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include <libimobiledevice/libimobiledevice.h>
-#include <libimobiledevice/lockdown.h>
-
-/** Service identifier passed to lockdownd_start_service() to start the debugserver service */
-#define DEBUGSERVER_SERVICE_NAME "com.apple.debugserver"
-/** Service identifier passed to lockdownd_start_service() to start the secure debugserver service */
-#define DEBUGSERVER_SECURE_SERVICE_NAME DEBUGSERVER_SERVICE_NAME ".DVTSecureSocketProxy"
-
-/** Error Codes */
-typedef enum {
-	DEBUGSERVER_E_SUCCESS        =  0,
-	DEBUGSERVER_E_INVALID_ARG    = -1,
-	DEBUGSERVER_E_MUX_ERROR      = -2,
-	DEBUGSERVER_E_SSL_ERROR      = -3,
-	DEBUGSERVER_E_RESPONSE_ERROR = -4,
-	DEBUGSERVER_E_TIMEOUT        = -5,
-	DEBUGSERVER_E_UNKNOWN_ERROR  = -256
-} debugserver_error_t;
-
-typedef struct debugserver_client_private debugserver_client_private; /**< \private */
-typedef debugserver_client_private *debugserver_client_t; /**< The client handle. */
-
-typedef struct debugserver_command_private debugserver_command_private; /**< \private */
-typedef debugserver_command_private *debugserver_command_t; /**< The command handle. */
-
-/* Interface */
-
-/**
- * Connects to the debugserver 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
- *     debugserver_client_t upon successful return. Must be freed using
- *     debugserver_client_free() after use.
- *
- * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when
- *     client is NULL, or an DEBUGSERVER_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_new(idevice_t device, lockdownd_service_descriptor_t service, debugserver_client_t * client);
-
-/**
- * Starts a new debugserver 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
- *     debugserver_client_t upon successful return. Must be freed using
- *     debugserver_client_free() after use.
- * @param label The label to use for communication. Usually the program name.
- *  Pass NULL to disable sending the label in requests to lockdownd.
- *
- * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
- *     code otherwise.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_start_service(idevice_t device, debugserver_client_t * client, const char* label);
-
-/**
- * Disconnects a debugserver client from the device and frees up the
- * debugserver client data.
- *
- * @param client The debugserver client to disconnect and free.
- *
- * @return DEBUGSERVER_E_SUCCESS on success, DEBUGSERVER_E_INVALID_ARG when
- *     client is NULL, or an DEBUGSERVER_E_* error code otherwise.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_free(debugserver_client_t client);
-
-/**
- * Sends raw data using the given debugserver service client.
- *
- * @param client The debugserver client to use for sending
- * @param data Data to send
- * @param size Size of the data to send
- * @param sent Number of bytes sent (can be NULL to ignore)
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *      DEBUGSERVER_E_INVALID_ARG when one or more parameters are
- *      invalid, or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified
- *      error occurs.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_send(debugserver_client_t client, const char* data, uint32_t size, uint32_t *sent);
-
-/**
- * Receives raw data using the given debugserver client with specified timeout.
- *
- * @param client The debugserver client to use for receiving
- * @param data Buffer that will be filled with the data received
- * @param size Number of bytes to receive
- * @param received Number of bytes received (can be NULL to ignore)
- * @param timeout Maximum time in milliseconds to wait for data.
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *      DEBUGSERVER_E_INVALID_ARG when one or more parameters are
- *      invalid, DEBUGSERVER_E_MUX_ERROR when a communication error
- *      occurs, DEBUGSERVER_E_TIMEOUT when the timeout is reached,
- *      or DEBUGSERVER_E_UNKNOWN_ERROR when an unspecified
- *      error occurs.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive_with_timeout(debugserver_client_t client, char *data, uint32_t size, uint32_t *received, unsigned int timeout);
-
-/**
- * Receives raw data from the debugserver service.
- *
- * @param client The debugserver client
- * @param data Buffer that will be filled with the data received
- * @param size Number of bytes to receive
- * @param received Number of bytes received (can be NULL to ignore)
- * @note The default read timeout is 10 seconds.
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when client or plist is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive(debugserver_client_t client, char *data, uint32_t size, uint32_t *received);
-
-/**
- * Sends a command to the debugserver service.
- *
- * @param client The debugserver client
- * @param command Command to process and send
- * @param response Response received for the command (can be NULL to ignore)
- * @param response_size Pointer to receive response size. Set to NULL to ignore.
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when client or command is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_send_command(debugserver_client_t client, debugserver_command_t command, char** response, size_t* response_size);
-
-/**
- * Receives and parses response of debugserver service.
- *
- * @param client The debugserver client
- * @param response Response received for last command (can be NULL to ignore)
- * @param response_size Pointer to receive response size. Set to NULL to ignore.
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when client is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_receive_response(debugserver_client_t client, char** response, size_t* response_size);
-
-/**
- * Controls status of ACK mode when sending commands or receiving responses.
- *
- * @see debugserver_client_send_command, debugserver_client_receive_response
- *
- * @param client The debugserver client
- * @param enabled A boolean flag indicating whether the internal ACK mode
- *   handling should be enabled or disabled.
- *
- * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
- *     code otherwise.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_ack_mode(debugserver_client_t client, int enabled);
-
-/**
- * Sets behavior when awaiting a response from the server.
- *
- * @see debugserver_client_send_command, debugserver_client_receive_response,
- *   debugserver_client_receive
- *
- * @param client The debugserver client
- * @param cancel_receive A function pointer that will be called approximately
- *     every receive_loop_timeout milliseconds; the function should return a
- *     boolean flag specifying whether to stop waiting for a response. If NULL,
- *     behaves as if it always returns true.
- * @param receive_loop_timeout Time in milliseconds between calls to
- *     cancel_receive.
- *
- * @return DEBUGSERVER_E_SUCCESS on success, or an DEBUGSERVER_E_* error
- *     code otherwise.
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_receive_params(debugserver_client_t client, int (*cancel_receive)(), int receive_loop_timeout);
-
-/**
- * Sets the argv which launches an app.
- *
- * @param client The debugserver client
- * @param argc Number of arguments
- * @param argv Array starting with the executable to be run followed by it's arguments
- * @param response Response received for the command (can be NULL to ignore)
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when client is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_argv(debugserver_client_t client, int argc, char* argv[], char** response);
-
-/**
- * Adds or sets an environment variable.
- *
- * @param client The debugserver client
- * @param env The environment variable in "KEY=VALUE" notation
- * @param response Response received for the command (can be NULL to ignore)
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when client is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_client_set_environment_hex_encoded(debugserver_client_t client, const char* env, char** response);
-
-/**
- * Creates and initializes a new command object.
- *
- * @param name The name of the command which is sent in plain text
- * @param argv Array of tokens for the command ment to be encoded
- * @param argc Number of items in the token array
- * @param command New command object
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when name or command is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_command_new(const char* name, int argc, char* argv[], debugserver_command_t* command);
-
-/**
- * Frees memory of command object.
- *
- * @param command The command object
- *
- * @return DEBUGSERVER_E_SUCCESS on success,
- *  DEBUGSERVER_E_INVALID_ARG when command is NULL
- */
-LIBIMOBILEDEVICE_API debugserver_error_t debugserver_command_free(debugserver_command_t command);
-
-/**
- * Encodes a string into hex notation.
- *
- * @param buffer String to encode into hex notiation
- * @param encoded_buffer The buffer receives a hex encoded string
- * @param encoded_length Length of the hex encoded string
- */
-LIBIMOBILEDEVICE_API void debugserver_encode_string(const char* buffer, char** encoded_buffer, uint32_t* encoded_length);
-
-/**
- * Decodes a hex encoded string.
- *
- * @param encoded_buffer The buffer with a hex encoded string
- * @param encoded_length Length of the encoded buffer
- * @param buffer Decoded string to be freed by the caller
- */
-LIBIMOBILEDEVICE_API void debugserver_decode_string(const char *encoded_buffer, size_t encoded_length, char** buffer);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif