1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* 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.
* @param label The label to use for communication. Usually the program name.
* Pass NULL to disable sending the label in requests to lockdownd.
*
* @return HEARTBEAT_E_SUCCESS on success, or an HEARTBEAT_E_* error
* code otherwise.
*/
heartbeat_error_t heartbeat_client_start_service(idevice_t device, heartbeat_client_t * client, const char* label)
{
heartbeat_error_t err = HEARTBEAT_E_UNKNOWN_ERROR;
service_client_factory_start_service(device, HEARTBEAT_SERVICE_NAME, (void**)client, label, SERVICE_CONSTRUCTOR(heartbeat_client_new), &err);
return err;
}
/**
* 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;
}
|
