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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
/*
* syslog_relay.c
* com.apple.syslog_relay 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 "syslog_relay.h"
#include "lockdown.h"
#include "common/debug.h"
struct syslog_relay_worker_thread {
syslog_relay_client_t client;
syslog_relay_receive_cb_t cbfunc;
void *user_data;
};
/**
* Convert a service_error_t value to a syslog_relay_error_t value.
* Used internally to get correct error codes.
*
* @param err An service_error_t error code
*
* @return A matching syslog_relay_error_t error code,
* SYSLOG_RELAY_E_UNKNOWN_ERROR otherwise.
*/
static syslog_relay_error_t syslog_relay_error(service_error_t err)
{
switch (err) {
case SERVICE_E_SUCCESS:
return SYSLOG_RELAY_E_SUCCESS;
case SERVICE_E_INVALID_ARG:
return SYSLOG_RELAY_E_INVALID_ARG;
case SERVICE_E_MUX_ERROR:
return SYSLOG_RELAY_E_MUX_ERROR;
case SERVICE_E_SSL_ERROR:
return SYSLOG_RELAY_E_SSL_ERROR;
default:
break;
}
return SYSLOG_RELAY_E_UNKNOWN_ERROR;
}
/**
* Connects to the syslog_relay 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
* syslog_relay_client_t upon successful return. Must be freed using
* syslog_relay_client_free() after use.
*
* @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
* client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
*/
syslog_relay_error_t syslog_relay_client_new(idevice_t device, lockdownd_service_descriptor_t service, syslog_relay_client_t * client)
{
*client = NULL;
if (!device || !service || service->port == 0 || !client || *client) {
debug_info("Incorrect parameter passed to syslog_relay_client_new.");
return SYSLOG_RELAY_E_INVALID_ARG;
}
debug_info("Creating syslog_relay_client, port = %d.", service->port);
service_client_t parent = NULL;
syslog_relay_error_t ret = syslog_relay_error(service_client_new(device, service, &parent));
if (ret != SYSLOG_RELAY_E_SUCCESS) {
debug_info("Creating base service client failed. Error: %i", ret);
return ret;
}
syslog_relay_client_t client_loc = (syslog_relay_client_t) malloc(sizeof(struct syslog_relay_client_private));
client_loc->parent = parent;
client_loc->worker = (thread_t)NULL;
*client = client_loc;
debug_info("syslog_relay_client successfully created.");
return 0;
}
/**
* Starts a new syslog_relay 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
* syslog_relay_client_t upon successful return. Must be freed using
* syslog_relay_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 SYSLOG_RELAY_E_SUCCESS on success, or an SYSLOG_RELAY_E_* error
* code otherwise.
*/
syslog_relay_error_t syslog_relay_client_start_service(idevice_t device, syslog_relay_client_t * client, const char* label)
{
syslog_relay_error_t err = SYSLOG_RELAY_E_UNKNOWN_ERROR;
service_client_factory_start_service(device, SYSLOG_RELAY_SERVICE_NAME, (void**)client, label, SERVICE_CONSTRUCTOR(syslog_relay_client_new), &err);
return err;
}
/**
* Disconnects a syslog_relay client from the device and frees up the
* syslog_relay client data.
*
* @param client The syslog_relay client to disconnect and free.
*
* @return SYSLOG_RELAY_E_SUCCESS on success, SYSLOG_RELAY_E_INVALID_ARG when
* client is NULL, or an SYSLOG_RELAY_E_* error code otherwise.
*/
syslog_relay_error_t syslog_relay_client_free(syslog_relay_client_t client)
{
if (!client)
return SYSLOG_RELAY_E_INVALID_ARG;
syslog_relay_error_t err = syslog_relay_error(service_client_free(client->parent));
client->parent = NULL;
if (client->worker) {
debug_info("Joining syslog capture callback worker thread");
thread_join(client->worker);
}
free(client);
return err;
}
/**
* Receives data from the service.
*
* @param client The syslog_relay 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)
* @param timeout Maximum time in milliseconds to wait for data.
*
* @return SYSLOG_RELAY_E_SUCCESS on success,
* SYSLOG_RELAY_E_INVALID_ARG when client or plist is NULL
*/
syslog_relay_error_t syslog_relay_receive(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received)
{
return syslog_relay_receive_with_timeout(client, data, size, received, 1000);
}
/**
* Receives data using the given syslog_relay client with specified timeout.
*
* @param client The syslog_relay 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 SYSLOG_RELAY_E_SUCCESS on success,
* SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
* invalid, SYSLOG_RELAY_E_MUX_ERROR when a communication error
* occurs, or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
* error occurs.
*/
syslog_relay_error_t syslog_relay_receive_with_timeout(syslog_relay_client_t client, char* data, uint32_t size, uint32_t *received, unsigned int timeout)
{
syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR;
int bytes = 0;
if (!client || !data || (size == 0)) {
return SYSLOG_RELAY_E_INVALID_ARG;
}
res = syslog_relay_error(service_receive_with_timeout(client->parent, data, size, (uint32_t*)&bytes, timeout));
if (bytes <= 0) {
debug_info("Could not read data, error %d", res);
}
if (received) {
*received = (uint32_t)bytes;
}
return res;
}
void *syslog_relay_worker(void *arg)
{
service_error_t ret = SERVICE_E_UNKNOWN_ERROR;
struct syslog_relay_worker_thread *srwt = (struct syslog_relay_worker_thread*)arg;
if (!srwt)
return NULL;
debug_info("Running");
while (srwt->client->parent) {
char c;
uint32_t bytes = 0;
ret = syslog_relay_receive_with_timeout(srwt->client, &c, 1, &bytes, 100);
if ((bytes == 0) && (ret == SYSLOG_RELAY_E_SUCCESS)) {
continue;
} else if (ret < 0) {
debug_info("Connection to syslog relay interrupted");
break;
}
if(c != 0) {
srwt->cbfunc(c, srwt->user_data);
}
}
if (srwt) {
free(srwt);
}
debug_info("Exiting");
return NULL;
}
/**
* Starts capturing the syslog of the device using a callback.
*
* Use syslog_relay_stop_capture() to stop receiving the syslog.
*
* @param client The syslog_relay client to use
* @param callback Callback to receive each character from the syslog.
* @param user_data Custom pointer passed to the callback function.
*
* @return SYSLOG_RELAY_E_SUCCESS on success,
* SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
* invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
* error occurs or a syslog capture has already been started.
*/
syslog_relay_error_t syslog_relay_start_capture(syslog_relay_client_t client, syslog_relay_receive_cb_t callback, void* user_data)
{
if (!client || !callback)
return SYSLOG_RELAY_E_INVALID_ARG;
syslog_relay_error_t res = SYSLOG_RELAY_E_UNKNOWN_ERROR;
if (client->worker) {
debug_info("Another syslog capture thread appears to be running already.");
return res;
}
/* start worker thread */
struct syslog_relay_worker_thread *srwt = (struct syslog_relay_worker_thread*)malloc(sizeof(struct syslog_relay_worker_thread));
if (srwt) {
srwt->client = client;
srwt->cbfunc = callback;
srwt->user_data = user_data;
if (thread_create(&client->worker, syslog_relay_worker, srwt) == 0) {
res = SYSLOG_RELAY_E_SUCCESS;
}
}
return res;
}
/**
* Stops capturing the syslog of the device.
*
* Use syslog_relay_start_capture() to start receiving the syslog.
*
* @param client The syslog_relay client to use
*
* @return SYSLOG_RELAY_E_SUCCESS on success,
* SYSLOG_RELAY_E_INVALID_ARG when one or more parameters are
* invalid or SYSLOG_RELAY_E_UNKNOWN_ERROR when an unspecified
* error occurs or a syslog capture has already been started.
*/
syslog_relay_error_t syslog_relay_stop_capture(syslog_relay_client_t client)
{
if (client->worker) {
/* notify thread to finish */
service_client_t parent = client->parent;
client->parent = NULL;
/* join thread to make it exit */
thread_join(client->worker);
client->worker = (thread_t)NULL;
client->parent = parent;
}
return SYSLOG_RELAY_E_SUCCESS;
}
|