xolo-server 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9f5dc9ea500833d5c8801217644bb7f3d13854381904e82f4258686f4ca2658
+  data.tar.gz: d7f5707fac107f389747d7eb754c872e001e8e08e1aa9bae5c2450773dffdf47
+SHA512:
+  metadata.gz: d0eaea573242edf948631e7276654e88bfe16b586d2545af05bb09968d511e564163e9a0d15b98cf7e5bcaa0238cf48bd753f21dd5cba0be11a18861adb12091
+  data.tar.gz: 46d443c1d859c1cd56a1cc0eef30ae9f5a8da32d878ca991eb66c1564c17c6b56cace0ab140d26d9bd5355dcfa01a624a8133060016d4b2017c8a15dc331d4fc

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+TOMORROW OPEN SOURCE TECHNOLOGY LICENSE 1.0
+
+The Tomorrow Open Source Technology License 1.0 differs from the original Apache License 2.0 in the following manner.  The scope of the trademark grant in section 6 is different.
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   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.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,7 @@
+# Xolo - CLI and Automated Package and Patch Management for Jamf Pro
+
+The xolo-server gem packages the code needed to run `xoloserver`, a sinatra-based HTTPS server that is the heart of Xolo [link to come], a command-line based system for automation and standardization around software deployment and management via Jamf Pro and the Jamf Title Editor.
+
+The xolo server provides the interface between the admin tool `xadm` and the Jamf Pro and Jamf Title Editor APIs.
+
+More documentation coming soon. 

data/bin/xoloserver

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+
+# frozen_string_literal: true
+
+require 'xolo/server'
+
+# The Server Wrapper App
+#####################
+class XoloServer
+
+  # include Xolo::Core::Output
+
+  ###########################
+  def initialize
+    # CLI
+    Xolo::Server.parse_cli
+    Xolo::Server.debug = Xolo::Server.cli_opts[:debug]
+    Xolo::Server.app_env = Xolo::Server.cli_opts[:production] ? Xolo::Server::APP_ENV_PROD : Xolo::Server::APP_ENV_DEV
+  end
+
+  ###########################
+  def run
+    Process.setproctitle Xolo::Server::EXECUTABLE_FILENAME
+
+    # Run the Server
+    if Xolo::Server.config_opts.empty?
+      Xolo::Server.logger.info "Starting version #{Xolo::VERSION} in #{Xolo::Server.app_env} mode"
+      Xolo::Server::App.run!
+
+    # Set config
+    elsif Xolo::Server.config_opts[:set]
+      set_config
+
+    # Show config
+    # always --show unless --set
+    else
+      show_config
+    end
+  end # run
+
+  ###########################
+  def show_config
+    puts '# Current Xolo Server Settings:'
+    puts '#################################'
+
+    keys_to_display = Xolo::Server.config_opts[:keys_to_display] || Xolo::Server::Configuration::KEYS.keys
+    max_key_len = keys_to_display.max_by(&:length).length + 2
+
+    # Display the requested keys
+    keys_to_display.each do |k|
+      deets = Xolo::Server::Configuration::KEYS[k]
+
+      v = Xolo::Server.config_opts[:expand] ? Xolo::Server.config.send(k) : Xolo::Server.config.raw_data[k]
+
+      if v.pix_empty?
+        if deets
+          '** required but not set' if deets[:required]
+        else
+          'Unknown Key'
+        end
+      end
+
+      printf "%-#{max_key_len}s %s\n", "#{k}: ", v
+    end # keys_to_display.each
+  end
+
+  ###########################
+  def set_config
+    # puts 'Config opts:'
+    # Xolo::Server.config_opts.each do |k, v|
+    #   puts "  #{k} (#{k.class}): #{v}"
+    # end
+    # puts '-------------------------------'
+
+    # raw_data is the data as read from the config file, which is the data we want to save back
+    #   after updating the values
+    data_to_save = Xolo::Server.config.raw_data.dup
+
+    Xolo::Server::Configuration::KEYS.each_key do |k|
+      next unless Xolo::Server.config_opts.key? "#{k}_given".to_sym
+
+      new_val = Xolo::Server.config_opts[k]
+      puts "Setting #{k} to #{new_val}"
+      data_to_save[k] = new_val
+    end
+
+    Xolo::Server.config.save_to_file(data: data_to_save)
+  end
+
+end # class XoloServer
+
+# MAIN
+#####################
+begin
+  app = XoloServer.new
+  app.run
+rescue => e
+  warn "ERROR #{e.class.name.split('::').last}: #{e}"
+  e.backtrace.each { |l| warn "..#{l}" }
+end

data/data/com.pixar.xoloserver.plist

@@ -0,0 +1,29 @@
+<?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>KeepAlive</key>
+  <true/>
+  <key>Label</key>
+  <string>com.pixar.xoloserver</string>
+  <!-- You probably want to set these environment variables
+  <key>EnvironmentVariables</key>
+  <dict>
+    <key>GEM_PATH</key>
+    <string></string>
+    <key>PATH</key>
+    <string></string>
+  </dict>
+  -->
+  <key>ProgramArguments</key>
+  <array>
+    <string>/usr/local/bin/xoloserver</string>
+  </array>
+  <key>RunAtLoad</key>
+  <true/>
+  <key>StandardOutPath</key>
+  <string>/Library/Application Support/xoloserver/logs/xoloserver.log</string>
+  <key>StandardErrorPath</key>
+  <string>/Library/Application Support/xoloserver/logs/xoloserver.log</string>
+</dict>
+</plist>

data/data/uninstall-pkgs-by-id.zsh

@@ -0,0 +1,103 @@
+#!/bin/zsh
+
+export PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin"
+
+# Used by Xolo to uninstall packages based on one or more package-IDs as used by the
+# 'pkgutil' command.
+#
+# This will get the list of files installed by each package-ID, and in a
+# depth-first manner, delete them all. Directories will only be deleted if
+# they are empty after deleting anything inside them what was installed by the same
+# package. (hence the need for depth-first traversal)
+#
+# NOTE: This will not be useful if something was installed in a manner other than
+# an installer.pkg (e.g. drag-installing an app) because there won't be
+# a matching entry in the pkgutil database.
+# It also won't help if the user has moved or renamed files after installation.
+
+# DO NOT CHANGE THE VALUE OF IDS_TO_UNINSTALL
+# This is a placeholder for the package IDs that Xolo will insert into the script
+IDS_TO_UNINSTALL=(PKG_IDS_FROM_XOLO_GO_HERE)
+
+
+# the current IDs known to pkgutil
+IFS=$'\n' installed_pkgids=($(/usr/sbin/pkgutil --pkgs))
+
+# iterate over our ids
+for pkgid in $IDS_TO_UNINSTALL ; do
+
+  # next unless this id is known
+  if ! (( $installed_pkgids[(Ie)$pkgid] )) ; then
+    echo "pkg ID $pkgid is not known"
+    continue
+  fi
+
+  # the items to delete for a pkg ID
+  IFS=$'\n' items_to_delete=($(/usr/sbin/pkgutil --files $pkgid ))
+
+  # next if that failed for some reason
+  if ! [[ $? = 0 ]] ; then
+    echo "failed to get file list for $pkgid, skipping"
+    continue
+  fi
+
+  # IMPORTANT - get the install volume and  install location to  prepend
+  # to the pathnames
+  inst_volume=$(/usr/sbin/pkgutil --pkg-info-plist $pkgid | /usr/bin/plutil -extract volume  raw -- -)
+  echo "inst_volume is: '$inst_volume'"
+
+  # if the inst_volume is set and it's last character is not a slash
+  # we need to insert a slash after it
+  [[ -n $inst_volume ]] && [[ "${inst_volume[-1]}" != '/' ]] && vol_slash='/'
+
+  inst_location=$(/usr/sbin/pkgutil --pkg-info-plist $pkgid | /usr/bin/plutil -extract install-location raw -- -)
+  echo "inst_location is: '$inst_location'"
+
+  # if the location is also just /, then don't use it
+  [[ "$inst_location" = '/' ]] && inst_location=''
+  echo "inst_location is NOW: '$inst_location'"
+
+  # if the inst_location is set and it's last character is not a slash
+  # we need to insert a slash after it
+  [[ -n $inst_location ]] && [[ "${inst_location[-1]}" != '/' ]] && loc_slash='/'
+
+
+  echo "deleting files installed by $pkgid"
+  echo '----------------'
+
+  # we need iterate them in reverse them so that we delete things depth-first
+  # which is what the (Oa) does
+  for path in ${(Oa)items_to_delete}; do
+
+    # echo "orig path is: '$path'"
+
+    path_to_delete="${inst_volume}${vol_slash}${inst_location}${loc_slash}${path}"
+
+    if [[ -f "$path_to_delete" ]] ; then
+      echo  "$path_to_delete is a file - deleting it"
+      /bin/rm -f "$path_to_delete"
+
+    elif [[ -L "$path_to_delete" ]] ; then
+      echo  "$path_to_delete is a symlink - deleting it"
+      /bin/rm -f "$path_to_delete"
+
+    elif [[ -d "$path_to_delete" ]] ; then
+      echo "$path_to_delete is a directory..."
+
+      if [[ $(/bin/ls -A "$path_to_delete" | /usr/bin/wc -l) -eq 0  ]] ; then
+         echo "... and it's empty - deleting it"
+         /bin/rm -f "$path_to_delete"
+      else
+         echo "... but its not empty - NOT deleting it"
+      fi
+
+    else
+      echo "$path_to_delete doesn't exist'"
+    fi
+
+  done
+
+  echo "done deleting files from $pkgid"
+  echo "------------------------------------"
+
+done

data/lib/xolo/server/app.rb

@@ -0,0 +1,133 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+#
+
+# frozen_string_literal: true
+
+# main module
+module Xolo
+
+  module Server
+
+    # The actual server application - a Sinatra/Thin HTTPS server
+    class App < Sinatra::Base
+
+      # Extensions & Helpers
+      ##############################
+      ##############################
+
+      register Xolo::Server::Routes
+      register Xolo::Server::Routes::Auth
+      register Xolo::Server::Routes::Maint
+      register Xolo::Server::Routes::JamfPro
+      register Xolo::Server::Routes::TitleEditor
+      register Xolo::Server::Routes::Titles
+      register Xolo::Server::Routes::Versions
+      register Xolo::Server::Routes::Uploads
+
+      helpers Xolo::Core::Constants
+      helpers Xolo::Core::JSONWrappers
+      helpers Xolo::Server::Helpers::Log
+      helpers Xolo::Server::Helpers::Notification
+      helpers Xolo::Server::Helpers::Auth
+      helpers Xolo::Server::Helpers::JamfPro
+      helpers Xolo::Server::Helpers::TitleEditor
+      helpers Xolo::Server::Helpers::Titles
+      helpers Xolo::Server::Helpers::Versions
+      helpers Xolo::Server::Helpers::FileTransfers
+      helpers Xolo::Server::Helpers::PkgSigning
+      helpers Xolo::Server::Helpers::ProgressStreaming
+      helpers Xolo::Server::Helpers::ClientData
+      helpers Xolo::Server::Helpers::Maintenance
+
+      # Sinatra setup
+      ##############################
+      ##############################
+
+      ##########
+      configure do
+        Xolo::Server.logger.debug 'Configuring Server App'
+        set :server, :thin
+        set :bind, '0.0.0.0'
+        set :port, 443
+
+        set :dump_errors, true
+        disable :show_exceptions
+
+        # Logging is handled by the Xolo::Server::Log module
+
+        enable :sessions
+        set :session_secret, SecureRandom.hex(64)
+        set :protection, session: true
+        set :sessions, expire_after: Xolo::Server::Constants::SESSION_EXPIRE_AFTER
+      end
+
+      ###############
+      configure :development do
+        require 'pp'
+      end
+
+      #############
+      configure :production do
+        set :show_exceptions, false
+      end
+
+      # Run !
+      ################
+      def self.run!(**options, &block)
+        Xolo::Server.logger.info 'Server App Starting Up'
+
+        setup
+
+        super do |server|
+          server.ssl = true
+          # verify peer is false so that we don't require client certs
+          server.ssl_options = {
+            cert_chain_file: Xolo::Server::Configuration::SSL_CERT_FILE.to_s,
+            private_key_file: Xolo::Server::Configuration::SSL_KEY_FILE.to_s,
+            verify_peer: false
+          }
+        end # super do
+      end
+
+      # Do some setup as we start the server
+      ##########################
+      def self.setup
+        Xolo::Server::DATA_DIR.mkpath
+        Xolo::Server::Title::TITLES_DIR.mkpath
+
+        setup_ssl
+
+        Xolo::Server.start_time = Time.now
+
+        Xolo::Server::Log.log_rotation_timer_task.execute
+        Xolo::Server::Helpers::Maintenance.cleanup_timer_task.execute
+
+        # Disable warnings in logs about known scope bug in Jamf Classic API
+        Jamf::Scopable::Scope.do_not_warn_about_policy_scope_bugs
+      end
+
+      ##########################
+      def self.setup_ssl
+        Xolo::Server.logger.debug 'Setting up SSL certificates'
+        Xolo::Server::Configuration::SSL_DIR.mkpath
+        Xolo::Server::Configuration::SSL_DIR.chmod 0o700
+        Xolo::Server::Configuration::SSL_CERT_FILE.pix_save Xolo::Server.config.ssl_cert
+        Xolo::Server::Configuration::SSL_CERT_FILE.chmod 0o600
+        Xolo::Server::Configuration::SSL_KEY_FILE.pix_save Xolo::Server.config.ssl_key
+        Xolo::Server::Configuration::SSL_KEY_FILE.chmod 0o600
+      end
+
+      ######################
+      def debug?
+        Xolo::Server.debug?
+      end
+
+    end # class App
+
+  end # Server
+
+end #  Xolo