Copyright (C) 2008 Shrew Soft Inc Copyright (C) 2010 Ermal Luci All rights reserved. Parts of this code was originally based on vpn_ipsec_sad.php Copyright (C) 2003-2004 Manuel Kasper Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ require_once("globals.inc"); require_once("openvpn.inc"); require_once("filter.inc"); require_once("shaper.inc"); require_once("util.inc"); require_once("pfsense-utils.inc"); global $current_openvpn_version, $current_openvpn_version_rev; $current_openvpn_version = "2.3.8"; $current_openvpn_version_rev = "01"; function openvpn_client_export_install() { global $current_openvpn_version; $pfs_version = substr(trim(file_get_contents("/etc/version")),0,3); if ($pfs_version == "2.1" || $pfs_version == "2.2") { conf_mount_rw(); $tarpath = "/usr/local/pkg/openvpn-client-export-{$current_openvpn_version}.tgz"; $ovpndir = "/usr/local/share/openvpn"; $workdir = "{$ovpndir}/client-export"; if (!is_dir($workdir)) { mkdir($workdir, 0777, true); } exec("/usr/bin/tar zxf {$tarpath} -C {$ovpndir}"); conf_mount_ro(); } } function openvpn_client_export_deinstall() { exec("/bin/rm -r /usr/local/share/openvpn/client-export"); } function openvpn_client_export_prefix($srvid, $usrid = null, $crtid = null) { global $config; // lookup server settings $settings = $config['openvpn']['openvpn-server'][$srvid]; if (empty($settings)) { return false; } if ($settings['disable']) { return false; } $host = empty($config['system']['hostname']) ? "openvpn" : $config['system']['hostname']; $prot = ($settings['protocol'] == 'UDP' ? 'udp' : $settings['protocol']); $port = $settings['local_port']; $filename_addition = ""; if ($usrid && is_numeric($usrid)) { $filename_addition = "-" . $config['system']['user'][$usrid]['name']; } elseif ($crtid && is_numeric($crtid) && function_exists("cert_get_cn")) { $filename_addition = "-" . str_replace(' ', '_', cert_get_cn($config['cert'][$crtid]['crt'])); } return "{$host}-{$prot}-{$port}{$filename_addition}"; } function openvpn_client_pem_to_pk12($outpath, $outpass, $crtpath, $keypath, $capath = false) { $eoutpath = escapeshellarg($outpath); $eoutpass = escapeshellarg($outpass); $ecrtpath = escapeshellarg($crtpath); $ekeypath = escapeshellarg($keypath); if ($capath) { $ecapath = escapeshellarg($capath); exec("/usr/bin/openssl pkcs12 -export -in {$ecrtpath} -inkey {$ekeypath} -certfile {$ecapath} -out {$eoutpath} -passout pass:{$eoutpass}"); } else { exec("/usr/bin/openssl pkcs12 -export -in {$ecrtpath} -inkey {$ekeypath} -out {$eoutpath} -passout pass:{$eoutpass}"); } unlink($crtpath); unlink($keypath); if ($capath) { unlink($capath); } } function openvpn_client_export_validate_config($srvid, $usrid, $crtid) { global $config, $g, $input_errors; // lookup server settings $settings = $config['openvpn']['openvpn-server'][$srvid]; if (empty($settings)) { $input_errors[] = "Could not locate server configuration."; return false; } if ($settings['disable']) { $input_errors[] = "You cannot export for disabled servers."; return false; } // lookup server certificate info $server_cert = lookup_cert($settings['certref']); if (!$server_cert) { $input_errors[] = "Could not locate server certificate."; } else { $server_ca = ca_chain($server_cert); if (!$server_ca) { $input_errors[] = "Could not locate the CA reference for the server certificate."; } if (function_exists("cert_get_cn")) { $servercn = cert_get_cn($server_cert['crt']); } } // lookup user info if (is_numeric($usrid)) { $user = $config['system']['user'][$usrid]; if (!$user) { $input_errors[] = "Could not find user settings."; } } // lookup user certificate info if ($settings['mode'] == "server_tls_user") { if ($settings['authmode'] == "Local Database") { $cert = $user['cert'][$crtid]; } else { $cert = $config['cert'][$crtid]; } if (!$cert) { $input_errors[] = "Could not find client certificate."; } else { // If $cert is not an array, it's a certref not a cert. if (!is_array($cert)) { $cert = lookup_cert($cert); } } } elseif (($settings['mode'] == "server_tls") || (($settings['mode'] == "server_tls_user") && ($settings['authmode'] != "Local Database"))) { $cert = $config['cert'][$crtid]; if (!$cert) { $input_errors[] = "Could not find client certificate."; } } else { $nokeys = true; } if ($input_errors) { return false; } return array($settings, $server_cert, $server_ca, $servercn, $user, $cert, $nokeys); } function openvpn_client_export_config($srvid, $usrid, $crtid, $useaddr, $verifyservercn, $randomlocalport, $usetoken, $nokeys = false, $proxy, $expformat = "baseconf", $outpass = "", $skiptls = false, $doslines = false, $openvpnmanager, $advancedoptions = "") { global $config, $input_errors, $g; $pfs_version = substr(trim(file_get_contents("/etc/version")), 0, 3); $nl = ($doslines) ? "\r\n" : "\n"; $conf = ""; if ($expformat == "inlinevisc") { $conf .= << 2.1) { $conf .= "comp-lzo {$settings['compression']}{$nl}"; } else { $conf .= "comp-lzo{$nl}"; } } if ($settings['passtos']) { $conf .= "passtos{$nl}"; } if ($openvpnmanager) { if (!empty($settings['client_mgmt_port'])) { $client_mgmt_port = $settings['client_mgmt_port']; } else { $client_mgmt_port = 166; } $conf .= $nl; $conf .= "# dont terminate service process on wrong password, ask again{$nl}"; $conf .= "auth-retry interact{$nl}"; $conf .= "# open management channel{$nl}"; $conf .= "management 127.0.0.1 {$client_mgmt_port}{$nl}"; $conf .= "# wait for management to explicitly start connection{$nl}"; $conf .= "management-hold{$nl}"; $conf .= "# query management channel for user/pass{$nl}"; $conf .= "management-query-passwords{$nl}"; $conf .= "# disconnect VPN when management program connection is closed{$nl}"; $conf .= "management-signal{$nl}"; $conf .= "# forget password when management disconnects{$nl}"; $conf .= "management-forget-disconnect{$nl}"; $conf .= $nl; }; // add advanced options $advancedoptions = str_replace("\r\n", "\n", $advancedoptions); $advancedoptions = str_replace("\n", $nl, $advancedoptions); $advancedoptions = str_replace(";", $nl, $advancedoptions); $conf .= $advancedoptions; $conf .= $nl; switch ($expformat) { case "zip": // create template directory $tempdir = "{$g['tmp_path']}/{$prefix}"; @mkdir($tempdir, 0700, true); file_put_contents("{$tempdir}/{$prefix}.ovpn", $conf); $cafile = "{$tempdir}/{$cafile}"; file_put_contents("{$cafile}", $server_ca); if ($settings['tls']) { $tlsfile = "{$tempdir}/{$prefix}-tls.key"; file_put_contents($tlsfile, base64_decode($settings['tls'])); } // write key files if ($settings['mode'] != "server_user") { $crtfile = "{$tempdir}/{$prefix}-cert.crt"; file_put_contents($crtfile, base64_decode($cert['crt'])); $keyfile = "{$tempdir}/{$prefix}.key"; file_put_contents($keyfile, base64_decode($cert['prv'])); // convert to pkcs12 format $p12file = "{$tempdir}/{$prefix}.p12"; if ($usetoken) { openvpn_client_pem_to_pk12($p12file, $outpass, $crtfile, $keyfile); } else { openvpn_client_pem_to_pk12($p12file, $outpass, $crtfile, $keyfile, $cafile); } } $command = "cd " . escapeshellarg("{$tempdir}/..") . " && /usr/local/bin/zip -r " . escapeshellarg("{$g['tmp_path']}/{$prefix}-config.zip") . " " . escapeshellarg($prefix); exec($command); // Remove temporary directory exec("rm -rf " . escapeshellarg($tempdir)); return "{$g['tmp_path']}/{$prefix}-config.zip"; break; case "inline": case "inlinedroid": case "inlineios": case "inlinevisc": // Inline CA $conf .= "{$nl}" . trim($server_ca) . "{$nl}{$nl}"; if ($settings['mode'] != "server_user") { // Inline Cert $conf .= "{$nl}" . trim(base64_decode($cert['crt'])) . "{$nl}{$nl}"; // Inline Key $conf .= "{$nl}" . trim(base64_decode($cert['prv'])) . "{$nl}{$nl}"; } else { // Work around OpenVPN Connect assuming you have a client cert even when you don't need one $conf .= "setenv CLIENT_CERT 0{$nl}"; } // Inline TLS if ($settings['tls']) { $conf .= "{$nl}" . trim(base64_decode($settings['tls'])) . "{$nl}{$nl} key-direction 1{$nl}"; } return $conf; break; case "yealink_t28": case "yealink_t38g": case "yealink_t38g2": // create template directory $tempdir = "{$g['tmp_path']}/{$prefix}"; $keydir = "{$tempdir}/keys"; mkdir($tempdir, 0700, true); mkdir($keydir, 0700, true); file_put_contents("{$tempdir}/vpn.cnf", $conf); $cafile = "{$keydir}/ca.crt"; file_put_contents("{$cafile}", $server_ca); if ($settings['tls']) { $tlsfile = "{$keydir}/ta.key"; file_put_contents($tlsfile, base64_decode($settings['tls'])); } // write key files if ($settings['mode'] != "server_user") { $crtfile = "{$keydir}/client1.crt"; file_put_contents($crtfile, base64_decode($cert['crt'])); $keyfile = "{$keydir}/client1.key"; file_put_contents($keyfile, base64_decode($cert['prv'])); } exec("tar -C {$tempdir} -cf {$g['tmp_path']}/client.tar ./keys ./vpn.cnf"); // Remove temporary directory exec("rm -rf {$tempdir}"); return $g['tmp_path'] . "/client.tar"; break; case "snom": // create template directory $tempdir = "{$g['tmp_path']}/{$prefix}"; mkdir($tempdir, 0700, true); file_put_contents("{$tempdir}/vpn.cnf", $conf); $cafile = "{$tempdir}/ca.crt"; file_put_contents("{$cafile}", $server_ca); if ($settings['tls']) { $tlsfile = "{$tempdir}/ta.key"; file_put_contents($tlsfile, base64_decode($settings['tls'])); } // write key files if ($settings['mode'] != "server_user") { $crtfile = "{$tempdir}/phone1.crt"; file_put_contents($crtfile, base64_decode($cert['crt'])); $keyfile = "{$tempdir}/phone1.key"; file_put_contents($keyfile, base64_decode($cert['prv'])); } exec("cd {$tempdir}/ && tar -cf {$g['tmp_path']}/vpnclient.tar *"); // Remove temporary directory exec("rm -rf {$tempdir}"); return $g['tmp_path'] . "/vpnclient.tar"; break; default: return $conf; } } function openvpn_client_export_installer($srvid, $usrid, $crtid, $useaddr, $verifyservercn, $randomlocalport, $usetoken, $outpass, $proxy, $openvpnmanager, $advancedoptions, $openvpn_version = "x86-xp") { global $config, $g, $input_errors, $current_openvpn_version, $current_openvpn_version_rev; $uname_p = trim(exec("uname -p")); switch ($openvpn_version) { case "x86-xp": $client_install_exe = "openvpn-install-{$current_openvpn_version}-I0{$current_openvpn_version_rev}-i686.exe"; break; case "x64-xp": $client_install_exe = "openvpn-install-{$current_openvpn_version}-I0{$current_openvpn_version_rev}-x86_64.exe"; break; case "x86-win6": $client_install_exe = "openvpn-install-{$current_openvpn_version}-I6{$current_openvpn_version_rev}-i686.exe"; break; case "x64-win6": $client_install_exe = "openvpn-install-{$current_openvpn_version}-I6{$current_openvpn_version_rev}-x86_64.exe"; break; default: $client_install_exe = "openvpn-install-{$current_openvpn_version}-I0{$current_openvpn_version_rev}-i686.exe"; } $ovpndir = "/usr/local/share/openvpn"; $workdir = "{$ovpndir}/client-export"; if (!file_exists($workdir . "/template/{$client_install_exe}")) { openvpn_client_export_install(); } $validconfig = openvpn_client_export_validate_config($srvid, $usrid, $crtid); if ($validconfig) { list($settings, $server_cert, $server_ca, $servercn, $user, $cert, $nokeys) = $validconfig; } else { return false; } // create template directory $tempdir = $g['tmp_path'] . "/openvpn-export-".uniqid(); mkdir($tempdir, 0700, true); // create config directory $confdir = "{$tempdir}/config"; if (!is_dir($conf_dir)) { mkdir($confdir, 0700, true); } // copy the template directory exec("cp -r {$workdir}/template/* {$tempdir}"); // and put the required installer exe in place exec("/bin/cp {$tempdir}/{$client_install_exe} {$tempdir}/openvpn-install.exe"); if (stristr($openvpn_version, "x64")) { rename("{$tempdir}/openvpn-postinstall64.exe", "{$tempdir}/openvpn-postinstall.exe"); } // write configuration file $prefix = openvpn_client_export_prefix($srvid, $usrid, $crtid); $cfgfile = "{$confdir}/{$prefix}-config.ovpn"; if (!empty($proxy) && $proxy['proxy_authtype'] != "none") { $proxy['passwdfile'] = "{$prefix}-password"; $pwdfle = "{$proxy['user']}\r\n"; $pwdfle .= "{$proxy['password']}\r\n"; file_put_contents("{$confdir}/{$proxy['passwdfile']}", $pwdfle); } $conf = openvpn_client_export_config($srvid, $usrid, $crtid, $useaddr, $verifyservercn, $randomlocalport, $usetoken, $nokeys, $proxy, "", "baseconf", false, true, $openvpnmanager, $advancedoptions); if (!$conf) { $input_errors[] = "Could not create a config to export."; return false; } file_put_contents($cfgfile, $conf); $cafile = "{$tempdir}/config/{$prefix}-ca.crt"; file_put_contents($cafile, $server_ca); if ($settings['tls']) { $tlsfile = "{$tempdir}/config/{$prefix}-tls.key"; file_put_contents($tlsfile, base64_decode($settings['tls'])); } // write key files if ($settings['mode'] != "server_user") { $crtfile = "{$tempdir}/config/{$prefix}-{$user['name']}.crt"; file_put_contents($crtfile, base64_decode($cert['crt'])); $keyfile = "{$tempdir}/config/{$prefix}-{$user['name']}.key"; file_put_contents($keyfile, base64_decode($cert['prv'])); // convert to pkcs12 format $p12file = "{$tempdir}/config/{$prefix}.p12"; if ($usetoken) { openvpn_client_pem_to_pk12($p12file, $outpass, $crtfile, $keyfile); } else { openvpn_client_pem_to_pk12($p12file, $outpass, $crtfile, $keyfile, $cafile); } } // 7zip the configuration data chdir($tempdir); $files = "config "; if ($openvpnmanager) { $files .= "openvpnmanager "; } $files .= "openvpn-install.exe "; $files .= "openvpn-postinstall.exe "; if ($usetoken) { $procchain = ';!@Install@!UTF-8! RunProgram="openvpn-postinstall.exe /Import" ;!@InstallEnd@!' ; } else { $procchain = ';!@Install@!UTF-8! RunProgram="openvpn-postinstall.exe" ;!@InstallEnd@!' ; } file_put_contents("{$tempdir}/7zipConfig",$procchain); if (file_exists("/usr/pbi/p7zip-{$uname_p}/bin/7z")) { exec("/usr/pbi/p7zip-{$uname_p}/bin/7z -y a archive.7z {$files}"); } else { exec("/usr/local/libexec/p7zip/7z -y a archive.7z {$files}"); } // create the final installer $outfile = "{$tempdir}-install.exe"; chdir($g['tmp_path']); exec("/bin/cat {$tempdir}/7zS.sfx {$tempdir}/7zipConfig {$tempdir}/archive.7z > {$outfile}"); // cleanup exec("/bin/rm -r {$tempdir}"); return $outfile; } function viscosity_openvpn_client_config_exporter($srvid, $usrid, $crtid, $useaddr, $verifyservercn, $randomlocalport, $usetoken, $outpass, $proxy, $openvpnmanager, $advancedoptions) { global $config, $g; $uname_p = trim(exec("uname -p")); $ovpndir = "/usr/local/share/openvpn/"; if (!file_exists($workdir . "/template/openvpn-install.exe")) { openvpn_client_export_install(); } $uniq = uniqid(); $tempdir = $g['tmp_path'] . "/openvpn-export-" . $uniq; $zipfile = $g['tmp_path'] . "/{$uniq}-Viscosity.visc.zip"; $validconfig = openvpn_client_export_validate_config($srvid, $usrid, $crtid); if ($validconfig) { list($settings, $server_cert, $server_ca, $servercn, $user, $cert, $nokeys) = $validconfig; } else { return false; } // create template directory mkdir($tempdir, 0700, true); mkdir($tempdir . "/Viscosity.visc", 0700, true); // Append new Viscosity.visc directory on top $tempdir = $tempdir . "/Viscosity.visc/"; // write cofiguration file $prefix = openvpn_client_export_prefix($srvid, $usrid, $crtid); if (!empty($proxy) && $proxy['proxy_authtype'] != "none") { $proxy['passwdfile'] = "config-password"; $pwdfle = "{$proxy['user']}\n"; $pwdfle .= "{$proxy['password']}\n"; file_put_contents("{$tempdir}/{$proxy['passwdfile']}", $pwdfle); } $conf = openvpn_client_export_config($srvid, $usrid, $crtid, $useaddr, $verifyservercn, $randomlocalport, $usetoken, true, $proxy, "baseconf", $outpass, true, true, $openvpnmanager, $advancedoptions); if (!$conf) { return false; } // We need to nuke the ca line from the above config if it exists. $conf = explode("\n", $conf); for ($i = 0; $i < count($conf); $i++) { if ((substr($conf[$i], 0, 3) == "ca ") || (substr($conf[$i], 0, 7) == "pkcs12 ")) { unset($conf[$i]); } } $conf = implode("\n", $conf); $friendly_name = $settings['description']; $visc_settings = <<