ruby-jss 1.6.4 → 2.0.0b1

data/lib/jss/client.rb

@@ -1,301 +0,0 @@
-### Copyright 2020 Pixar
-
-###
-###    Licensed under the Apache License, Version 2.0 (the "Apache License")
-###    with the following modification; you may not use this file except in
-###    compliance with the Apache License and the following modification to it:
-###    Section 6. Trademarks. is deleted and replaced with:
-###
-###    6. Trademarks. This License does not grant permission to use the trade
-###       names, trademarks, service marks, or product names of the Licensor
-###       and its affiliates, except as required to comply with Section 4(c) of
-###       the License and to reproduce the content of the NOTICE file.
-###
-###    You may obtain a copy of the Apache License at
-###
-###        http://www.apache.org/licenses/LICENSE-2.0
-###
-###    Unless required by applicable law or agreed to in writing, software
-###    distributed under the Apache License with the above modification is
-###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-###    KIND, either express or implied. See the Apache License for the specific
-###    language governing permissions and limitations under the Apache License.
-###
-###
-
-###
-module JSS
-
-  # 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.
-  #
-  class Client
-
-    # Constants
-    #####################################
-
-    # The Pathname to the preferences plist used by the jamf binary
-    JAMF_PLIST = Pathname.new '/Library/Preferences/com.jamfsoftware.jamf.plist'
-
-    # The Pathname to the JAMF support folder
-    JAMF_SUPPORT_FOLDER = Pathname.new '/Library/Application Support/JAMF'
-
-    # The JAMF receipts folder, where package installs are tracked.
-    RECEIPTS_FOLDER = JAMF_SUPPORT_FOLDER + 'Receipts'
-
-    # The JAMF downloads folder
-    DOWNLOADS_FOLDER = JAMF_SUPPORT_FOLDER + 'Downloads'
-
-    # 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
-
-    # ignore console user = root (loginwindow)
-    ROOT_USER = 'root'.freeze
-
-    # ignore primary console user loginwindow
-    LOGINWINDOW_USER = 'loginwindow'.freeze
-
-    # The end of the path to the Self Service Executable.
-    # Used to figure out who's running Self Service.app
-    SELF_SERVICE_EXECUTABLE_END = '/Self Service.app/Contents/MacOS/Self Service'.freeze
-
-    # the ps command used to figure out who's running Self Service
-    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/'
-
-    # Class Methods
-    #####################################
-
-
-
-    # Get the current IP address as a String.
-    #
-    # This handy code doesn't acutally make a UDP connection,
-    # it just starts to set up the connection, then uses that to get
-    # the local IP.
-    #
-    # Lifted gratefully from
-    # http://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/
-    #
-    # @return [String] the current IP address.
-    #
-    def self.my_ip_address
-      # turn off reverse DNS resolution temporarily
-      # @note the 'socket' library has already been required by 'rest-client'
-      orig = Socket.do_not_reverse_lookup
-      Socket.do_not_reverse_lookup = true
-
-      UDPSocket.open do |s|
-        s.connect '192.168.0.0', 1
-        s.addr.last
-      end
-    ensure
-      Socket.do_not_reverse_lookup = orig
-    end
-
-    # Is the jamf binary installed?
-    #
-    # @return [Boolean] is the jamf binary installed?
-    #
-    def self.installed?
-      JAMF_BINARY.executable?
-    end
-
-    # What version of the jamf binary is installed?
-    #
-    # @return [String,nil] the version of the jamf binary installed on this client, nil if not installed
-    #
-    def self.jamf_version
-      installed? ? run_jamf(:version).chomp.split('=')[1] : nil
-    end
-
-    # the URL to the jss for this client
-    #
-    # @return [String] the url to the JSS for this client
-    #
-    def self.jss_url
-      @url = jamf_plist['jss_url']
-      return nil if @url.nil?
-      @url =~ %r{(https?)://(.+):(\d+)/}
-      @protocol = Regexp.last_match(1)
-      @server = Regexp.last_match(2)
-      @port = Regexp.last_match(3)
-      @url
-    end
-
-    # The JSS server hostname for this client
-    #
-    # @return [String] the JSS server for this client
-    #
-    def self.jss_server
-      jss_url
-      @server
-    end
-
-    # The protocol for JSS connections for this client
-    #
-    # @return [String] the protocol to the JSS for this client, "http" or "https"
-    #
-    def self.jss_protocol
-      jss_url
-      @protocol
-    end
-
-    # The port number for JSS connections for this client
-    #
-    # @return [Integer] the port to the JSS for this client
-    #
-    def self.jss_port
-      jss_url
-      @port
-    end
-
-    # The contents of the JAMF plist
-    #
-    # @return [Hash] the parsed contents of the JAMF_PLIST if it exists,
-    # an empty hash if not
-    #
-    def self.jamf_plist
-      return {} unless JAMF_PLIST.file?
-      JSS.parse_plist JAMF_PLIST
-    end
-
-    # All the JAMF receipts on this client
-    #
-    # @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?
-      RECEIPTS_FOLDER.children.select(&:file?)
-    end
-
-    # Is the JSS available right now?
-    #
-    # @return [Boolean] is the JSS available now?
-    #
-    def self.jss_available?
-      run_jamf :checkJSSConnection, '-retry 1'
-      $CHILD_STATUS.exitstatus.zero?
-    end
-
-    # The JSS::Computer object for this computer
-    #
-    # @return [JSS::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
-      nil
-    end
-
-    # The UUID for this computer via system_profiler
-    #
-    # @return [String] the UUID/UDID for this computer
-    #
-    def self.udid
-      hardware_data['platform_UUID']
-    end
-
-    # The serial number for this computer via system_profiler
-    #
-    # @return [String] the serial number for this computer
-    #
-    def self.serial_number
-      hardware_data['serial_number']
-    end
-
-    # The parsed HardwareDataType output from system_profiler
-    #
-    # @return [Hash] the HardwareDataType data from the system_profiler command
-    #
-    def self.hardware_data
-      raw = `/usr/sbin/system_profiler SPHardwareDataType -xml 2>/dev/null`
-      JSS.parse_plist(raw)[0]['_items'][0]
-    end
-
-    # Who's currently got an active GUI session? - might be
-    # more than one if Fast User Switching is in use.
-    #
-    # @return [Array<String>] The current users with GUI sessions
-    #
-    def self.console_users
-      output = `#{CONSOLE_USERS_SCUTIL_CMD}`
-      userlines = output.lines.select { |l| l =~ /SessionUserNameKey\s*:/ }
-      userlines.map! { |ul| ul.split(':').last.strip }
-      userlines.reject { |un| un == ROOT_USER }
-    end
-
-    # Which console user is using the primary GUI console?
-    # Returns nil if the primary GUI console is at the login window.
-    #
-    # @return [String,nil] The login name of the user is using the primary
-    #   GUI console, or nil if at the login window.
-    #
-    def self.primary_console_user
-      `#{CONSOLE_USERS_SCUTIL_CMD}` =~ /^\s*Name : (\S+)$/
-      user = Regexp.last_match(1)
-      user == LOGINWINDOW_USER ? nil : user
-    end
-
-    # alias for primary_console_user
-    def self.console_user
-      primary_console_user
-    end
-
-    # Who's currently running Self Service.app? - might be
-    # more than one if Fast User Switching is in use.
-    #
-    # @return [Array<String>] The current users running Self Service.app
-    #
-    def self.self_service_users
-      ss_userlines = `#{PS_USER_COMM}`.lines.select { |l| l.include? SELF_SERVICE_EXECUTABLE_END }
-      ss_userlines.map { |ssl| ssl.split(' ').first }
-    end
-
-    # @param user[String, nil] The user to query, the current user if nil.
-    #
-    # @return [Boolean, nil] Is 'Do Not Disturb' enabled for the user?
-    #  nil if unknown/not-applicable
-    #
-    def self.do_not_disturb?(user = nil)
-      home = user ? homedir(user) : Dir.home
-      myudid = udid
-      nc_prefs_file = Pathname.new "#{home}/#{USER_PREFS_BYHOST_FOLDER}/com.apple.notificationcenterui.#{myudid}.plist"
-      return nil unless nc_prefs_file.readable?
-      JSS.parse_plist(nc_prefs_file)['doNotDisturb']
-    end
-
-    # The home dir of the specified user, nil if
-    # no homedir in local dscl.
-    #
-    # @param user[String] the user whose homedir to look up
-    #
-    # @return [Pathname, nil] The user's homedir or nil if no such user
-    #
-    def self.homedir(user)
-      dir = `/usr/bin/dscl . -read /Users/#{user} NFSHomeDirectory 2>/dev/null`.chomp.split(': ').last
-      dir ? Pathname.new(dir) : nil
-    end
-
-  end # class Client
-
-end # module
-
-require 'jss/client/jamf_binary'
-require 'jss/client/jamf_helper'
-require 'jss/client/management_action'

data/lib/jss/compatibility.rb

@@ -1,88 +0,0 @@
-# Copyright 2020 Pixar
-
-#
-#    Licensed under the Apache License, Version 2.0 (the "Apache License")
-#    with the following modification; you may not use this file except in
-#    compliance with the Apache License and the following modification to it:
-#    Section 6. Trademarks. is deleted and replaced with:
-#
-#    6. Trademarks. This License does not grant permission to use the trade
-#       names, trademarks, service marks, or product names of the Licensor
-#       and its affiliates, except as required to comply with Section 4(c) of
-#       the License and to reproduce the content of the NOTICE file.
-#
-#    You may obtain a copy of the Apache License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#    Unless required by applicable law or agreed to in writing, software
-#    distributed under the Apache License with the above modification is
-#    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-#    KIND, either express or implied. See the Apache License for the specific
-#    language governing permissions and limitations under the Apache License.
-#
-#
-
-# backporting of some newer ruby methods into older rubies
-#
-
-# Hash.key
-#
-# #key exists in ruby 1.9+, in 1.8 its called #index
-# it returns the hash key for a given value, if the value exists
-# in the hash
-#
-###########################################
-unless {}.respond_to? :key
-  class Hash
-
-    alias key index
-
-  end
-end
-
-# Array.sample
-#
-# #sample exists in ruby 1.9+, in 1.8 its called #choice
-# it returns a randomly chosen element of the given array
-# eg: [1, 2, 3].sample returns either 1, 2, or 3
-#
-###########################################
-unless [].respond_to? :sample
-  class Array
-
-    alias sample choice
-
-  end
-end
-
-# String.force_encoding
-#
-#
-###########################################
-unless ''.respond_to? :force_encoding
-  class String
-
-    def force_encoding(_args = nil)
-      self
-    end
-
-  end
-end
-
-
-# String.casecmp?
-#
-#
-###########################################
-unless ''.respond_to? :casecmp?
-  class String
-
-    def casecmp?(other)
-      return nil unless other.is_a? String
-
-      casecmp(other).zero?
-    end
-
-  end
-end

data/lib/jss/composer.rb

@@ -1,190 +0,0 @@
-### Copyright 2020 Pixar
-
-###
-###    Licensed under the Apache License, Version 2.0 (the "Apache License")
-###    with the following modification; you may not use this file except in
-###    compliance with the Apache License and the following modification to it:
-###    Section 6. Trademarks. is deleted and replaced with:
-###
-###    6. Trademarks. This License does not grant permission to use the trade
-###       names, trademarks, service marks, or product names of the Licensor
-###       and its affiliates, except as required to comply with Section 4(c) of
-###       the License and to reproduce the content of the NOTICE file.
-###
-###    You may obtain a copy of the Apache License at
-###
-###        http://www.apache.org/licenses/LICENSE-2.0
-###
-###    Unless required by applicable law or agreed to in writing, software
-###    distributed under the Apache License with the above modification is
-###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-###    KIND, either express or implied. See the Apache License for the specific
-###    language governing permissions and limitations under the Apache License.
-###
-###
-
-###
-module JSS
-
-  ###
-  ### This module provides two methods for building very simple Casper-happy .pkg and .dmg packages for deployment.
-  ###
-  ### Unlike Composer.app from JAMF, this module currently doesn't offer a way to do a before/after disk scan
-  ### and use the differences to build the root folder from which the package is built. Nor does the module support
-  ### editing the pre/post install scripts in .pkgs.
-  ###
-  ### The 'root folder', a folder representing the root filesystem of the target machine where the package will be installed,
-  ### must already exist and be fully populated and with correct permissions.
-  ###
-  module Composer
-
-    #####################################
-    ### Constants
-    #####################################
-
-    ### the apple pkgutil tool
-    PKG_UTIL = Pathname.new '/usr/sbin/pkgutil'
-
-    ### The location of the cli tool for making .pkgs
-    PKGBUILD = Pathname.new '/usr/bin/pkgbuild'
-
-    ### the default bundle identifier prefix for pkgs
-    PKG_BUNDLE_ID_PFX = 'ruby-jss-composer'.freeze
-
-    ### Apple's hdiutil for making dmgs
-    HDI_UTIL = '/usr/bin/hdiutil'.freeze
-
-    ### Where to save the output ?
-    DEFAULT_OUT_DIR = Pathname.new '/Users/Shared'
-
-    ### Make a casper-happy .pkg out of a root folder, permissions are assumed to be correct.
-    ###
-    ### @param name[String] the name of the .pkg. The .pkg suffix will be added if not present
-    ###
-    ### @param version[String] the version of the .pkg, needed for building the .pkg
-    ###
-    ### @param root[String, Pathname] the path to the 'root folder' representing
-    ###   the root file system of the target install drive
-    ###
-    ### @param opts[Hash] the options for building the .pkg
-    ###
-    ### @options opts :pkg_id[String] the full package if for the new pkg.
-    ###   e.g. 'com.mycompany.myapp'
-    ###
-    ### @option opts :bundle_id_prefix[String] the pkg bundle identifier prefix.
-    ###   If no :pkg_id is provided, one is made using this prefix and
-    ###   the name provided. e.g. 'com.mycompany'
-    ###   Defaults to '{PKG_BUNDLE_ID_PFX}'. See 'man pkgbuild' for more info
-    ###
-    ### @option opts :out_dir[String,Pathname] he folder in which the .pkg will be
-    ###   created. Defaults to {DEFAULT_OUT_DIR}
-    ###
-    ### @option opts :preserve_ownership[Boolean] If true, the owner/group of the
-    ###   rootpath are preserved.
-    ###   Default is false: they become the pkgbuild/installer 'recommended'
-    ###   (root/wheel or root/admin)
-    ###
-    ### @option opts :signing_identity[String] the optional name of the signing identity (certificate) to
-    ###   use for signing the pkg. See `man pkgbuild` for details
-    ###
-    ### @option opts :signing_options[String] the optional string of options to pass to pkgbuild.
-    ###  See `man pkgbuild` for details
-    ###
-    ### @return [Pathname] the local path to the new .pkg
-    ###
-    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
-      opts[:bundle_id_prefix] ||= PKG_BUNDLE_ID_PFX
-
-      pkg_filename = name.end_with?('.pkg') ? name : name + '.pkg'
-      pkg_id = opts[:pkg_id]
-      pkg_id ||= opts[:bundle_id_prefix] + '.' + name
-      pkg_out = "#{opts[:out_dir]}/#{pkg_filename}"
-      pkg_ownership = opts[:preserve_ownership] ? 'preserve' : 'recommended'
-
-      if opts[:signing_identity]
-        signing = "--sign '#{opts[:signing_identity]}'"
-        signing << " #{opts[:signing_options]}" if opts[:signing_options]
-      else
-        signing = ''
-      end # if opts[:signing_identity]
-
-      ### first, run 'analyze' to get a 'component plist' in which we can change some settings
-      ### for any bundles in the root (bundles like .apps, frameworks, plugins, etc..)
-      ###
-      ### we edit the settings thus:
-      ### BundleOverwriteAction = upgrade, totally replace any version current on disk
-      ### BundleIsVersionChecked = false, allow us to install regardless of what version is currently installed
-      ### BundleIsRelocatable = false,  if there's a version of this in some other location, Do Not move this one there after installation
-      ### BundleHasStrictIdentifier = false, don't care if there's something at the install path with a different bundle id.
-      ###
-      ### In other words, just install the thing!
-      ### (see 'man pkgbuild' for more info)
-      ###
-      ###
-      comp_plist_out = Pathname.new "/tmp/#{PKG_BUNDLE_ID_PFX}-#{pkg_filename}.plist"
-      system "#{PKGBUILD} --analyze --root '#{root}' '#{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?
-        comp_plist_arg = ''
-      else
-        ### otherwise, edit the bundle dictionaries
-        comp_plist.each do |bndl|
-          bndl.delete 'ChildBundles' if bndl['ChildBundles']
-          bndl['BundleOverwriteAction'] = 'upgrade'
-          bndl['BundleIsVersionChecked'] = false
-          bndl['BundleIsRelocatable'] = false
-          bndl['BundleHasStrictIdentifier'] = false
-        end
-        ### write out the edits
-        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}'"
-
-        raise 'There was an error building the .pkg' unless it_built
-      ensure
-        comp_plist_out.delete if comp_plist_out.exist?
-      end
-
-      Pathname.new pkg_out
-    end # mk_dot_pkg
-
-    ###
-    ### Make a casper-happy .dmg out of a root folder, permissions are assumed to be correct.
-    ###
-    ### @param name[String] The name of the .dmg, the suffix will be added if needed
-    ###
-    ### @param root[String, Pathname]  the path to the "root folder" representing the root file system of the target install drive
-    ###
-    ### @param out_dir[String, Pathname] the folder in which the .pkg will be created. Defaults to {DEFAULT_OUT_DIR}
-    ###
-    ### @return [Pathname] the local path to the new .dmg
-    ###
-    ###
-    def self.mk_dmg(name, root, out_dir = DEFAULT_OUT_DIR)
-      dmg_filename = "#{name}.dmg"
-      dmg_vol = name
-      dmg_out = Pathname.new "#{out_dir}/#{dmg_filename}"
-      if dmg_out.exist?
-        mv_to = dmg_out.dirname + "#{dmg_out.basename}.#{Time.now.strftime('%Y%m%d%H%M%S')}"
-        dmg_out.rename mv_to
-      end # if dmg out exist
-
-      ### TODO - this may need to be sudo'd to handle proper internal permissions.
-      system "#{HDI_UTIL} create -volname '#{dmg_vol}' -scrub -srcfolder '#{root}' '#{dmg_out}'"
-
-      raise 'There was an error building the .dmg' unless $?.exitstatus.zero?
-      Pathname.new dmg_out
-    end # mk_dmg
-
-  end # module Composer
-
-end # module JSS