Welcome: Difference between revisions

From iPhone Development Wiki
(grammar)
m (Typo)
 
(94 intermediate revisions by 13 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
== Welcome to the iPhoneDevWiki ==
{{DISPLAYTITLE:{{FULLPAGENAME}}}}
[[File:Drill bits.jpg|right]]
 
<div>
<h1><span class="mw-headline" id="Welcome_to_the_iPhoneDevWiki">Welcome to the iPhone Development Wiki</span></h1>
Our goal is to share the sum of all human<ref> We'll make an exception for lawyers; they may submit too. Cf. http://wiki.creativecommons.org/Frequently_Asked_Questions#How_does_a_Creative_Commons_license_operate.3F: "Creative Commons licenses are expressed in three different formats: the Commons Deed (human-readable code), the Legal Code (lawyer-readable code); and the metadata (machine readable code)."</ref> knowledge about jailbroken iOS development. In other words, this is a collection of documentation written by developers to help each other write extensions (tweaks) for jailbroken iOS, and you're invited to learn from it and contribute to it too.
Our goal is to share the sum of all human<ref> We'll make an exception for lawyers; they may submit too. Cf. http://wiki.creativecommons.org/Frequently_Asked_Questions#How_does_a_Creative_Commons_license_operate.3F: "Creative Commons licenses are expressed in three different formats: the Commons Deed (human-readable code), the Legal Code (lawyer-readable code); and the metadata (machine readable code)."</ref> knowledge about jailbroken iOS development. In other words, this is a collection of documentation written by developers to help each other write extensions (tweaks) for jailbroken iOS, and you're invited to learn from it and contribute to it too.


What is this wiki for?
What is this wiki for?


* Information about using iOS [[frameworks]] (both public and [[PrivateFrameworks|private]]), [[SpringBoard.app|SpringBoard]], system [[daemons]] (for hooking and hacking), and classes in applications included with the system.
* Information about using iOS frameworks, system daemons (for hooking and hacking), and other iOS internals.
* Information about third-party libraries and extensions for developers ([[ActionMenu]], [[AppList]], [[Flipswitch]], [[IconSupport]], [[libactivator]], [[libhide]], [[libobjcipc]], [[libstatusbar]], [[PreferenceLoader]], etc.).
* Information about third-party libraries and extensions for developers.
* Lists of [[Open Source Projects]], [[Reverse Engineering Tools]], and other useful information for developers.
* Useful information for reverse engineers and tweak developers.
* Documentation about making preferences for extensions: [[PreferenceLoader]], [[PreferenceBundles]], [[Preferences specifier plist]], [[Preferences.framework]].
* Documentation about making [https://{{SERVERNAME}}/index.php/Category:Preferences preferences] for tweaks.
* Anything else about development for jailbroken iOS devices. (For other technical information about iOS, see [http://theiphonewiki.com The iPhone Wiki], which covers topics including jailbreak exploits, internal iOS systems, and iOS hardware details. [http://theiphonewiki.com/wiki/Up_to_Speed "Up to Speed"] is its getting-started page about learning about security research on iOS.)
* Anything else about development for jailbroken iOS devices.  


'''For iOS 8:''' '''[[Updating extensions for iOS 8]]'''.
<b>Feature Page: [[ Talk:Maintenance ]] </b>


'''Some iOS 7 articles:''' [[Updating extensions for iOS 7]], [[Debugging on iOS 7]], [[Downgrading iPhone 4 from iOS 7]], [[BiometricKit.framework]], [[TouchID]], [[UIBackdropView]], [[AVFlashlight]], [[SBAppSliderController]].
<b>We're currently in the process of some overdue site maintenance and upgrades. Check the above page for a running changelog</b>


'''Other new articles:''' [[Tweak DRM]], [[List of development blogs]], [[UIPeripheralHostView]], [[SBIconViewMap]], [[Kik]], [[LibPassword]], [[Active Developers]], [[WinterBoard]], [[iWidgets]], [[Daemons]], [[launchd]].
=== Other Community Resources ===


If you'd like to make a new article or improve an existing article, see [[Help:Editing]] for advice (and see [[#Editing this wiki]] for ideas). '''Articles you are invited to start''' (no need to write a comprehensive page, just get these articles started with your perspective): [[Using ARC in tweaks]] (pros and cons), [[Advice for new developers]] (handling support, criticism, pricing, marketing, and other challenges), [[Packaging]] (tools, control file tips, troubleshooting dpkg-deb errors), ''edit this page and add your idea here''.
* [https://theapplewiki.com/wiki/Main_Page The Apple Wiki] Topics including jailbreak exploits, internal iOS systems, and iOS hardware details.
* [http://theiphonewiki.com The iPhone Wiki] The legacy version of The Apple Wiki, which is no longer updated.
* [http://theiphonewiki.com/wiki/Up_to_Speed "Up to Speed"] is its getting-started page about learning about security research on iOS.
* [https://appledb.dev/ AppleDB] Apple Device Database
* [https://github.com/hack-different/apple-knowledge Apple Knowledge Repo] Repo conglomerating various sources on Apple Internal Systems.
 
<div>


== Getting started ==
== Getting started ==


New to developing for jailbroken devices? Welcome, it's fun and challenging! Hopefully you already have some experience with Objective-C. You will want to get familiar with [[MobileSubstrate|Cydia Substrate (formerly called MobileSubstrate)]] and [[Theos]], and you can study some [[Open Source Projects]] to see how existing tweaks work. See '''[[Getting Started]]''' and also take a look at [[Best Practices]] and [[MobileSubstrate Pitfalls]].
New to developing for jailbroken devices? Welcome, it's fun and challenging! Hopefully you already have some experience with Objective-C. You will want to get familiar with [[MobileSubstrate|Cydia Substrate (formerly called MobileSubstrate)]] and [[Theos]], and you can study some [[Open Source Projects]] to see how existing tweaks work. See '''[[Getting Started]]''' and also take a look at [[Best Practices]] and [[MobileSubstrate Pitfalls]]. If you're looking for a more thorough and sequential tutorial, take a look at the book ''[http://iosre.com/t/ios-app-reverse-engineering-the-worlds-1st-book-of-very-detailed-ios-app-reverse-engineering-skills/1117 iOS App Reverse Engineering]'' and its forum [http://bbs.iosre.com iOSRE].


'''How to ask for help:''' You can ask questions in the IRC channel [https://kiwiirc.com/client/irc.saurik.com/#iphonedev #iphonedev on irc.saurik.com] (where a bunch of developers hang out). IRC is an old-school chat system; if you don't already know how to use it, [[How to use IRC]] has details for you. There are also tags for [http://stackoverflow.com/questions/tagged/jailbreak "jailbreak"], [http://stackoverflow.com/questions/tagged/cydia "Cydia"], and [http://stackoverflow.com/questions/tagged/theos "Theos"] on Stack Overflow, a site for programming questions in general; feel free to ask there as well. (If you want to help answer questions, following [https://twitter.com/jailbreakdevqs @JailbreakDevQs] might be useful.) For non-development-related troubleshooting questions, try [http://www.jailbreakqa.com/ JailbreakQA] or [http://www.reddit.com/r/jailbreak/ /r/jailbreak].
'''[[Getting Help | How to ask for help]]:''' There are tags for [http://stackoverflow.com/questions/tagged/jailbreak "jailbreak"], [http://stackoverflow.com/questions/tagged/cydia "Cydia"], and [http://stackoverflow.com/questions/tagged/theos "Theos"] on Stack Overflow, a site for programming questions in general; feel free to ask there as well. On reddit, there's [http://www.reddit.com/r/jailbreakdevelopers/ /r/jailbreakdevelopers]. For non-development-related troubleshooting questions, try [http://www.reddit.com/r/jailbreak/ /r/jailbreak].
 
</div>
</div>


== Overview of contents ==
== Overview of contents ==


What are you looking for?
<div class="flex" style="
    flex-direction: row;
    display: flex;
    flex-wrap: nowrap;
    justify-content: flex-start;
">
<div style="width: 50%;">
=== Frameworks: ===
* {{fwlink|UIKit}}
* {{fwlink|GraphicsServices}}
* {{fwlink|AppSupport}}
* {{fwlink|BiometricKit}}
* {{fwlink|ChatKit}}
* {{fwlink|MobileWiFi}}
* '''''[[Frameworks|more »]]'''''
 
=== Applications: ===
* [[SpringBoard]]
* {{applink|Preferences}}
* {{applink|MobileSafari}}
* '''''[[:Category:Applications | more »]]'''''
 
=== System directories: ===
* [[Frameworks]]
* [[Internet Plug-Ins]]
* [[PreferenceBundles]]
* [[PrivateFrameworks]]
* '''''[[Template:Navbox_Library|more »]]'''''
 
=== Other parts of iOS: ===
* [[dyld_shared_cache]]
* [[Bluetooth]]
* [[CgBI file format]]
* [[Coprocessors]]
* [[Daemons]]
* [[Entitlements]]
* [[iOS Keyboard]]
* [[launchd]]
* [[NFC]]
* [[Notifications]]
* [[Seatbelt]]
 
=== By iOS Version ===
 
* '''New in iOS 17:''' [[Updating extensions for iOS 17]]
* '''New in iOS 15/16:''' [[Updating extensions for iOS 15/16]]
* '''New in iOS 14:''' [[Updating extensions for iOS 14]]
* '''New in iOS 13:''' [[Updating extensions for iOS 13]]
* '''New in iOS 12:''' [[Updating extensions for iOS 12]]
* '''New in iOS 11:''' [[Updating extensions for iOS 11]]
* '''New in iOS 10:''' [[Updating extensions for iOS 10]], [[ControlCenterUI.framework]], [[UserNotificationsUIKit.framework]].
* '''New in iOS 9:''' [[Updating extensions for iOS 9]], [[Updating extensions for iOS 9.3.3]], [[Breadcrumbs]].
* '''New in iOS 8:''' [[Updating extensions for iOS 8]], [[AssertionServices.framework]], [[SBSRestartRenderServerAction]], [[FBSSystemService]], [[UIAlertController]].
* '''New in iOS 7:''' [[Updating extensions for iOS 7]], [[Debugging on iOS 7]], [[Downgrading iPhone 4 from iOS 7]], [[BiometricKit.framework]], [[TouchID]], [[UIBackdropView]], [[AVFlashlight]], [[SBAppSliderController]].
* '''New in iOS 6:''' [[BackBoardServices.framework]], [[backboardd]], [[ChatKit.framework]], [[BKSProcessAssertion]].
* '''New in iOS 5:''' [[SBIconView]], [[CKMadridService]], [[SBAppContextHostManager]].
* '''New in iOS 4:''' [[SBAppSwitcherModel]].
 
</div>
<div style="width: 50%;">
 
=== Development tools: ===
* [[Theos]], [[Logos]], [[NIC]], [[Logify]]
* [[Reverse Engineering Tools]]
* [[Jailbreak Development Tools]]
* [[Preferences specifier plist]]
* [[SSH Over USB]]
* [[MobileSubstrate|Cydia Substrate (MobileSubstrate)]]
* [[debugserver|debugserver (remote debugging)]]
* [[ldid]]
* [[On-device toolchains]]
* [[Retrieving SDKs]]
* [[Xcode|Xcode &ndash; Bypass Provisioning Profile]]
 
=== Extensions: ===
* [[PreferenceLoader]]
* [[RocketBootstrap]]
* [[libactivator]]
* '''''[[:Category:Cydia_packages|more »]]'''''
 
=== Other articles about development: ===
* [[Getting Started]]
* [[Best Practices]]
* [[MobileSubstrate Pitfalls]]
* [[Open Source Projects]]
* [[Advice for new developers]]
* [[Cydia Store Integration]]
* [[Tweak DRM]]
* [[Code Signing]]
* [[Repository Management]]
* [[Packaging]]
* [[Crack prevention]]
* [[List of development blogs]]
* [[Using ARC in tweaks]]
* [[Career advice]]
 
</div>
</div>
 


* '''Frameworks''':
** {{fwlink|UIKit}} &bull; {{fwlink|GraphicsServices}} &bull; {{fwlink|AppSupport}} &bull; {{fwlink|BiometricKit}} &bull; {{fwlink|ChatKit}} &bull; {{fwlink|MobileWiFi}} &bull; '''''[[Template:Navbox Frameworks|more »]]'''''
* '''Applications''':
** {{applink|SpringBoard}} &bull; {{applink|Preferences}} &bull; {{applink|MobileSafari}} &bull; '''''[[Template:Navbox Applications|more »]]'''''
* '''Extensions''':
** [[ActionMenu]] &bull; [[AppList]] &bull; [[Cydget]] &bull; [[Flipswitch]] &bull; [[IconSupport]] &bull; [[LayerSnapshotter]] &bull; [[libactivator]] &bull; [[libhide]] &bull; [[libobjcipc]] &bull; [[libstatusbar]] &bull; [[PreferenceLoader]] &bull; [[WinterBoard]] &bull; '''''[[:Category:Cydia_packages|more »]]'''''
* '''System directories''':
** [[Frameworks]] &bull; [[Internet Plug-Ins]] &bull; [[PreferenceBundles]] &bull; [[PrivateFrameworks]] &bull; '''''[[Template:Navbox_Library|more »]]'''''
* '''Other parts of iOS''':
** [[Bluetooth]] &bull; [[CgBI file format]] &bull; [[Daemons]] &bull; [[dyld_shared_cache]] &bull; [[Entitlements]] &bull; [[launchd]] &bull; [[Notifications]] &bull; [[Seatbelt]] &bull; [[Coprocessors]]
* '''Development tools''':
** [[Cycript]] &bull; [[MobileSubstrate|Cydia Substrate (MobileSubstrate)]] &bull; [[debugserver|debugserver (remote debugging)]] &bull; [[Jailbreak Development Tools]] &bull; [[ldid]] &bull; [[On-device toolchains]] &bull; [[Reverse Engineering Tools]] &bull; [[Theos]], [[Logos]], [[NIC]], [[Logify]] &bull; [[Retrieving SDKs]] &bull; [[Xcode|Xcode &ndash; Bypass Provisioning Profile]] &bull; [[SSH Over USB]]
* '''Other articles about development''':
** [[Getting Started]] &bull; [[Best Practices]] &bull; [[MobileSubstrate Pitfalls]] &bull; [[Open Source Projects]] &bull; [[Updating extensions for iOS 7]] &bull; [[Debugging on iOS 7]] &bull; [[Cydia Store Integration]] &bull; [[Tweak DRM]] &bull; [[Code Signing]] &bull; [[Repository Management]] &bull; [[Crack prevention]] &bull; [[List of development blogs]]


Translated articles:  
Translated articles:  


* '''Français''': [[Main page/fr]] &bull; [[MobileSubstrate/fr]] &bull; [[SSH Over USB/fr]] &bull; [[UIFont/fr]] &bull; [[UIColor/fr]] &bull; [[ActorKit.framework/fr]] &bull; [[IOSOpenDev/fr]]
* '''Français''': [[Main page/fr]] &bull; [[MobileSubstrate/fr]] &bull; [[SSH Over USB/fr]] &bull; [[UIFont/fr]] &bull; [[UIColor/fr]] &bull; [[ActorKit.framework/fr]] &bull; [[IOSOpenDev/fr]]
* '''ไทย''': [[MobileSubstrate/th]] &bull; [[SSH Over USB/th]] &bull; [[SpringBoard.app/th]] &bull; [[UIColor/th]]
* '''ไทย''': [[SSH Over USB/th]] &bull; [[SpringBoard.app/th]] &bull; [[UIColor/th]]
* '''Deutsch''': [[Theos/de]]


<!-- {{Navbox Frameworks}}
<!-- {{Navbox Frameworks}}
{{Navbox Applications}} -->
{{Navbox Applications}} -->
<div class="flex" style="
    flex-direction: row;
    display: flex;
    flex-wrap: nowrap;
    justify-content: flex-start;
">
<div style="width: 50%;">


== Editing this wiki ==
== Editing this wiki ==


* If you have anything at all to contribute, feel free to do so!
* If you have anything at all to contribute, feel free to do so!
* An account is required to edit pages, but everyone is welcome to make an account. If you have trouble with the account creation process, or any questions about editing the wiki, please ask in #iphonedev on irc.saurik.com for help (see [[IRC]]).


Some ideas for information to contribute:
Some ideas for information to contribute:
Line 73: Line 177:
* Translate an existing article into a non-English language. Check out the list at [[Special:PopularPages]] for ideas about high-priority articles to translate, and then make a new page with this name format: <code>Article name/[language code]</code>. [http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3/languages/Names.php Here's the list of language codes.] For example: [[PreferenceLoader/de]] or [[Libactivator/sv]].
* Translate an existing article into a non-English language. Check out the list at [[Special:PopularPages]] for ideas about high-priority articles to translate, and then make a new page with this name format: <code>Article name/[language code]</code>. [http://svn.wikimedia.org/svnroot/mediawiki/trunk/phase3/languages/Names.php Here's the list of language codes.] For example: [[PreferenceLoader/de]] or [[Libactivator/sv]].


</div>
<div style="width: 50%;">
== Good Edit Candidates ==
If you're looking for some articles to work on that dont require a ton of in-depth RE, or are important yet woefully outdated, the following articles are good candidates:
* [[Jailbreak detection]]
* [[CATransition]]
* [[Code Signing]] - Not bad info, needs updated primary instructions for current year
* [[Notifications]] - Update with info about MuireyIPC, new pages, etc. 
* [[Best_Practices]]
* [[IOS Keyboard]] - Woefully outdated + no useful info
* [[IWidgets]] - Conglomerate and link to modern replacements.
</div>
</div>
----
----


<references />
<references />

Latest revision as of 15:05, 7 October 2023


Welcome to the iPhone Development Wiki

Our goal is to share the sum of all human[1] knowledge about jailbroken iOS development. In other words, this is a collection of documentation written by developers to help each other write extensions (tweaks) for jailbroken iOS, and you're invited to learn from it and contribute to it too.

What is this wiki for?

  • Information about using iOS frameworks, system daemons (for hooking and hacking), and other iOS internals.
  • Information about third-party libraries and extensions for developers.
  • Useful information for reverse engineers and tweak developers.
  • Documentation about making preferences for tweaks.
  • Anything else about development for jailbroken iOS devices.

Feature Page: Talk:Maintenance

We're currently in the process of some overdue site maintenance and upgrades. Check the above page for a running changelog

Other Community Resources

  • The Apple Wiki Topics including jailbreak exploits, internal iOS systems, and iOS hardware details.
  • The iPhone Wiki The legacy version of The Apple Wiki, which is no longer updated.
  • "Up to Speed" is its getting-started page about learning about security research on iOS.
  • AppleDB Apple Device Database
  • Apple Knowledge Repo Repo conglomerating various sources on Apple Internal Systems.

Getting started

New to developing for jailbroken devices? Welcome, it's fun and challenging! Hopefully you already have some experience with Objective-C. You will want to get familiar with Cydia Substrate (formerly called MobileSubstrate) and Theos, and you can study some Open Source Projects to see how existing tweaks work. See Getting Started and also take a look at Best Practices and MobileSubstrate Pitfalls. If you're looking for a more thorough and sequential tutorial, take a look at the book iOS App Reverse Engineering and its forum iOSRE.

How to ask for help: There are tags for "jailbreak", "Cydia", and "Theos" on Stack Overflow, a site for programming questions in general; feel free to ask there as well. On reddit, there's /r/jailbreakdevelopers. For non-development-related troubleshooting questions, try /r/jailbreak.

Overview of contents

Frameworks:

Applications:

System directories:

Other parts of iOS:

By iOS Version


Translated articles:


Editing this wiki

  • If you have anything at all to contribute, feel free to do so!

Some ideas for information to contribute:

  • Add more projects to the list of Open Source Projects, or fill out details on that page.
  • Expand Getting Started for new developers - what do they need to know before beginning? How do they set up a development environment on OS X, Windows, and Linux? What are common beginner's mistakes that they should watch out for? How to reverse-engineer parts of iOS for writing tweaks? How to debug with GDB and learn about memory management?
  • Update articles that haven't been significantly edited in a few years, such as Seatbelt and Crack prevention. See Special:AncientPages for a list of articles that haven't been updated recently.
  • Help Cycript explain why Cycript is fun - syntax highlighting, injection, auto-completion, generally exploring around.
  • Make a page that documents a class or framework you're familiar with.
  • If you've developed a library that other developers can use or write addons/plugins/extensions for, make a page that documents your project.
  • Update Xcode with better information about how to build apps for jailbroken devices.
  • Make the homepage more useful! For example, add links to good pages that are hidden/buried deep within the wiki.
  • The following articles are linked from nowhere in the wiki: Special:LonelyPages - you can fix that by linking them somewhere.
  • Check out the most popular pages and see if they need updating: Special:PopularPages.
  • Write an article that is in demand: Special:WantedPages.
  • Translate an existing article into a non-English language. Check out the list at Special:PopularPages for ideas about high-priority articles to translate, and then make a new page with this name format: Article name/[language code]. Here's the list of language codes. For example: PreferenceLoader/de or Libactivator/sv.

Good Edit Candidates

If you're looking for some articles to work on that dont require a ton of in-depth RE, or are important yet woefully outdated, the following articles are good candidates:


  1. We'll make an exception for lawyers; they may submit too. Cf. http://wiki.creativecommons.org/Frequently_Asked_Questions#How_does_a_Creative_Commons_license_operate.3F: "Creative Commons licenses are expressed in three different formats: the Commons Deed (human-readable code), the Legal Code (lawyer-readable code); and the metadata (machine readable code)."