pki: ipsec: T3642: Migrate IPSec to use PKI configuration

3 files changed, 200 insertions, 30 deletions

diff --git a/src/conf_mode/vpn_ipsec.py b/src/conf_mode/vpn_ipsec.py
index d598ff6da..e8e8b453a 100755
--- a/src/conf_mode/vpn_ipsec.py
+++ b/src/conf_mode/vpn_ipsec.py
@@ -23,6 +23,10 @@ from vyos.config import Config
 from vyos.configdict import leaf_node_changed
 from vyos.configverify import verify_interface_exists
 from vyos.ifconfig import Interface
+from vyos.pki import wrap_certificate
+from vyos.pki import wrap_crl
+from vyos.pki import wrap_public_key
+from vyos.pki import wrap_private_key
 from vyos.template import ip_from_cidr
 from vyos.template import render
 from vyos.validate import is_ipv6_link_local
@@ -115,6 +119,8 @@ def get_config(config=None):
     ipsec['interface_change'] = leaf_node_changed(conf, base + ['ipsec-interfaces', 'interface'])
     ipsec['l2tp_exists'] = conf.exists(['vpn', 'l2tp', 'remote-access', 'ipsec-settings'])
     ipsec['nhrp_exists'] = conf.exists(['protocols', 'nhrp', 'tunnel'])
+    ipsec['pki'] = conf.get_config_dict(['pki'], key_mangling=('-', '_'),
+                                             get_first_key=True, no_tag_node_value_mangle=True)
     ipsec['rsa_keys'] = conf.get_config_dict(['vpn', 'rsa-keys'], key_mangling=('-', '_'),
                                              get_first_key=True, no_tag_node_value_mangle=True)
 
@@ -187,6 +193,24 @@ def get_dhcp_address(iface):
             return ip_from_cidr(address)
     return None
 
+def verify_pki(pki, x509_conf):
+    if not pki or 'ca' not in pki or 'certificate' not in pki:
+        raise ConfigError(f'PKI is not configured')
+
+    ca_cert_name = x509_conf['ca_certificate']
+    cert_name = x509_conf['certificate']
+
+    if not dict_search(f'ca.{ca_cert_name}.certificate', ipsec['pki']):
+        raise ConfigError(f'Missing CA certificate on specified PKI CA certificate "{ca_cert_name}"')
+
+    if not dict_search(f'certificate.{cert_name}.certificate', ipsec['pki']):
+        raise ConfigError(f'Missing certificate on specified PKI certificate "{cert_name}"')
+
+    if not dict_search(f'certificate.{cert_name}.private.key', ipsec['pki']):
+        raise ConfigError(f'Missing private key on specified PKI certificate "{cert_name}"')
+
+    return True
+
 def verify(ipsec):
     if not ipsec:
         return None
@@ -237,24 +261,12 @@ def verify(ipsec):
                 if 'x509' not in peer_conf['authentication']:
                     raise ConfigError(f"Missing x509 settings on site-to-site peer {peer}")
 
-                if 'key' not in peer_conf['authentication']['x509']:
-                    raise ConfigError(f"Missing x509 key on site-to-site peer {peer}")
-
-                if 'ca_cert_file' not in peer_conf['authentication']['x509'] or 'cert_file' not in peer_conf['authentication']['x509']:
-                    raise ConfigError(f"Missing x509 settings on site-to-site peer {peer}")
+                x509 = peer_conf['authentication']['x509']
 
-                if 'file' not in peer_conf['authentication']['x509']['key']:
-                    raise ConfigError(f"Missing x509 key file on site-to-site peer {peer}")
+                if 'ca_certificate' not in x509 or 'certificate' not in x509:
+                    raise ConfigError(f"Missing x509 certificates on site-to-site peer {peer}")
 
-                for key in ['ca_cert_file', 'cert_file', 'crl_file']:
-                    if key in peer_conf['authentication']['x509']:
-                        path = os.path.join(X509_PATH, peer_conf['authentication']['x509'][key])
-                        if not os.path.exists(path):
-                            raise ConfigError(f"File not found for {key} on site-to-site peer {peer}")
-
-                key_path = os.path.join(X509_PATH, peer_conf['authentication']['x509']['key']['file'])
-                if not os.path.exists(key_path):
-                    raise ConfigError(f"Private key not found on site-to-site peer {peer}")
+                verify_pki(ipsec['pki'], x509)
 
             if peer_conf['authentication']['mode'] == 'rsa':
                 if not verify_rsa_local_key(ipsec):
@@ -320,6 +332,31 @@ def verify(ipsec):
                         if ('local' in tunnel_conf and 'prefix' in tunnel_conf['local']) or ('remote' in tunnel_conf and 'prefix' in tunnel_conf['remote']):
                             raise ConfigError(f"Local/remote prefix cannot be used with ESP transport mode on tunnel {tunnel} for site-to-site peer {peer}")
 
+def generate_pki_files(pki, x509_conf):
+    ca_cert_name = x509_conf['ca_certificate']
+    ca_cert_data = dict_search(f'ca.{ca_cert_name}.certificate', pki)
+    ca_cert_crls = dict_search(f'ca.{ca_cert_name}.crl', pki) or []
+    crl_index = 1
+
+    cert_name = x509_conf['certificate']
+    cert_data = dict_search(f'certificate.{cert_name}.certificate', pki)
+    key_data = dict_search(f'certificate.{cert_name}.private.key', pki)
+    protected = 'passphrase' in x509_conf
+
+    with open(os.path.join(CA_PATH, f'{ca_cert_name}.pem'), 'w') as f:
+        f.write(wrap_certificate(ca_cert_data))
+
+    for crl in ca_cert_crls:
+        with open(os.path.join(CRL_PATH, f'{ca_cert_name}_{crl_index}.pem'), 'w') as f:
+            f.write(wrap_crl(crl))
+        crl_index += 1
+
+    with open(os.path.join(CERT_PATH, f'{cert_name}.pem'), 'w') as f:
+        f.write(wrap_certificate(cert_data))
+
+    with open(os.path.join(KEY_PATH, f'{cert_name}.pem'), 'w') as f:
+        f.write(wrap_private_key(key_data, protected))
+
 def generate(ipsec):
     data = {}
 
@@ -334,24 +371,20 @@ def generate(ipsec):
         data['marks'] = {}
         data['rsa_local_key'] = verify_rsa_local_key(ipsec)
 
+        for path in [swanctl_dir, CERT_PATH, CA_PATH, CRL_PATH]:
+            if not os.path.exists(path):
+                os.mkdir(path, mode=0o755)
+
+        if not os.path.exists(KEY_PATH):
+            os.mkdir(KEY_PATH, mode=0o700)
+
         if 'site_to_site' in data and 'peer' in data['site_to_site']:
             for peer, peer_conf in ipsec['site_to_site']['peer'].items():
                 if peer in ipsec['dhcp_no_address']:
                     continue
 
                 if peer_conf['authentication']['mode'] == 'x509':
-                    cert_file = os.path.join(X509_PATH, peer_conf['authentication']['x509']['cert_file'])
-                    copy_file(cert_file, CERT_PATH, True)
-
-                    key_file = os.path.join(X509_PATH, peer_conf['authentication']['x509']['key']['file'])
-                    copy_file(key_file, X509_PATH, True)
-
-                    ca_cert_file = os.path.join(X509_PATH, peer_conf['authentication']['x509']['ca_cert_file'])
-                    copy_file(ca_cert_file, CA_PATH, True)
-
-                    if 'crl_file' in peer_conf['authentication']['x509']:
-                        crl_file = os.path.join(X509_PATH, peer_conf['authentication']['x509']['crl_file'])
-                        copy_file(crl_file, CRL_PATH, True)
+                    generate_pki_files(ipsec['pki'], peer_conf['authentication']['x509'])
 
                 local_ip = ''
                 if 'local_address' in peer_conf:
diff --git a/src/migration-scripts/ipsec/6-to-7 b/src/migration-scripts/ipsec/6-to-7
new file mode 100755
index 000000000..6655fba93
--- /dev/null
+++ b/src/migration-scripts/ipsec/6-to-7
@@ -0,0 +1,137 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Migrate /config/auth certificates and keys into PKI configuration
+
+import os
+
+from sys import argv
+from sys import exit
+
+from vyos.configtree import ConfigTree
+from vyos.pki import load_certificate
+from vyos.pki import load_crl
+from vyos.pki import load_private_key
+from vyos.pki import encode_certificate
+from vyos.pki import encode_private_key
+
+if (len(argv) < 1):
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+pki_base = ['pki']
+ipsec_site_base = ['vpn', 'ipsec', 'site-to-site', 'peer']
+
+config = ConfigTree(config_file)
+changes_made = False
+
+AUTH_DIR = '/config/auth'
+
+def wrapped_pem_to_config_value(pem):
+    return "".join(pem.strip().split("\n")[1:-1])
+
+if config.exists(ipsec_site_base):
+    config.set(pki_base + ['ca'])
+    config.set_tag(pki_base + ['ca'])
+
+    config.set(pki_base + ['certificate'])
+    config.set_tag(pki_base + ['certificate'])
+
+    for peer in config.list_nodes(ipsec_site_base):
+        if not config.exists(ipsec_site_base + [peer, 'authentication', 'x509']):
+            continue
+
+        changes_made = True
+
+        peer_x509_base = ipsec_site_base + [peer, 'authentication', 'x509']
+        pki_name = 'peer_' + peer.replace(".", "-")
+
+        if config.exists(peer_x509_base + ['cert-file']):
+            cert_file = config.return_value(peer_x509_base + ['cert-file'])
+            cert_path = os.path.join(AUTH_DIR, cert_file)
+            cert = None
+
+            with open(cert_path, 'r') as f:
+                cert_data = f.read()
+                cert = load_certificate(cert_data, wrap_tags=False)
+
+            cert_pem = encode_certificate(cert)
+            config.set(pki_base + ['certificate', pki_name, 'certificate'], value=wrapped_pem_to_config_value(cert_pem))
+            config.set(peer_x509_base + ['certificate'], value=pki_name)
+            config.delete(peer_x509_base + ['cert-file'])
+
+        if config.exists(peer_x509_base + ['ca-cert-file']):
+            ca_cert_file = config.return_value(peer_x509_base + ['ca-cert-file'])
+            ca_cert_path = os.path.join(AUTH_DIR, ca_cert_file)
+            ca_cert = None
+
+            with open(ca_cert_path, 'r') as f:
+                ca_cert_data = f.read()
+                ca_cert = load_certificate(ca_cert_data, wrap_tags=False)
+
+            ca_cert_pem = encode_certificate(ca_cert)
+            config.set(pki_base + ['ca', pki_name, 'certificate'], value=wrapped_pem_to_config_value(ca_cert_pem))
+            config.set(peer_x509_base + ['ca-certificate'], value=pki_name)
+            config.delete(peer_x509_base + ['ca-cert-file'])
+
+        if config.exists(peer_x509_base + ['crl-file']):
+            crl_file = config.return_value(peer_x509_base + ['crl-file'])
+            crl_path = os.path.join(AUTH_DIR, crl_file)
+            crl = None
+
+            with open(crl_path, 'r') as f:
+                crl_data = f.read()
+                crl = load_crl(crl_data, wrap_tags=False)
+
+            crl_pem = encode_certificate(crl)
+            config.set(pki_base + ['ca', pki_name, 'crl'], value=wrapped_pem_to_config_value(crl_pem))
+            config.delete(peer_x509_base + ['crl-file'])
+
+        if config.exists(peer_x509_base + ['key', 'file']):
+            key_file = config.return_value(peer_x509_base + ['key', 'file'])
+            key_passphrase = None
+
+            if config.exists(peer_x509_base + ['key', 'password']):
+                key_passphrase = config.return_value(peer_x509_base + ['key', 'password'])
+
+            key_path = os.path.join(AUTH_DIR, key_file)
+            key = None
+
+            with open(key_path, 'r') as f:
+                key_data = f.read()
+                key = load_private_key(key_data, passphrase=key_passphrase, wrap_tags=False)
+
+            key_pem = encode_private_key(key, passphrase=key_passphrase)
+            config.set(pki_base + ['certificate', pki_name, 'private', 'key'], value=wrapped_pem_to_config_value(key_pem))
+
+            if key_passphrase:
+                config.set(pki_base + ['certificate', pki_name, 'private', 'password-protected'])
+                config.set(peer_x509_base + ['private-key-passphrase'], value=key_passphrase)
+            
+            config.delete(peer_x509_base + ['key'])
+
+if changes_made:
+    try:
+        with open(file_name, 'w') as f:
+            f.write(config.to_string())
+    except OSError as e:
+        print("Failed to save the modified config: {}".format(e))
+        sys.exit(1)
diff --git a/src/op_mode/pki.py b/src/op_mode/pki.py
index 321a5e60d..d99a432aa 100755
--- a/src/op_mode/pki.py
+++ b/src/op_mode/pki.py
@@ -473,8 +473,8 @@ def generate_openvpn_key(name, install=False):
         key_version = version_search[1]
 
     print("Configure mode commands to install OpenVPN key:")
-    print("set pki openvpn tls-auth %s key '%s'" % (name, key_data))
-    print("set pki openvpn tls-auth %s version '%s'" % (name, key_version))
+    print("set pki openvpn shared-secret %s key '%s'" % (name, key_data))
+    print("set pki openvpn shared-secret %s version '%s'" % (name, key_version))
 
 def generate_wireguard_key(name, install=False):
     private_key = cmd('wg genkey')