Difference between revisions of "RocketBootstrap"

From iPhone Development Wiki
Jump to: navigation, search
m (Added Library navbox.)
m (CFMessagePort Example: Improved example.)
 
(7 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
'''RocketBootstrap''' is a library that solves a denied lookup error of [[IPC]] services on iOS 7 and above<ref>[http://iphonedevwiki.net/index.php/Updating_extensions_for_iOS_7#Inter-process_communication Updating extensions for iOS 7 - Inter-process communication]</ref>.
 
'''RocketBootstrap''' is a library that solves a denied lookup error of [[IPC]] services on iOS 7 and above<ref>[http://iphonedevwiki.net/index.php/Updating_extensions_for_iOS_7#Inter-process_communication Updating extensions for iOS 7 - Inter-process communication]</ref>.
  
''"One common way processes communicate with each other on iOS and OS X is through a messaging system called mach ports. Each port is a channel that can either receive or send messages. There is a central registration system for these ports called bootstrap, where ports can be registered and accessed by a service name assigned to them. Recent versions of iOS restrict which names a process can access—MobileMail, MobileSafari and App Store apps are only allowed to access a very specific set of services that come with iOS. RocketBootstrap adds a secondary lookup service that doesn't restrict which processes can access which services."''
+
''"One common way processes communicate with each other on iOS and OS X is through a messaging system called mach ports. Each port is a channel that can either receive or send messages. There is a central registration system for these ports called bootstrap, where ports can be registered and accessed by a service name assigned to them. Recent versions of iOS restrict which names a process can access—MobileMail, MobileSafari and App Store apps are only allowed to access a very specific set of services that come with iOS. RocketBootstrap adds a secondary lookup service that doesn't restrict which processes can access which services."'' <ref>[https://www.reddit.com/r/jailbreak/comments/1tv0qw/activator_182_rc1_released_with_rocketbootstrap/cebqh9p rpetrich's reddit post for RocketBootstrap's release]</ref>
  
 
== How to use this library ==
 
== How to use this library ==
Line 32: Line 32:
 
* <code>, com.rpetrich.rocketbootstrap (>= 1.0.2) | firmware (<< 7.0)</code> to the <code>Depends</code> field.
 
* <code>, com.rpetrich.rocketbootstrap (>= 1.0.2) | firmware (<< 7.0)</code> to the <code>Depends</code> field.
  
== Example Usage ==
+
== LightMessaging example ==
 +
 
 +
See [[LightMessaging]].
 +
 
 +
== CPDistributedMessagingCenter Example ==
  
 
Make sure you have the <tt>CPDistributedMessagingCenter</tt> interface declared.
 
Make sure you have the <tt>CPDistributedMessagingCenter</tt> interface declared.
Line 39: Line 43:
  
 
<source lang="objc">
 
<source lang="objc">
CPDistributedMessagingCenter *c = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
+
@interface MYMessagingCenter : NSObject {
// apply rocketbootstrap regardless of iOS version (via rpetrich)
+
CPDistributedMessagingCenter * _messagingCenter;
rocketbootstrap_distributedmessagingcenter_apply(c);
+
}
[c runServerOnCurrentThread];
+
@end
[c registerForMessageName:@"myMessageName" target:myTarget selector:@selector(handleMessageNamed:withUserInfo:)];
+
 
 +
@implementation MYMessagingCenter
 +
 
 +
+ (void)load {
 +
[self sharedInstance];
 +
}
 +
 
 +
+ (instancetype)sharedInstance {
 +
static dispatch_once_t once = 0;
 +
__strong static id sharedInstance = nil;
 +
dispatch_once(&once, ^{
 +
sharedInstance = [self new];
 +
});
 +
return sharedInstance;
 +
}
 +
 
 +
- (instancetype)init {
 +
if ((self = [super init])) {
 +
_messagingCenter = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
 +
// apply rocketbootstrap regardless of iOS version (via rpetrich)
 +
rocketbootstrap_distributedmessagingcenter_apply(_messagingCenter);
 +
 
 +
[_messagingCenter runServerOnCurrentThread];
 +
[_messagingCenter registerForMessageName:@"myMessageName" target:self selector:@selector(handleMessageNamed:withUserInfo:)];
 +
}
 +
 
 +
return self;
 +
}
 +
 
 +
- (NSDictionary *)handleMessageNamed:(NSString *)name withUserInfo:(NSDictionary *)userInfo {
 +
return [NSDictionary dictionaryWithObjectsAndKeys:@"key", @"object", nil];
 +
}
 +
 
 +
@end
 
</source>
 
</source>
  
Line 49: Line 86:
  
 
<source lang="objc">
 
<source lang="objc">
CPDistributedMessagingCenter *c = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
+
static CPDistributedMessagingCenter *c = nil;
rocketbootstrap_distributedmessagingcenter_apply(c);
+
 
[c sendMessageName:@"myMessageName" userInfo:nil]; //send an NSDictionary here to pass data
+
%ctor {
 +
c = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
 +
rocketbootstrap_distributedmessagingcenter_apply(c);
 +
 
 +
// Send a message with no dictionary
 +
[c sendMessageName:@"myMessageName" userInfo:nil];
 +
 
 +
// Send a message with a dictionary
 +
NSDictionary * message = [NSDictionary dictionaryWithObjectsAndKeys: @"key", @"object", nil];
 +
[c sendMessageName:@"myMessageName" userInfo:message];
 +
 
 +
// Send a message with no dictionary and receive a reply dictionary
 +
NSDictionary * reply = [c sendMessageAndReceiveReplyName:@"myMessageName" userInfo:nil];
 +
 
 +
// Send a message with a dictionary and receive a reply dictionary
 +
NSDictionary * replyWithMessage = [c sendMessageAndReceiveReplyName:@"myMessageName" userInfo:message];
 +
}
 +
</source>
 +
 
 +
== CFMessagePort Example ==
 +
 
 +
(Pilfered from [http://nshipster.com/inter-process-communication/ the NSHipster article on IPC])
 +
 
 +
=== Server ===
 +
 
 +
<source lang="objc">
 +
static CFDataRef Callback(CFMessagePortRef port,
 +
                          SInt32 messageID,
 +
                          CFDataRef data,
 +
                          void *info)
 +
{
 +
    // ...
 +
}
 +
 
 +
%ctor {
 +
    static CFMessagePortRef localPort =
 +
        CFMessagePortCreateLocal(nil,
 +
                                CFSTR("com.example.app.port.server"),
 +
                                Callback,
 +
                                nil,
 +
                                nil);
 +
 
 +
    CFRunLoopSourceRef runLoopSource =
 +
        CFMessagePortCreateRunLoopSource(nil, localPort, 0);
 +
 
 +
    CFRunLoopAddSource(CFRunLoopGetCurrent(),
 +
                      runLoopSource,
 +
                      kCFRunLoopCommonModes);
 +
 
 +
    rocketbootstrap_cfmessageportexposelocal(localPort);
 +
}
 +
</source>
 +
 
 +
=== Client ===
 +
 
 +
<source lang="objc">
 +
void doStuff() {
 +
    CFDataRef data;
 +
    SInt32 messageID = 0x1111; // Arbitrary
 +
    CFTimeInterval timeout = 10.0;
 +
 
 +
    CFMessagePortRef remotePort =
 +
        rocketbootstrap_cfmessageportcreateremote(nil,
 +
                                  CFSTR("com.example.app.port.client"));
 +
 
 +
    SInt32 status =
 +
        CFMessagePortSendRequest(remotePort,
 +
                                messageID,
 +
                                data,
 +
                                timeout,
 +
                                timeout,
 +
                                NULL,
 +
                                NULL);
 +
 
 +
    if (status == kCFMessagePortSuccess) {
 +
        // ...
 +
    }
 +
}
 
</source>
 
</source>
  
 
== Usage notes ==
 
== Usage notes ==
  
If you want to run a server inside a daemon, then you still need a simple SpringBoard tweak, that just has to call bootstrap_unlock with the service name (take the code from the rocket bootstrap header and include bootstrap.h). Then you can run a server with the same name inside your daemon. rocketbootstrap_distributedmessagingcenter_apply must still be called on both the server and on the clients. It even works for sendMessageAndReceiveReplyName.
+
If you want to run a server inside a daemon, then you still need a simple SpringBoard tweak, that just has to call <code>rocketbootstrap_unlock</code> with the service name. Then you can run a server with the same name inside your daemon.
  
 
You shouldn't be registering Mach services in sandboxed apps; RocketBootstrap allows exposing services ''to'' sandboxed apps, but can't allow exposing services ''from'' sandboxed apps without exposing a very large security flaw.
 
You shouldn't be registering Mach services in sandboxed apps; RocketBootstrap allows exposing services ''to'' sandboxed apps, but can't allow exposing services ''from'' sandboxed apps without exposing a very large security flaw.

Latest revision as of 22:42, 7 March 2019

RocketBootstrap
Cydia Package
Developer Ryan Petrich
Package ID com.rpetrich.rocketbootstrap
Latest Version 1.0.2


RocketBootstrap is a library that solves a denied lookup error of IPC services on iOS 7 and above[1].

"One common way processes communicate with each other on iOS and OS X is through a messaging system called mach ports. Each port is a channel that can either receive or send messages. There is a central registration system for these ports called bootstrap, where ports can be registered and accessed by a service name assigned to them. Recent versions of iOS restrict which names a process can access—MobileMail, MobileSafari and App Store apps are only allowed to access a very specific set of services that come with iOS. RocketBootstrap adds a secondary lookup service that doesn't restrict which processes can access which services." [2]

How to use this library

Headers are available from RocketBootstrap's GitHub project and the library can be found at /usr/lib/librocketbootstrap.dylib on a device where RocketBootstrap is installed. If using Theos, place the headers in $THEOS/include/RocketBootstrap, the library in $THEOS/lib/.

Include directive

#import <rocketbootstrap/rocketbootstrap.h>

Makefile

Add to your Makefile:

  • rocketbootstrap to the XXX_LIBRARIES variable.
  • AppSupport to the XXX_PRIVATE_FRAMEWORKS variable.

Packaging

Add to your package's control file:

  • , com.rpetrich.rocketbootstrap (>= 1.0.2) | firmware (<< 7.0) to the Depends field.

LightMessaging example

See LightMessaging.

CPDistributedMessagingCenter Example

Make sure you have the CPDistributedMessagingCenter interface declared.

Server inside a SpringBoard tweak

@interface MYMessagingCenter : NSObject {
	CPDistributedMessagingCenter * _messagingCenter;
}
@end

@implementation MYMessagingCenter

+ (void)load {
	[self sharedInstance];
}

+ (instancetype)sharedInstance {
	static dispatch_once_t once = 0;
	__strong static id sharedInstance = nil;
	dispatch_once(&once, ^{
		sharedInstance = [self new];
	});
	return sharedInstance;
}

- (instancetype)init {
	if ((self = [super init])) {
		_messagingCenter = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
		// apply rocketbootstrap regardless of iOS version (via rpetrich)
		rocketbootstrap_distributedmessagingcenter_apply(_messagingCenter);

		[_messagingCenter runServerOnCurrentThread];
		[_messagingCenter registerForMessageName:@"myMessageName" target:self selector:@selector(handleMessageNamed:withUserInfo:)];
	}

	return self;
}

- (NSDictionary *)handleMessageNamed:(NSString *)name withUserInfo:(NSDictionary *)userInfo {
	return [NSDictionary dictionaryWithObjectsAndKeys:@"key", @"object", nil];
}

@end

Client from sandboxed app

static CPDistributedMessagingCenter *c = nil;

%ctor {
	c = [CPDistributedMessagingCenter centerNamed:@"com.mycompany.myCenter"];
	rocketbootstrap_distributedmessagingcenter_apply(c);

	// Send a message with no dictionary
	[c sendMessageName:@"myMessageName" userInfo:nil];

	// Send a message with a dictionary
	NSDictionary * message = [NSDictionary dictionaryWithObjectsAndKeys: @"key", @"object", nil];
	[c sendMessageName:@"myMessageName" userInfo:message];

	// Send a message with no dictionary and receive a reply dictionary
	NSDictionary * reply = [c sendMessageAndReceiveReplyName:@"myMessageName" userInfo:nil];

	// Send a message with a dictionary and receive a reply dictionary
	NSDictionary * replyWithMessage = [c sendMessageAndReceiveReplyName:@"myMessageName" userInfo:message];
}

CFMessagePort Example

(Pilfered from the NSHipster article on IPC)

Server

static CFDataRef Callback(CFMessagePortRef port,
                          SInt32 messageID,
                          CFDataRef data,
                          void *info)
{
    // ...
}

%ctor {
    static CFMessagePortRef localPort =
        CFMessagePortCreateLocal(nil,
                                 CFSTR("com.example.app.port.server"),
                                 Callback,
                                 nil,
                                 nil);

    CFRunLoopSourceRef runLoopSource =
        CFMessagePortCreateRunLoopSource(nil, localPort, 0);

    CFRunLoopAddSource(CFRunLoopGetCurrent(),
                       runLoopSource,
                       kCFRunLoopCommonModes);

    rocketbootstrap_cfmessageportexposelocal(localPort);
}

Client

void doStuff() {
    CFDataRef data;
    SInt32 messageID = 0x1111; // Arbitrary
    CFTimeInterval timeout = 10.0;

    CFMessagePortRef remotePort =
        rocketbootstrap_cfmessageportcreateremote(nil,
                                  CFSTR("com.example.app.port.client"));

    SInt32 status =
        CFMessagePortSendRequest(remotePort,
                                 messageID,
                                 data,
                                 timeout,
                                 timeout,
                                 NULL,
                                 NULL);

    if (status == kCFMessagePortSuccess) {
        // ...
    }
}

Usage notes

If you want to run a server inside a daemon, then you still need a simple SpringBoard tweak, that just has to call rocketbootstrap_unlock with the service name. Then you can run a server with the same name inside your daemon.

You shouldn't be registering Mach services in sandboxed apps; RocketBootstrap allows exposing services to sandboxed apps, but can't allow exposing services from sandboxed apps without exposing a very large security flaw.

Assuming there aren't any security problems, actually calling a service that's running inside of an app from SpringBoard (which is usually what people want to do) is problematic. Backgrounding apps causes them to enter a frozen "SIGSTOP" state, which means any calls to the service running inside of the app will block indefinitely.

Even if that is suppressed, it could happen that the SpringBoard part attempts to call the service running in the app at the same time as the app is trying to call any of the usual SpringBoard services. When that happens, they deadlock. This might happen infrequently, but it's a really bad failure case in that the system just hangs. Real users will encounter it, if it's present.

You can call from a background thread (not good, it could stay alive for a long time), or use timeouts (not good, now you have to tune it and you get UI hitches) or use asynchronous code (not bad, but it's more work than you may be willing to go through).

See also

References

External links