ios_config_profile 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4267630f92b93647afd9e12bbde39f59b125aaaa
-  data.tar.gz: 080df555388eb95780ec2db2cc3945c5ade5383c
+  metadata.gz: 484593ccd957488fd9f9c9724007abc5ce862a04
+  data.tar.gz: 2cb6e494c411616491387468da5dc7a11a779470
 SHA512:
-  metadata.gz: ad828932f801a0e5fd70d912b956e014ec9b64fb04afc76149f1b7afb537633ee131386cc79a184625ecc92535677958ca94ea2767f25c55f5f758b19a39512d
-  data.tar.gz: cdf06afed6fdab690ed6d73b7f5dbc6045566dfe689f86cf3e94f1c23935272fad433bb51e0ad826820447ce5b3fc75ccf3e421127dc1cc401a5457bce7d7ecb
+  metadata.gz: 7c3ff5e780b454ac27be0cefa1f0a2c51afbe2412e4868a360a119e1258320d3aab90f0a385fff084d8b44f900e5171af2269cfd45158c98aa72fe0ae4cb3f5b
+  data.tar.gz: 24c22198fb46cc69497e1dd97a41aa8a963034473c399ba9159477b30106951403a2e08f8b8dbb330a16ef8b57625de3e2604736f0408d040f9fa7c9ff3e6ace

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.4.0 (2016-02-07)
+
+Features
+
+ - Add installation and usage information to README
+ - Remove hardcoded references to Cellabus
+ - Bring test coverage to 100%
+
 ## 1.3.0 (2016-01-24)
 
 Features

data/README.md

@@ -1,15 +1,40 @@
-# ios_config_profile
+# IOSConfigProfile
 
+[![Gem Version](https://badge.fury.io/rb/ios_config_profile.svg)](https://badge.fury.io/rb/ios_config_profile)
 [ ![Codeship Status for cellabus/ios_config_profile](https://codeship.com/projects/78639f70-c12a-0132-6290-3eb2295b72b3/status?branch=master)](https://codeship.com/projects/73471)
 [![Dependency Status](https://gemnasium.com/cellabus/ios_config_profile.svg)](https://gemnasium.com/cellabus/ios_config_profile)
 [![Code Climate](https://codeclimate.com/github/cellabus/ios_config_profile/badges/gpa.svg)](https://codeclimate.com/github/cellabus/ios_config_profile)
 [![Test Coverage](https://codeclimate.com/github/cellabus/ios_config_profile/badges/coverage.svg)](https://codeclimate.com/github/cellabus/ios_config_profile/coverage)
+[![security](https://hakiri.io/github/cellabus/ios_config_profile/master.svg)](https://hakiri.io/github/cellabus/ios_config_profile/master)
 
 Gem for creating and manipulating Apple Configuration Profiles and Mobile
 Device Management (MDM) Protocols
 
-# Usage
-TODO
+## Installation
+
+Add this to your Gemfile
+
+```ruby
+gem 'ios-cert-enrollment', git: 'https://github.com/cellabus/ios-cert-enrollment'
+gem 'ios_config_profile'
+```
+
+This gem requires IOSCertEnrollment.  The [rubygems version](https://rubygems.org/gems/ios-cert-enrollment) works
+but it is highly recommended to use an [updated version](https://github.com/cellabus/ios-cert-enrollment).
+
+## Usage
+
+Apple Configuration Profiles are Property List (plist) files a type of XML file.
+The plist gem converts hashes into plist files.
+
+For a given configuration profile, you can initialize the class and export it
+into a plist string.  For example:
+
+```ruby
+payload = IOSConfigProfile::InstallBookPayload.new '12345'
+payload = payload.to_command_payload
+```
+
+## Development
 
-# Development
 To run tests - `bundle exec rspec`

data/lib/ios_config_profile.rb

@@ -1,5 +1,6 @@
 require "ios-cert-enrollment"
 require "ios_config_profile/version"
+require "ios_config_profile/base"
 require "ios_config_profile/basic_payload"
 require "ios_config_profile/command_payload"
 require "ios_config_profile/encrypted_payload"

data/lib/ios_config_profile/base.rb

@@ -0,0 +1,19 @@
+module IOSConfigProfile
+  @@root_domain = 'com.cellabus'
+
+  def self.root_domain= x
+    @@root_domain = x
+  end
+  def self.root_domain
+    @@root_domain
+  end
+
+  @@organization = 'Cellabus, Inc.'
+
+  def self.organization= x
+    @@organization = x
+  end
+  def self.organization
+    @@organization
+  end
+end

data/lib/ios_config_profile/content/install_doc_payload.rb

@@ -20,7 +20,7 @@ module IOSConfigProfile
         "MediaType" => "Book",
         "Kind" => "pdf",
         "Title" => name,
-        "PersistentID" => "com.cellabus.files.#{filepicker_url}",
+        "PersistentID" => "#{IOSConfigProfile.root_domain}.files.#{filepicker_url}",
       }
     end
   end

data/lib/ios_config_profile/content/remove_doc_payload.rb

@@ -16,7 +16,7 @@ module IOSConfigProfile
       {
         "RequestType" => "RemoveMedia",
         "MediaType" => "Book",
-        "PersistentID" => "com.cellabus.files.#{doc_url}",
+        "PersistentID" => "#{IOSConfigProfile.root_domain}.files.#{doc_url}",
       }
     end
   end

data/lib/ios_config_profile/content/web_clip_payload.rb

@@ -22,14 +22,14 @@ module IOSConfigProfile
           "Icon" => StringIO.new(icon),
           "IsRemovable" => false,
           "PayloadType" => "com.apple.webClip.managed",
-          "PayloadIdentifier" => "com.cellabus.webclip",
+          "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.webclip",
           "PayloadDescription" => "Add home screen website bookmark",
           "PayloadUUID" => uuid,
           "PayloadVersion" => 1,
         }],
         "PayloadType" => "Configuration",
-        "PayloadDisplayName" => "Cellabus Web Clip",
-        "PayloadIdentifier" => "com.cellabus.config.mdm.#{SecureRandom.urlsafe_base64}",
+        "PayloadDisplayName" => "#{IOSConfigProfile.organization} Web Clip",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.config.mdm.#{SecureRandom.urlsafe_base64}",
         "PayloadUUID" => uuid,
         "PayloadVersion" => 1,
       }

data/lib/ios_config_profile/device/app_lock_payload.rb

@@ -17,14 +17,14 @@ module IOSConfigProfile
         "PayloadContent" => [{
           "App" => { "Identifier" => app_bundle_id },
           "PayloadType" => "com.apple.app.lock",
-          "PayloadIdentifier" => "com.cellabusapplock.profile.mdm",
+          "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}applock.profile.mdm",
           "PayloadDescription" => "Lock device to an app",
           "PayloadUUID" => uuid,
           "PayloadVersion" => 1,
         }],
         "PayloadType" => "Configuration",
-        "PayloadDisplayName" => "Cellabus App Lock",
-        "PayloadIdentifier" => "com.cellabusapplock.profile.mdm",
+        "PayloadDisplayName" => "#{IOSConfigProfile.organization} App Lock",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}applock.profile.mdm",
         "PayloadUUID" => uuid,
         "PayloadVersion" => 1,
       }

data/lib/ios_config_profile/device/dep_payload.rb

@@ -18,10 +18,10 @@ module IOSConfigProfile
     def dep_payload
       {
         "PayloadContent" => [mdm_payload, security_payload],
-        "PayloadDescription" => "Cellabus MDM Enrollment Profile",
-        "PayloadDisplayName" => "Cellabus MDM Enrollment Profile",
-        "PayloadIdentifier" => "com.cellabus.mdm.enrollment.profile",
-        "PayloadOrganization" => "Cellabus, Inc.",
+        "PayloadDescription" => "#{IOSConfigProfile.organization} MDM Enrollment Profile",
+        "PayloadDisplayName" => "#{IOSConfigProfile.organization} MDM Enrollment Profile",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.mdm.enrollment.profile",
+        "PayloadOrganization" => IOSConfigProfile.organization,
         "PayloadRemovalDisallowed" => false,
         "PayloadType" => "Configuration",
         "PayloadUUID" => uuid,

data/lib/ios_config_profile/device/mdm_payload.rb

@@ -30,10 +30,10 @@ module IOSConfigProfile
 
         "PayloadType" => "com.apple.mdm",
         "PayloadVersion" => 1,
-        "PayloadIdentifier" => "com.cellabusipcu.profile.mdm",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}ipcu.profile.mdm",
         "PayloadDisplayName" => "Mobile Device Management",
         "PayloadDescription" => "Configures Mobile Device Management",
-        "PayloadOrganization" => "Cellabus, Inc.",
+        "PayloadOrganization" => IOSConfigProfile.organization,
       }
     end
   end

data/lib/ios_config_profile/device/restrictions_payload.rb

@@ -125,7 +125,7 @@ module IOSConfigProfile
     def add_boilerplate(payload)
       content = {
         "PayloadType" => "com.apple.applicationaccess",
-        "PayloadIdentifier" => "com.cellabus.restrictions",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.restrictions",
         "PayloadDescription" => "Restrict device capabilities",
         "PayloadUUID" => uuid,
         "PayloadRemovalDisallowed" => true,
@@ -134,8 +134,8 @@ module IOSConfigProfile
       {
         "PayloadContent" => [content],
         "PayloadType" => "Configuration",
-        "PayloadDisplayName" => "Cellabus Device Restrictions",
-        "PayloadIdentifier" => "com.cellabus.config.mdm.#{SecureRandom.urlsafe_base64}",
+        "PayloadDisplayName" => "#{IOSConfigProfile.organization} Device Restrictions",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.config.mdm.#{SecureRandom.urlsafe_base64}",
         "PayloadUUID" => uuid,
         "PayloadVersion" => 1,
       }

data/lib/ios_config_profile/device/scep_payload.rb

@@ -15,7 +15,7 @@ module IOSConfigProfile
     def security_payload
       {
         "URL" => url,
-        # 'Name' => 'Cellabus SCEP Payload',
+        # 'Name' => '#{IOSConfigProfile.organization} SCEP Payload',
         # 'Subject' => '',
         # 'Challenge' => '',
         # 'Keysize' => 1024,
@@ -24,10 +24,10 @@ module IOSConfigProfile
 
         "PayloadType" => "com.apple.security.scep",
         "PayloadVersion" => 1,
-        "PayloadIdentifier" => "com.cellabus.profile.scep",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.profile.scep",
         "PayloadDisplayName" => "Security",
         "PayloadDescription" => "Provides device authentication (certificate or identity).",
-        "PayloadOrganization" => "",
+        "PayloadOrganization" => IOSConfigProfile.organization,
       }
     end
   end

data/lib/ios_config_profile/device/security_payload.rb

@@ -22,10 +22,10 @@ module IOSConfigProfile
 
         "PayloadType" => "com.apple.security.pkcs12",
         "PayloadVersion" => 1,
-        "PayloadIdentifier" => "com.cellabusipcu.profile.credential",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}ipcu.profile.credential",
         "PayloadDisplayName" => "Security",
         "PayloadDescription" => "Provides device authentication (certificate or identity).",
-        "PayloadOrganization" => "Cellabus, Inc.",
+        "PayloadOrganization" => IOSConfigProfile.organization,
       }
     end
   end

data/lib/ios_config_profile/device/vpn_payload.rb

@@ -17,7 +17,7 @@ module IOSConfigProfile
       {
         "PayloadContent" => [{
           "PayloadType" => "com.apple.vpn.managed",
-          "PayloadIdentifier" => "com.cellabus.vpn",
+          "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.vpn",
           "PayloadDescription" => "Set up VPN networking access",
           "PayloadUUID" => uuid,
           "PayloadVersion" => 1,
@@ -29,8 +29,8 @@ module IOSConfigProfile
           "VendorConfig" => get_vendor_config,
         }],
         "PayloadType" => "Configuration",
-        "PayloadDisplayName" => "Cellabus VPN Configuration",
-        "PayloadIdentifier" => "com.cellabus.vpn",
+        "PayloadDisplayName" => "#{IOSConfigProfile.organization} VPN Configuration",
+        "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}.vpn",
         "PayloadUUID" => uuid,
         "PayloadVersion" => 1,
       }

data/lib/ios_config_profile/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module IOSConfigProfile
-  VERSION = "1.3.0".freeze
+  VERSION = "1.4.0".freeze
 end

data/spec/base_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe IOSConfigProfile do
+  context '@@root_domain' do
+    after :all do
+      IOSConfigProfile.root_domain = 'com.cellabus'
+    end
+
+    it 'has a root domain' do
+      expect(IOSConfigProfile.root_domain).to eq 'com.cellabus'
+    end
+
+    it 'can set a root_domain' do
+      example = 'com.example'
+      IOSConfigProfile.root_domain = example
+      expect(IOSConfigProfile.root_domain).to eq example
+    end
+  end
+
+  context '@@organization' do
+    after :all do
+      IOSConfigProfile.organization = 'Cellabus, Inc.'
+    end
+
+    it 'has an organization' do
+      expect(IOSConfigProfile.organization).to eq 'Cellabus, Inc.'
+    end
+
+    it 'can set an organization' do
+      example = 'example'
+      IOSConfigProfile.organization = example
+      expect(IOSConfigProfile.organization).to eq example
+    end
+  end
+end

data/spec/content/remove_doc_payload_spec.rb

@@ -6,7 +6,7 @@ describe IOSConfigProfile::RemoveDocPayload do
   describe "#initialize" do
     it "must be initialized with a doc's url" do
       payload = subject.new "1234"
-      expect(payload["PersistentID"]).to eq "com.cellabus.files.1234"
+      expect(payload["PersistentID"]).to eq "#{IOSConfigProfile.root_domain}.files.1234"
       expect { subject.new nil }.to raise_error RuntimeError
     end
     it "has required payload values" do

data/spec/content/web_clip_payload_spec.rb

@@ -5,7 +5,7 @@ describe IOSConfigProfile::WebClipPayload do
 
   it "contains valid Configuration entries" do
     expect(subject["PayloadType"]).to eq "Configuration"
-    expect(subject["PayloadDisplayName"]).to eq "Cellabus Web Clip"
+    expect(subject["PayloadDisplayName"]).to eq "#{IOSConfigProfile.organization} Web Clip"
   end
 
   it "contains valid PayloadContent" do

data/spec/device/app_lock_payload_spec.rb

@@ -11,7 +11,7 @@ describe IOSConfigProfile::AppLockPayload do
     end
     it "has required payload values" do
       payload = subject.new "1234"
-      expect(payload["PayloadIdentifier"]).to eq "com.cellabusapplock.profile.mdm"
+      expect(payload["PayloadIdentifier"]).to eq "#{IOSConfigProfile.root_domain}applock.profile.mdm"
       expect(payload["PayloadContent"][0]["PayloadType"]).to eq "com.apple.app.lock"
     end
     it "has a uuid" do

data/spec/device/mdm_payload_spec.rb

@@ -16,10 +16,10 @@ describe IOSConfigProfile::MDMPayload do
 
       "PayloadType" => "com.apple.mdm",
       "PayloadVersion" => 1,
-      "PayloadIdentifier" => "com.cellabusipcu.profile.mdm",
+      "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}ipcu.profile.mdm",
       "PayloadDisplayName" => "Mobile Device Management",
       "PayloadDescription" => "Configures Mobile Device Management",
-      "PayloadOrganization" => "Cellabus, Inc.",
+      "PayloadOrganization" => IOSConfigProfile.organization,
     }
   end
   let(:url) { "https://example.com" }

data/spec/device/security_payload_spec.rb

@@ -9,10 +9,10 @@ describe IOSConfigProfile::SecurityPayload do
 
       "PayloadType" => "com.apple.security.pkcs12",
       "PayloadVersion" => 1,
-      "PayloadIdentifier" => "com.cellabusipcu.profile.credential",
+      "PayloadIdentifier" => "#{IOSConfigProfile.root_domain}ipcu.profile.credential",
       "PayloadDisplayName" => "Security",
       "PayloadDescription" => "Provides device authentication (certificate or identity).",
-      "PayloadOrganization" => "Cellabus, Inc.",
+      "PayloadOrganization" => IOSConfigProfile.organization,
     }
   end
 

data/spec/device/vpn_payload_spec.rb

@@ -35,6 +35,10 @@ describe IOSConfigProfile::VPNPayload do
     subject { IOSConfigProfile::VPNPayload.new config }
     it "raises errors for unimplemented vpn types" do
       subject.send :get_vendor_config
+      subject.vpn_config[:vpn_type] = "PPTP"
+      expect { subject.send :get_vendor_config }.to raise_error NotImplementedError
+      subject.vpn_config[:vpn_type] = "IKEv2"
+      expect { subject.send :get_vendor_config }.to raise_error NotImplementedError
       subject.vpn_config[:vpn_type] = "AlwaysOn"
       expect { subject.send :get_vendor_config }.to raise_error NotImplementedError
       subject.vpn_config[:vpn_type] = "asdf"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ios_config_profile
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Albert Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -128,6 +128,7 @@ files:
 - Rakefile
 - ios_config_profile.gemspec
 - lib/ios_config_profile.rb
+- lib/ios_config_profile/base.rb
 - lib/ios_config_profile/basic_payload.rb
 - lib/ios_config_profile/command_payload.rb
 - lib/ios_config_profile/content/install_application_payload.rb
@@ -156,6 +157,7 @@ files:
 - lib/ios_config_profile/device/vpn_payload.rb
 - lib/ios_config_profile/encrypted_payload.rb
 - lib/ios_config_profile/version.rb
+- spec/base_spec.rb
 - spec/basic_payload_spec.rb
 - spec/command_payload_spec.rb
 - spec/content/install_application_payload_spec.rb
@@ -211,6 +213,7 @@ summary: This gem provides an easy way to generate configuration profiles for us
   with Apple iOS devices. These profiles and payloads can be delivered via Apple MDM,
   Apple's Configurator, or the iPhone Configuration Utility (IPCU).
 test_files:
+- spec/base_spec.rb
 - spec/basic_payload_spec.rb
 - spec/command_payload_spec.rb
 - spec/content/install_application_payload_spec.rb