Class: JSS::DistributionPoint

Inherits:
APIObject show all
Defined in:
lib/jss/api_object/distribution_point.rb,
lib/jss.rb

Overview

A Distribution Point in the JSS

As well as the normal Class and Instance methods for APIObject subclasses, the DistributionPoint class provides more interaction with other parts of the API.

Beyond the standard listing methods DistributionPoint.all, .all_ids, etc, every JSS has a single “master” distribution point. The Class method DistributionPoint.master_distribution_point will return the JSS::DistributionPoint object for that master.

Also, some network segments have specific DistributionPoints assigned to them. Calling the Class method DistributionPoint.my_distribution_point will return a JSS::DistributionPoint object for your local IP address.

Once you have an instance of JSS::DistributionPoint, you can mount it (on a Mac) by calling its #mount method and unmount it with #unmount. The Package and possibly Script classes use this to upload items to the master.

See Also:

Constant Summary collapse

RSRC_BASE =

The base for REST resources of this class

'distributionpoints'.freeze
RSRC_LIST_KEY =

the hash key used for the JSON list output of all objects in the JSS its also used in various error messages

:distribution_points
RSRC_OBJECT_KEY =

The hash key used for the JSON object output. It's also used in various error messages

:distribution_point
MOUNT_OPTIONS =

what are the mount options? these are comma-separated, and are passed with -o

'nobrowse'.freeze
EMPTY_PW_256 =

An empty SHA256 digest

'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'.freeze
DEFAULT_MOUNTPOINT_DIR =

Set default local mount for distribution point

Pathname.new '/tmp'
DEFAULT_MOUNTPOINT_PREFIX =
'CasperDistribution-id'.freeze
OBJECT_HISTORY_OBJECT_TYPE =

the object type for this object in the object history table. See APIObject#add_object_history_entry

76

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ DistributionPoint

As well as the standard :id, :name, and :data, you can instantiate this class with :id => :master, in which case you'll get the Master Distribution Point as defined in the JSS. An error will be raised if one hasn't been defined.

You can also do this more easily by calling JSS.master_distribution_point



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/jss/api_object/distribution_point.rb', line 208

def initialize(args = {})
  # TODO: this looks redundant with super....
  args[:api] ||= JSS.api
  @api = args[:api]

  @init_data = nil

  # looking for master?
  if args[:id] == :master

    self.class.all_ids(api: @api).each do |id|
      @init_data = @api.get_rsrc("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
      if @init_data[:is_master]
        @id = @init_data[:id]
        @name = @init_data[:name]
        break
      end # if data is master
      @init_data = nil
    end # each id
  end # if args is master

  super(args) if @init_data.nil?

  @ip_address = @init_data[:ip_address]
  @local_path = @init_data[:local_path]
  @enable_load_balancing = @init_data[:enable_load_balancing]
  @failover_point = @init_data[:failover_point]
  @is_master = @init_data[:is_master]

  @connection_type = @init_data[:connection_type]
  @share_port = @init_data[:share_port]
  @share_name = @init_data[:share_name]
  @workgroup_or_domain = @init_data[:workgroup_or_domain]

  @read_write_username = @init_data[:read_write_username]
  @read_write_password_sha256 = @init_data[:read_write_password_sha256]
  @read_only_username = @init_data[:read_only_username]
  @read_only_password_sha256 = @init_data[:read_only_password_sha256]
  @ssh_username = @init_data[:ssh_username]
  @ssh_password_sha256 = @init_data[:ssh_password_sha256]
  @http_username = @init_data[:http_username]
  @http_password_sha256 = @init_data[:http_password_sha256]

  @http_downloads_enabled = @init_data[:http_downloads_enabled]
  @protocol = @init_data[:protocol]
  @port = @init_data[:port]
  @context = @init_data[:context]
  @no_authentication_required = @init_data[:no_authentication_required]
  @certificate_required = @init_data[:certificate_required]
  @username_password_required = @init_data[:username_password_required]
  @certificate = @init_data[:certificate]
  @http_url = @init_data[:http_url]
  @failover_point_url = @init_data[:failover_point_url]

  @port = @init_data[:ssh_password]

  # Note, as of Casper 9.3:
  # :management_password_md5=>"xxxxx"
  # and
  # :management_password_sha256=> "xxxxxxxxxx"
  # Are the read/write password
  #
  # An empty passwd is
  # MD5 = d41d8cd98f00b204e9800998ecf8427e
  # SHA256 = e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
  #
  # Seemms the read-only pw isn't available in the API

  # if we mount for fileservice, where's the mountpoint?
  @mountpoint = Pathname.new "/#{DEFAULT_MOUNTPOINT_DIR}/#{DEFAULT_MOUNTPOINT_PREFIX}#{@id}"
end

Instance Attribute Details

#certificateString (readonly)

Returns the name of the cert. used for http cert. auth.

Returns:

  • (String)

    the name of the cert. used for http cert. auth.



185
186
187
# File 'lib/jss/api_object/distribution_point.rb', line 185

def certificate
  @certificate
end

#certificate_requiredBoolean (readonly)

Returns do http downloads use cert. authentication?.

Returns:

  • (Boolean)

    do http downloads use cert. authentication?



173
174
175
# File 'lib/jss/api_object/distribution_point.rb', line 173

def certificate_required
  @certificate_required
end

#connection_typeString (readonly)

Returns Protocol for fileservice access (e.g. AFP, SMB).

Returns:

  • (String)

    Protocol for fileservice access (e.g. AFP, SMB)



132
133
134
# File 'lib/jss/api_object/distribution_point.rb', line 132

def connection_type
  @connection_type
end

#contextString (readonly)

Returns the “context” for http downloads (what goes after the hostname part of the URL).

Returns:

  • (String)

    the “context” for http downloads (what goes after the hostname part of the URL)



167
168
169
# File 'lib/jss/api_object/distribution_point.rb', line 167

def context
  @context
end

#enable_load_balancingString (readonly)

Returns load balanacing enabled?.

Returns:

  • (String)

    load balanacing enabled?



121
122
123
# File 'lib/jss/api_object/distribution_point.rb', line 121

def enable_load_balancing
  @enable_load_balancing
end

#failover_pointInteger (readonly)

Returns the id of the DP to use for failover.

Returns:

  • (Integer)

    the id of the DP to use for failover



124
125
126
# File 'lib/jss/api_object/distribution_point.rb', line 124

def failover_point
  @failover_point
end

#failover_point_urlString (readonly)

Returns the URL to use if this one doesn't work.

Returns:

  • (String)

    the URL to use if this one doesn't work



191
192
193
# File 'lib/jss/api_object/distribution_point.rb', line 191

def failover_point_url
  @failover_point_url
end

#http_downloads_enabledBoolean (readonly)

Returns are http downloads available from this DP?.

Returns:

  • (Boolean)

    are http downloads available from this DP?



158
159
160
# File 'lib/jss/api_object/distribution_point.rb', line 158

def http_downloads_enabled
  @http_downloads_enabled
end

#http_password_sha256String (readonly)

Returns the password for http downloads, if needed, as a SHA256 digest.

Returns:

  • (String)

    the password for http downloads, if needed, as a SHA256 digest



182
183
184
# File 'lib/jss/api_object/distribution_point.rb', line 182

def http_password_sha256
  @http_password_sha256
end

#http_urlString (readonly)

Returns the URL for http downloads.

Returns:

  • (String)

    the URL for http downloads



188
189
190
# File 'lib/jss/api_object/distribution_point.rb', line 188

def http_url
  @http_url
end

#http_usernameString (readonly)

Returns the username to use for http downloads if needed for user/pw auth.

Returns:

  • (String)

    the username to use for http downloads if needed for user/pw auth



179
180
181
# File 'lib/jss/api_object/distribution_point.rb', line 179

def http_username
  @http_username
end

#ip_addressString (readonly) Also known as: hostname

Returns the hostname of this DP.

Returns:

  • (String)

    the hostname of this DP



115
116
117
# File 'lib/jss/api_object/distribution_point.rb', line 115

def ip_address
  @ip_address
end

#is_masterBoolean (readonly) Also known as: master?

Returns is this the master DP?.

Returns:

  • (Boolean)

    is this the master DP?



127
128
129
# File 'lib/jss/api_object/distribution_point.rb', line 127

def is_master
  @is_master
end

#local_pathString (readonly)

Returns the local path on the server to the distribution point directory.

Returns:

  • (String)

    the local path on the server to the distribution point directory



118
119
120
# File 'lib/jss/api_object/distribution_point.rb', line 118

def local_path
  @local_path
end

#no_authentication_requiredBoolean (readonly)

Returns do http downloads work without auth?.

Returns:

  • (Boolean)

    do http downloads work without auth?



170
171
172
# File 'lib/jss/api_object/distribution_point.rb', line 170

def no_authentication_required
  @no_authentication_required
end

#portInteger (readonly)

Returns the port for http access.

Returns:

  • (Integer)

    the port for http access



164
165
166
# File 'lib/jss/api_object/distribution_point.rb', line 164

def port
  @port
end

#protocolString (readonly)

Returns the protocol to use for http downloads (http/https).

Returns:

  • (String)

    the protocol to use for http downloads (http/https)



161
162
163
# File 'lib/jss/api_object/distribution_point.rb', line 161

def protocol
  @protocol
end

#read_only_password_sha256String (readonly)

Returns read-only password as a SHA256 digest.

Returns:

  • (String)

    read-only password as a SHA256 digest



150
151
152
# File 'lib/jss/api_object/distribution_point.rb', line 150

def read_only_password_sha256
  @read_only_password_sha256
end

#read_only_usernameString (readonly)

Returns read-only username for fileservice.

Returns:

  • (String)

    read-only username for fileservice



147
148
149
# File 'lib/jss/api_object/distribution_point.rb', line 147

def read_only_username
  @read_only_username
end

#read_write_password_sha256String (readonly)

Returns the read-write password as a SHA256 digest.

Returns:

  • (String)

    the read-write password as a SHA256 digest



144
145
146
# File 'lib/jss/api_object/distribution_point.rb', line 144

def read_write_password_sha256
  @read_write_password_sha256
end

#read_write_usernameString (readonly)

Returns the read-write username for fileservice access.

Returns:

  • (String)

    the read-write username for fileservice access



141
142
143
# File 'lib/jss/api_object/distribution_point.rb', line 141

def read_write_username
  @read_write_username
end

#share_nameString (readonly)

Returns the name of the fileservice sharepoint.

Returns:

  • (String)

    the name of the fileservice sharepoint



138
139
140
# File 'lib/jss/api_object/distribution_point.rb', line 138

def share_name
  @share_name
end

#share_portInteger (readonly)

Returns the port for fileservice access.

Returns:

  • (Integer)

    the port for fileservice access



135
136
137
# File 'lib/jss/api_object/distribution_point.rb', line 135

def share_port
  @share_port
end

#ssh_password_sha256String (readonly)

Returns the ssh password as a SHA256 digest.

Returns:

  • (String)

    the ssh password as a SHA256 digest



199
200
201
# File 'lib/jss/api_object/distribution_point.rb', line 199

def ssh_password_sha256
  @ssh_password_sha256
end

#ssh_usernameString (readonly)

Returns ssh username.

Returns:



196
197
198
# File 'lib/jss/api_object/distribution_point.rb', line 196

def ssh_username
  @ssh_username
end

#username_password_requiredBoolean (readonly)

Returns do http downloads use user/pw auth?.

Returns:

  • (Boolean)

    do http downloads use user/pw auth?



176
177
178
# File 'lib/jss/api_object/distribution_point.rb', line 176

def username_password_required
  @username_password_required
end

#workgroup_or_domainString (readonly)

Returns work group or domain for SMB.

Returns:

  • (String)

    work group or domain for SMB



153
154
155
# File 'lib/jss/api_object/distribution_point.rb', line 153

def workgroup_or_domain
  @workgroup_or_domain
end

Class Method Details

.master_distribution_point(refresh = false, api: JSS.api) ⇒ JSS::DistributionPoint

Get the DistributionPoint instance for the master distribution point in the JSS. If there's only one in the JSS, return it even if not marked as master.

Parameters:

  • refresh (Boolean) (defaults to: false)

    should the distribution point be re-queried?

  • api (JSS::APIConnection) (defaults to: JSS.api)

    which API connection should we query?

Returns:



93
94
95
# File 'lib/jss/api_object/distribution_point.rb', line 93

def self.master_distribution_point(refresh = false, api: JSS.api)
  api.master_distribution_point refresh
end

.my_distribution_point(refresh = false, api: JSS.api) ⇒ JSS::DistributionPoint

Get the DistributionPoint instance for the machine running this code, based on its IP address. If none is defined for this IP address, use the result of master_distribution_point

Parameters:

  • refresh (Boolean) (defaults to: false)

    should the distribution point be re-queried?

  • api (JSS::APIConnection) (defaults to: JSS.api)

    which API connection should we query?

Returns:



107
108
109
# File 'lib/jss/api_object/distribution_point.rb', line 107

def self.my_distribution_point(refresh = false, api: JSS.api)
  api.my_distribution_point refresh
end

Instance Method Details

#check_pw(user, pw) ⇒ Boolean, Nil

Check the validity of a password.

Parameters:

  • user (Symbol)

    one of :ro, :rw, :ssh, :http

  • pw (String)

    the password to check for the given user

Returns:

  • (Boolean, Nil)

    was the password correct? nil is returned if there is no password set in the JSS.

Raises:



289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/jss/api_object/distribution_point.rb', line 289

def check_pw(user, pw)
  raise JSS::InvalidDataError, 'The first parameter must be one of :ro, :rw, :ssh, :http' unless %i[ro rw ssh http].include? user

  sha256 = case user
           when :rw then @read_write_password_sha256
           when :ro then @read_only_password_sha256
           when :http then @http_password_sha256
           when :ssh then @ssh_password_sha256
  end # case

  return nil if sha256 == EMPTY_PW_256

  sha256 == Digest::SHA2.new(256).update(pw).to_s
end

#mount(pw = nil, access = :ro) ⇒ Pathname

Mount this distribution point locally.

Parameters:

  • pw (String, Symbol) (defaults to: nil)

    the read-only or read-write password for this DistributionPoint If :prompt, the user is promted on the commandline to enter the password for the :user. If :stdin#, the password is read from a line of std in represented by the digits at #, so :stdin3 reads the passwd from the third line of standard input. defaults to line 2, if no digit is supplied. see JSS.stdin

  • access (Symbol) (defaults to: :ro)

    how to mount the DistributionPoint, and which password to expect. :ro (or anything else) = read-only, :rw = read-write

Returns:



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/jss/api_object/distribution_point.rb', line 389

def mount(pw = nil, access = :ro)
  return @mountpoint if mounted?

  access = :ro unless access == :rw

  password = if pw == :prompt
               JSS.prompt_for_password "Enter the password for the #{access} user '#{access == :ro ? @read_only_username : @read_write_username}':"
             elsif pw.is_a?(Symbol) && pw.to_s.start_with?('stdin')
               pw.to_s =~ /^stdin(\d+)$/
               line = Regexp.last_match(1)
               line ||= 2
               JSS.stdin line
             else
               pw
  end

  pwok = check_pw(access, password)
  unless pwok
    msg = pwok.nil? ? "No #{access} password set in the JSS" : "Incorrect password for #{access} account"
    raise JSS::InvalidDataError, msg
  end

  username = access == :ro ? @read_only_username : @read_write_username

  safe_pw = CGI.escape password.to_s

  @mount_url = "#{@connection_type.downcase}://#{username}:#{safe_pw}@#{@ip_address}/#{@share_name}"
  @mnt_cmd = case @connection_type.downcase
             when 'smb' then '/sbin/mount_smbfs'
             when 'afp' then '/sbin/mount_afp'
             else raise "Can't mount distribution point #{@name}: no known connection type."
  end

  @mountpoint.mkpath

  mount_out = `#{@mnt_cmd} -o '#{MOUNT_OPTIONS}' '#{@mount_url}' '#{@mountpoint}' 2>&1`
  if ($CHILD_STATUS.exitstatus == 0) && @mountpoint.mountpoint?
    # if system @mnt_cmd.to_s, *['-o', MOUNT_OPTIONS, @mount_url, @mountpoint.to_s]
    @mounted = access
  else
    @mountpoint.rmdir if @mountpoint.directory?
    @mounted = nil
    raise JSS::FileServiceError, "Can't mount #{@ip_address}: #{mount_out}"
  end
  @mountpoint
end

#mounted?Boolean

Is this thing mounted right now?

Returns:

  • (Boolean)


459
460
461
# File 'lib/jss/api_object/distribution_point.rb', line 459

def mounted?
  @mountpoint.directory? && @mountpoint.mountpoint?
end

#reachable_for_download?(pw = '', check_http = true) ⇒ FalseClass, Symbol

Check to see if this dist point is reachable for downloads (read-only) via either http, if available, or filesharing.

Parameters:

  • pw (String) (defaults to: '')

    the read-only password to use for checking the connection If http downloads are enabled, and no http password is required this can be omitted.

  • check_http (Boolean) (defaults to: true)

    should we try the http download first, if enabled? If you're intentionally using the ro password for filesharing, and want to check only filesharing, then set this to false.

Returns:

  • (FalseClass, Symbol)

    false if not reachable, otherwise :http or :mountable



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/jss/api_object/distribution_point.rb', line 317

def reachable_for_download?(pw = '', check_http = true)
  pw ||= ''
  http_checked = ''
  if check_http && http_downloads_enabled
    if @username_password_required
      # we don't check the pw here, because if the connection fails, we'll
      # drop down below to try the password for mounting.
      # we'll escape all the chars that aren't unreserved
      # reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]")
      user_pass = "#{CGI.escape @http_username.to_s}:#{CGI.escape ro_pw.to_s}@"
      url = @http_url.sub "://#{@ip_address}", "://#{user_pass}#{@ip_address}"
    else
      url = @http_url
    end

    begin
      open(url).read
      return :http
    rescue
      http_checked = 'http and '
    end
  end # if  check_http && http_downloads_enabled

  return :mountable if mounted?

  return false unless check_pw :ro, pw

  begin
    mount pw, :ro
    return :mountable
  rescue
    return false
  ensure
    unmount
  end
end

#reachable_for_upload?(pw) ⇒ FalseClass, Symbol

Check to see if this dist point is reachable for uploads (read-write) via filesharing.

Parameters:

  • pw (String)

    the read-write password to use for checking the connection

Returns:

  • (FalseClass, Symbol)

    false if not reachable, otherwise :mountable



361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/jss/api_object/distribution_point.rb', line 361

def reachable_for_upload?(pw)
  return :mountable if mounted?
  return false unless check_pw :rw, pw

  begin
    mount pw, :rw
    return :mountable
  rescue
    return false
  ensure
    unmount
  end
end

#unmountvoid Also known as: umount

This method returns an undefined value.

Unmount the distribution point.

Does nothing if it wasn't mounted with #mount.



442
443
444
445
446
447
448
449
450
451
452
453
# File 'lib/jss/api_object/distribution_point.rb', line 442

def unmount
  return nil unless mounted?

  if system "/sbin/umount '#{@mountpoint}'"
    sleep 1 # the umount takes time.
    @mountpoint.rmdir if @mountpoint.directory? && !@mountpoint.mountpoint?
    @mounted = false
  else
    raise JSS::FileServiceError, "There was a problem unmounting #{@mountpoint}"
  end
  nil
end