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
|
/**
* @file libimobiledevice/bt_packet_logger.h
* @brief Capture the Bluetooth HCI trace from a device
* \internal
*
* Copyright (c) 2021 Geoffrey Kruse, 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 IBT_PACKET_LOGGER_H
#define IBT_PACKET_LOGGER_H
#ifdef __cplusplus
extern "C" {
#endif
#include <libimobiledevice/libimobiledevice.h>
#include <libimobiledevice/lockdown.h>
#define BT_PACKETLOGGER_SERVICE_NAME "com.apple.bluetooth.BTPacketLogger"
#define BT_MAX_PACKET_SIZE 65535
/** Error Codes */
typedef enum {
BT_PACKET_LOGGER_E_SUCCESS = 0,
BT_PACKET_LOGGER_E_INVALID_ARG = -1,
BT_PACKET_LOGGER_E_MUX_ERROR = -2,
BT_PACKET_LOGGER_E_SSL_ERROR = -3,
BT_PACKET_LOGGER_E_NOT_ENOUGH_DATA = -4,
BT_PACKET_LOGGER_E_TIMEOUT = -5,
BT_PACKET_LOGGER_E_UNKNOWN_ERROR = -256
} bt_packet_logger_error_t;
typedef struct {
uint32_t length;
uint32_t ts_secs;
uint32_t ts_usecs;
} bt_packet_logger_header_t;
typedef struct bt_packet_logger_client_private bt_packet_logger_client_private;
typedef bt_packet_logger_client_private *bt_packet_logger_client_t; /**< The client handle. */
/** Receives each character received from the device. */
typedef void (*bt_packet_logger_receive_cb_t)(uint8_t * data, uint16_t len, void *user_data);
/* Interface */
/**
* Connects to the bt_packet_logger 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
* bt_packet_logger_client_t upon successful return. Must be freed using
* bt_packet_logger_client_free() after use.
*
* @return BT_PACKET_LOGGER_E_SUCCESS on success, BT_PACKET_LOGGER_E_INVALID_ARG when
* client is NULL, or an BT_PACKET_LOGGER_E_* error code otherwise.
*/
bt_packet_logger_error_t bt_packet_logger_client_new(idevice_t device, lockdownd_service_descriptor_t service, bt_packet_logger_client_t * client);
/**
* Starts a new bt_packet_logger 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
* bt_packet_logger_client_t upon successful return. Must be freed using
* bt_packet_logger_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 BT_PACKET_LOGGER_E_SUCCESS on success, or an BT_PACKET_LOGGER_E_* error
* code otherwise.
*/
bt_packet_logger_error_t bt_packet_logger_client_start_service(idevice_t device, bt_packet_logger_client_t * client, const char* label);
/**
* Disconnects a bt_packet_logger client from the device and frees up the
* bt_packet_logger client data.
*
* @param client The bt_packet_logger client to disconnect and free.
*
* @return BT_PACKET_LOGGER_E_SUCCESS on success, BT_PACKET_LOGGER_E_INVALID_ARG when
* client is NULL, or an BT_PACKET_LOGGER_E_* error code otherwise.
*/
bt_packet_logger_error_t bt_packet_logger_client_free(bt_packet_logger_client_t client);
/**
* Starts capturing the syslog of the device using a callback.
*
* Use bt_packet_logger_stop_capture() to stop receiving the syslog.
*
* @param client The bt_packet_logger client to use
* @param callback Callback to receive each character from the syslog.
* @param user_data Custom pointer passed to the callback function.
*
* @return BT_PACKET_LOGGER_E_SUCCESS on success,
* BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are
* invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified
* error occurs or a syslog capture has already been started.
*/
bt_packet_logger_error_t bt_packet_logger_start_capture(bt_packet_logger_client_t client, bt_packet_logger_receive_cb_t callback, void* user_data);
/**
* Stops capturing the syslog of the device.
*
* Use bt_packet_logger_start_capture() to start receiving the syslog.
*
* @param client The bt_packet_logger client to use
*
* @return BT_PACKET_LOGGER_E_SUCCESS on success,
* BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are
* invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified
* error occurs or a syslog capture has already been started.
*/
bt_packet_logger_error_t bt_packet_logger_stop_capture(bt_packet_logger_client_t client);
/* Receiving */
/**
* Receives data using the given bt_packet_logger client with specified timeout.
*
* @param client The bt_packet_logger 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 BT_PACKET_LOGGER_E_SUCCESS on success,
* BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are
* invalid, BT_PACKET_LOGGER_E_MUX_ERROR when a communication error
* occurs, or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified
* error occurs.
*/
bt_packet_logger_error_t bt_packet_logger_receive_with_timeout(bt_packet_logger_client_t client, char *data, uint32_t size, uint32_t *received, unsigned int timeout);
#ifdef __cplusplus
}
#endif
#endif
|
