Class: Puppet::Provider::NameService::DirectoryService

Inherits:
Puppet::Provider::NameService show all
Defined in:
lib/vendor/puppet/provider/nameservice/directoryservice.rb

Constant Summary collapse

@@ds_to_ns_attribute_map =

JJM 2007-07-25: This map is used to map NameService attributes to their

corresponding DirectoryService attribute names.
See: http://images.apple.com/server/docs.Open_Directory_v10.4.pdf

JJM: Note, this is de-coupled from the Puppet::Type, and must

be actively maintained.  There may also be collisions with different
types (Users, Groups, Mounts, Hosts, etc...)

{
  'RecordName' => :name,
  'PrimaryGroupID' => :gid,
  'NFSHomeDirectory' => :home,
  'UserShell' => :shell,
  'UniqueID' => :uid,
  'RealName' => :comment,
  'Password' => :password,
  'GeneratedUID' => :guid,
  'IPAddress'    => :ip_address,
  'ENetAddress'  => :en_address,
  'GroupMembership' => :members,
}
@@ns_to_ds_attribute_map =

JJM The same table as above, inverted.

{
  :name => 'RecordName',
  :gid => 'PrimaryGroupID',
  :home => 'NFSHomeDirectory',
  :shell => 'UserShell',
  :uid => 'UniqueID',
  :comment => 'RealName',
  :password => 'Password',
  :guid => 'GeneratedUID',
  :en_address => 'ENetAddress',
  :ip_address => 'IPAddress',
  :members => 'GroupMembership',
}
@@password_hash_dir = 
"/var/db/shadow/hash"
@@users_plist_dir = 
'/var/db/dslocal/nodes/Default/users'

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Class Attribute Summary collapse

Attributes inherited from Puppet::Provider

#model, #resource

Attributes included from Util::Docs

#doc, #nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Puppet::Provider::NameService

#autogen, autogen_default, autogen_defaults, #autogen_id, #delete, #ensure, #exists?, #get, #groups, #info2hash, #initialize, initvars, listbyname, option, options, resource_type=, section, validate, verify

Methods inherited from Puppet::Provider

#<=>, #clear, command, #command, commands, declared_feature?, default?, defaultfor, #get, #initialize, initvars, make_command_methods, mk_resource_methods, mkmodelmethods, #name, optional_commands, specificity, supports_parameter?, #to_s

Methods included from Util::Logging

#clear_deprecation_warnings, #deprecation_warning, #send_log

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Methods included from Util::Warnings

clear_warnings, notice_once, warnonce

Methods included from Confiner

#confine, #confine_collection, #suitable?

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, #exceptwrap, #fail

Constructor Details

This class inherits a constructor from Puppet::Provider::NameService

Class Attribute Details

.ds_path=(value) ⇒ Object (writeonly)

JJM: This allows us to pass information when calling

    Puppet::Type.type
e.g. Puppet::Type.type(:user).provide :directoryservice, :ds_path => "Users"
This is referenced in the get_ds_path class method



15
16
17
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 15

def ds_path=(value)
  @ds_path = value
end

.macosx_version_major=(value) ⇒ Object (writeonly)

Sets the attribute macosx_version_major

Parameters:

  • value —

    the value to set the attribute macosx_version_major to.



16
17
18
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 16

def macosx_version_major=(value)
  @macosx_version_major = value
end

Class Method Details

.convert_binary_to_xml(plist_data) ⇒ Object

This method will accept a binary plist (as a string) and convert it to a hash via Plist::parse_xml.



407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 407

def self.convert_binary_to_xml(plist_data)
  Puppet.debug('Converting binary plist to XML')
  Puppet.debug('Executing: \'plutil -convert xml1 -o - -\'')
  IO.popen('plutil -convert xml1 -o - -', mode='r+') do |io|
    io.write plist_data
    io.close_write
    @converted_plist = io.read
  end
  Puppet.debug('Converting XML values to a hash.')
  @plist_hash = Plist::parse_xml(@converted_plist)
  @plist_hash
end

.convert_xml_to_binary(plist_data) ⇒ Object

This method will accept a hash that has been returned from Plist::parse_xml and convert it to a binary plist (string value).



394
395
396
397
398
399
400
401
402
403
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 394

def self.convert_xml_to_binary(plist_data)
  Puppet.debug('Converting XML plist to binary')
  Puppet.debug('Executing: \'plutil -convert binary1 -o - -\'')
  IO.popen('plutil -convert binary1 -o - -', mode='r+') do |io|
    io.write plist_data.to_plist
    io.close_write
    @converted_plist = io.read
  end
  @converted_plist
end

.generate_attribute_hash(input_hash, *type_properties) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 171

def self.generate_attribute_hash(input_hash, *type_properties)
  attribute_hash = {}
  input_hash.keys.each do |key|
    ds_attribute = key.sub("dsAttrTypeStandard:", "")
    next unless (@@ds_to_ns_attribute_map.keys.include?(ds_attribute) and type_properties.include? @@ds_to_ns_attribute_map[ds_attribute])
    ds_value = input_hash[key]
    case @@ds_to_ns_attribute_map[ds_attribute]
      when :members
        ds_value = ds_value # only members uses arrays so far
      when :gid, :uid
        # OS X stores objects like uid/gid as strings.
        # Try casting to an integer for these cases to be
        # consistent with the other providers and the group type
        # validation
        begin
          ds_value = Integer(ds_value[0])
        rescue ArgumentError
          ds_value = ds_value[0]
        end
      else ds_value = ds_value[0]
    end
    attribute_hash[@@ds_to_ns_attribute_map[ds_attribute]] = ds_value
  end

  # NBK: need to read the existing password here as it's not actually
  # stored in the user record. It is stored at a path that involves the
  # UUID of the user record for non-Mobile local acccounts.
  # Mobile Accounts are out of scope for this provider for now
  attribute_hash[:password] = self.get_password(attribute_hash[:guid], attribute_hash[:name]) if @resource_type.validproperties.include?(:password) and Puppet.features.root?
  attribute_hash
end

.get_ds_path ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 80

def self.get_ds_path
  # JJM: 2007-07-24 This method dynamically returns the DS path we're concerned with.
  #      For example, if we're working with an user type, this will be /Users
  #      with a group type, this will be /Groups.
  #   @ds_path is an attribute of the class itself.
  return @ds_path if defined?(@ds_path)
  # JJM: "Users" or "Groups" etc ...  (Based on the Puppet::Type)
  #       Remember this is a class method, so self.class is Class
  #       Also, @resource_type seems to be the reference to the
  #       Puppet::Type this class object is providing for.
  @resource_type.name.to_s.capitalize + "s"
end

.get_exec_preamble(ds_action, resource_name = nil) ⇒ Object 



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
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 238

def self.get_exec_preamble(ds_action, resource_name = nil)
  # JJM 2007-07-24
  #     DSCL commands are often repetitive and contain the same positional
  #     arguments over and over. See http://developer.apple.com/documentation/Porting/Conceptual/PortingUnix/additionalfeatures/chapter_10_section_9.html
  #     for an example of what I mean.
  #     This method spits out proper DSCL commands for us.
  #     We EXPECT name to be @resource[:name] when called from an instance object.

  # 10.4 doesn't support the -plist option for dscl, and 10.5 has a
  # different format for the -url output with objects with spaces in
  # their values. *sigh*. Use -url for 10.4 in the hope this can be
  # deprecated one day, and use -plist for 10.5 and higher.
  if self.get_macosx_version_major > "10.4"
    command_vector = [ command(:dscl), "-plist", "." ]
  elsif self.get_macosx_version_major == "10.4"
    command_vector = [ command(:dscl), "-url", "." ]
  else
    fail("Puppet does not support OS X versions < 10.4")
  end

  # JJM: The actual action to perform.  See "man dscl"
  #      Common actiosn: -create, -delete, -merge, -append, -passwd
  command_vector << ds_action
  # JJM: get_ds_path will spit back "Users" or "Groups",
  # etc...  Depending on the Puppet::Type of our self.
  if resource_name
    command_vector << "/#{get_ds_path}/#{resource_name}"
  else
    command_vector << "/#{get_ds_path}"
  end
  # JJM:  This returns most of the preamble of the command.
  #       e.g. 'dscl / -create /Users/mccune'
  command_vector
end

.get_macosx_version_major ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 93

def self.get_macosx_version_major
  return @macosx_version_major if defined?(@macosx_version_major)
  begin
    # Make sure we've loaded all of the facts
    Facter.loadfacts

    if Facter.value(:macosx_productversion_major)
      product_version_major = Facter.value(:macosx_productversion_major)
    else
      # TODO: remove this code chunk once we require Facter 1.5.5 or higher.
      Puppet.warning("DEPRECATION WARNING: Future versions of the directoryservice provider will require Facter 1.5.5 or newer.")
      product_version = Facter.value(:macosx_productversion)
      fail("Could not determine OS X version from Facter") if product_version.nil?
      product_version_major = product_version.scan(/(\d+)\.(\d+)./).join(".")
    end
    fail("#{product_version_major} is not supported by the directoryservice provider") if %w{10.0 10.1 10.2 10.3}.include?(product_version_major)
    @macosx_version_major = product_version_major
    return @macosx_version_major
  rescue Puppet::ExecutionFailure => detail
    fail("Could not determine OS X version: #{detail}")
  end
end

.get_password(guid, username) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 354

def self.get_password(guid, username)
  # Use Puppet::Util::Package.versioncmp() to catch the scenario where a
  # version '10.10' would be < '10.7' with simple string comparison. This
  # if-statement only executes if the current version is less-than 10.7
  if (Puppet::Util::Package.versioncmp(get_macosx_version_major, '10.7') == -1)
    password_hash = nil
    password_hash_file = "#{@@password_hash_dir}/#{guid}"
    if File.exists?(password_hash_file) and File.file?(password_hash_file)
      fail("Could not read password hash file at #{password_hash_file}") if not File.readable?(password_hash_file)
      f = File.new(password_hash_file)
      password_hash = f.read
      f.close
    end
    password_hash
  else
    if File.exists?("#{@@users_plist_dir}/#{username}.plist")
      # If a plist exists in /var/db/dslocal/nodes/Default/users, we will
      # extract the binary plist from the 'ShadowHashData' key, decode the
      # salted-SHA512 password hash, and then return it.
      users_plist = Plist::parse_xml(plutil('-convert', 'xml1', '-o', '/dev/stdout', "#{@@users_plist_dir}/#{username}.plist"))
      if users_plist['ShadowHashData']
        # users_plist['ShadowHashData'][0].string is actually a binary plist
        # that's nested INSIDE the user's plist (which itself is a binary
        # plist).
        password_hash_plist = users_plist['ShadowHashData'][0].string
        converted_hash_plist = convert_binary_to_xml(password_hash_plist)

        # converted_hash_plist['SALTED-SHA512'].string is a Base64 encoded
        # string. The password_hash provided as a resource attribute is a
        # hex value. We need to convert the Base64 encoded string to a
        # hex value and provide it back to Puppet.
        password_hash = converted_hash_plist['SALTED-SHA512'].string.unpack("H*")[0]
        password_hash
      end
    end
  end
end

.instances ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 67

def self.instances
  # JJM Class method that provides an array of instance objects of this
  #     type.
  # JJM: Properties are dependent on the Puppet::Type we're managine.
  type_property_array = [:name] + @resource_type.validproperties

  # Create a new instance of this Puppet::Type for each object present
  #    on the system.
  list_all_present.collect do |name_string|
    self.new(single_report(name_string, *type_property_array))
  end
end

.list_all_present ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 117

def self.list_all_present
  # JJM: List all objects of this Puppet::Type already present on the system.
  begin
    dscl_output = execute(get_exec_preamble("-list"))
  rescue Puppet::ExecutionFailure => detail
    fail("Could not get #{@resource_type.name} list from DirectoryService")
  end
  dscl_output.split("\n")
end

.next_system_id(id_type, min_id = 20) ⇒ Object

Unlike most other *nixes, OS X doesn’t provide built in functionality for automatically assigning uids and gids to accounts, so we set up these methods for consumption by functionality like –mkusers By default we restrict to a reasonably sane range for system accounts



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 424

def self.next_system_id(id_type, min_id=20)
  dscl_args = ['.', '-list']
  if id_type == 'uid'
    dscl_args << '/Users' << 'uid'
  elsif id_type == 'gid'
    dscl_args << '/Groups' << 'gid'
  else
    fail("Invalid id_type #{id_type}. Only 'uid' and 'gid' supported")
  end
  dscl_out = dscl(dscl_args)
  # We're ok with throwing away negative uids here.
  ids = dscl_out.split.compact.collect { |l| l.to_i if l.match(/^\d+$/) }
  ids.compact!.sort! { |a,b| a.to_f <=> b.to_f }
  # We're just looking for an unused id in our sorted array.
  ids.each_index do |i|
    next_id = ids[i] + 1
    return next_id if ids[i+1] != next_id and next_id >= min_id
  end
end

.parse_dscl_plist_data(dscl_output) ⇒ Object 



167
168
169
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 167

def self.parse_dscl_plist_data(dscl_output)
  Plist.parse_xml(dscl_output)
end

.parse_dscl_url_data(dscl_output) ⇒ Object 



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
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 127

def self.parse_dscl_url_data(dscl_output)
  # we need to construct a Hash from the dscl -url output to match
  # that returned by the dscl -plist output for 10.5+ clients.
  #
  # Nasty assumptions:
  #   a) no values *end* in a colon ':', only keys
  #   b) if a line ends in a colon and the next line does start with
  #      a space, then the second line is a value of the first.
  #   c) (implied by (b)) keys don't start with spaces.

  dscl_plist = {}
  dscl_output.split("\n").inject([]) do |array, line|
    if line =~ /^\s+/   # it's a value
      array[-1] << line # add the value to the previous key
    else
      array << line
    end
    array
  end.compact

  dscl_output.each do |line|
    # This should be a 'normal' entry. key and value on one line.
    # We split on ': ' to deal with keys/values with a colon in them.
    split_array = line.split(/:\s+/)
    key = split_array.first
    value = CGI::unescape(split_array.last.strip.chomp)
    # We need to treat GroupMembership separately as it is currently
    # the only attribute we care about multiple values for, and
    # the values can never contain spaces (shortnames)
    # We also make every value an array to be consistent with the
    # output of dscl -plist under 10.5
    if key == "GroupMembership"
      dscl_plist[key] = value.split(/\s/)
    else
      dscl_plist[key] = [value]
    end
  end
  dscl_plist
end

.set_password(resource_name, guid, password_hash) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
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/vendor/puppet/provider/nameservice/directoryservice.rb', line 273

def self.set_password(resource_name, guid, password_hash)
  # Use Puppet::Util::Package.versioncmp() to catch the scenario where a
  # version '10.10' would be < '10.7' with simple string comparison. This
  # if-statement only executes if the current version is less-than 10.7
  if (Puppet::Util::Package.versioncmp(get_macosx_version_major, '10.7') == -1)
    password_hash_file = "#{@@password_hash_dir}/#{guid}"
    begin
      File.open(password_hash_file, 'w') { |f| f.write(password_hash)}
    rescue Errno::EACCES => detail
      fail("Could not write to password hash file: #{detail}")
    end

    # NBK: For shadow hashes, the user AuthenticationAuthority must contain a value of
    # ";ShadowHash;". The LKDC in 10.5 makes this more interesting though as it
    # will dynamically generate ;Kerberosv5;;username@LKDC:SHA1 attributes if
    # missing. Thus we make sure we only set ;ShadowHash; if it is missing, and
    # we can do this with the merge command. This allows people to continue to
    # use other custom AuthenticationAuthority attributes without stomping on them.
    #
    # There is a potential problem here in that we're only doing this when setting
    # the password, and the attribute could get modified at other times while the
    # hash doesn't change and so this doesn't get called at all... but
    # without switching all the other attributes to merge instead of create I can't
    # see a simple enough solution for this that doesn't modify the user record
    # every single time. This should be a rather rare edge case. (famous last words)

    dscl_vector = self.get_exec_preamble("-merge", resource_name)
    dscl_vector << "AuthenticationAuthority" << ";ShadowHash;"
    begin
      dscl_output = execute(dscl_vector)
    rescue Puppet::ExecutionFailure => detail
      fail("Could not set AuthenticationAuthority.")
    end
  else
    # 10.7 uses salted SHA512 password hashes which are 128 characters plus
    # an 8 character salt. Previous versions used a SHA1 hash padded with
    # zeroes. If someone attempts to use a password hash that worked with
    # a previous version of OX X, we will fail early and warn them.
    if password_hash.length != 136
      fail("OS X 10.7 requires a Salted SHA512 hash password of 136 characters. \
           Please check your password and try again.")
    end

    if File.exists?("#{@@users_plist_dir}/#{resource_name}.plist")
      # If a plist already exists in /var/db/dslocal/nodes/Default/users, then
      # we will need to extract the binary plist from the 'ShadowHashData'
      # key, log the new password into the resultant plist's 'SALTED-SHA512'
      # key, and then save the entire structure back.
      users_plist = Plist::parse_xml(plutil( '-convert', 'xml1', '-o', '/dev/stdout', \
                                     "#{@@users_plist_dir}/#{resource_name}.plist"))

      # users_plist['ShadowHashData'][0].string is actually a binary plist
      # that's nested INSIDE the user's plist (which itself is a binary
      # plist). If we encounter a user plist that DOESN'T have a
      # ShadowHashData field, create one.
      if users_plist['ShadowHashData']
        password_hash_plist = users_plist['ShadowHashData'][0].string
        converted_hash_plist = convert_binary_to_xml(password_hash_plist)
      else
        users_plist['ShadowHashData'] = [StringIO.new]
        converted_hash_plist = {'SALTED-SHA512' => StringIO.new}
      end

      # converted_hash_plist['SALTED-SHA512'].string expects a Base64 encoded
      # string. The password_hash provided as a resource attribute is a
      # hex value. We need to convert the provided hex value to a Base64
      # encoded string to nest it in the converted hash plist.
      converted_hash_plist['SALTED-SHA512'].string = \
        password_hash.unpack('a2'*(password_hash.size/2)).collect { |i| i.hex.chr }.join

      # Finally, we can convert the nested plist back to binary, embed it
      # into the user's plist, and convert the resultant plist back to
      # a binary plist.
      changed_plist = convert_xml_to_binary(converted_hash_plist)
      users_plist['ShadowHashData'][0].string = changed_plist
      Plist::Emit.save_plist(users_plist, "#{@@users_plist_dir}/#{resource_name}.plist")
      plutil('-convert', 'binary1', "#{@@users_plist_dir}/#{resource_name}.plist")
    end
  end
end

.single_report(resource_name, *type_properties) ⇒ Object 



203
204
205
206
207
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
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 203

def self.single_report(resource_name, *type_properties)
  # JJM 2007-07-24:
  #     Given a the name of an object and a list of properties of that
  #     object, return all property values in a hash.
  #
  #     This class method returns nil if the object doesn't exist
  #     Otherwise, it returns a hash of the object properties.

  all_present_str_array = list_all_present

  # NBK: shortcut the process if the resource is missing
  return nil unless all_present_str_array.include? resource_name

  dscl_vector = get_exec_preamble("-read", resource_name)
  begin
    dscl_output = execute(dscl_vector)
  rescue Puppet::ExecutionFailure => detail
    fail("Could not get report.  command execution failed.")
  end

  # Two code paths is ugly, but until we can drop 10.4 support we don't
  # have a lot of choice. Ultimately this should all be done using Ruby
  # to access the DirectoryService APIs directly, but that's simply not
  # feasible for a while yet.
  if self.get_macosx_version_major > "10.4"
    dscl_plist = self.parse_dscl_plist_data(dscl_output)
  elsif self.get_macosx_version_major == "10.4"
    dscl_plist = self.parse_dscl_url_data(dscl_output)
  else
    fail("Puppet does not support OS X versions < 10.4")
  end

  self.generate_attribute_hash(dscl_plist, *type_properties)
end

Instance Method Details

#add_members(current_members, new_members) ⇒ Object 



591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 591

def add_members(current_members, new_members)
  new_members.flatten.each do |new_member|
    if current_members.nil? or not current_members.include?(new_member)
      cmd = [:dseditgroup, "-o", "edit", "-n", ".", "-a", new_member, @resource[:name]]
      begin
        execute(cmd)
      rescue Puppet::ExecutionFailure => detail
        fail("Could not add #{new_member} to group: #{@resource.name}, #{detail}")
      end
    end
  end
end

#create ⇒ Object

NBK: we override @parent.create as we need to execute a series of commands to create objects with dscl, rather than the single command nameservice.rb expects to be returned by addcmd. Thus we don’t bother defining addcmd.



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 517

def create
  if exists?
    info "already exists"
    return nil
  end

  # NBK: First we create the object with a known guid so we can set the contents
  # of the password hash if required
  # Shelling out sucks, but for a single use case it doesn't seem worth
  # requiring people install a UUID library that doesn't come with the system.
  # This should be revisited if Puppet starts managing UUIDs for other platform
  # user records.
  guid = %x{/usr/bin/uuidgen}.chomp

  exec_arg_vector = self.class.get_exec_preamble("-create", @resource[:name])
  exec_arg_vector << @@ns_to_ds_attribute_map[:guid] << guid
  begin
    execute(exec_arg_vector)
  rescue Puppet::ExecutionFailure => detail
    fail("Could not set GeneratedUID for #{@resource.class.name} #{@resource.name}: #{detail}")
  end

  if value = @resource.should(:password) and value != ""
    self.class.set_password(@resource[:name], guid, value)
  end

  # Now we create all the standard properties
  Puppet::Type.type(@resource.class.name).validproperties.each do |property|
    next if property == :ensure
    value = @resource.should(property)
    if property == :gid and value.nil?
      value = self.class.next_system_id(id_type='gid')
    end
    if property == :uid and value.nil?
      value = self.class.next_system_id(id_type='uid')
    end
    if value != "" and not value.nil?
      if property == :members
        add_members(nil, value)
      else
        exec_arg_vector = self.class.get_exec_preamble("-create", @resource[:name])
        exec_arg_vector << @@ns_to_ds_attribute_map[property.intern]
        next if property == :password  # skip setting the password here
        exec_arg_vector << value.to_s
        begin
          execute(exec_arg_vector)
        rescue Puppet::ExecutionFailure => detail
          fail("Could not create #{@resource.class.name} #{@resource.name}: #{detail}")
        end
      end
    end
  end
end

#deletecmd ⇒ Object 



604
605
606
607
608
609
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 604

def deletecmd
  # JJM: Like addcmd, only called when deleting the object itself
  #    Note, this isn't used to delete properties of the object,
  #    at least that's how I understand it...
  self.class.get_exec_preamble("-delete", @resource[:name])
end

#ensure=(ensure_value) ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 445

def ensure=(ensure_value)
  super
  # We need to loop over all valid properties for the type we're
  # managing and call the method which sets that property value
  # dscl can't create everything at once unfortunately.
  if ensure_value == :present
    @resource.class.validproperties.each do |name|
      next if name == :ensure
      # LAK: We use property.sync here rather than directly calling
      # the settor method because the properties might do some kind
      # of conversion.  In particular, the user gid property might
      # have a string and need to convert it to a number
      if @resource.should(name)
        @resource.property(name).sync
      elsif value = autogen(name)
        self.send(name.to_s + "=", value)
      else
        next
      end
    end
  end
end

#getinfo(refresh = false) ⇒ Object 



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 611

def getinfo(refresh = false)
  # JJM 2007-07-24:
  #      Override the getinfo method, which is also defined in nameservice.rb
  #      This method returns and sets @infohash
  # I'm not re-factoring the name "getinfo" because this method will be
  # most likely called by nameservice.rb, which I didn't write.
  if refresh or (! defined?(@property_value_cache_hash) or ! @property_value_cache_hash)
    # JJM 2007-07-24: OK, there's a bit of magic that's about to
    # happen... Let's see how strong my grip has become... =)
    #
    # self is a provider instance of some Puppet::Type, like
    # Puppet::Type::User::ProviderDirectoryservice for the case of the
    # user type and this provider.
    #
    # self.class looks like "user provider directoryservice", if that
    # helps you ...
    #
    # self.class.resource_type is a reference to the Puppet::Type class,
    # probably Puppet::Type::User or Puppet::Type::Group, etc...
    #
    # self.class.resource_type.validproperties is a class method,
    # returning an Array of the valid properties of that specific
    # Puppet::Type.
    #
    # So... something like [:comment, :home, :password, :shell, :uid,
    # :groups, :ensure, :gid]
    #
    # Ultimately, we add :name to the list, delete :ensure from the
    # list, then report on the remaining list. Pretty whacky, ehh?
    type_properties = [:name] + self.class.resource_type.validproperties
    type_properties.delete(:ensure) if type_properties.include? :ensure
    type_properties << :guid  # append GeneratedUID so we just get the report here
    @property_value_cache_hash = self.class.single_report(@resource[:name], *type_properties)
    [:uid, :gid].each do |param|
      @property_value_cache_hash[param] = @property_value_cache_hash[param].to_i if @property_value_cache_hash and @property_value_cache_hash.include?(param)
    end
  end
  @property_value_cache_hash
end

#password=(passphrase) ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 468

def password=(passphrase)
  exec_arg_vector = self.class.get_exec_preamble("-read", @resource.name)
  exec_arg_vector << @@ns_to_ds_attribute_map[:guid]
  begin
    guid_output = execute(exec_arg_vector)
    guid_plist = Plist.parse_xml(guid_output)
    # Although GeneratedUID like all DirectoryService values can be multi-valued
    # according to the schema, in practice user accounts cannot have multiple UUIDs
    # otherwise Bad Things Happen, so we just deal with the first value.
    guid = guid_plist["dsAttrTypeStandard:#{@@ns_to_ds_attribute_map[:guid]}"][0]
    self.class.set_password(@resource.name, guid, passphrase)
  rescue Puppet::ExecutionFailure => detail
    fail("Could not set #{param} on #{@resource.class.name}[#{@resource.name}]: #{detail}")
  end
end

#remove_unwanted_members(current_members, new_members) ⇒ Object 



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 571

def remove_unwanted_members(current_members, new_members)
  current_members.each do |member|
    if not new_members.flatten.include?(member)
      cmd = [:dseditgroup, "-o", "edit", "-n", ".", "-d", member, @resource[:name]]
      begin
        execute(cmd)
      rescue Puppet::ExecutionFailure => detail
        # TODO: We're falling back to removing the member using dscl due to rdar://8481241
        # This bug causes dseditgroup to fail to remove a member if that member doesn't exist
        cmd = [:dscl, ".", "-delete", "/Groups/#{@resource.name}", "GroupMembership", member]
        begin
          execute(cmd)
        rescue Puppet::ExecutionFailure => detail
          fail("Could not remove #{member} from group: #{@resource.name}, #{detail}")
        end
      end
    end
  end
end

#set(param, value) ⇒ Object

NBK: we override @parent.set as we need to execute a series of commands to deal with array values, rather than the single command nameservice.rb expects to be returned by modifycmd. Thus we don’t bother defining modifycmd.



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/vendor/puppet/provider/nameservice/directoryservice.rb', line 488

def set(param, value)
  self.class.validate(param, value)
  current_members = @property_value_cache_hash[:members]
  if param == :members
    # If we are meant to be authoritative for the group membership
    # then remove all existing members who haven't been specified
    # in the manifest.
    remove_unwanted_members(current_members, value) if @resource[:auth_membership] and not current_members.nil?

    # if they're not a member, make them one.
    add_members(current_members, value)
  else
    exec_arg_vector = self.class.get_exec_preamble("-create", @resource[:name])
    # JJM: The following line just maps the NS name to the DS name
    #      e.g. { :uid => 'UniqueID' }
    exec_arg_vector << @@ns_to_ds_attribute_map[param.intern]
    # JJM: The following line sends the actual value to set the property to
    exec_arg_vector << value.to_s
    begin
      execute(exec_arg_vector)
    rescue Puppet::ExecutionFailure => detail
      fail("Could not set #{param} on #{@resource.class.name}[#{@resource.name}]: #{detail}")
    end
  end
end