2 # Copyright (c) 2009, 2010, 2011 Nicira Networks
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 # A daemon to monitor attempts to create GRE-over-IPsec tunnels.
18 # Uses racoon and setkey to support the configuration. Assumes that
19 # OVS has complete control over IPsec configuration for the box.
22 # - Doesn't actually check that Interface is connected to bridge
23 # - If a certificate is badly formed, Racoon will refuse to start. We
24 # should do a better job of verifying certificates are valid before
25 # adding an interface to racoon.conf.
35 from ovs.db import error
36 from ovs.db import types
42 vlog = ovs.vlog.Vlog("ovs-monitor-ipsec")
43 root_prefix = '' # Prefix for absolute file names, for testing.
44 setkey = "/usr/sbin/setkey"
47 # Class to configure the racoon daemon, which handles IKE negotiation
49 # Default locations for files
50 conf_file = "/etc/racoon/racoon.conf"
51 cert_dir = "/etc/racoon/certs"
52 psk_file = "/etc/racoon/psk.txt"
54 # Racoon configuration header we use for IKE
55 conf_header = """# Configuration file generated by Open vSwitch
57 # Do not modify by hand!
59 path pre_shared_key "%s";
60 path certificate "%s";
64 # Racoon configuration footer we use for IKE
65 conf_footer = """sainfo anonymous {
68 encryption_algorithm aes;
69 authentication_algorithm hmac_sha1, hmac_md5;
70 compression_algorithm deflate;
75 # Certificate entry template.
76 cert_entry = """remote %s {
80 certificate_type x509 "%s" "%s";
82 peers_identifier asn1dn;
83 peers_certfile x509 "%s";
86 encryption_algorithm aes;
88 authentication_method rsasig;
95 # Pre-shared key template.
96 psk_entry = """remote %s {
100 encryption_algorithm aes;
102 authentication_method pre_shared_key;
113 if not os.path.isdir(root_prefix + self.cert_dir):
114 os.mkdir(self.cert_dir)
116 # Clean out stale peer certs from previous runs
117 for ovs_cert in glob.glob("%s%s/ovs-*.pem"
118 % (root_prefix, self.cert_dir)):
122 vlog.warn("couldn't remove %s" % ovs_cert)
124 # Replace racoon's conf file with our template
128 exitcode = subprocess.call([root_prefix + "/etc/init.d/racoon",
131 # Racoon is finicky about its configuration file and will
132 # refuse to start if it sees something it doesn't like
133 # (e.g., a certificate file doesn't exist). Try restarting
134 # the process before giving up.
135 vlog.warn("attempting to restart racoon")
136 exitcode = subprocess.call([root_prefix + "/etc/init.d/racoon",
139 vlog.warn("couldn't reload racoon")
142 # Rewrite the Racoon configuration file
143 conf_file = open(root_prefix + self.conf_file, 'w')
144 conf_file.write(Racoon.conf_header % (self.psk_file, self.cert_dir))
146 for host, vals in self.cert_hosts.iteritems():
147 conf_file.write(Racoon.cert_entry % (host, vals["certificate"],
148 vals["private_key"], vals["peer_cert_file"]))
150 for host in self.psk_hosts:
151 conf_file.write(Racoon.psk_entry % host)
153 conf_file.write(Racoon.conf_footer)
156 # Rewrite the pre-shared keys file; it must only be readable by root.
157 orig_umask = os.umask(0077)
158 psk_file = open(root_prefix + Racoon.psk_file, 'w')
161 psk_file.write("# Generated by Open vSwitch...do not modify by hand!")
162 psk_file.write("\n\n")
163 for host, vals in self.psk_hosts.iteritems():
164 psk_file.write("%s %s\n" % (host, vals["psk"]))
169 def _add_psk(self, host, psk):
170 if host in self.cert_hosts:
171 raise error.Error("host %s already defined for cert" % host)
173 self.psk_hosts[host] = psk
176 def _verify_certs(self, vals):
177 # Racoon will refuse to start if the certificate files don't
178 # exist, so verify that they're there.
179 if not os.path.isfile(root_prefix + vals["certificate"]):
180 raise error.Error("'certificate' file does not exist: %s"
181 % vals["certificate"])
182 elif not os.path.isfile(root_prefix + vals["private_key"]):
183 raise error.Error("'private_key' file does not exist: %s"
184 % vals["private_key"])
186 # Racoon won't start if a given certificate or private key isn't
187 # valid. This is a weak test, but will detect the most flagrant
189 if vals["peer_cert"].find("-----BEGIN CERTIFICATE-----") == -1:
190 raise error.Error("'peer_cert' is not in valid PEM format")
192 cert = open(root_prefix + vals["certificate"]).read()
193 if cert.find("-----BEGIN CERTIFICATE-----") == -1:
194 raise error.Error("'certificate' is not in valid PEM format")
196 cert = open(root_prefix + vals["private_key"]).read()
197 if cert.find("-----BEGIN RSA PRIVATE KEY-----") == -1:
198 raise error.Error("'private_key' is not in valid PEM format")
200 def _add_cert(self, host, vals):
201 if host in self.psk_hosts:
202 raise error.Error("host %s already defined for psk" % host)
204 if vals["certificate"] == None:
205 raise error.Error("'certificate' not defined for %s" % host)
206 elif vals["private_key"] == None:
207 # Assume the private key is stored in the same PEM file as
208 # the certificate. We make a copy of "vals" so that we don't
209 # modify the original "vals", which would cause the script
210 # to constantly think that the configuration has changed
213 vals["private_key"] = vals["certificate"]
215 self._verify_certs(vals)
217 # The peer's certificate comes to us in PEM format as a string.
218 # Write that string to a file for Racoon to use.
219 peer_cert_file = "%s/ovs-%s.pem" % (self.cert_dir, host)
220 f = open(root_prefix + peer_cert_file, "w")
221 f.write(vals["peer_cert"])
224 vals["peer_cert_file"] = peer_cert_file
226 self.cert_hosts[host] = vals
229 def _del_cert(self, host):
230 peer_cert_file = self.cert_hosts[host]["peer_cert_file"]
231 del self.cert_hosts[host]
234 os.remove(root_prefix + peer_cert_file)
238 def add_entry(self, host, vals):
239 if vals["peer_cert"]:
240 self._add_cert(host, vals)
242 self._add_psk(host, vals)
244 def del_entry(self, host):
245 if host in self.cert_hosts:
247 elif host in self.psk_hosts:
248 del self.psk_hosts[host]
252 # Class to configure IPsec on a system using racoon for IKE and setkey
253 # for maintaining the Security Association Database (SAD) and Security
254 # Policy Database (SPD). Only policies for GRE are supported.
259 self.racoon = Racoon()
262 def call_setkey(self, cmds):
264 p = subprocess.Popen([root_prefix + setkey, "-c"],
265 stdin=subprocess.PIPE,
266 stdout=subprocess.PIPE)
268 vlog.err("could not call %s%s" % (root_prefix, setkey))
271 # xxx It is safer to pass the string into the communicate()
272 # xxx method, but it didn't work for slightly longer commands.
273 # xxx An alternative may need to be found.
275 return p.communicate()[0]
277 def get_spi(self, local_ip, remote_ip, proto="esp"):
278 # Run the setkey dump command to retrieve the SAD. Then, parse
279 # the output looking for SPI buried in the output. Note that
280 # multiple SAD entries can exist for the same "flow", since an
281 # older entry could be in a "dying" state.
283 host_line = "%s %s" % (local_ip, remote_ip)
284 results = self.call_setkey("dump ;\n").split("\n")
285 for i in range(len(results)):
286 if results[i].strip() == host_line:
287 # The SPI is in the line following the host pair
288 spi_line = results[i + 1]
289 if (spi_line[1:4] == proto):
290 spi = spi_line.split()[2]
291 spi_list.append(spi.split('(')[1].rstrip(')'))
295 self.call_setkey("flush;\n")
297 def sad_del(self, local_ip, remote_ip):
298 # To delete all SAD entries, we should be able to use setkey's
299 # "deleteall" command. Unfortunately, it's fundamentally broken
300 # on Linux and not documented as such.
303 # Delete local_ip->remote_ip SAD entries
304 spi_list = self.get_spi(local_ip, remote_ip)
306 cmds += "delete %s %s esp %s;\n" % (local_ip, remote_ip, spi)
308 # Delete remote_ip->local_ip SAD entries
309 spi_list = self.get_spi(remote_ip, local_ip)
311 cmds += "delete %s %s esp %s;\n" % (remote_ip, local_ip, spi)
314 self.call_setkey(cmds)
317 self.call_setkey("spdflush;\n")
319 def spd_add(self, local_ip, remote_ip):
320 cmds = ("spdadd %s %s gre -P out ipsec esp/transport//require;\n" %
321 (local_ip, remote_ip))
322 cmds += ("spdadd %s %s gre -P in ipsec esp/transport//require;\n" %
323 (remote_ip, local_ip))
324 self.call_setkey(cmds)
326 def spd_del(self, local_ip, remote_ip):
327 cmds = "spddelete %s %s gre -P out;\n" % (local_ip, remote_ip)
328 cmds += "spddelete %s %s gre -P in;\n" % (remote_ip, local_ip)
329 self.call_setkey(cmds)
331 def add_entry(self, local_ip, remote_ip, vals):
332 if remote_ip in self.entries:
333 raise error.Error("host %s already configured for ipsec"
336 self.racoon.add_entry(remote_ip, vals)
337 self.spd_add(local_ip, remote_ip)
339 self.entries.append(remote_ip)
341 def del_entry(self, local_ip, remote_ip):
342 if remote_ip in self.entries:
343 self.racoon.del_entry(remote_ip)
344 self.spd_del(local_ip, remote_ip)
345 self.sad_del(local_ip, remote_ip)
347 self.entries.remove(remote_ip)
350 def keep_table_columns(schema, table_name, column_types):
351 table = schema.tables.get(table_name)
353 raise error.Error("schema has no %s table" % table_name)
356 for column_name, column_type in column_types.iteritems():
357 column = table.columns.get(column_name)
359 raise error.Error("%s table schema lacks %s column"
360 % (table_name, column_name))
361 if column.type != column_type:
362 raise error.Error("%s column in %s table has type \"%s\", "
363 "expected type \"%s\""
364 % (column_name, table_name,
365 column.type.toEnglish(),
366 column_type.toEnglish()))
367 new_columns[column_name] = column
368 table.columns = new_columns
372 def prune_schema(schema):
373 string_type = types.Type(types.BaseType(types.StringType))
374 optional_ssl_type = types.Type(types.BaseType(types.UuidType,
375 ref_table_name='SSL'), None, 0, 1)
376 string_map_type = types.Type(types.BaseType(types.StringType),
377 types.BaseType(types.StringType),
381 new_tables["Interface"] = keep_table_columns(
382 schema, "Interface", {"name": string_type,
384 "options": string_map_type})
385 new_tables["Open_vSwitch"] = keep_table_columns(
386 schema, "Open_vSwitch", {"ssl": optional_ssl_type})
387 new_tables["SSL"] = keep_table_columns(
388 schema, "SSL", {"certificate": string_type,
389 "private_key": string_type})
390 schema.tables = new_tables
393 def update_ipsec(ipsec, interfaces, new_interfaces):
394 for name, vals in interfaces.iteritems():
395 if name not in new_interfaces:
396 ipsec.del_entry(vals["local_ip"], vals["remote_ip"])
398 for name, vals in new_interfaces.iteritems():
399 orig_vals = interfaces.get(name)
401 # Configuration for this host already exists. Check if it's
403 if vals == orig_vals:
406 ipsec.del_entry(vals["local_ip"], vals["remote_ip"])
409 ipsec.add_entry(vals["local_ip"], vals["remote_ip"], vals)
410 except error.Error, msg:
411 vlog.warn("skipping ipsec config for %s: %s" % (name, msg))
414 def get_ssl_cert(data):
415 for ovs_rec in data["Open_vSwitch"].rows.itervalues():
417 if ssl and ssl.certificate and ssl.private_key:
418 return (ssl.certificate, ssl.private_key)
425 parser = argparse.ArgumentParser()
426 parser.add_argument("database", metavar="DATABASE",
427 help="A socket on which ovsdb-server is listening.")
428 parser.add_argument("--root-prefix", metavar="DIR",
429 help="Use DIR as alternate root directory"
432 ovs.vlog.add_args(parser)
433 ovs.daemon.add_args(parser)
434 args = parser.parse_args()
435 ovs.vlog.handle_args(args)
436 ovs.daemon.handle_args(args)
439 root_prefix = args.root_prefix
441 remote = args.database
442 schema_file = "%s/vswitch.ovsschema" % ovs.dirs.PKGDATADIR
443 schema = ovs.db.schema.DbSchema.from_json(ovs.json.from_file(schema_file))
445 idl = ovs.db.idl.Idl(remote, schema)
447 ovs.daemon.daemonize()
454 poller = ovs.poller.Poller()
459 ssl_cert = get_ssl_cert(idl.tables)
462 for rec in idl.tables["Interface"].rows.itervalues():
463 if rec.type == "ipsec_gre":
465 options = rec.options
467 "remote_ip": options.get("remote_ip"),
468 "local_ip": options.get("local_ip", "0.0.0.0/0"),
469 "certificate": options.get("certificate"),
470 "private_key": options.get("private_key"),
471 "use_ssl_cert": options.get("use_ssl_cert"),
472 "peer_cert": options.get("peer_cert"),
473 "psk": options.get("psk")}
475 if entry["peer_cert"] and entry["psk"]:
476 vlog.warn("both 'peer_cert' and 'psk' defined for %s"
479 elif not entry["peer_cert"] and not entry["psk"]:
480 vlog.warn("no 'peer_cert' or 'psk' defined for %s" % name)
483 # The "use_ssl_cert" option is deprecated and will
484 # likely go away in the near future.
485 if entry["use_ssl_cert"] == "true":
487 vlog.warn("no valid SSL entry for %s" % name)
490 entry["certificate"] = ssl_cert[0]
491 entry["private_key"] = ssl_cert[1]
493 new_interfaces[name] = entry
495 if interfaces != new_interfaces:
496 update_ipsec(ipsec, interfaces, new_interfaces)
497 interfaces = new_interfaces
500 if __name__ == '__main__':
504 # Let system.exit() calls complete normally
507 vlog.exception("traceback")
508 sys.exit(ovs.daemon.RESTART_EXIT_CODE)