-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathMobileDeviceAccess.h
1534 lines (1409 loc) · 56.4 KB
/
MobileDeviceAccess.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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*! \mainpage MobileDeviceAccess
*
* This module is intended to provide access to the iPhone and iPod Touch file systems.
* It achieves this via the same mechanism that iTunes uses, relying on direct entry
* points into an undocumented private framework provided by Apple.
*
* It will be necessary to include /System/Library/PrivateFrameworks/MobileDevice.framework
* in any project using this library
*
* \author Jeff Laing
* <br>
* Copyright 2010 Tristero Computer Systems. All rights reserved.
* \section intro_sec Typical Usage
*
* The application delegate will usually register itself as a listener to the MobileDeviceAccess
* singleton. It will then be called back for every iPhone and iPod Touch that connects. To access
* files on the AMDevice, create one of the subclasses AFCDirectoryAccess using the
* corresponding \p -newAFCxxxDirectory: method.
*
* \section refs_sec References
*
* 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 library doesn't contain any of the 'recovery-mode' or other 'jailbreak-related' stuff
*
* Some of the places I looked include:
* - http://iphonesvn.halifrag.com/svn/iPhone/
* - http://www.theiphonewiki.com/wiki/index.php?title=MobileDevice_Library
* - http://code.google.com/p/iphonebrowser/issues/detail?id=52
* - http://www.koders.com/csharp/fidE79340F4674D47FFF3EFB6F949A1589D942798F3.aspx
* - http://iphone-docs.org/doku.php?id=docs:protocols:screenshot
* I can't guarantee that they're still there.
*/
#pragma once
// sometimes pragma once seems to get confused so lets go belt and braces
#if !defined(_MobileDeviceAccess_h_)
#define _MobileDeviceAccess_h_
#import <Foundation/Foundation.h>
#import <Cocoa/Cocoa.h>
//#import <CoreGraphics/CoreGraphics.h>
#ifdef __cplusplus
extern "C" {
#endif
// Apple's opaque types
typedef uint32_t afc_error_t;
typedef uint64_t afc_file_ref;
/* opaque structures */
typedef struct _am_device *am_device;
typedef struct _afc_connection *afc_connection;
typedef struct _am_device_notification *am_device_notification;
// on OSX, this is a raw file descriptor, not a pointer - it ends up being
// passed directly to send()
//typedef struct _am_service *am_service;
typedef int am_service;
/// This class represents a service running on the mobile device. To create
/// an instance of this class, send the \p -startService: message to an instance
/// of AMDevice.
///
/// On a jailbroken 3.1.2 iPod Touch, the file
/// \p /System/Library/Lockdown/Services.plist lists the following as
/// valid service names:
/// - \p "com.apple.afc" - see AFCMediaDirectory
/// - \p "com.apple.crashreportcopymobile" - see AFCCrashLogDirectory
/// - \p "com.apple.mobile.house_arrest" - see AFCApplicationDirectory
/// - \p "com.apple.mobile.installation_proxy" - see AMInstallationProxy
/// - \p "com.apple.syslog_relay" - see AMSyslogRelay
/// - \p "com.apple.mobile.file_relay" - see AMFileRelay
/// - \p "com.apple.springboardservices" - see AMSpringboardServices
/// - \p "com.apple.mobile.notification_proxy" - see AMNotificationProxy
/// - \p "com.apple.mobilesync" - see AMMobileSync
/// (implemented as /usr/libexec/SyncAgent --lockdown --oneshot -v)
/// - \p "com.apple.crashreportcopy"
/// (implemented as /usr/libexec/CrashReportCopyAgent --lockdown --oneshot)
/// - \p "com.apple.crashreportcopymover"
/// (renamed to com.apple.crashreportmover at 3.1.2)
/// (implemented as /usr/libexec/crash_mover --lockdown)
/// - \p "com.apple.misagent"
/// (implemented as /usr/libexec/misagent)
/// - \p "com.apple.debug_image_mount"
/// (renamed to com.apple.mobile.debug_image_mount at 3.1.2)
/// (implemented as /usr/libexec/debug_image_mount)
/// - \p "com.apple.mobile.integrity_relay"
/// (implemented as /usr/libexec/mobile_integrity_relay)
/// - \p "com.apple.mobile.MCInstall"
/// (implemented as /usr/libexec/mc_mobile_tunnel)
/// - \p "com.apple.mobile.mobile_image_mounter"
/// (implemented as /usr/libexec/mobile_image_mounter)
/// (see also http://iphone-docs.org/doku.php?id=docs:protocols:mobile_image_mounter)
/// - \p "com.apple.mobilebackup"
/// (implemented as /usr/libexec/BackupAgent --lockdown)
///
/// If you use pwnage you get these as well - blackra1n doesn't
/// set them up
/// - \p "com.apple.afc2" - see AFCRootDirectory
/// - \p "org.devteam.utility"
/// (implemented as ??????)
///
/// The following are mentioned in \p Services.plist but the corresponding binaries
/// do not appear to be installed.
///
/// - \p "com.apple.purpletestr"
/// (implemented as /usr/libexec/PurpleTestr --lockdown --oneshot)
/// - \p "com.apple.mobile.diagnostics_relay"
/// (implemented as /usr/libexec/mobile_diagnostics_relay)
/// - \p "com.apple.mobile.factory_proxy"
/// (implemented as /usr/libexec/mobile_factory_proxy)
/// - \p "com.apple.mobile.software_update"
/// (implemented as /usr/libexec/software_update)
/// - \p "com.apple.mobile.system_profiler"
/// (implemented as /usr/sbin/system_profiler)
///
/// The Internet suggests that the following existed in the past:
/// - \p "com.apple.screenshotr"
/// or that its available IFF you are have the Developer disk image
/// mounted
@interface AMService : NSObject {
@protected
am_service _service;
NSString *_lasterror;
id _delegate;
}
/// The last error that occurred on this service
///
/// The object remembers the last error that occurred, which allows most other api's
/// to return YES/NO as their failure condition. If no error occurred,
/// this property will be nil.
@property (readonly) NSString *lasterror;
/// The delegate for this service. Whilst AMService does not use it directly,
/// some of the subclasses (like AMInstallationProxy) do. The delegate is
/// *not* retained - it is the callers responsibility to ensure it remains
/// valid for the life of the service.
@property (assign) id delegate;
@end
/// This class represents an installed application on the device. To retrieve
/// the list of installed applications on a device use [AMDevice installedApplications]
/// or one of the methods on AMInstallationProxy.
///
/// Information about an application is derived from and maintained in an internal
/// dictionary similar to the following:
/// <PRE>
/// ApplicationType = System;
/// CFBundleDevelopmentRegion = English;
/// CFBundleExecutable = MobileSafari;
/// CFBundleIdentifier = "com.apple.mobilesafari";
/// CFBundleInfoDictionaryVersion = "6.0";
/// CFBundlePackageType = APPL;
/// CFBundleResourceSpecification = "ResourceRules.plist";
/// CFBundleSignature = "????";
/// CFBundleSupportedPlatforms = ( iPhoneOS );
/// CFBundleURLTypes = (
/// {
/// CFBundleURLName = "Web site URL";
/// CFBundleURLSchemes = ( http, https );
/// }, {
/// CFBundleURLName = "Radar URL";
/// CFBundleURLSchemes = ( rdar, radar );
/// }, {
/// CFBundleURLName = "FTP URL";
/// CFBundleURLSchemes = ( ftp );
/// }, {
/// CFBundleURLName = "RSS URL";
/// CFBundleURLSchemes = ( feed, feeds );
/// }
/// );
/// CFBundleVersion = "528.16";
/// DTPlatformName = iphoneos;
/// DTSDKName = "iphoneos3.1.2.internal";
/// LSRequiresIPhoneOS = 1;
/// MinimumOSVersion = "3.1.2";
/// Path = "/Applications/MobileSafari.app";
/// PrivateURLSchemes = ( webclip );
/// SBIsRevealable = 1;
/// SBUsesNetwork = 3;
/// SafariProductVersion = "4.0";
/// UIHasPrefs = 1;
/// UIJetsamPriority = 75;
/// </PRE>
/// The contents of the dictionary are key-value coded in a manner that allows
/// NSPredicate to be used to filter applications.
/// For example, to locate all applications which use networking, you could use
/// <PRE>
/// [NSPredicate predicateWithFormat:@"SBUsesNetwork != nil"]
/// </PRE>
/// To locate hidden applications, you could use:
/// <PRE>
/// [NSPredicate predicateWithFormat:@"SBAppTags contains 'hidden'" ];
/// </PRE>
@interface AMApplication : NSObject {
@private
NSDictionary *_info;
NSString *_appname;
NSString *_bundleid;
}
/// Return the internal dictionary that contains all our information. Note that
/// the application may be incomplete since it is filtered by the attributes listed
/// in the applicationAttributes member of the AMDevice object.
- (NSDictionary*) info;
/// Return the name (usually) visible in the Springboard. To get the actual name
/// being displayed, use AMSpringboardServices getIconState method and search
/// using the AMApplication's bundleid.
- (NSString*) appname;
/// Return the CFBundleID value from
/// the applications Info.plist.
- (NSString*) bundleid;
/// Return the full pathname of the directory that
/// the .app file is installed in
- (NSString*) appdir;
@end
/// This class represents the com.apple.mobile.notification_proxy service
/// running on the device. It allows programs on the Mac to send simple
/// notifications to programs running on the device.
///
/// To create one, send the \p -newAMNotificationProxy message to an instance of AMDevice.
///
/// To receive notifications on the mobile device, add an observer to the
/// Darwin Notification Center as follows:
/// <pre>
/// static void gotNotification(
/// CFNotificationCenterRef center,
/// void *observer,
/// CFStringRef name,
/// const void *alwaysZero1,
/// CFDictionaryRef alwaysZero2)
/// {
/// ...
/// }
/// ...
/// CFNotificationCenterAddObserver(
/// CFNotificationCenterGetDarwinNotifyCenter(),
/// observer,
/// &gotNotification,
/// name, // eg, CFSTR("com.myapp.notification")
/// NULL,
/// 0 );
/// </pre>
///
/// Alternately, use the AMNotificationCenter class defined in
/// "MobileDeviceAccessIPhone.h"
///
/// Under the covers, it is implemented as a service called \p "com.apple.mobile.notification_proxy" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/notification_proxy
/// </PRE>
#if 0
https://gist.github.com/149443/6a40bf5cb9e47abe8a4b406c6396940e8a30dc7a suggests
com.apple.language.changed
com.apple.AddressBook.PreferenceChanged
com.apple.mobile.data_sync.domain_changed
com.apple.mobile.lockdown.device_name_changed
com.apple.mobile.developer_image_mounted
com.apple.mobile.lockdown.trusted_host_attached
com.apple.mobile.lockdown.host_detached
com.apple.mobile.lockdown.host_attached
com.apple.mobile.lockdown.phone_number_changed
com.apple.mobile.lockdown.registration_failed
com.apple.mobile.lockdown.activation_state
com.apple.mobile.lockdown.brick_state
com.apple.itunes-client.syncCancelRequest
com.apple.itunes-client.syncSuspendRequest
com.apple.itunes-client.syncResumeRequest
com.apple.springboard.attemptactivation
com.apple.mobile.application_installed
com.apple.mobile.application_uninstalled
#endif
@interface AMNotificationProxy : AMService {
@private
NSMutableDictionary *_messages;
}
/// Send the named notification to the
/// Darwin Notification Center on the device. Note that there is no
/// possibility to send any information with the notification.
/// @param notification
- (void)postNotification:(NSString*)notification;
/// Add an observer for a specific message. Whenever this message is
/// recieved by the proxy, it will be passed to all observers who
/// are registered, in an indeterminate order.
/// @param notificationObserver
/// @param notificationSelector
/// @param notificationName
- (void)addObserver:(id)notificationObserver
selector:(SEL)notificationSelector
name:(NSString *)notificationName;
/// Remove an observer for a specific message. Once this message
/// is processed, the \p notificationObserver object will no longer
/// recieve notifications.
/// @param notificationObserver
/// @param notificationName
- (void)removeObserver:(id)notificationObserver
name:(NSString *)notificationName;
/// Remove an observer for all messages.
/// @param notificationObserver
- (void)removeObserver:(id)notificationObserver;
@end
/// This class allows certain bits of information to be retrieved
/// from the springboard.
///
/// Under the covers, it is implemented as a service called \p "com.apple.springboardservices" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/springboardservicesrelay
/// </PRE>
@interface AMSpringboardServices : AMService {
}
/// This method seems to return an NSArray which contains one entry
/// per "page" on the iPod, though the first page appears to be for
/// the icons displayed in the dock.
///
/// Each page appears to be an NSArray of entries, each of which
/// describes an icon position on the page. Each icon is represented
/// by an NSDictionary containing the following keys
/// - bundleIdentifier = "com.apple.mobileipod";
/// - displayIdentifier = "com.apple.mobileipod-AudioPlayer";
/// - displayName = Music;
/// - iconModDate = 2009-09-26 20:45:29 +1000;
///
/// If a position is unoccupied, the entry will be an NSInteger (0)
/// The array for each page appears to be padded to a multiple of
/// 4, rather than reserving a full 16 entries per page.
- (id)getIconState;
/// This method returns an NSDictionary containing a single entry with
/// the key "pngData", which contains an NSData holding the .png data
/// for the requested application.
///
/// The key required appears to be the displayIdentifier rather than
/// the bundleIdentifier.
- (id)getIconPNGData:(NSString*)displayIdentifier;
/// This method returns an NSImage holding the icon .png data
/// for the requested application.
///
/// The key required appears to be the displayIdentifier rather than
/// the bundleIdentifier.
- (NSImage*)getIcon:(NSString*)displayIdentifier;
@end
/// This protocol describes the messages that will be sent by AMInstallationProxy
/// to its delegate.
@protocol AMInstallationProxyDelegate
@optional
/// A new current operation is beginning.
-(void)operationStarted:(NSDictionary*)info;
/// The current operation is continuing.
-(void)operationContinues:(NSDictionary*)info;
/// The current operation finished (one way or the other)
-(void)operationCompleted:(NSDictionary*)info;
@end
/// This class communicates with the mobile_installation_proxy. It can be used
/// to retrieve information about installed applications on the device (as well as other
/// installation operations that are not supported by this framework).
///
/// Under the covers, it is implemented as a service called \p "com.apple.mobile.installation_proxy" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/mobile_installation_proxy
/// </PRE>
/// That binary seems to vet the incoming requests, then pass them to the installd process
/// for execution.
///
/// The protocol also seems to be a one-shot. That is, you need to establish multiple connections
/// if you want to perform multiple operations.
///
/// See also: http://iphone-docs.org/doku.php?id=docs:protocols:installation_proxy
@interface AMInstallationProxy : AMService
/// Return an array of all installed applications (see AMApplication) matching the input type.
/// @param type may be "User", "System" or "Internal". If specified as \p nil, it is ignored
/// and all application types are returned.
///
/// This is used indirectly by [AMDevice installedApplications] which may be a more convenient
/// interface.
- (NSArray *)browse:(NSString*)type;
/// Returns an array of all installed applications (see AMApplication) that match the input predicate.
/// @param filter defines the conditions for accepting an application.
- (NSArray *)browseFiltered:(NSPredicate*)filter;
/// Return a dictionary (indexed by bundleid) of all installed applications (see AMApplication) matching the input type,
/// and optionally filtering those that have a specific attribute in their Info.plist.
/// @param type may be "User", "System", "Internal" or "Any"
/// @param attr can be any attribute (like CFBundlePackageType, etc). Note, however that
/// you can't filter on the value of the attribute, just its existance.
///
/// You probably don't want to use lookupType:withAttribute - see browseFiltered: instead.
- (NSDictionary*)lookupType:(NSString*)type
withAttribute:(NSString*)attr;
/// Ask the installation daemon on the device to create an archive of a specific
/// application. Once finished a corresponding
/// zip file will be present in the Media/ApplicationArchives directory where it could
/// be retrieved via AFCMediaDirectory.
/// The contents of the archive depends on the values of the container: and payload:
/// arguments.
/// If the uninstall: argument is YES, the application will also be uninstalled.
- (BOOL)archive:(NSString*)bundleid
container:(BOOL)container
payload:(BOOL)payload
uninstall:(BOOL)uninstall;
/// Ask the installation daemon on the device to restore a previously archived application.
/// The .zip file must be placed in the Media/ApplicationArchives directory.
- (BOOL)restore:(NSString*)bundleid;
/// Ask the installation daemon on the device what application archives are
/// available. Return an array of bundle ids which can be passed to functions
/// like restore:
- (NSArray*)archivedAppBundleIds;
/// Ask the installation daemon on the device what application archives are
/// available. Return a dictionary keyed by application bundle id.
///
/// This seems to be reading the file /var/mobile/Library/MobileInstallation/ArchivedApplications.plist
/// which is not otherwise accessible (except using AFCRootDirectory on jailbreaked devices)
- (NSDictionary*)archivedAppInfo;
/// Remove the archive for a given bundle id. Note that this is more than just removing
/// the .zip file from the Media/ApplicationArchives directory - if you do that, the
/// archive remains "known to" the installation daemon and future requests to archive
/// this bundle will fail. Sadly, explicit requests to removeArchive: will file if the
/// .zip file has been removed as well. (The simplest fix for this scenario is to create
/// a dummy file before calling removeArchive:)
- (BOOL)removeArchive:(NSString*)bundleid;
/// Ask the installation daemon on the device to install an application. pathname
/// must be the name of a directory located in /var/mobile/Media and must contain
/// a pre-expanded .app which must not already exist on the device
- (BOOL)install:(NSString*)pathname;
/// Ask the installation daemon on the device to upgrade an application. pathname
/// must be the name of a directory located in /var/mobile/Media and must contain
/// a pre-expanded .app which already exists on the device
- (BOOL)upgrade:(NSString*)bundleId from:(NSString*)pathname;
@end
/// This class communicates with the MobileSync service. There is a fairly complicated protocol
/// required.
///
/// Under the covers, it is implemented as a service called \p "com.apple.mobilesync" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/SyncAgent --lockdown --oneshot -v
/// </PRE>
@interface AMMobileSync : AMService
- (id)getContactData;
@end
/// This class communicates with the syslog_relay.
///
/// To create one, send \p -newAMSyslogRelay:\p message: to an instance of AMDevice.
///
/// The message must conform to the prototype
/// <PRE>
/// -(void)syslogMessageRead:(NSString*)line
/// </PRE>
///
/// Under the covers, it is implemented as a service called \p "com.apple.syslog_relay" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/syslog_relay --lockdown
/// </PRE>
@interface AMSyslogRelay : AMService {
CFReadStreamRef _readstream;
id _listener;
SEL _message;
}
@end
/// This class copies back specific files or sets of files from
/// the device, in CPIO file format. The file format is non-negotiable and individual files
/// cannot be requested. Instead, the caller specifies one or more "fileset names" from the
/// following table.
/// <TABLE>
/// <TR><TH>Set Name</TH><TH>File/Directory</TH></TR>
/// <TR><TD>AppleSupport</TD><TD>/private/var/logs/AppleSupport</TD></TR>
/// <TR><TD>Caches</TD><TD>/private/var/mobile/Library/Caches</TD></TR>
/// <TR><TD>CrashReporter</TD><TD>/Library/Logs/CrashReporter<BR>/private/var/mobile/Library/Logs/CrashReporter</TD></TR>
/// <TR><TD>MobileWirelessSync</TD><TD>/private/var/mobile/Library/Logs/MobileWirelessSync</TD></TR>
/// <TR><TD>Lockdown</TD><TD>/private/var/root/Library/Lockdown/activation_records
/// <BR>/private/var/root/Library/Lockdown/data_ark.plist
/// <BR>/private/var/root/Library/Lockdown/pair_records
/// <BR>/Library/Logs/lockdownd.log</TD></TR>
/// <TR><TD>MobileInstallation</TD><TD>/var/mobile/Library/Logs/MobileInstallation
/// <BR>/var/mobile/Library/Caches/com.apple.mobile.installation.plist
/// <BR>/var/mobile/Library/MobileInstallation/ArchivedApplications.plist
/// <BR>/var/mobile/Library/MobileInstallation/ApplicationAttributes.plist
/// <BR>/var/mobile/Library/MobileInstallation/SafeHarbor.plist</TD></TR>
/// <TR><TD>SafeHarbor</TD><TD>/var/mobile/Library/SafeHarbor</TD></TR>
/// <TR><TD>Network</TD><TD>/private/var/log/ppp</TD></TR>
/// <BR>/private/var/log/racoon.log
/// <BR>/var/log/eapolclient.en0.log</TD></TR>
/// <TR><TD>SystemConfiguration</TD><TD>/Library/Preferences/SystemConfiguration</TD></TR>
/// <TR><TD>UserDatabases</TD><TD>/private/var/mobile/Library/AddressBook</TD></TR>
/// <BR>/private/var/mobile/Library/Calendar
/// <BR>/private/var/mobile/Library/CallHistory
/// <BR>/private/var/mobile/Library/Mail/Envelope Index
/// <BR>/private/var/mobile/Library/SMS</TD></TR>
/// <TR><TD>VPN</TD><TD>/private/var/log/racoon.log</TD></TR>
/// <TR><TD>WiFi</TD><TD>/var/log/wifimanager.log
/// <BR>/var/log/eapolclient.en0.log</TD></TR>
/// <TR><TD>tmp</TD><TD>/private/var/tmp</TD></TR>
/// </TABLE>
/// The special fileset name "All" includes the files from all the other sets.
///
/// Due to the protocol used by the "com.apple.mobile.file_relay" service, the AMFileRelay
/// can only be used once and must be released afterward.
///
/// Under the covers, it is implemented as a service called \p "com.apple.mobile.file_relay" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/mobile_file_relay
/// </PRE>
@interface AMFileRelay : AMService {
bool _used;
}
/// Gets one or more filesets and writes the results to the nominated stream.
/// If a problem occurs during the request, the method returns NO and
/// lasterror will be set to an appropriate
/// error code / message.
/// - AlreadyUsed - AMFileRelay object has already been used
/// - InvalidSource - fileset name is invalid
/// - StagingEmpty - fileset contains no files to transfer
/// - CreateStagingPathFailed - failed to create temporary work directory on device
/// - CopierCreationFailed - BOMCopierNew() failed (on device)
/// - PopulationFailed - BOMCopierCopy() failed (on device)
- (bool)getFileSets:(NSArray*)set into:(NSOutputStream*)output;
/// Gets a single fileset and writes the result to the nominated stream. This is
/// a convenience wrapper around \p -getFileSets:
- (bool)getFileSet:(NSString*)name into:(NSOutputStream*)output;
@end
/// This class represents an open file on the device.
/// The caller can read from or write to the file depending on the
/// file open mode.
@interface AFCFileReference : NSObject
{
@private
afc_file_ref _ref;
afc_connection _afc;
NSString *_lasterror;
}
/// The last error that occurred on this file
///
/// The object remembers the last error that occurred, which allows most other api's
/// to return YES/NO as their failure condition. If no previous error occurred,
/// this property will be nil.
@property (readonly) NSString *lasterror;
/// Close the file.
/// Any outstanding writes are flushed to disk.
- (bool)closeFile;
/// Change the current position within the file.
/// @param offset is the number of bytes to move by
/// @param mode must be one of the following:
/// - \p SEEK_SET (0) - offset is relative to the start of the file
/// - \p SEEK_CUR (1) - offset is relative to the current position
/// - \p SEEK_END (2) - offset is relative to the end of the file
- (bool)seek:(int64_t)offset mode:(int)mode;
/// Return the current position within the file.
/// The position is suitable to be passed to \p seek: \p mode:SEEK_SET
- (bool)tell:(uint64_t*)offset;
/// Read \p n
/// bytes from the file into the nominated buffer (which must be at
/// least \p n bytes long). Returns the number of bytes actually read.
- (uint32_t)readN:(uint32_t)n bytes:(char *)buff;
/// Write \p n bytes to the file. Returns \p true if the write was
/// successful and \p false otherwise.
- (bool)writeN:(uint32_t)n bytes:(const char *)buff;
/// Write the contents of an NSData to the file. Returns \p true if the
/// write was successful and \p false otherwise
- (bool)writeNSData:(NSData*)data;
/// Set the size of the file
///
/// Truncates the file to the specified size.
- (bool)setFileSize:(uint64_t)size;
@end
/// This object manages a single file server connection to the connected device.
/// Using it, you can open files for reading or writing. It also provides higher-order
/// functions such as directory scanning, directory creation and file copying.
///
/// You should not use these directly. Instead, see AFCMediaDirectory, AFCApplicationDirectory
/// and AFCRootDirectory
@interface AFCDirectoryAccess : AMService
{
@protected
afc_connection _afc; ///< the low-level connection
}
/**
* Return a dictionary containing information about the connected device.
*
* Keys in the result dictionary include:
* - \p "Model"
* - \p "FSFreeBytes"
* - \p "FSBlockSize"
* - \p "FSTotalBytes"
*/
- (NSDictionary*)deviceInfo;
/**
* Return a dictionary containing information about the specified file.
* @param path Full pathname to the file to retrieve information for
*
* Keys in the result dictionary include:
* - \p "st_ifmt" - file type
* - \p "S_IFREG" - regular file
* - \p "S_IFDIR" - directory
* - \p "S_IFCHR" - character device
* - \p "S_IFBLK" - block device
* - \p "S_IFLNK" - symbolic link (see LinkTarget)
*
* - \p "st_blocks" - number of disk blocks occupied by file
*
* - \p "st_nlink" - number of "links" occupied by file
*
* - \p "st_size" - number of "bytes" in file
*
* - \p "LinkTarget" - target of symbolic link (only if st_ifmt="S_IFLNK")
*
* - \p "st_birthtime" - time that file was created
*
* - \p "st_mtime" - time that file was modified
*/
- (NSDictionary*)getFileInfo:(NSString*)path;
/**
* Return YES if the specified file/directory exists on the device.
* @param path Full pathname to file/directory to check
*/
- (BOOL)fileExistsAtPath:(NSString *)path;
/**
* Return a array containing a list of simple filenames found
* in the specified directory. The entries for "." and ".." are
* not included.
* @param path Full pathname to the directory to scan
*/
- (NSArray*)directoryContents:(NSString*)path;
/**
* Return a array containing a list of full pathnames found
* in the specified directory, and all subordinate directories.
* Entries for directories will end in "/"
* The entries for "." and ".." are not included.
* @param path Full pathname to the directory to scan
*/
- (NSArray*)recursiveDirectoryContents:(NSString*)path;
/**
* Open a file for reading.
* @param path Full pathname to the file to open
*/
- (AFCFileReference*)openForRead:(NSString*)path;
/**
* Open a file for writing.
* @param path Full pathname to the file to open
*/
- (AFCFileReference*)openForWrite:(NSString*)path;
/**
* Open a file for reading or writing.
* @param path Full pathname to the file to open
*/
- (AFCFileReference*)openForReadWrite:(NSString*)path;
/**
* Create a new directory on the device.
* @param path Full pathname of the directory to create
*/
- (BOOL)mkdir:(NSString*)path;
/**
* Unlink a file or directory on the device. If a directory is specified, it must
* be empty.
* @param path Full pathname of the directory to delete
*/
- (BOOL)unlink:(NSString*)path;
/**
* Rename a file or directory on the device.
* @param oldpath Full pathname of file or directory to rename
* @param newpath Full pathname to rename file or directory to
*/
- (BOOL)rename:(NSString*)oldpath to:(NSString*)newpath;
/**
* Create a hard link on the device.
* @param linkname Full pathname of link to create
* @param target Target of link
*/
- (BOOL)link:(NSString*)linkname to:(NSString*)target;
/**
* Create a symbolic link on the device.
* @param linkname Full pathname of symbolic link to create
* @param target Target of symbolic link
*/
- (BOOL)symlink:(NSString*)linkname to:(NSString*)target;
/**
* Set file modification time for a file on the device
* @param pathname Full pathname of file to modify
* @param timestamp Time to set it's modification time to
*/
- (BOOL)setmodtime:(NSString*)pathname to:(NSDate*)timestamp;
/**
* Copy the contents of a local file or directory (on the Mac) to
* a directory on the device. The copy is recursive (for directories)
* and will copy symbolic links as links.
* @param frompath Full pathname of the local file/directory
* @param topath Full pathname of the device directory to copy into
*/
- (BOOL)copyLocalFile:(NSString*)frompath toRemoteDir:(NSString*)topath;
/**
* Copy the contents of a local file (on the Mac) to the device.
* @param frompath Full pathname of the local file
* @param topath Full pathname of the device file to copy into
*/
- (BOOL)copyLocalFile:(NSString*)frompath toRemoteFile:(NSString*)topath;
/**
* Copy the contents of a device file to a file on the Mac.
* @param frompath Full pathname of the device file
* @param topath Full pathname of the local file to copy into
*/
- (BOOL)copyRemoteFile:(NSString*)frompath toLocalFile:(NSString*)topath;
/**
* Close this connection. From this point on, none of the other functions
* will run correctly.
*/
- (void)close;
@end
/// This class represents an AFC connection that is rooted to the devices
/// Media directory (/var/mobile/Media).
///
/// To create one, send the \p -newAFCMediaDirectory message to an instance of AMDevice.
///
/// Under the covers, it is implemented as a service called \p "com.apple.afc" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/afcd --lockdown -d /var/mobile/Media -u mobile
/// </PRE>
///
/// Common subdirectories to access within the Media directory are:
/// - DCIM
/// - ApplicationArchives
/// - PublicStaging
@interface AFCMediaDirectory : AFCDirectoryAccess {
}
@end
/// This class represents an AFC connection that is rooted to the devices
/// crash-log directory (/var/mobile/Library/Logs/CrashReporter).
///
/// To create one, send the \p -newAFCCrashLogDirectory message to an instance of AMDevice.
///
/// Under the covers, it is implemented as a service called \p "com.apple.crashreportcopymobile" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/afcd --lockdown -d /var/mobile/Library/Logs/CrashReporter -u mobile
/// </PRE>
@interface AFCCrashLogDirectory : AFCDirectoryAccess {
}
@end
/// This class represents an AFC connection on a jail-broken device. It has
/// full access to the devices filesystem.
///
/// To create one, send the \p -newAFCRootDirectory message to an instance of AMDevice.
///
/// Note, instances of this class will only operate correctly on devices that are
/// running the \p "com.apple.afc2" service. If your device was jailbroken with
/// blackra1n this service may be missing in which case it can be installed via
/// Cydia.
///
/// Under the covers, it is implemented as a service called \p "com.apple.afc2" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/afcd --lockdown -d /
/// </PRE>
@interface AFCRootDirectory : AFCDirectoryAccess {
}
@end
/// This class represents an AFC connection that is rooted to a single
/// application's sandbox. You must know the \p CFBundleIdentifier value
/// from the application's \p Info.plist
///
/// To create one, send the \p -newAFCApplicationDirectory: message to an instance of AMDevice.
///
/// The current user will be 'mobile' and will only be able to
/// access files within the sandbox. The root directory will appear to contain
/// - the application
/// - Documents
/// - Library
/// - tmp
///
/// Under the covers, it is implemented as a service called \p "com.apple.mobile.house_arrest" which
/// executes the following command on the device:
/// <PRE>
/// /usr/libexec/mobile_house_arrest
/// </PRE>
@interface AFCApplicationDirectory : AFCDirectoryAccess {
}
@end
/// This class represents a connected device
/// (iPhone or iPod Touch).
@interface AMDevice : NSObject {
@private
am_device _device;
NSString *_lasterror;
NSString *_deviceName;
NSString *_udid;
NSArray *_applAttributes;
bool _connected, _insession;
}
/// The last error that occurred on this device
///
/// The object remembers the last error that occurred, which allows most other api's
/// to return YES/NO as their failure condition. If no previous error occurred,
/// this property will be nil.
@property (readonly) NSString *lasterror;
/// Returns the device name (the name visible in the Devices section
/// in iTunes and labelled as Name: in the Summary pane in iTunes).
///
/// The same value may be retrieved by passing \p "DeviceName" to \p -deviceValueForKey:
@property (readonly) NSString *deviceName; // configured name
/// Returns the 40 character UDID (the field labeled as Identifier: in the Summary pane
/// in iTunes - if its not visible, click the Serial Number: label).
///
/// The same value may be retrieved by passing \p "UniqueDeviceID" to \p -deviceValueForKey:
@property (readonly) NSString *udid; // "ed9896a213aa2341274928472234127492847211"
/// Specific class of device. eg, "iPod1,1"
///
/// The same value may be retrieved by passing
/// \p "ProductType" to \p -deviceValueForKey:
@property (readonly) NSString *productType; // eg, "iPod1,1"
/// General class of device. eg, "iPod"
///
/// The same value may be retrieved by passing
/// \p "DeviceClass" to \p -deviceValueForKey:
@property (readonly) NSString *deviceClass;
/// Returns the serial number (the field labeled as Serial Number: in the Summary pane
/// in iTunes - if its not visible, click the Identifier: label)
///
/// The same value may be retrieved by passing \p "SerialNumber" to \p -deviceValueForKey:
@property (readonly) NSString *serialNumber; // "5984999T14P"
/// Returns the array of attributes that will be requested for when using the
/// installedApplications method. If nil, we use a "reasonable set".
@property (retain) NSArray *applicationAttributes;
/// Create a file service connection which can access the media directory.
/// This uses the service \p "com.apple.afc" which is present on all devices
/// and only allows access to the \p "/var/mobile/Media" directory structure
/// as the user 'mobile'
- (AFCMediaDirectory*)newAFCMediaDirectory;
/// Create a file service connection which can access the crash log directory.
/// This uses the service \p "com.apple.crashreportcopymobile" which is present on all devices
/// and only allows access to the \p "/var/mobile/Library/Logs/CrashReporter" directory structure
/// as the user 'mobile'
- (AFCCrashLogDirectory*)newAFCCrashLogDirectory;
/// Create a file service connection rooted in the sandbox for the nominated
/// application. This uses the service \p "com.apple.mobile.house_arrest" which is
/// present on all devices
/// and only allows access to the applications directory structure
/// as the user 'mobile'
/// @param bundleId This is the identifier value for the application.
- (AFCApplicationDirectory*)newAFCApplicationDirectory:(NSString*)bundleId;
/// Create a file service connection which can access the entire file system.
/// This uses the service \p "com.apple.afc2" which is only present on
/// jailbroken devices (and may need to be added manually with Cydia if you used
/// blackra1n to jailbreak).
- (AFCRootDirectory*)newAFCRootDirectory;
/// Create a notification proxy service.
/// This allows notifications to be posted on the device.
- (AMNotificationProxy*)newAMNotificationProxy;
/// Create a springboard services relay.
/// This allows info about icons and png data to be retrieved
- (AMSpringboardServices*)newAMSpringboardServices;
/// Create an installation proxy relay.
/// If an object is passed for the delegate, it will be notified during some of the
/// operations performed by the proxy.
- (AMInstallationProxy*)newAMInstallationProxyWithDelegate:(id<AMInstallationProxyDelegate>)delegate;
/// Create a fileset relay. This can be used to en-masse extract certain groups
/// of information from the device. For more information, see AMFileRelay.
- (AMFileRelay*)newAMFileRelay;
/// Create an instance of AMSyslogRelay which will relay us message
/// from the syslog daemon on the device.
/// @param listener This object will be notified for every message
/// recieved by the relay service from the syslog daemon
/// @param message This is the message sent to the \p listener object.
- (AMSyslogRelay*)newAMSyslogRelay:(id)listener message:(SEL)message;
/// Create a mobile sync relay. Allows synchronisation of information
/// with the device. For more information, see AMMobileSync.
- (AMMobileSync*)newAMMobileSync;
/// Returns an informational value from the device's root domain.
/// @param key can apparently be any value from
/// the following:
/// <TABLE>
/// <TR><TH>Key</TH><TH>Typical value</TH></TR>
/// <TR><TD><TT>ActivationState</TT></TD><TD>"Activated"</TD></TR>
/// <TR><TD><TT>ActivationStateAcknowledged</TT></TD><TD>1</TD></TR>
/// <TR><TD><TT>BasebandBootloaderVersion</TT></TD><TD>"5.8_M3S2"</TD></TR>
/// <TR><TD><TT>BasebandVersion</TT></TD><TD>"01.45.00"</TD></TR>
/// <TR><TD><TT>BluetoothAddress</TT></TD><TD>?</TD></TR>
/// <TR><TD><TT>BuildVersion</TT></TD><TD>"7A341"</TD></TR>
/// <TR><TD><TT>DeviceCertificate</TT></TD><TD>lots of bytes</TD></TR>
/// <TR><TD><TT>DeviceClass</TT></TD><TD>"iPod"</TD></TR>
/// <TR><TD><TT>DeviceName</TT></TD><TD>"SmartArray"</TD></TR>
/// <TR><TD><TT>DevicePublicKey</TT></TD><TD>lots of bytes</TD></TR>
/// <TR><TD><TT>FirmwareVersion</TT></TD><TD>"iBoot-596.24"</TD></TR>
/// <TR><TD><TT>HostAttached</TT></TD><TD>1</TD></TR>
/// <TR><TD><TT>IntegratedCircuitCardIdentity</TT></TD><TD>?</TD></TR>
/// <TR><TD><TT>InternationalMobileEquipmentIdentity</TT></TD><TD>?</TD></TR>
/// <TR><TD><TT>InternationalMobileSubscriberIdentity</TT></TD><TD>?</TD></TR>
/// <TR><TD><TT>ModelNumber</TT></TD><TD>"MA627"</TD></TR>
/// <TR><TD><TT>PhoneNumber</TT></TD><TD>?</TD></TR>
/// <TR><TD><TT>ProductType</TT></TD><TD>"iPod1,1"</TD></TR>
/// <TR><TD><TT>ProductVersion</TT></TD><TD>"3.0"</TD></TR>
/// <TR><TD><TT>ProtocolVersion</TT></TD><TD>2</TD></TR>
/// <TR><TD><TT>RegionInfo</TT></TD><TD>"ZP/B"</TD></TR>
/// <TR><TD><TT>SBLockdownEverRegisteredKey</TT></TD><TD>0</TD></TR>
/// <TR><TD><TT>SIMStatus</TT></TD><TD>"kCTSIMSupportSIMStatusReady"</TD></TR>
/// <TR><TD><TT>SerialNumber</TT></TD><TD>"5282327"</TD></TR>
/// <TR><TD><TT>SomebodySetTimeZone</TT></TD><TD>1</TD></TR>