Class: Puppet::Provider::UfwRoute::UfwRoute

Inherits:
ResourceApi::SimpleProvider
  • Object
show all
Defined in:
lib/puppet/provider/ufw_route/ufw_route.rb

Overview

Implementation for the ufw_route type using the Resource API.

Instance Method Summary collapse

Constructor Details

#initialize ⇒ UfwRoute

Returns a new instance of UfwRoute.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 7

def initialize
  @default_route_hash = {
    ensure: 'present',
    action: 'reject',
    interface_in: nil,
    interface_out: nil,
    log: nil,
    from_addr: 'any',
    from_ports_app: nil,
    to_addr: 'any',
    to_ports_app: nil,
    proto: 'any',
  }
  @instances = []
  super()
end

Instance Method Details

#create(context, name, should) ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 126

def create(context, name, should)
  context.notice("Creating '#{name}' with #{should.inspect}")
  route = @default_route_hash.merge(should)
  params = route_to_ufw_params(route)

  Puppet::Util::Execution.execute("/usr/sbin/ufw route #{params}", failonfail: true)
end

#delete(context, name) ⇒ Object 



146
147
148
149
150
151
152
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 146

def delete(context, name)
  context.notice("Deleting '#{name}'")

  is = @instances.find { |r| r[:name] == name }
  params = rule_to_ufw_params_nocomment(is)
  Puppet::Util::Execution.execute("/usr/sbin/ufw route delete #{params}", failonfail: true)
end

#get(context) ⇒ Object 



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

def get(context)
  context.debug('Returning list of routes')
  return [] unless ufw_installed?

  @instances = []
  route_list_lines.each do |line|
    context.debug(line)
    hash = route_to_hash(context, line)
    @instances << hash unless hash.nil?
    context.warning("Could not parse existing route: #{line}") if hash.nil?
  end
  @instances
end

#route_list_lines ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 38

def route_list_lines
  result = Puppet::Util::Execution.execute(['/usr/sbin/ufw', 'show', 'added'], failonfail: true)
  result.each_line
        .map(&:strip)
        .select { |line| line.start_with?('ufw route') }
end

#route_to_hash(_context, line) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 45

def route_to_hash(_context, line)
  %r{\scomment\s'(?<name>[^']+)'} =~ line
  no_comment = line.sub(%r{\scomment\s'(?<name>[^']+)'}, '')

  %r{ufw route (?<action>allow|deny|reject|limit)\s*(in on (?<interface_in>\w+))*\s*(out on (?<interface_out>\w+))*\s*(?<log>log|log-all)*} =~ no_comment
  %r{\sfrom\s(?<from_addr>[^\s]+)(\s(port|app)\s(?<from_ports_app>[^\s]+))*} =~ no_comment
  %r{\sto\s(?<to_addr>[^\s]+)(\s(port|app)\s(?<to_ports_app>[^\s]+))*} =~ no_comment
  %r{\sproto\s(?<proto>\w+)} =~ no_comment

  route = {
    action: action,
    interface_in: interface_in,
    interface_out: interface_out,
    log: log,
    from_addr: from_addr,
    from_ports_app: from_ports_app,
    to_addr: to_addr,
    to_ports_app: to_ports_app,
    proto: proto,
  }.delete_if { |_k, v| v.nil? }

  return nil if route.empty?

  route[:name] = name.nil? ? Digest::SHA256.hexdigest(no_comment) : name

  @default_route_hash.merge(route)
end

#route_to_ufw_params(route) ⇒ Object 



118
119
120
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 118

def route_to_ufw_params(route)
  route_to_ufw_params_array(route).join(' ')
end

#route_to_ufw_params_array(route) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 73

def route_to_ufw_params_array(route)
  in_definition = route[:interface_in].nil? ? nil : "in on #{route[:interface_in]}"
  out_definition = route[:interface_out].nil? ? nil : "out on #{route[:interface_out]}"

  from_addr = route[:from_addr].nil? ? 'any' : route[:from_addr]
  from_checked = "#{from_addr}!#{route[:from_ports_app]}"
  from_definition = case from_checked
                    when %r{.+!$}
                      "from #{from_addr}"
                    when %r{![\d,:]+$}
                      "from #{from_addr} port #{route[:from_ports_app]}"
                    when %r{!\w+$}
                      "from #{from_addr} app #{route[:from_ports_app]}"
                    end

  to_addr = route[:to_addr].nil? ? 'any' : route[:to_addr]
  to_checked = "#{to_addr}!#{route[:to_ports_app]}"
  to_definition = case to_checked
                  when %r{.+!$}
                    "to #{to_addr}"
                  when %r{![\d,:]+$}
                    "to #{to_addr} port #{route[:to_ports_app]}"
                  when %r{!\w+$}
                    "to #{to_addr} app #{route[:to_ports_app]}"
                  end

  uses_app_name = "#{from_definition} #{to_definition}".include? ' app '

  proto_definition = route[:proto].nil? ? nil : "proto #{route[:proto]}"
  proto_definition = nil if uses_app_name # Can't use proto with applications

  comment_definition = route[:name].nil? ? nil : "comment \'#{route[:name]}\'"

  [
    route[:action],
    in_definition,
    out_definition,
    route[:log],
    from_definition,
    to_definition,
    proto_definition,
    comment_definition,
  ].compact
end

#rule_to_ufw_params_nocomment(rule) ⇒ Object 



122
123
124
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 122

def rule_to_ufw_params_nocomment(rule)
  route_to_ufw_params_array(rule)[0...-1].join(' ')
end

#ufw_installed? ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 154

def ufw_installed?
  File.file?('/usr/sbin/ufw')
end

#update(context, name, should) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/puppet/provider/ufw_route/ufw_route.rb', line 134

def update(context, name, should)
  context.notice("Updating '#{name}' with #{should.inspect}")
  is = @instances.find { |r| r[:name] == name }
  route = @default_route_hash.merge(is).merge(should)

  is_params = rule_to_ufw_params_nocomment(is)
  Puppet::Util::Execution.execute("/usr/sbin/ufw route delete #{is_params}", failonfail: true)

  params = route_to_ufw_params(route)
  Puppet::Util::Execution.execute("/usr/sbin/ufw route #{params}", failonfail: true)
end