Module: Xolo::Server::Helpers::AutoPkg

Defined in:
lib/xolo/server/helpers/autopkg.rb

Overview

This is mixed in to Xolo::Server as a helper module, so its instance methods are available in sinatra routes and views.

  • unlock autpkg_user's login keychain if pw is in config
  • run recipe
  • move pkg to workspace
  • sign pkg if needed
  • wrap and re-sign if needed
  • rename pkg
  • upload to Jamf Pro

Constant Summary collapse

AUTOPKG_UPLOADED_BY =

Constants

'autopkg'
FAIL_UNTRUSTED_RECIPES_CLI_OPT = 
'-k FAIL_RECIPES_WITHOUT_TRUST_INFO=yes'

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(includer) ⇒ Object

when this module is included



43
44
45
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 43

def self.included(includer)
  Xolo.verbose_include includer, self
end

Instance Method Details

#autopkg_enabled? ⇒ Boolean

Is AutoPkg integration enabled for the server?

Returns:

  • (Boolean) 


80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 80

def autopkg_enabled?
  return @autopkg_enabled if defined?(@autopkg_enabled)

  @autopkg_enabled =
    Xolo::Server.config.autopkg_executable && \
    Pathname.new(Xolo::Server.config.autopkg_executable).executable? && \
    autopkg_user_entry && \
    true
rescue ArgumentError
  @autopkg_enabled = false
end

#autopkg_run_command(title_object) ⇒ Object

the autopkg run command for this title



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 94

def autopkg_run_command(title_object)
  # is autopkg enabled for the server as a whole?
  return unless autopkg_enabled?

  [
    '/bin/launchctl',
    'asuser',
    autopkg_user_entry.uid.to_s,
    'sudo',
    '-u',
    Xolo::Server.config.autopkg_user,
    Xolo::Server.config.autopkg_executable,
    'run',
    '--verbose',
    title_object.autopkg_recipe,
    FAIL_UNTRUSTED_RECIPES_CLI_OPT
  ]
end

#autopkg_user_entry ⇒ Object

The Etc::Passwd entry for the autopkg_user



53
54
55
56
57
58
59
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 53

def autopkg_user_entry
  return unless Xolo::Server.config.autopkg_user

  @autopkg_user_entry ||= Etc.getpwnam(Xolo::Server.config.autopkg_user)
rescue ArgumentError
  nil
end

#clean_old_pkgs(pkgdir) ⇒ void

This method returns an undefined value.

remove any existing pkgs from the given autopkg output dir

Parameters:

  • pkgdir (Pathname) —

    the directory to clean



159
160
161
162
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 159

def clean_old_pkgs(pkgdir)
  log_debug "Removing .pkg files from #{pkgdir} before running autopkg recipe"
  pkgdir.children.each { |c| c.delete if c.extname == '.pkg' }
end

#run_autopkg_recipe(title_object) ⇒ Pathname?

Run the AutoPkg recipe for this title return the Pathname to the latest pkg in the autopkg_dir

Parameters:

  • title_object (Xolo::Server::Title) —

    the title object for which to run the recipe. It must have an autopkg_recipe defined.

Returns:

  • (Pathname, nil) —

    the latest pkg file in the autopkg_dir after running the recipe, or nil if the recipe is not enabled for this title



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 121

def run_autopkg_recipe(title_object)
  # is autopkg enabled for this title?
  return unless title_object.autopkg_enabled?

  recipe = title_object.autopkg_recipe
  pkgdir = Pathname.new title_object.autopkg_dir
  clean_old_pkgs pkgdir

  cmd = autopkg_run_command(title_object)
  progress "Running AutoPkg recipe for #{title_object.title} via command: #{cmd.join(' ')}", log: :info

  unlock_autopkg_user_keychain

  souterr, status = Open3.capture2e(*cmd)
  souterr.strip!

  if status.success?
    progress "AutoPkg recipe #{recipe} for title '#{title_object.title}' completed successfully.", log: :info, alert: true
    log_debug 'AutoPkg output:'
    souterr.lines.each { |l| log_debug "AutoPkg: #{l.chomp}" }

    pkgs = pkgdir.children.select { |c| c.extname == '.pkg' }
    pkgs.max_by(&:mtime)

  else
    progress "ERROR: AutoPkg recipe #{recipe} failed with status #{status.exitstatus}.", log: :error, alert: true
    log_error 'AutoPkg output:'
    souterr.lines.each { |l| log_error "AutoPkg: #{l.chomp}" }

    raise "AutoPkg recipe #{recipe} failed."
  end
end

#unlock_autopkg_user_keychain ⇒ Object

unlock the autopkg_user's login keychain if a password is provided in the config This is necessary if any recipes need to access it for signing identities



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/xolo/server/helpers/autopkg.rb', line 64

def unlock_autopkg_user_keychain
  return unless autopkg_enabled?
  return unless Xolo::Server.config.autopkg_user_keychain_pw

  keychain_path = "#{autopkg_user_entry.dir}/Library/Keychains/login.keychain-db"
  cmd = [
    'unlock-keychain',
    '-p',
    Xolo::Server.config.autopkg_user_keychain_pw,
    keychain_path
  ]
  run_security(cmd.map { |i| security_escape i }.join(' '))
end