Class: Puppet::Provider::NameService

Inherits:
Puppet::Provider show all
Defined in:
lib/puppet/provider/nameservice.rb,
lib/puppet/provider/nameservice/pw.rb,
lib/puppet/provider/nameservice/objectadd.rb

Overview

This is the parent class of all NSS classes. They’re very different in their backend, but they’re pretty similar on the front-end. This class provides a way for them all to be as similar as possible.

Direct Known Subclasses

DirectoryService, ObjectAdd

Defined Under Namespace

Classes: DirectoryService, ObjectAdd, PW

Constant Summary

Constants inherited from Puppet::Provider

Confine

Constants included from Util::Logging

Util::Logging::FILE_AND_LINE, Util::Logging::FILE_NO_LINE, Util::Logging::MM, Util::Logging::NO_FILE_LINE

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

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

Instance Attribute Summary

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

#<=>, #clear, command, #command, commands, declared_feature?, default?, default_match, defaultfor, execfail, #execfail, execpipe, #execpipe, execute, #execute, fact_match, feature_match, #flush, has_command, #inspect, mk_resource_methods, #name, optional_commands, post_resource_eval, prefetch, specificity, supports_parameter?, #to_s

Methods included from Util::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #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, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, safe_posix_fork, set_env, symbolizehash, thinmark, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

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

Methods included from Util::SymbolicFileMode

#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, notice_once, warnonce

Methods included from Confiner

#confine, #confine_collection, #suitable?

Methods included from Util::Errors

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

Constructor Details

#initialize(resource) ⇒ NameService

Returns a new instance of NameService.



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/puppet/provider/nameservice.rb', line 278

def initialize(resource)
  super
  @custom_environment = {}
  @objectinfo = nil
  if resource.is_a?(Hash) && !resource[:canonical_name].nil?
    @canonical_name = resource[:canonical_name]
  else
    @canonical_name = resource[:name]
  end
end

Class Method Details

.autogen_default(param) ⇒ Object 



8
9
10
 
# File 'lib/puppet/provider/nameservice.rb', line 8

def autogen_default(param)
  defined?(@autogen_defaults) ? @autogen_defaults[param.intern] : nil
end

.autogen_defaults(hash) ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/puppet/provider/nameservice.rb', line 12

def autogen_defaults(hash)
  @autogen_defaults ||= {}
  hash.each do |param, value|
    @autogen_defaults[param.intern] = value
  end
end

.autogen_id(field, resource_type) ⇒ Object

Autogenerate either a uid or a gid. This is not very flexible: we can only generate one field type per class, and get kind of confused if asked for both.



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

def self.autogen_id(field, resource_type)
  # Figure out what sort of value we want to generate.
  case resource_type
  when :user;   database = :passwd;  method = :uid
  when :group;  database = :group;   method = :gid
  else
    raise Puppet::DevError, "Invalid resource name #{resource}"
  end

  # Initialize from the data set, if needed.
  unless @prevauto
    # Sadly, Etc doesn't return an enumerator, it just invokes the block
    # given, or returns the first record from the database.  There is no
    # other, more convenient enumerator for these, so we fake one with this
    # loop.  Thanks, Ruby, for your awesome abstractions. --daniel 2012-03-23
    highest = []
    Puppet::Etc.send(database) {|entry| highest << entry.send(method) }
    highest = highest.reject {|x| x > 65000 }.max

    @prevauto = highest || 1000
  end

  # ...and finally increment and return the next value.
  @prevauto += 1
end

.initvars ⇒ Object 



19
20
21
22
23
 
# File 'lib/puppet/provider/nameservice.rb', line 19

def initvars
  @checks = {}
  @options = {}
  super
end

.instances ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/puppet/provider/nameservice.rb', line 25

def instances
  objects = []
  Puppet::Etc.send("set#{section}ent")
  begin
    while ent = Puppet::Etc.send("get#{section}ent")
      objects << new(:name => ent.name, :canonical_name => ent.canonical_name, :ensure => :present)
    end
  end
  objects
end

.listbyname ⇒ Object

List everything out by name. Abstracted a bit so that it works for both users and groups.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/puppet/provider/nameservice.rb', line 55

def listbyname
  Puppet.deprecation_warning(_("listbyname is deprecated and will be removed in a future release of Puppet. Please use `self.instances` to obtain a list of users."))
  names = []
  Puppet::Etc.send("set#{section()}ent")
  begin
    while ent = Puppet::Etc.send("get#{section()}ent")
      names << ent.name
      yield ent.name if block_given?
    end
  ensure
    Puppet::Etc.send("end#{section()}ent")
  end

  names
end

.option(name, option) ⇒ Object 



36
37
38
39
 
# File 'lib/puppet/provider/nameservice.rb', line 36

def option(name, option)
  name = name.intern if name.is_a? String
  (defined?(@options) and @options.include? name and @options[name].include? option) ? @options[name][option] : nil
end

.options(name, hash) ⇒ Object

Raises:



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/puppet/provider/nameservice.rb', line 41

def options(name, hash)
  raise Puppet::DevError, "#{name} is not a valid attribute for #{resource_type.name}" unless resource_type.valid_parameter?(name)
  @options ||= {}
  @options[name] ||= {}

  # Set options individually, so we can call the options method
  # multiple times.
  hash.each do |param, value|
    @options[name][param] = value
  end
end

.resource_type=(resource_type) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/puppet/provider/nameservice.rb', line 71

def resource_type=(resource_type)
  super
  @resource_type.validproperties.each do |prop|
    next if prop == :ensure
    define_method(prop) { get(prop) || :absent} unless public_method_defined?(prop)
    define_method(prop.to_s + "=") { |*vals| set(prop, *vals) } unless public_method_defined?(prop.to_s + "=")
  end
end

.section ⇒ Object

This is annoying, but there really aren’t that many options, and this is built into Ruby.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/puppet/provider/nameservice.rb', line 82

def section
  unless resource_type
    raise Puppet::DevError,
      "Cannot determine Etc section without a resource type"
  end

  if @resource_type.name == :group
    "gr"
  else
    "pw"
  end
end

.validate(name, value) ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/puppet/provider/nameservice.rb', line 95

def validate(name, value)
  name = name.intern if name.is_a? String
  if @checks.include? name
    block = @checks[name][:block]
    raise ArgumentError, "Invalid value #{value}: #{@checks[name][:error]}" unless block.call(value)
  end
end

.verify(name, error, &block) ⇒ Object 



103
104
105
106
 
# File 'lib/puppet/provider/nameservice.rb', line 103

def verify(name, error, &block)
  name = name.intern if name.is_a? String
  @checks[name] = {:error => error, :block => block}
end

Instance Method Details

#autogen(field) ⇒ Object

Autogenerate a value. Mostly used for uid/gid, but also used heavily with DirectoryServices, because DirectoryServices is stupid.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/puppet/provider/nameservice.rb', line 117

def autogen(field)
  field = field.intern
  id_generators = {:user => :uid, :group => :gid}
  if id_generators[@resource.class.name] == field
    return self.class.autogen_id(field, @resource.class.name)
  else
    if value = self.class.autogen_default(field)
      return value
    elsif respond_to?("autogen_#{field}")
      return send("autogen_#{field}")
    else
      return nil
    end
  end
end

#comments_insync?(current, should) ⇒ Boolean

From overriding Puppet::Property#insync? Ruby Etc::getpwnam < 2.1.0 always returns a struct with binary encoded string values, and >= 2.1.0 will return binary encoded strings for values incompatible with current locale charset, or Encoding.default_external if compatible. Compare a “should” value with encoding of “current” value, to avoid unnecessary property syncs and comparison of strings with different encodings. (PUP-6777)

return basic string comparison after re-encoding (same as Puppet::Property#property_matches)

Returns:

  • (Boolean) 


309
310
311
312
313
 
# File 'lib/puppet/provider/nameservice.rb', line 309

def comments_insync?(current, should)
  # we're only doing comparison here so don't mutate the string
  desired = should[0].to_s.dup
  current == desired.force_encoding(current.encoding)
end

#create ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/puppet/provider/nameservice.rb', line 162

def create
  if exists?
    info "already exists"
    # The object already exists
    return nil
  end

  begin
    execute(self.addcmd, {:failonfail => true, :combine => true, :custom_environment => @custom_environment})
    if feature?(:manages_password_age) && (cmd = passcmd)
      execute(cmd)
    end
  rescue Puppet::ExecutionFailure => detail
    raise Puppet::Error, "Could not create #{@resource.class.name} #{@resource.name}: #{detail}", detail.backtrace
  end
end

#delete ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/puppet/provider/nameservice.rb', line 179

def delete
  unless exists?
    info "already absent"
    # the object already doesn't exist
    return nil
  end

  begin
    execute(self.deletecmd)
  rescue Puppet::ExecutionFailure => detail
    raise Puppet::Error, "Could not delete #{@resource.class.name} #{@resource.name}: #{detail}", detail.backtrace
  end
end

#ensure ⇒ Object 



193
194
195
196
197
198
199
 
# File 'lib/puppet/provider/nameservice.rb', line 193

def ensure
  if exists?
    :present
  else
    :absent
  end
end

#exists? ⇒ Boolean

Does our object exist?

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/puppet/provider/nameservice.rb', line 202

def exists?
  !!getinfo(true)
end

#get(param) ⇒ Object

Retrieve a specific value by name.



207
208
209
 
# File 'lib/puppet/provider/nameservice.rb', line 207

def get(param)
  (hash = getinfo(false)) ? unmunge(param, hash[param]) : nil
end

#getinfo(refresh) ⇒ Object

Retrieve what we can about our object



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/puppet/provider/nameservice.rb', line 228

def getinfo(refresh)
  if @objectinfo.nil? or refresh == true
    @etcmethod ||= ("get" + self.class.section.to_s + "nam").intern
    begin
      @objectinfo = Puppet::Etc.send(@etcmethod, @canonical_name)
    rescue ArgumentError
      @objectinfo = nil
    end
  end

  # Now convert our Etc struct into a hash.
  @objectinfo ? info2hash(@objectinfo) : nil
end

#groups ⇒ Object

The list of all groups the user is a member of. Different user mgmt systems will need to override this method.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/puppet/provider/nameservice.rb', line 244

def groups
  groups = []

  # Reset our group list
  Puppet::Etc.setgrent

  user = @resource[:name]

  # Now iterate across all of the groups, adding each one our
  # user is a member of
  while group = Puppet::Etc.getgrent
    members = group.mem

    groups << group.name if members.include? user
  end

  # We have to close the file, so each listing is a separate
  # reading of the file.
  Puppet::Etc.endgrent

  groups.join(",")
end

#info2hash(info) ⇒ Object

Convert the Etc struct into a hash.



268
269
270
271
272
273
274
275
276
 
# File 'lib/puppet/provider/nameservice.rb', line 268

def info2hash(info)
  hash = {}
  self.class.resource_type.validproperties.each do |param|
    method = posixmethod(param)
    hash[param] = info.send(posixmethod(param)) if info.respond_to? method
  end

  hash
end

#munge(name, value) ⇒ Object 



211
212
213
214
215
216
217
 
# File 'lib/puppet/provider/nameservice.rb', line 211

def munge(name, value)
  if block = self.class.option(name, :munge) and block.is_a? Proc
    block.call(value)
  else
    value
  end
end

#set(param, value) ⇒ Object

Raises:



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/puppet/provider/nameservice.rb', line 289

def set(param, value)
  self.class.validate(param, value)
  cmd = modifycmd(param, munge(param, value))
  raise Puppet::DevError, "Nameservice command must be an array" unless cmd.is_a?(Array)
  begin
    execute(cmd)
  rescue Puppet::ExecutionFailure => detail
    raise Puppet::Error, "Could not set #{param} on #{@resource.class.name}[#{@resource.name}]: #{detail}", detail.backtrace
  end
end

#unmunge(name, value) ⇒ Object 



219
220
221
222
223
224
225
 
# File 'lib/puppet/provider/nameservice.rb', line 219

def unmunge(name, value)
  if block = self.class.option(name, :unmunge) and block.is_a? Proc
    block.call(value)
  else
    value
  end
end