xolo-server 1.0.0

data/lib/xolo/server.rb

@@ -0,0 +1,205 @@
+# 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
+
+# This file is the entry point for loading the Xolo Server
+#
+# You can and should require the convenience file 'xolo-server.rb'
+#
+#    require 'xolo-server'
+
+require 'xolo/core'
+
+# Standard Libraries
+######
+require 'logger'
+require 'openssl'
+require 'securerandom'
+require 'singleton'
+require 'json'
+require 'yaml'
+require 'open3'
+require 'base64'
+require 'resolv'
+require 'shellwords'
+require 'net/smtp'
+
+# Gems
+######
+
+require 'ruby-jss'
+require 'windoo'
+require 'sinatra/base'
+require 'sinatra/custom_logger'
+require 'sinatra/extension' # see https://sinatrarb.com/contrib/extension
+require 'thin'
+require 'concurrent/hash'
+require 'concurrent/atomic/reentrant_read_write_lock'
+require 'concurrent/executor/thread_pool_executor'
+require 'concurrent/timer_task'
+
+# Xolo Server - order matters
+######
+require 'xolo/server/constants'
+require 'xolo/server/command_line'
+require 'xolo/server/log'
+require 'xolo/server/object_locks'
+
+module Xolo
+
+  # The Xolo Server is the focal point for a Xolo installation.
+  # It centralizes and standardizes all communication between
+  # the serverside parts of Xolo:
+  #
+  # - The Xolo Admin command-line application 'xadm'
+  #   - Used to manage software deployed by Xolo either manually
+  #     or via automated scripts (e.g. Xcode builds)
+  #
+  # - A Jamf Title Editor server
+  #   - Used as the 'external patch source' hosting locally-developed
+  #     software, and/or titles from other sources
+  #
+  # - A Jamf Pro server
+  #   - Connected to the Title Editor, the Jamf internal patch source,
+  #     and perhaps other external patch sources.
+  #   - Handles initial installation and patching of software on the
+  #     managed client Macs via Policies and Patch Policies.
+  #
+  # The Xolo server also (eventually) implements a webhook handling server that specifically
+  # handles PatchSoftwareTitleUpdated events from the Jamf Pro server. This allows
+  # for the automatic packaging, piloting, and maintenance of titles using
+  # tools such as AutoPkg.
+  #
+  # The Xolo client tool 'xolo', used on managed Macs, does not communicate
+  # directly with the Xolo server. Instead, it communicates with the Jamf Pro, mostly
+  # by running 'jamf policy' commands.
+  #
+  #
+  module Server
+
+    # Mixins & extensions
+    ##############################
+    ##############################
+
+    include Xolo::Server::Constants
+    extend Xolo::Server::CommandLine
+    extend Xolo::Server::ObjectLocks
+    include Xolo::Server::Log
+
+    # Constants
+    #############################
+    #############################
+
+    # everything xolo-related in Jamf is in this category
+    # (this is never used as a SSvc category - that should be set per title)
+    JAMF_XOLO_CATEGORY = 'xolo'
+
+    # Module methods
+    ##############################
+    ##############################
+
+    ################
+    def self.start_time
+      @start_time
+    end
+
+    ################
+    def self.start_time=(t)
+      @start_time = t
+    end
+
+    ################
+    def self.app_env
+      @app_env
+    end
+
+    ################
+    def self.app_env=(e)
+      ENV['APP_ENV'] = e.to_s
+      @app_env = e
+    end
+
+    ################
+    def self.debug=(bool)
+      @debug = bool ? true : false
+    end
+
+    ################
+    def self.debug?
+      @debug
+    end
+
+    ################
+    def self.config
+      Xolo::Server::Configuration.instance
+    end
+
+    ################
+    def self.shutting_down?
+      @shutting_down
+    end
+
+    ################
+    def self.shutting_down=(bool)
+      @shutting_down = bool ? true : false
+    end
+
+    # threads for reporting
+    ##########################
+    def self.thread_info
+      info = {}
+      Thread.list.each do |thr|
+        name =
+          if thr.name
+            thr.name
+          elsif Thread.main == thr
+            'Main'
+          elsif thr.to_s.include? 'eventmachine'
+            "eventmachine-#{thr.object_id}"
+          else
+            thr.to_s
+          end
+        info[name] = thr.status
+      end
+
+      info
+    end
+
+  end # Server
+
+end # Xolo
+
+# Load the rest of Xolo Server
+# order matters
+
+require 'xolo/server/mixins/changelog'
+require 'xolo/server/mixins/title_jamf_access'
+require 'xolo/server/mixins/title_ted_access'
+require 'xolo/server/mixins/version_jamf_access'
+require 'xolo/server/mixins/version_ted_access'
+
+require 'xolo/server/helpers/log'
+require 'xolo/server/helpers/auth'
+require 'xolo/server/helpers/notification'
+require 'xolo/server/helpers/pkg_signing'
+require 'xolo/server/helpers/progress_streaming'
+require 'xolo/server/helpers/title_editor'
+require 'xolo/server/helpers/jamf_pro'
+require 'xolo/server/helpers/titles'
+require 'xolo/server/helpers/versions'
+require 'xolo/server/helpers/client_data'
+require 'xolo/server/helpers/file_transfers'
+require 'xolo/server/helpers/maintenance'
+
+require 'xolo/server/configuration'
+
+require 'xolo/server/title'
+require 'xolo/server/version'
+
+require 'xolo/server/routes'
+
+require 'xolo/server/app'

data/lib/xolo-server.rb

@@ -0,0 +1,8 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+
+# Shortcut xolo-server => xolo/server
+require 'xolo/server'

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: xolo-server
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Lasell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pixar-ruby-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: ruby-jss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: windoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  == Xolo
+  Xolo (sorta pronounced 'show-low') is an HTTPS server and set of command-line tools for macOS that provide automatable access to the software deployment and patch management aspects of {Jamf Pro}[https://www.jamf.com/products/jamf-pro/] and the {Jamf Title Editor}[https://learn.jamf.com/en-US/bundle/title-editor/page/About_Title_Editor.html]. It enhances Jamf Pro's abilities in many ways:
+
+    - Management of titles and versions/patches is scriptable and automatable, allowing developers and admins to integrate with CI/CD workflows.
+    - Simplifies and standardizes the complex, multistep manual process of managing titles and patches using the Title Editor and Patch Management web interfaces.
+    - Client installs can be performed by remotely via ssh and/or MDM
+    - Automated pre-release piloting of new versions/patches
+    - Titles can be expired (auto-uninstalled) after a period of disuse, reclaiming unused licenses.
+    - And more!
+
+  "Xolo" is the short name for the Mexican hairless dog breed {'xoloitzcuintle'}[https://en.wikipedia.org/wiki/Xoloitzcuintle] (show-low-itz-kwint-leh), as personified by Dante in the 2017 Pixar film _Coco_.
+
+  The xolo-server gem packages the code needed to run `xoloserver`, the sinatra-based HTTPS server at the heart of Xolo.
+email: xolo@pixar.com
+executables:
+- xoloserver
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.md
+- bin/xoloserver
+- data/com.pixar.xoloserver.plist
+- data/uninstall-pkgs-by-id.zsh
+- lib/xolo-server.rb
+- lib/xolo/server.rb
+- lib/xolo/server/app.rb
+- lib/xolo/server/command_line.rb
+- lib/xolo/server/configuration.rb
+- lib/xolo/server/constants.rb
+- lib/xolo/server/helpers/auth.rb
+- lib/xolo/server/helpers/client_data.rb
+- lib/xolo/server/helpers/file_transfers.rb
+- lib/xolo/server/helpers/jamf_pro.rb
+- lib/xolo/server/helpers/log.rb
+- lib/xolo/server/helpers/maintenance.rb
+- lib/xolo/server/helpers/notification.rb
+- lib/xolo/server/helpers/pkg_signing.rb
+- lib/xolo/server/helpers/progress_streaming.rb
+- lib/xolo/server/helpers/title_editor.rb
+- lib/xolo/server/helpers/titles.rb
+- lib/xolo/server/helpers/versions.rb
+- lib/xolo/server/log.rb
+- lib/xolo/server/mixins/changelog.rb
+- lib/xolo/server/mixins/title_jamf_access.rb
+- lib/xolo/server/mixins/title_ted_access.rb
+- lib/xolo/server/mixins/version_jamf_access.rb
+- lib/xolo/server/mixins/version_ted_access.rb
+- lib/xolo/server/object_locks.rb
+- lib/xolo/server/routes.rb
+- lib/xolo/server/routes/auth.rb
+- lib/xolo/server/routes/jamf_pro.rb
+- lib/xolo/server/routes/maint.rb
+- lib/xolo/server/routes/title_editor.rb
+- lib/xolo/server/routes/titles.rb
+- lib/xolo/server/routes/uploads.rb
+- lib/xolo/server/routes/versions.rb
+- lib/xolo/server/title.rb
+- lib/xolo/server/version.rb
+homepage: https://pixaranimationstudios.github.io/xolo-home/
+licenses:
+- LicenseRef-LICENSE.txt
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--title"
+- Xolo-Server
+- "--line-numbers"
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Automation and Standardization for Jamf Pro Patch Management
+test_files: []