ruby-jss 1.6.4 → 2.0.0b1

data/lib/jamf/client/management_action.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,89 +24,98 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # jamf client computer
   class Client
 
-    #  Constants
+    #  Module for working with the Management Action.app, which is an interface
+    # to the Notification Center
+    # This should be included into Jamf::Client
     #####################################
+    module ManagementAction
 
-    # The Pathname to the Management Action executable
-    MGMT_ACTION = SUPPORT_BIN_FOLDER + 'Management Action.app/Contents/MacOS/Management Action'
+      # The Pathname to the Management Action executable
+      MGMT_ACTION = SUPPORT_BIN_FOLDER + 'Management Action.app/Contents/MacOS/Management Action'
 
-    # NC_ALERT_STYLE_FLAGS = 4432
-    # NCPREFS_DOMAIN = 'com.apple.ncprefs'.freeze
-    # MGMT_ACTION_BUNDLE_ID = 'com.jamfsoftware.Management-Action'.freeze
-    # HUP_NOTIF_CTR_CMD = '/usr/bin/killall sighup usernoted NotificationCenter'.freeze
+      # NC_ALERT_STYLE_FLAGS = 4432
+      # NCPREFS_DOMAIN = 'com.apple.ncprefs'.freeze
+      # MGMT_ACTION_BUNDLE_ID = 'com.jamfsoftware.Management-Action'.freeze
+      # HUP_NOTIF_CTR_CMD = '/usr/bin/killall sighup usernoted NotificationCenter'.freeze
 
-    # class Methods
-    #####################################
-
-    def self.management_action(msg, title: nil, subtitle: nil, delay: 0)
-      raise JSS::InvalidDataError, 'delay: must be a non-negative integer.' unless delay.is_a?(Integer) && delay > -1
-
-      cmd = Shellwords.escape MGMT_ACTION.to_s
-      cmd << " -message #{Shellwords.escape msg.to_s}"
-      cmd << " -title #{Shellwords.escape title.to_s}" if title
-      cmd << " -subtitle #{Shellwords.escape subtitle.to_s}" if subtitle
-      cmd << " -deliverydelay #{Shellwords.escape delay}" if delay > 0
-      `#{cmd} 2>&1`
-    end
-
-    # an alias of management_action
-    def self.nc_notify(msg, title: nil, subtitle: nil, delay: 0)
-      management_action(msg, title: title, subtitle: subtitle, delay: delay)
-    end
-
-    private_class_method
-
-    # Skipping all the force-alerts stuff until we figure out cleaner
-    # ways to do it in 10.13+
-    # The plan is to be able to make the NotificationCenter notification be an
-    # 'alert' (which stays visible til the user clicks) or a
-    # 'banner' (which vanishes in a few seconds), regardless of the user's
-    # setting in the NC prefs.
-
-    def self.force_alerts
-      orig_flags = {}
-      console_users.each do |user|
-        orig_flags[user] = set_mgmt_action_ncprefs_flags user, NC_ALERT_STYLE_FLAGS, hup: false
-      end
-      system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
-      sleep 1
-      orig_flags
-    end
-
-    def self.restore_alerts(orig_flags)
-      orig_flags.each do |user, flags|
-        set_mgmt_action_ncprefs_flags user, flags, hup: false
+      # when this module is included, also extend our Class Methods
+      def self.included(includer)
+        Jamf.load_msg "--> #{includer} is including Jamf::Client::ManagementAction"
+        includer.extend(ClassMethods)
       end
-      system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
-    end
-
-    # set the NotificationCenter option flags for a user
-    # flags = an integer.
-    #
-    # Doesn't seem to work in 10.13, so ignore this for now.
-    #
-    # @return [Integer] the original flags, or given flags if no originals.
-    #
-    def self.set_mgmt_action_ncprefs_flags(user, flags, hup: true)
-      plist = Pathname.new "/Users/#{user}/Library/Preferences/#{NCPREFS_DOMAIN}.plist"
-      prefs = Jamf.parse_plist plist
-      mgmt_action_setting = prefs['apps'].select { |a| a['bundle-id'] == MGMT_ACTION_BUNDLE_ID }.first
-      if mgmt_action_setting
-        orig_flags = mgmt_action_setting['flags']
-        mgmt_action_setting['flags'] = flags
-      else
-        orig_flags = flags
-        prefs['apps'] << { 'bundle-id' => MGMT_ACTION_BUNDLE_ID, 'flags' => flags }
-      end
-      plist.open('w') { |f| f.write Jamf.xml_plist_from(prefs) }
-      system HUP_NOTIF_CTR_CMD if hup
-      orig_flags
-    end
+
+      # class Methods
+      #####################################
+
+      module ClassMethods
+
+        def management_action(msg, title: nil, subtitle: nil, delay: 0)
+          raise Jamf::InvalidDataError, 'delay: must be a non-negative integer.' unless delay.is_a?(Integer) && delay > -1
+
+          cmd = Shellwords.escape MGMT_ACTION.to_s
+          cmd << " -message #{Shellwords.escape msg.to_s}"
+          cmd << " -title #{Shellwords.escape title.to_s}" if title
+          cmd << " -subtitle #{Shellwords.escape subtitle.to_s}" if subtitle
+          cmd << " -deliverydelay #{Shellwords.escape delay}" if delay > 0
+          `#{cmd} 2>&1`
+        end
+        alias nc_notify management_action
+
+        # Skipping all the force-alerts stuff until we figure out cleaner
+        # ways to do it in 10.13+
+        # The plan is to be able to make the NotificationCenter notification be an
+        # 'alert' (which stays visible til the user clicks) or a
+        # 'banner' (which vanishes in a few seconds), regardless of the user's
+        # setting in the NC prefs.
+
+        def force_alerts
+          orig_flags = {}
+          console_users.each do |user|
+            orig_flags[user] = set_mgmt_action_ncprefs_flags user, NC_ALERT_STYLE_FLAGS, hup: false
+          end
+          system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
+          sleep 1
+          orig_flags
+        end
+
+        def restore_alerts(orig_flags)
+          orig_flags.each do |user, flags|
+            set_mgmt_action_ncprefs_flags user, flags, hup: false
+          end
+          system HUP_NOTIF_CTR_CMD unless orig_flags.empty?
+        end
+
+        # set the NotificationCenter option flags for a user
+        # flags = an integer.
+        #
+        # Doesn't seem to work in 10.13, so ignore this for now.
+        #
+        # @return [Integer] the original flags, or given flags if no originals.
+        #
+        def set_mgmt_action_ncprefs_flags(user, flags, hup: true)
+          plist = Pathname.new "/Users/#{user}/Library/Preferences/#{NCPREFS_DOMAIN}.plist"
+          prefs = JSS.parse_plist plist
+          mgmt_action_setting = prefs['apps'].select { |a| a['bundle-id'] == MGMT_ACTION_BUNDLE_ID }.first
+          if mgmt_action_setting
+            orig_flags = mgmt_action_setting['flags']
+            mgmt_action_setting['flags'] = flags
+          else
+            orig_flags = flags
+            prefs['apps'] << { 'bundle-id' => MGMT_ACTION_BUNDLE_ID, 'flags' => flags }
+          end
+          plist.open('w') { |f| f.write JSS.xml_plist_from(prefs) }
+          system HUP_NOTIF_CTR_CMD if hup
+          orig_flags
+        end
+
+      end # ClassMethods
+
+    end # moculde
 
   end # class Client
 

data/lib/jamf/client.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,24 +23,13 @@
 ###
 ###
 
-###
 module Jamf
 
-  # This class represents a Jamf/JSS Client computer, on which
-  # this code is running.
-  #
-  # Since the class represents the current machine, there's no need
-  # to make an instance of it, all methods are class methods.
-  #
-  # At the moment, only Macintosh computers are supported.
-  #
-  # TODO: convert this to a module, since that's how it's used.
+  # This module contains methods for working locally on a managed Jamf client
+  # computer, on which this code is running.
   #
   class Client
 
-    # Constants
-    #####################################
-
     # The Pathname to the preferences plist used by the jamf binary
     JAMF_PLIST = Pathname.new '/Library/Preferences/com.jamfsoftware.jamf.plist'
 
@@ -56,9 +45,6 @@ module Jamf
     # The bin folder inside the Jamf support folder
     SUPPORT_BIN_FOLDER = JAMF_SUPPORT_FOLDER + 'bin'
 
-    # The bin folder with the jamf binary and a few other things
-    USR_LOCAL_BIN_FOLDER = Pathname.new '/usr/local/jamf/bin'
-
     # This command gives raw info about console users
     CONSOLE_USERS_SCUTIL_CMD = 'echo "show State:/Users/ConsoleUser" | /usr/sbin/scutil'.freeze
 
@@ -76,16 +62,11 @@ module Jamf
     PS_USER_COMM = 'ps -A -o user,comm'.freeze
 
     # the path to a users byhost folder from home
-    USER_PREFS_BYHOST_FOLDER = 'Library/Preferences/ByHost/'
+    USER_PREFS_BYHOST_FOLDER = 'Library/Preferences/ByHost/'.freeze
 
-    # If some processs C has a parent process P whose command (via ps -o comm)
-    # matches this, then process C is being run by Jamf
-    POLICY_SCRIPT_CMD_RE = %r{sh -c PATH=\$PATH:/usr/local/jamf/bin; '/Library/Application Support/JAMF/tmp/.* >& '/Library/Application Support/JAMF/tmp/\d+.tmp}.freeze
-
-    # If some processs C has a parent process P whose command (via ps -o comm)
-    # matching POLICY_SCRIPT_CMD_RE, and process P has a parent process G that
-    # matches this (C is grandchild of G), then process C is being run by a Jamf policy
-    POLICY_CMD_RE = %r{/bin/jamf policy }.freeze
+    include Jamf::Client::JamfBinary
+    include Jamf::Client::JamfHelper
+    include Jamf::Client::ManagementAction
 
     # Class Methods
     #####################################
@@ -179,7 +160,7 @@ module Jamf
     #
     def self.jamf_plist
       return {} unless JAMF_PLIST.file?
-      Jamf.parse_plist JAMF_PLIST
+      JSS.parse_plist JAMF_PLIST
     end
 
     # All the JAMF receipts on this client
@@ -187,7 +168,7 @@ module Jamf
     # @return [Array<Pathname>] an array of Pathnames for all regular files in the jamf receipts folder
     #
     def self.receipts
-      raise JSS::NoSuchItemError, "The JAMF Receipts folder doesn't exist on this computer." unless RECEIPTS_FOLDER.exist?
+      raise Jamf::NoSuchItemError, "The JAMF Receipts folder doesn't exist on this computer." unless RECEIPTS_FOLDER.exist?
       RECEIPTS_FOLDER.children.select(&:file?)
     end
 
@@ -200,13 +181,13 @@ module Jamf
       $CHILD_STATUS.exitstatus.zero?
     end
 
-    # The JSS::Computer object for this computer
+    # The Jamf::Computer object for this computer
     #
-    # @return [JSS::Computer,nil] The JSS record for this computer, nil if not in the JSS
+    # @return [Jamf::Computer,nil] The JSS record for this computer, nil if not in the JSS
     #
     def self.jss_record
-      JSS::Computer.fetch udid: udid
-    rescue JSS::NoSuchItemError
+      Jamf::Computer.fetch udid: udid
+    rescue Jamf::NoSuchItemError
       nil
     end
 
@@ -232,7 +213,7 @@ module Jamf
     #
     def self.hardware_data
       raw = `/usr/sbin/system_profiler SPHardwareDataType -xml 2>/dev/null`
-      Jamf.parse_plist(raw)[0]['_items'][0]
+      JSS.parse_plist(raw)[0]['_items'][0]
     end
 
     # Who's currently got an active GUI session? - might be
@@ -284,7 +265,7 @@ module Jamf
       myudid = udid
       nc_prefs_file = Pathname.new "#{home}/#{USER_PREFS_BYHOST_FOLDER}/com.apple.notificationcenterui.#{myudid}.plist"
       return nil unless nc_prefs_file.readable?
-      Jamf.parse_plist(nc_prefs_file)['doNotDisturb']
+      JSS.parse_plist(nc_prefs_file)['doNotDisturb']
     end
 
     # The home dir of the specified user, nil if
@@ -299,58 +280,6 @@ module Jamf
       dir ? Pathname.new(dir) : nil
     end
 
-    # Search up the process lineage to see if any ancestor processes indicate
-    # that the current process is being run by a Jamf Policy.
-    #
-    # @return [Boolean] Is the current process being run as a script by a Jamf Policy?
-    #
-    def self.script_running_via_policy?
-      root_ps_lines = `ps -u root -x -o pid -o ppid -o user -o command`.lines
-
-      parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd Process.pid, root_ps_lines
-      return false unless parent_pid
-
-      until parent_command =~ POLICY_SCRIPT_CMD_RE || parent_pid.nil?
-        parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd parent_pid, root_ps_lines
-        return false if parent_pid.zero?
-      end
-      return false if parent_pid.nil?
-
-      # if we're here, our parent is a jamf process, lets confirm that its
-      # a jamf policy
-      until parent_command =~ POLICY_CMD_RE || parent_pid.nil?
-        parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd parent_pid, root_ps_lines
-        return false if parent_pid.zero?
-      end
-      !parent_pid.nil?
-    end
-
-    # given a pid and optionally the output of `ps -o pid -o ppid -o user -o command`
-    # return an array with the pid, user, and command of the pid's parent process
-    #
-    # @param pid [Integer, String] the process id for which we want parent info
-    #
-    # @param ps_lines [Array<String>] the lines of output from
-    #   `ps -o pid -o ppid -o user -o command` possibly with other options.
-    #    If omitted, `ps -a -x -o pid -o ppid -o user -o command` will be used
-    #
-    # @return [Array<Integer, String, String>] the pid, user, and commandline
-    #  of the parent process of the given pid. All will be nil if not found
-    #
-    def self.parent_pid_user_and_cmd(pid, ps_lines = nil)
-      ps_lines ||= `ps -a -x -o pid -o ppid -o user -o command`.lines
-
-      parent_ps_line = ps_lines.select { |l| l =~ /^\s*#{pid}\s/ }.first
-      return [nil, nil, nil] unless parent_ps_line
-
-      parent_ps_line =~ /^\s*\d+\s+(\d+)\s+(\S+)\s+(.*)$/
-      [Regexp.last_match(1).to_i, Regexp.last_match(2), Regexp.last_match(3)]
-    end
-
   end # class Client
 
 end # module
-
-require 'jamf-client/jamf_binary'
-require 'jamf-client/jamf_helper'
-require 'jamf-client/management_action'

data/lib/jamf/composer.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -92,7 +92,7 @@ module Jamf
     ###
     ### @return [Pathname] the local path to the new .pkg
     ###
-    def self.mk_pkg(name, version, root, opts = {})
+    def self.mk_pkg(name, version, root, **opts)
       raise NoSuchItemError, "Missing pkgbuild tool. Please make sure you're running 10.8 or later." unless PKGBUILD.executable?
 
       opts[:out_dir] ||= DEFAULT_OUT_DIR
@@ -126,7 +126,7 @@ module Jamf
       ###
       comp_plist_out = Pathname.new "/tmp/#{PKG_BUNDLE_ID_PFX}-#{pkg_filename}.plist"
       system "#{PKGBUILD} --analyze --root '#{root}' '#{comp_plist_out}'"
-      comp_plist = Jamf.parse_plist comp_plist_out
+      comp_plist = JSS.parse_plist comp_plist_out
 
       ### if the plist is empty, there are no bundles in the pkg
       if comp_plist[0].nil?
@@ -141,13 +141,13 @@ module Jamf
           bndl['BundleHasStrictIdentifier'] = false
         end
         ### write out the edits
-        comp_plist_out.open('w') { |f| f.write Jamf.xml_plist_from(comp_plist) }
+        comp_plist_out.open('w') { |f| f.write JSS.xml_plist_from(comp_plist) }
         comp_plist_arg = "--component-plist '#{comp_plist_out}'"
       end
 
       ### now build the pkg
       begin
-        it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}' "
+        it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}'"
 
         raise 'There was an error building the .pkg' unless it_built
       ensure