Source

MobileDeviceAccess / MobileDevice.h

  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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/* ex:set ts=4 sw=4: <- for vi
 *
 * IPod.h
 *
 * This is based on information extracted from around the Internet, by people
 * who wanted to look a lot further under the covers than I did.  I've deliberately
 * pushed all Apple's datatypes back to being opaque, since there is nothing
 * to be gained by looking inside them, and everything to lose.
 *
 * This file doesn't contain any of the 'recovery-mode' or other 'jailbreak-related' stuff
 *
 * http://iphonesvn.halifrag.com/svn/iPhone/
 * http://www.theiphonewiki.com/wiki/index.php?title=MobileDevice_Library#MobileDevice_Header_.28mobiledevice.h.29
 * http://code.google.com/p/iphonebrowser/issues/detail?id=52
 * http://www.koders.com/csharp/fidE79340F4674D47FFF3EFB6F949A1589D942798F3.aspx
 *
 * As far as I'm concerned, this header is in the Public Domain.
 */
#pragma once

#ifdef __cplusplus
extern "C" {
#endif

/*
 * its critical that we spell out all integer sizes, for the entry points
 * and data structures in the external DLL/framework that we have no
 * control over.
 */
#include <stdint.h>

#if defined(WIN32)
#include <CoreFoundation.h>
typedef uint32_t mach_error_t;
#elif defined(__APPLE__)
#include <CoreFoundation/CoreFoundation.h>
#include <mach/error.h>
#endif

/* Error codes */
#define MDERR_APPLE_MOBILE		(err_system(0x3a))
#define MDERR_IPHONE			(err_sub(0))

/* Apple Mobile (AM*) errors */
#define MDERR_OK                ERR_SUCCESS
#define MDERR_SYSCALL           (ERR_MOBILE_DEVICE | 0x01)
#define MDERR_OUT_OF_MEMORY     (ERR_MOBILE_DEVICE | 0x03)
#define MDERR_QUERY_FAILED      (ERR_MOBILE_DEVICE | 0x04) 
#define MDERR_INVALID_ARGUMENT  (ERR_MOBILE_DEVICE | 0x0b)
#define MDERR_NO_SUCH_SERVICE   (ERR_MOBILE_DEVICE | 0x22)
#define MDERR_DICT_NOT_LOADED   (ERR_MOBILE_DEVICE | 0x25)

/* Apple File Connection (AFC*) errors */
#define MDERR_AFC_OUT_OF_MEMORY 0x03

/* Services, found in /System/Library/Lockdown/Services.plist */
#define AMSVC_AFC                   "com.apple.afc"
#define AMSVC_AFC2                  "com.apple.afc2"
#define AMSVC_BACKUP                "com.apple.mobilebackup"
#define AMSVC_CRASH_REPORT_COPY     "com.apple.crashreportcopy"
#define AMSVC_DEBUG_IMAGE_MOUNT     "com.apple.mobile.debug_image_mount"
#define AMSVC_NOTIFICATION_PROXY    "com.apple.mobile.notification_proxy"
#define AMSVC_PURPLE_TEST           "com.apple.purpletestr"
#define AMSVC_SOFTWARE_UPDATE       "com.apple.mobile.software_update"
#define AMSVC_SYNC                  "com.apple.mobilesync"
#define AMSVC_SCREENSHOT            "com.apple.screenshotr"
#define AMSVC_SYSLOG_RELAY          "com.apple.syslog_relay"
#define AMSVC_SYSTEM_PROFILER       "com.apple.mobile.system_profiler"

typedef uint32_t afc_error_t;
typedef uint64_t afc_file_ref;

/* opaque structures */
typedef struct _am_device				*am_device;
typedef struct _am_service				*am_service;
typedef struct _afc_connection			*afc_connection;
typedef struct _am_device_notification	*am_device_notification;
typedef struct _afc_directory			*afc_directory;
typedef struct _afc_dictionary			*afc_dictionary;

/* Messages passed to device notification callbacks: passed as part of
 * am_device_notification_callback_info. */
typedef enum {
	ADNCI_MSG_CONNECTED     = 1,
	ADNCI_MSG_DISCONNECTED  = 2,
	ADNCI_MSG_UNKNOWN       = 3
} adnci_msg;

struct am_device_notification_callback_info {
	am_device	dev;				/* 0    device */ 
	uint32_t	msg;				/* 4    one of adnci_msg */
} __attribute__ ((packed));

/* The type of the device notification callback function. */
typedef void (*am_device_notification_callback)(
	struct am_device_notification_callback_info *,
	void* callback_data);

/* ----------------------------------------------------------------------------
 *   Public routines
 * ------------------------------------------------------------------------- */

/* Registers a notification with the current run loop. The callback gets
 * copied into the notification struct, as well as being registered with the
 * current run loop. callback_data gets passed to the callback in addition
 * to the info block.
 * unused0 and unused1 are both 0 when iTunes calls this.
 *
 *  Returns:
 *      MDERR_OK            if successful
 *      MDERR_SYSCALL       if CFRunLoopAddSource() failed
 *      MDERR_OUT_OF_MEMORY if we ran out of memory
 */

mach_error_t AMDeviceNotificationSubscribe(
	am_device_notification_callback callback,
	uint32_t unused0,
	uint32_t unused1,
	void *callback_data,
	am_device_notification *notification);

/*
 * Unregisters notifications. Buggy (iTunes 8.2): if you subscribe, unsubscribe and subscribe again, arriving 
           notifications will contain cookie and subscription from 1st call to subscribe, not the 2nd one. iTunes 
           calls this function only once on exit.
        */
mach_error_t AMDeviceNotificationUnsubscribe(
	am_device_notification subscription);

/*  Connects to the iPhone. Pass in the am_device structure that the
 *  notification callback will give to you.
 *
 *  Returns:
 *      MDERR_OK                if successfully connected
 *      MDERR_SYSCALL           if setsockopt() failed
 *      MDERR_QUERY_FAILED      if the daemon query failed
 *      MDERR_INVALID_ARGUMENT  if USBMuxConnectByPort returned 0xffffffff
 */

mach_error_t AMDeviceConnect(
	am_device device);

/*  Calls PairingRecordPath() on the given device, than tests whether the path
 *  which that function returns exists. During the initial connect, the path
 *  returned by that function is '/', and so this returns 1.
 *
 *  Returns:
 *      0   if the path did not exist
 *      1   if it did
 */

int AMDeviceIsPaired(
	am_device device);

// __DLLIMPORT mach_error_t AMDevicePair(struct am_device device);

/*  iTunes calls this function immediately after testing whether the device is
 *  paired. It creates a pairing file and establishes a Lockdown connection.
 *
 *  Returns:
 *      MDERR_OK                if successful
 *      MDERR_INVALID_ARGUMENT  if the supplied device is null
 *      MDERR_DICT_NOT_LOADED   if the load_dict() call failed
 */

mach_error_t AMDeviceValidatePairing(
	am_device device);

/*  Creates a Lockdown session and adjusts the device structure appropriately
 *  to indicate that the session has been started. iTunes calls this function
 *  after validating pairing.
 *
 *  Returns:
 *      MDERR_OK                if successful
 *      MDERR_INVALID_ARGUMENT  if the Lockdown conn has not been established
 *      MDERR_DICT_NOT_LOADED   if the load_dict() call failed
 */

mach_error_t AMDeviceStartSession(
	am_device device);

/* Starts a service and returns a handle that can be used in order to further
 * access the service. You should stop the session and disconnect before using
 * the service. iTunes calls this function after starting a session. It starts 
 * the service and the SSL connection. unknown may safely be
 * NULL (it is when iTunes calls this), but if it is not, then it will be
 * filled upon function exit. service_name should be one of the AMSVC_*
 * constants. If the service is AFC (AMSVC_AFC), then the handle is the handle
 * that will be used for further AFC* calls.
 *
 * Returns:
 *      MDERR_OK                if successful
 *      MDERR_SYSCALL           if the setsockopt() call failed
 *      MDERR_INVALID_ARGUMENT  if the Lockdown conn has not been established
 */

mach_error_t AMDeviceStartService(
	am_device device,
	CFStringRef service_name,
	am_service *handle,
	uint32_t *unknown);

/* Stops a session. You should do this before accessing services.
 *
 * Returns:
 *      MDERR_OK                if successful
 *      MDERR_INVALID_ARGUMENT  if the Lockdown conn has not been established
 */

mach_error_t AMDeviceStopSession(
	am_device device);

/* Opens an Apple File Connection. You must start the appropriate service
 * first with AMDeviceStartService(). In iTunes, io_timeout is 0.
 *
 * Returns:
 *      MDERR_OK                if successful
 *      MDERR_AFC_OUT_OF_MEMORY if malloc() failed
 */

afc_error_t AFCDirectoryAccessOpen(
	am_service handle,
	uint32_t io_timeout,
    afc_connection *conn);

/* Retrieves an afc_dictionary that describes the connected device.  To
 * extract values from the dictionary, use AFCKeyValueRead() and close
 * it when finished with AFCKeyValueClose()
 */
afc_error_t AFCDeviceInfoOpen(
	afc_connection conn,
	afc_dictionary *info);

/* Turns debug mode on if the environment variable AFCDEBUG is set to a numeric
 * value, or if the file '/AFCDEBUG' is present and contains a value. */
void AFCPlatformInit();

/* Opens a directory on the iPhone. Retrieves an afc_directory which can be
 * queried (with AFCDirectoryRead()) to enumerate through the filenames in
 * the directory.  Once finished, close with AFCDirectoryClose()
 *
 * Note that this normally only accesses the iTunes sandbox/partition as the
 * root, which is /var/root/Media. Pathnames are specified with '/' delimiters
 * as in Unix style.
 *
 * Returns:
 *      MDERR_OK                if successful
 */

afc_error_t AFCDirectoryOpen(
	afc_connection conn,
	const char *path,
	afc_directory *dir);

/* Acquires the next entry in a directory previously opened with
 * AFCDirectoryOpen(). When dirent is filled with a NULL value, then the end
 * of the directory has been reached. '.' and '..' will be returned as the
 * first two entries in each directory except the root; you may want to skip
 * over them.
 *
 * Returns:
 *      MDERR_OK                if successful, even if no entries remain
 */

afc_error_t AFCDirectoryRead(
	afc_connection conn,
	afc_directory dir,
    char **dirent);

/* Close the directory previously opened with AFCDirectoryOpen()
 */
afc_error_t AFCDirectoryClose(
	afc_connection conn,
	afc_directory dir);

/* Create a new directory on the device.
 */
afc_error_t AFCDirectoryCreate(
	afc_connection conn,
	const char *dirname);

/* Removes an existing file or directory from the device.
 */
afc_error_t AFCRemovePath(
	afc_connection conn,
	const char *dirname);

/* Renames an existing file or directory on the device */
afc_error_t AFCRenamePath(
	afc_connection conn,
	const char *from,
	const char *to);

/* Returns the context field of the given AFC connection. */
uint32_t AFCDirectoryAccessGetContext(
	afc_connection conn);

/* Set the context field of the given AFC connection.
 */
uint32_t AFCDirectoryAccessSetContext(
	afc_connection conn,
	uint32_t ctx);

/* Returns the fs_block_size field of the given AFC connection. */
uint32_t AFCDirectoryAccessGetFSBlockSize(
	afc_connection conn);

/* Returns the io_timeout field of the given AFC connection. In iTunes this is 0. */
uint32_t AFCDirectoryAccessGetIOTimeout(
	afc_connection conn);
	
uint32_t AFCDirectoryAccessSetIOTimeout(
	afc_connection conn,
	uint32_t timeout);

/* Returns the sock_block_size field of the given AFC connection. */
uint32_t AFCDirectoryAccessGetSocketBlockSize(
	afc_connection conn);

/* Closes the given AFC connection. */
afc_error_t AFCDirectoryAccessClose(
	afc_connection conn);

/* ----------------------------------------------------------------------------
 *   Less-documented public routines
 * ------------------------------------------------------------------------- */

afc_error_t AFCFileRefOpen(
	afc_connection conn,
	const char *path,				/* pathname of file to open */
    uint64_t mode,					/* 1=read, 2=write, 3=read/write */
	afc_file_ref *ref);
	
afc_error_t AFCFileRefSeek(
	afc_connection conn,
	afc_file_ref ref,
	int64_t offset,				/* signed offset from pos */
	uint64_t pos);				/* 0=SEEK_SET, 1=SEEK_CUR, 2=SEEK_END */

afc_error_t AFCFileRefTell(
	afc_connection conn,
	afc_file_ref ref,
	uint64_t *offset);
	
// afc_error_t AFCFileRefLock(afc_connection *conn, afc_file_ref ref,
//    ...);
// int _AFCDirectoryAccessIsValid(afc_connection *conn)

afc_error_t AFCFileRefRead(
	afc_connection conn,
	afc_file_ref ref,
    void *buf,
	uint32_t *len);

afc_error_t AFCFileRefSetFileSize(
	afc_connection conn,
	afc_file_ref ref,
    uint64_t offset);
	
afc_error_t AFCFileRefWrite(
	afc_connection conn,
	afc_file_ref ref,
    const void *buf,
	uint32_t len);
	
afc_error_t AFCFileRefClose(
	afc_connection conn,
	afc_file_ref ref);

afc_error_t AFCFileInfoOpen(
	afc_connection conn,
	const char *path,
	afc_dictionary *info);
	
afc_error_t AFCKeyValueRead(
	afc_dictionary dict,
	char **key,
	char **val);
	
afc_error_t AFCKeyValueClose(
	afc_dictionary dict);

uint32_t AMDeviceGetConnectionID(am_device device);
mach_error_t AMDeviceEnterRecovery(am_device device);
mach_error_t AMDeviceDisconnect(am_device device);
mach_error_t AMDeviceRetain(am_device device);
mach_error_t AMDeviceRelease(am_device device);

uint32_t AMDeviceGetInterfaceType(
	am_device device); // { return 1; }

uint32_t AMDeviceGetInterfaceSpeed(
	am_device device); // { return 0x78000; }

/* Reads various device settings; returns nil if no value is found for
 * the nominated key
 *
 * Must be balanced by CFRelease()
 *
 * Possible values for key:
 * ActivationState
 * ActivationStateAcknowledged
 * BasebandBootloaderVersion
 * BasebandVersion
 * BluetoothAddress
 * BuildVersion
 * DeviceCertificate
 * DeviceClass
 * DeviceName
 * DevicePublicKey
 * FirmwareVersion
 * HostAttached
 * IntegratedCircuitCardIdentity
 * InternationalMobileEquipmentIdentity
 * InternationalMobileSubscriberIdentity
 * ModelNumber
 * PhoneNumber
 * ProductType
 * ProductVersion
 * ProtocolVersion
 * RegionInfo
 * SBLockdownEverRegisteredKey
 * SIMStatus
 * SerialNumber
 * SomebodySetTimeZone
 * TimeIntervalSince1970
 * TimeZone
 * TimeZoneOffsetFromUTC
 * TrustedHostAttached
 * UniqueDeviceID
 * Uses24HourClock
 * WiFiAddress
 * iTunesHasConnected
 */
CFStringRef AMDeviceCopyValue(
	am_device device,
	uint32_t mbz,
	CFStringRef key);

/*
 * Returns the udid of the specified device.  The same value is returned
 * from AMDeviceCopyValue(device,0,"UniqueDeviceID").
 *
 * Must be balanced by CFRelease()
 */
CFStringRef AMDeviceCopyDeviceIdentifier(
	am_device device);

mach_error_t AMDShutdownNotificationProxy(
	void *);

/*edits by geohot*/
mach_error_t AMDeviceDeactivate(am_device device);
mach_error_t AMDeviceActivate(am_device device, CFMutableDictionaryRef);
/*end*/

#ifdef __cplusplus
}
#endif