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

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

Constant Summary

Constants inherited from Puppet::Provider

Confine

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Class Attribute Summary collapse

Attributes inherited from Puppet::Provider

#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, #comments_insync?, #delete, #ensure, #exists?, #get, #groups, #has_sensitive_data?, #info2hash, #initialize, initvars, #munge, option, options, resource_type=, section, #unmunge, validate, verify

Methods inherited from Puppet::Provider

#<=>, #clear, command, #command, commands, declared_feature?, default?, default_match, defaultfor, execpipe, #execpipe, execute, #execute, fact_match, feature_match, #flush, #get, has_command, #initialize, initvars, #inspect, mk_resource_methods, #name, notdefaultfor, optional_commands, prefetch, some_default_match, specificity, supports_parameter?, #to_s

Methods included from Util::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #format_backtrace, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, #send_log, setup_facter_logging!, #warn_once

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

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

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Docs

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

Methods included from Util::Warnings

clear_warnings, debug_once, maybe_log, notice_once, warnonce

Methods included from Confiner

#confine, #confine_collection, #suitable?

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, error_location, error_location_with_space, error_location_with_unknowns, #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/puppet/provider/nameservice/directoryservice.rb', line 15

def ds_path=(value)
  @ds_path = value
end

Class Method Details

.convert_binary_to_hash(plist_data) ⇒ Object

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



280
281
282
283
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 280

def self.convert_binary_to_hash(plist_data)
  Puppet.debug('Converting binary plist to hash')
  Puppet::Util::Plist.parse_plist(plist_data)
end

.convert_hash_to_binary(plist_data) ⇒ Object

This method will accept a hash and convert it to a binary plist (string value).



274
275
276
277
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 274

def self.convert_hash_to_binary(plist_data)
  Puppet.debug('Converting plist hash to binary')
  Puppet::Util::Plist.dump_plist(plist_data, :binary)
end

.ds_to_ns_attribute_map ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 42

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

.generate_attribute_hash(input_hash, *type_properties) ⇒ Object 



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

def self.generate_attribute_hash(input_hash, *type_properties)
  attribute_hash = {}
  input_hash.each_key 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
      # do nothing, 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 accounts.
  # Mobile Accounts are out of scope for this provider for now
  attribute_hash[:password] = 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 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 86

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 



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

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 https://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.

  command_vector = [command(:dscl), "-plist", "."]

  # JJM: The actual action to perform. See "man dscl".
  #      Common actions: -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_password(guid, username) ⇒ Object 



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/puppet/provider/nameservice/directoryservice.rb', line 248

def self.get_password(guid, username)
  plist_file = "#{users_plist_dir}/#{username}.plist"
  if Puppet::FileSystem.exist?(plist_file)
    # 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 = Puppet::Util::Plist.read_plist_file(plist_file)

    if users_plist['ShadowHashData']
      # users_plist['ShadowHashData'][0] 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]
      converted_hash_plist = convert_binary_to_hash(password_hash_plist)

      # converted_hash_plist['SALTED-SHA512'] 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.
      converted_hash_plist['SALTED-SHA512'].unpack1("H*")

    end
  end
end

.instances ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 73

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 managing.
  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|
    new(single_report(name_string, *type_property_array))
  end
end

.list_all_present ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 100

def self.list_all_present
  # rubocop:disable Naming/MemoizedInstanceVariableName
  @all_present ||= begin
    # rubocop:enable Naming/MemoizedInstanceVariableName
    # JJM: List all objects of this Puppet::Type already present on the system.
    begin
      dscl_output = execute(get_exec_preamble("-list"))
    rescue Puppet::ExecutionFailure
      fail(_("Could not get %{resource} list from DirectoryService") % { resource: @resource_type.name })
    end
    dscl_output.split("\n")
  end
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 289

def self.next_system_id(id_type, min_id = 20)
  dscl_args = ['.', '-list']
  case id_type
  when 'uid'
    dscl_args << '/Users' << 'uid'
  when 'gid'
    dscl_args << '/Groups' << 'gid'
  else
    fail(_("Invalid id_type %{id_type}. Only 'uid' and 'gid' supported") % { id_type: id_type })
  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 =~ /^\d+$/ }
  ids.compact!.sort_by!(&: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

.ns_to_ds_attribute_map ⇒ Object 



61
62
63
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 61

def self.ns_to_ds_attribute_map
  @ns_to_ds_attribute_map ||= ds_to_ns_attribute_map.invert
end

.parse_dscl_plist_data(dscl_output) ⇒ Object 



114
115
116
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 114

def self.parse_dscl_plist_data(dscl_output)
  Puppet::Util::Plist.parse_plist(dscl_output)
end

.password_hash_dir ⇒ Object 



65
66
67
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 65

def self.password_hash_dir
  '/var/db/shadow/hash'
end

.post_resource_eval ⇒ Object

There is no generalized mechanism for provider cache management, but we can use post_resource_eval, which will be run for each suitable provider at the end of each transaction. Use this to clear @all_present after each run.



30
31
32
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 30

def self.post_resource_eval
  @all_present = nil
end

.set_password(resource_name, guid, password_hash) ⇒ Object 



201
202
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
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 201

def self.set_password(resource_name, guid, password_hash)
  # 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 OS X, we will fail early and warn them.
  if password_hash.length != 136
    # TRANSLATORS 'OS X 10.7' is an operating system and should not be translated, 'Salted SHA512' is the name of a hashing algorithm
    fail(_("OS X 10.7 requires a Salted SHA512 hash password of 136 characters.") +
         ' ' + _("Please check your password and try again."))
  end

  plist_file = "#{users_plist_dir}/#{resource_name}.plist"
  if Puppet::FileSystem.exist?(plist_file)
    # 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 = Puppet::Util::Plist.read_plist_file(plist_file)

    # users_plist['ShadowHashData'][0] 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]
      converted_hash_plist = convert_binary_to_hash(password_hash_plist)
    else
      users_plist['ShadowHashData'] = ''.dup
      converted_hash_plist = { 'SALTED-SHA512' => ''.dup }
    end

    # converted_hash_plist['SALTED-SHA512'] 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'] = \
      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_hash_to_binary(converted_hash_plist)
    users_plist['ShadowHashData'][0] = changed_plist
    Puppet::Util::Plist.write_plist_file(users_plist, plist_file, :binary)
  end
end

.single_report(resource_name, *type_properties) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 151

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
    fail(_("Could not get report.  command execution failed."))
  end

  dscl_plist = parse_dscl_plist_data(dscl_output)

  generate_attribute_hash(dscl_plist, *type_properties)
end

.users_plist_dir ⇒ Object 



69
70
71
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 69

def self.users_plist_dir
  '/var/db/dslocal/nodes/Default/users'
end

Instance Method Details

#add_members(current_members, new_members) ⇒ Object 



463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 463

def add_members(current_members, new_members)
  new_members.flatten.each do |new_member|
    next unless current_members.nil? or !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: %{name}, %{detail}") % { new_member: new_member, name: @resource.name, detail: detail })
    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.



386
387
388
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
435
436
437
438
439
440
441
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 386

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} %{name}: %{detail}") % { resource: @resource.class.name, name: @resource.name, detail: detail })
  end

  value = @resource.should(:password)
  if value && 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('gid')
    end
    if property == :uid and value.nil?
      value = self.class.next_system_id('uid')
    end
    if value != "" and !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} %{name}: %{detail}") % { resource: @resource.class.name, name: @resource.name, detail: detail })
        end
      end
    end
  end
end

#deletecmd ⇒ Object 



476
477
478
479
480
481
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 476

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

#ds_to_ns_attribute_map ⇒ Object

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...)



40
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 40

def ds_to_ns_attribute_map; self.class.ds_to_ns_attribute_map; end

#ensure=(ensure_value) ⇒ Object 



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

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
      else
        value = autogen(name)
        if value
          send(name.to_s + "=", value)
        else
          next
        end
      end
    end
  end
end

#getinfo(refresh = false) ⇒ Object 



483
484
485
486
487
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
513
514
515
516
517
518
519
520
521
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 483

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

#ns_to_ds_attribute_map ⇒ Object

JJM The same table as above, inverted.



59
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 59

def ns_to_ds_attribute_map; self.class.ns_to_ds_attribute_map end

#password=(passphrase) ⇒ Object 



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 337

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 = Puppet::Util::Plist.parse_plist(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}[%{name}]: %{detail}") % { param: param, resource: @resource.class.name, name: @resource.name, detail: detail })
  end
end

#remove_unwanted_members(current_members, new_members) ⇒ Object 



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/puppet/provider/nameservice/directoryservice.rb', line 443

def remove_unwanted_members(current_members, new_members)
  current_members.each do |member|
    next if new_members.flatten.include?(member)

    cmd = [:dseditgroup, "-o", "edit", "-n", ".", "-d", member, @resource[:name]]
    begin
      execute(cmd)
    rescue Puppet::ExecutionFailure
      # 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}, %{detail}") % { member: member, resource: @resource.name, detail: detail })
      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.



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

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 !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}[%{name}]: %{detail}") % { param: param, resource: @resource.class.name, name: @resource.name, detail: detail })
    end
  end
end