Class: Puppet::SSL::Key::File

Inherits:
Indirector::SslFile show all
Defined in:
lib/puppet/indirector/key/file.rb

Constant Summary

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 included from Util::Docs

#doc, #nodoc

Instance Method Summary collapse

Methods inherited from Indirector::SslFile

#ca?, ca_location, collection_directory, file_location, #find, #initialize, #path, #search, store_at, store_ca_at, store_in

Methods inherited from Indirector::Terminus

abstract_terminus?, const2name, #indirection, indirection_name, inherited, #initialize, mark_as_abstract_terminus, #model, model, #name, name2const, register_terminus_class, terminus_class, terminus_classes, #terminus_type, #validate, #validate_key, #validate_model

Methods included from Util::InstanceLoader

#instance_docs, #instance_hash, #instance_load, #instance_loader, #instance_loading?, #loaded_instance, #loaded_instances

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_encode, uri_query_encode, 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

Constructor Details

This class inherits a constructor from Puppet::Indirector::SslFile

Instance Method Details

#allow_remote_requests? ⇒ Boolean

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/puppet/indirector/key/file.rb', line 10

def allow_remote_requests?
  false
end

#destroy(request) ⇒ Object

Remove the public key, in addition to the private key



24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/puppet/indirector/key/file.rb', line 24

def destroy(request)
  super

  key_path = Puppet::FileSystem.pathname(public_key_path(request.key))
  return unless Puppet::FileSystem.exist?(key_path)

  begin
    Puppet::FileSystem.unlink(key_path)
  rescue => detail
    raise Puppet::Error, _("Could not remove %{request} public key: %{detail}") % { request: request.key, detail: detail }, detail.backtrace
  end
end

#public_key_path(name) ⇒ Object

Where should we store the public key?



15
16
17
18
19
20
21
 
# File 'lib/puppet/indirector/key/file.rb', line 15

def public_key_path(name)
  if ca?(name)
    Puppet[:capub]
  else
    File.join(Puppet[:publickeydir], name.to_s + ".pem")
  end
end

#save(request) ⇒ Object

Save the public key, in addition to the private key.



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/puppet/indirector/key/file.rb', line 38

def save(request)
  super

  begin
    # RFC 1421 states PEM is 7-bit ASCII https://tools.ietf.org/html/rfc1421
    Puppet.settings.setting(:publickeydir).open_file(public_key_path(request.key), 'w:ASCII') do |f|
      f.print request.instance.content.public_key.to_pem
    end
  rescue => detail
    raise Puppet::Error, _("Could not write %{request}: %{detail}") % { request: request.key, detail: detail }, detail.backtrace
  end
end