Class: Puppetserver::Ca::Utils::FileSystem

Inherits:
Object
  • Object
show all
Defined in:
lib/puppetserver/ca/utils/file_system.rb

Constant Summary collapse

DIR_MODES = 
{
  :ssldir => 0771,
  :cadir => 0755,
  :certdir => 0755,
  :privatekeydir => 0750,
  :publickeydir => 0755,
  :signeddir => 0755
}

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FileSystem

Returns a new instance of FileSystem.



66
67
68
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 66

def initialize
  @user, @group = find_user_and_group
end

Class Method Details

.check_for_existing_files(one_or_more_paths) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 43

def self.check_for_existing_files(one_or_more_paths)
  errors = []
  Array(one_or_more_paths).each do |path|
    if File.exist?(path)
      errors << "Existing file at '#{path}'"
    end
  end
  errors
end

.ensure_dirs(one_or_more_dirs) ⇒ Object 



26
27
28
29
30
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 26

def self.ensure_dirs(one_or_more_dirs)
  Array(one_or_more_dirs).each do |directory|
    instance.ensure_dir(directory)
  end
end

.forcibly_symlink(source, link_target) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 53

def self.forcibly_symlink(source, link_target)
  FileUtils.remove_dir(link_target, true)
  FileUtils.symlink(source, link_target)
  # Ensure the symlink has the same ownership as the source.
  # This requires using `FileUtils.chown` rather than `File.chown`, as
  # the latter will update the ownership of the source rather than the
  # link itself.
  # Symlink permissions are ignored in favor of the source's permissions,
  # so we don't have to change those.
  source_info = File.stat(source)
  FileUtils.chown(source_info.uid, source_info.gid, link_target)
end

.instance ⇒ Object 



18
19
20
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 18

def self.instance
  @instance ||= new
end

.validate_file_paths(one_or_more_paths) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 32

def self.validate_file_paths(one_or_more_paths)
  errors = []
  Array(one_or_more_paths).each do |path|
    if !File.exist?(path) || !File.readable?(path)
      errors << "Could not read file '#{path}'"
    end
  end

  errors
end

.write_file(*args) ⇒ Object 



22
23
24
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 22

def self.write_file(*args)
  instance.write_file(*args)
end

Instance Method Details

#ensure_dir(directory) ⇒ Object

Warning: directory mode should be specified in DIR_MODES above



100
101
102
103
104
105
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 100

def ensure_dir(directory)
  if !File.exist?(directory)
    FileUtils.mkdir_p(directory, mode: DIR_MODES[directory])
    FileUtils.chown(@user, @group, directory)
  end
end

#find_user_and_group ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 70

def find_user_and_group
  if !running_as_root?
    return Process.euid, Process.egid
  else
    if pe_puppet_exists?
      return 'pe-puppet', 'pe-puppet'
    else
      return 'puppet', 'puppet'
    end
  end
end

#pe_puppet_exists? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 86

def pe_puppet_exists?
  !!(Etc.getpwnam('pe-puppet') rescue nil)
end

#running_as_root? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 82

def running_as_root?
  !Gem.win_platform? && Process.euid == 0
end

#write_file(path, one_or_more_objects, mode) ⇒ Object 



90
91
92
93
94
95
96
97
 
# File 'lib/puppetserver/ca/utils/file_system.rb', line 90

def write_file(path, one_or_more_objects, mode)
  File.open(path, 'w', mode) do |f|
    Array(one_or_more_objects).each do |object|
      f.puts object.to_s
    end
  end
  FileUtils.chown(@user, @group, path)
end