panes 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c27a4bafb78b8558831d8c2ac57112893220b7c
-  data.tar.gz: 1b486182db4cd059de77597adeecf97b6b67cc8d
+SHA256:
+  metadata.gz: b0343768815d21efa34dd48f1b8e2f4fe55afa1b2e87f58f4292882c09ddc7ce
+  data.tar.gz: be2bec29919621870e04b1ecb6e466211ffc07758c1c5524ae0f230703deeec2
 SHA512:
-  metadata.gz: 8378d0dca7f5dfce37bf6e79a668df7662644e10f97f1db9d86e3dcf199b98297ea8b145819188f65e972cfe9729d1b6c81c254190b25b8f7a5595c7d5a2d92a
-  data.tar.gz: e8128bbcc4cc5b49a4af072b217bc856ff959249277a25bcc4aeb8ec4d9ecf60b1674f8c7d1b74818212e944cc349176eb5d11f4a60186f05dea2839f2f296e7
+  metadata.gz: 882a169cc5c179193a85222328ece70e71380af402f34b3de8617c89a2ccae6492c41f4eaf4d3a59b11b5f692d170a7204d3383c017867d90008b543a78d16bb
+  data.tar.gz: e8d3f861d9a8940b69f5515965b47e4e07fc52b43a07867a7cdc61b868414c6d3b9e526d604b44132f9e9d617f52d8a44c591006041edc3f11df3671aa1b2b22

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in panes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nic Scott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# A ruby gem to disable or enable system preference panes for macOS
+
+Version .0.2.0 was tested on macOS 10.14. It may or may not work on other OS versions.
+
+Version .0.1.2 was tested on macOS 10.12. It may or may not work on other OS versions.
+
+For more usage see this
+[blog post](https://redlinetech.wordpress.com/2017/06/21/disable-system-preference-panes-in-macos/)
+
+<img src="https://redlinetech.files.wordpress.com/2017/06/disabled.png?w=625">
+##### To install:
+```bash
+sudo gem install panes
+```
+
+##### To verify:
+```bash
+gem list
+```
+
+---
+## Usage:
+
+Panes requires **sudo** access to read and write to the main plist file. You can run commands in two ways. From a ruby interactive shell, or running a ruby script directly from the command line.
+
+##### Example 1: IRB
+
+```ruby
+sudo irb
+require 'panes'
+Panes.Disable("com.apple.preference.network")
+```
+
+
+
+##### Eaxmple 2: Run a ruby script from terminal
+
+Put your commands in a ruby file and run it via the terminal. Example, create a file named "test-command.rb"
+
+test-command.rb:
+
+```ruby
+#!//usr/bin/ruby
+
+require 'panes'
+Panes.Disable("com.apple.preference.network")
+```
+Run the command from terminal:
+```bash
+sudo ruby test-command.rb
+```
+
+
+
+You must require 'panes' in your ruby file. Then you can run the command below to see all your options.
+
+```ruby
+Panes.Options
+```
+This will return:
+> - CFBundleIdentifier
+> - CreateProfile
+> - Disable
+> - Enable
+> - List
+> - OptionalCFBundleIdentifier
+> - Options
+> - Reset
+
+---
+
+# Examples ...
+
+#### List CFBundleIdentifiers:
+
+```ruby
+puts Panes.CFBundleIdentifier
+```
+CFBundleIdentifier is a string usually in reverse DNS format, that specifies the specific app type of the bundle. Used in macOS to specify Applications.
+
+---
+#### Create a new "com.apple.systempreferences.plist":
+```ruby
+Panes.CreateProfile
+```
+If the file "/Library/Preferences/com.apple.systempreferences.plist" doesn't exist, it will be created.
+
+There's no real reason to run this independently, it's used internally when the file isn't found.
+
+---
+#### Disable a Preference Pane:
+
+The heart of this gem is the Disable method. It takes a specific CFBundleIdentifier or multiple CFBundleIdentifiers.
+
+##### examples:
+```ruby
+#to disable one Pane
+Panes.Disable("com.apple.preference.network")
+```
+```ruby
+#to disable multiple Panes, use comma separated list
+Panes.Disable(
+ "com.apple.preference.network",
+ "com.apple.preferences.Bluetooth")
+```
+
+---
+#### Enable a Preference Pane:
+```ruby
+Panes.Enable("com.apple.preference.network")
+```
+If you decide to enable a pane after it's been disable.
+
+---
+#### List all Preference Panes:
+```ruby
+Panes.List
+```
+you'll get a list of available preference panes:
+> - Accounts.prefPane
+> - Appearance.prefPane
+> - AppStore.prefPane
+> - Bluetooth.prefPane
+> - and so forth ....
+
+---
+#### List Optional Preference Panes:
+```ruby
+puts Panes.OptionalCFBundleIdentifier
+```
+These are usually Panes that have been installed by a user like Adobe Flash or Oracle Java
+
+  ##### example:
+> - com.adobe.flashplayerpreferences
+> - com.oracle.java.JavaControlPanel
+
+---
+#### List options:
+```ruby
+Panes.Options
+```
+Prints available methods
+
+---
+#### Reset all changes:
+```ruby
+Panes.Reset
+```
+This enables all panes and deletes the "/Library/Preferences/com.apple.systempreferences.plist" file

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "panes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/panes/version.rb

@@ -0,0 +1,3 @@
+module Panes
+  VERSION = "0.3.0"
+end

data/lib/panes.rb

@@ -0,0 +1,171 @@
+
+
+require 'CFPropertyList'
+require 'FileUtils'
+
+module Panes
+  #======================================================================
+	# Variables
+
+	PATHTOPLIST="/System/Library/PreferencePanes"
+	PreferencePanes=Dir.entries("#{PATHTOPLIST}")
+
+	# Print .prePanes in /System/Library/PreferencePanes folder
+	def self.List
+		list_of_panes=[]
+		PreferencePanes.each do |prePane|
+			if !prePane.start_with?(".")
+				list_of_panes << prePane
+			end
+		end
+		puts list_of_panes
+	end
+
+	#print CFBundleIdentifier for each item in /System/Library/PreferencePanes folder
+	def self.CFBundleIdentifier
+		list_of_panes=[]
+		PreferencePanes.each do |prePane|
+			if !prePane.start_with?(".")
+				list_of_panes << prePane
+			end
+		end
+
+		final_list=[]
+		list_of_panes.each do |prePane|
+			plist = CFPropertyList::List.new(:file => "#{PATHTOPLIST}/#{prePane}/Contents/Info.plist")
+			results=CFPropertyList.native_types(plist.value)
+			final_list << results["CFBundleIdentifier"]
+		end
+		return final_list
+	end
+
+	#print CFBundleIdentifier for items installed by the user, typical installs would be flash or java
+	def self.OptionalCFBundleIdentifier
+		optionalpanes=Dir.entries("/Library/PreferencePanes")
+
+		list_of_panes=[]
+		optionalpanes.each do |prePane|
+			if !prePane.start_with?(".")
+				list_of_panes << prePane
+			end
+		end
+
+		final_list=[]
+		list_of_panes.each do |prePane|
+			plist = CFPropertyList::List.new(:file => "/Library/PreferencePanes/#{prePane}/Contents/Info.plist")
+			results=CFPropertyList.native_types(plist.value)
+			final_list << results["CFBundleIdentifier"]
+		end
+		return final_list
+	end
+
+
+	#creates an empty com.apple.systempreferences in tmp folder
+	def self.CreateProfile
+		profile = "/Library/preferences/com.apple.systempreferences.plist"
+		new_profile = File.open(profile, "w")
+		new_profile.puts '<?xml version="1.0" encoding="UTF-8"?>
+		<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+		<plist version="1.0">
+		<dict>
+			<key>DisabledPreferencePanes</key>
+			<array>
+			</array>
+		</dict>
+		</plist>
+		'
+		new_profile.close
+		FileUtils.chmod(0644,"#{profile}")
+	    FileUtils.chown 'root', 'wheel', "#{profile}"
+	end
+
+	#to restrict access to a preference pane, put the CFBundleIdentifier as the argument
+	# example is Panes.Disable("com.apple.preference.network")
+	def self.Disable(*prefs)
+
+		if File.file?("/Library/preferences/com.apple.systempreferences.plist")
+			preference_panes_to_disable =[]
+
+			prefs.each do |x|
+				preference_panes_to_disable << x
+			end
+
+			plist = CFPropertyList::List.new(:file => "/Library/preferences/com.apple.systempreferences.plist")
+			results=CFPropertyList.native_types(plist.value)
+
+			results["DisabledPreferencePanes"].each do |x|
+				preference_panes_to_disable << x
+			end
+
+			preference_panes_to_disable.each do |x|
+				indexnumber = preference_panes_to_disable.index(x)
+				results["DisabledPreferencePanes"][indexnumber] = "#{x}"
+			end
+
+			plist.value = CFPropertyList.guess(results)
+			plist.save("/Library/preferences/com.apple.systempreferences.plist", CFPropertyList::List::FORMAT_BINARY)
+		else
+			Panes.CreateProfile
+			preference_panes_to_disable =[]
+
+			prefs.each do |x|
+				preference_panes_to_disable << x
+			end
+
+			plist = CFPropertyList::List.new(:file => "/Library/preferences/com.apple.systempreferences.plist")
+			results=CFPropertyList.native_types(plist.value)
+
+			results["DisabledPreferencePanes"].each do |x|
+				preference_panes_to_disable << x
+			end
+
+			preference_panes_to_disable.each do |x|
+				indexnumber = preference_panes_to_disable.index(x)
+				results["DisabledPreferencePanes"][indexnumber] = "#{x}"
+			end
+
+			plist.value = CFPropertyList.guess(results)
+			plist.save("/Library/preferences/com.apple.systempreferences.plist", CFPropertyList::List::FORMAT_BINARY)
+
+		end
+		command="sudo killall cfprefsd"
+		system(command)
+	end
+
+	#to remove a restriction, put the CFBundleIdentifier as the argument
+	def self.Enable(*prefs)
+		if File.file?("/Library/preferences/com.apple.systempreferences.plist")
+			plist = CFPropertyList::List.new(:file => "/Library/preferences/com.apple.systempreferences.plist")
+			results=CFPropertyList.native_types(plist.value)
+			prefs.each do |check_a|
+				results["DisabledPreferencePanes"].each do |check_b|
+					if check_a == check_b 
+						results["DisabledPreferencePanes"].delete(check_a)
+					end
+				end
+			end
+			plist.value = CFPropertyList.guess(results)
+			plist.save("/Library/preferences/com.apple.systempreferences.plist", CFPropertyList::List::FORMAT_BINARY)
+			command="sudo killall cfprefsd"
+			system(command)
+		else
+			puts "Error: no plist. Try running 'sudo killall cfprefsd' from the terminal"
+		end
+	end
+
+	
+	#reset all disable panes
+	def self.Reset
+		command="sudo rm -rf /Library/Preferences/com.apple.systempreferences.plist"
+		system(command)
+		cfprefsd="sudo killall cfprefsd"
+		system(cfprefsd)
+	end
+
+	#to print all the availbe options to use with the Panes command
+	def self.Options
+		puts (Panes.methods - Object.methods).sort
+	end
+end
+Panes.Disable("com.apple.preference.network")
+

data/panes.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "panes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "panes"
+  spec.version       = Panes::VERSION
+  spec.authors       = ["Nic Scott"]
+  spec.email         = ["nls.inbox@gmail.com"]
+
+  spec.summary       = "A ruby gem for MacAdmins to help manage access to System Preference Panes. Easily enable or disable access to individual panes."
+  spec.homepage      = "https://github.com/nlscott/panes"
+  spec.license       = "MIT"
+
+=begin
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+=end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 2.2.33"
+  spec.add_development_dependency "rake", ">= 11.2.2"
+  spec.add_development_dependency "minitest", "5.18.1"
+  spec.add_development_dependency "CFPropertyList", ">= 3.0.6"
+
+end

metadata

@@ -1,78 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: panes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nic Scott
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-16 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.18.1
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.0.6
 description: 
 email:
 - nls.inbox@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/panes.rb
+- lib/panes/version.rb
+- panes-0.2.0.gem
+- panes.gemspec
 homepage: https://github.com/nlscott/panes
 licenses:
 - MIT
@@ -92,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A ruby gem for MacAdmins to help manage access to System Preference Panes.