Sample iOS MDM server
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 4 commits ahead of project-imas:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client-reporting
images
references
scripts
server
vendor @ f3565f5
.gitignore
.gitmodules
README.md

README.md

Overviewanalytics

Instructions and code for setting up a simple iOS Mobile Device Management (MDM) server. MDM allows for OS level control of multiple devices from a centralized location. A remote administrator can install/remove apps, install/revoke certificates, lock the device, change password requirements, etc.

Prerequisites

  • Publicly accessible Linux/Unix server
  • Apple Enterprise Account
  • Apple Developer Account
  • Python 2.7 (See Server Setup for libraries)
  • openssl command-line
  • Java SDK (java/javac)
  • Apple's iPhone Configuration Utility

Setup

  1. Create MDM Vendor CSR

    • Open Keychain Access.
    • Go to the menu bar: Keychain Access -> Certificate Assistant -> Request a Certificate From a Certificate Authority.
    • Use the same email as the developer account that will be used. Enter in a common name as well.
    • Select Saved to disk.
  2. Upload CSR to Apple

    • Go to Apple's Certificates, Identifiers & Profiles page.
    • Select MDM CSR under Production. If this option is disabled, you will need to contact apple to enable it. You can either email apple at devprograms@apple.com or go through the online contact menu. In your message, indicate that you are looking to create an MDM Vendor Certificate and need the MDM CSR option enabled on the certificate creation page. Apple should respond within one business day according to their contact page.
    • When you have the MDM CSR option available, select it and hit continue. Hit continue again through Apple's description of how to create a CSR file (we already have one).
    • Upload the .certSigningRequest file we created in step 1 and then hit generate. A .cer file should be downloaded. Name it something like mdmvendor.cer.
  3. Export MDM private key

    • Open your mdmvendor.cer file in Keychain Access.
    • Select Certificates from the left side.
    • You should find your certificate listed as MDM Vendor: Common Name.
    • There should be an arrow on that line that opens up show the MDM private key.
    • Right-click the private key, select Export..., and save as private.p12
    • Remember where you save this file, we will use it in step 5.
  4. Create Push Certificate CSR

    • In Keychain Access, again select from the menu bar: Keychain Access -> Certificate Assistant -> Request a Certificate From a Certificate Authority.
    • Enter your email (can be a different email) and a common name.
    • Select Saved to disk and name it something like push.csr.
  5. Extract MDM private key and MDM Vendor Certificate

    • Extract private key using the following command:

    openssl pkcs12 -in private.p12 -nocerts -out key.pem

    • Strip the password from the private key using the following command:

    openssl rsa -in key.pem out private.key

    • Extract certificate using the following command:

    openssl pkcs12 -in private.p12 -clcerts -nokeys -out cert.pem

    • Convert certificate to DES using the following command:

    openssl x509 -in cert.pem -inform PEM -out mdm.cer -outform DES

    • These files will be used in the next step.
  6. Use the mdmvendorsign tool to create applepush.csr

    • We're going to use the python code located in /vendor/. If /vendor/ is currently empty, you probably forgot to init and update submodules

    git submodule init git submodule update

    • Copy private.key, push.csr, and mdm.cer into /vendor/

    • Run the following command while in that directory:

    python mdm_vendorpython mdm_vendor_sign.py –key private.key –csr push.csr –mdm mdm.cer –out applepush.csr

    • This should generate applepush.csr.
  7. Get Push Certificate from Apple

    • Go to Apple's Push Certificates Portal and click the Create a Certificate button.
    • Upload applepush.csr to create a new entry in the table.
    • Download the resulting push certificate.
    • Open the push certificate in Keychain Access.
  8. Prepare Push Certificate

    • Find the push certificate in Keychain Access. It should look like APSP:hexstuffhere.
    • Right-click the certificate and select Get Info.
    • Copy down the User ID which should look like com.apple.mgmt.External.hexstuffhere... We will use it later on in step 9.
    • Right-click the certificate and select Export... and save it as mdm.p12
    • Run the following command to convert it to a pem file:

    openssl pkcs12 -in mdm.p12 -out PushCert.pem -nodes

    • Move the resulting PushCert.pem file to /server/
  9. Generate additional certs

    • Go to the scripts directory and run make_certs.sh.
    • This will generate a number of necessary certs to move forward.
    • Certs will be automatically moved to their proper location in /server.
    • We'll use identity.p12 in step 10 to create an Enroll.mobileconfig file
  10. Create Enroll.mobileconfig * Open the iPhone Configuration Utilities program, select Configuration Profiles, and then click the New button. * In the General category: Pick a name to identify the cert. For Identifier, use the com.apple.mgmt.External.hexstuffhere that you copied down earlier. * In the Credentials category, click configure and find your scripts/identity.p12 file generated in step 9. For password, we either use the PEM password or the export password - if the profile does not install, try the other option. Please leave feedback with which worked. * For Mobile Device Management:

    • Server URL: https://YOUR_HOSTNAME_OR_IP:8080/server
    • Check In URL: https://YOUR_HOSTNAME_OR_IP:8080/checkin
    • Topic: com.apple.mgmt... string (same as General->Identifier)
    • Identity: identity.p12
    • Sign messages: Checked
    • Check out when removed: Unchecked
    • Query device for: Check all that you want
    • Add / Remove: Check all that you want
    • Security: Check all that you want
    • Use Development APNS server: Uncheck * When done, click Export. Choose None for security and then Export.... * Save the file as Enroll. You will now have an Enroll.mobileconfig file - move it to the /server directory.
  11. Cleanup * Any additional files that are not in /server/ generated during this process are not necessary for running the server. Some of them may have/be private keys or other unique information, so it is probably a good idea to protect or destroy those files. * Most certs will be located in the /scripts/ folder. There may be some generated from Keychain Access that were saved by the user and may be saved elsewhere. * Please secure these files and prevent others from being able to access them.

NOTE: UPDATING CERTIFICATE INSTRUCTIONS - WORK IN PROGRESS

Server Setup

The server code is based on and heavily takes from Intrepidus Group's blackhat presentation. Copy over the mdm-server/server directory you put the enrollment profile and certificates in to your server.

You must have the following installed on the server:

  • Openssl
    • Recommend downloading and compiling yourself
    • Some Debian-based distros disable features needed by M2Crypto
    • Source available at http://www.openssl.org/source/
  • Python 2.7, with the following libraries
    • web.py

    • M2Crypto

    • PyOpenSSL

    • APNSWrapper

      • APNSWrapper appears to be inactive
      • On 22 October 2014, Apple removed support for SSLv3, which APNSWrapper uses, due to the poodle vulnerability
      • As a temporary solution, users need to edit line 131 of connections.py of the source code of APNSWrapper
      • Change "SSLv3" to "TLSv1", so that the line reads:
        ssl_version = self.ssl_module.PROTOCOL_TLSv1,
      • After making the change, users should install the library using:
        python setup.py install
      • More information will follow as we find a better solution

Network Settings

  • Outbound access to gateway.push.apple.com:2195
  • Inbound access to port 8080
  • iOS device must also have outbound access to gateway.push.apple.com:5223

If everything is setup appropriately, simply navigate to the /server directory and run python server.py.

On the device navigate to: https://YOUR_HOST:8080/ Once there you need to, in order:

  1. Tap here to install the CA Cert (for Server/Identity)
  2. Tap here to enroll in MDM (the device should appear after this step)
  3. Select Command (DeviceLock is a good one to test) and check your device. Click Submit to send the command.
  4. If everything works, the device should lock and you're good to go! As of right now some of the commands aren't fully implemented. Feel free to experiment with different commands!

Device Enrollment Steps

You can now run those commands from any web browser, a successfull command will often looks something like the following:


Command Success

Click the "Response" button to see the plist response from apple. Click the pencil to edit the device name, device owner, and device location.

When stopping the server, the standard control-c doesn't usually work. Instead use control-z to suspend the process and then use a kill command to end the process.

^z
[1]+  Stopped                 python server.py
user:~/mdm-server/server$ kill %1
[1]+  Terminated              python server.py
user:~/mdm-server/server$ 

The server uses the pickle library to save devices. When the device class is updated, the pickle format may be invalidated, causing the server to error. In order to fix this, remove the devicelist.pickle file (make a backup just in case!) and re-enroll all devices.

Client Reporting

The MDM server also has REST endpoints for reporting issues and geolocation data from the enrolled clients. This functionality may be used at a later point in time by a security app. The API can be imported into any project as follows:

  • Click on the top level Project item and add files ("option-command-a")
  • Navigate to client-reporting/
  • Highlight the client-reporting subdirectory
  • Click the Add button

The library provides the following functions:

+(void) setHostAddress: (NSString*) host; // Set where the MDM server lives
+(void) setPause : (BOOL) toggle; // Toggle whether to add a thread execution pause to allow requests to finish
+(void) reportJailbreak;  // Report that the device has been jailbroken
+(void) reportDebugger; // Report that the application has a debugger attached
+(void) reportLocation : (CLLocationCoordinate2D*) coords; // Report the lat/lon location of the device

"setHostAddress" and "setPause" are meant to be set once only, and effect all "report" calls. An example usage may look like:

// Code in application init
[client_reporting setHostAddress:@"192.168.0.0"];
[client_reporting setPause:YES];

// Later code during execution
[client_reporting reportDebugger]

This client API can be coupled with the iMAS security-check controls to provide accurate reporting of jailbreak and debugger detection.

Apologies for the long and complex setup, we hope to eventually make things easier and simpler. Please post questions to github if you get stuck and we'll do our best to help. Enjoy!

LICENSE AND ATTRIBUTION

Copyright 2013-2014 The MITRE Corporation, All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This project also uses code from various sources under various licenses.

The original code from the Intrepidus Group's python server is under the BSD License found here.

The python vendor signing code is located here and is under the MIT license.

The Softhinker certificate signing code is under the Apache License found here.

The website's Bootstrap code is under the MIT License found here.

The certificate setup instructions were based on this blog post. Our thanks to Daniel.

Finally we use some free glyphicons that are included with bootstrap.