5 * Copyright (C) 2010-2014 BMW Car IT GmbH.
6 * Copyright (C) 2016-2019 Jolla Ltd.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
33 #include <linux/if_tun.h>
34 #include <sys/types.h>
35 #include <sys/socket.h>
40 #define CONNMAN_API_SUBJECT_TO_CHANGE
41 #include <connman/plugin.h>
42 #include <connman/log.h>
43 #include <connman/task.h>
44 #include <connman/dbus.h>
45 #include <connman/ipconfig.h>
46 #include <connman/agent.h>
47 #include <connman/setting.h>
48 #include <connman/vpn-dbus.h>
50 #include "../vpn-provider.h"
51 #include "../vpn-agent.h"
56 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
58 static DBusConnection *connection;
65 { "Host", "--remote", 1 },
66 { "OpenVPN.CACert", "--ca", 1 },
67 { "OpenVPN.Cert", "--cert", 1 },
68 { "OpenVPN.Key", "--key", 1 },
69 { "OpenVPN.MTU", "--tun-mtu", 1 },
70 { "OpenVPN.NSCertType", "--ns-cert-type", 1 },
71 { "OpenVPN.Proto", "--proto", 1 },
72 { "OpenVPN.Port", "--port", 1 },
73 { "OpenVPN.AuthUserPass", "--auth-user-pass", 1 },
74 { "OpenVPN.AskPass", "--askpass", 1 },
75 { "OpenVPN.AuthNoCache", "--auth-nocache", 0 },
76 { "OpenVPN.TLSRemote", "--tls-remote", 1 },
77 { "OpenVPN.TLSAuth", NULL, 1 },
78 { "OpenVPN.TLSAuthDir", NULL, 1 },
79 { "OpenVPN.TLSCipher", "--tls-cipher", 1},
80 { "OpenVPN.Cipher", "--cipher", 1 },
81 { "OpenVPN.Auth", "--auth", 1 },
82 { "OpenVPN.CompLZO", "--comp-lzo", 0 },
83 { "OpenVPN.RemoteCertTls", "--remote-cert-tls", 1 },
84 { "OpenVPN.ConfigFile", "--config", 1 },
85 { "OpenVPN.DeviceType", NULL, 1 },
86 { "OpenVPN.Verb", "--verb", 1 },
89 struct ov_private_data {
90 struct vpn_provider *provider;
91 struct connman_task *task;
94 vpn_provider_connect_cb_t cb;
99 GIOChannel *mgmt_channel;
100 int connect_attempts;
101 int failed_attempts_privatekey;
104 static void ov_connect_done(struct ov_private_data *data, int err)
106 if (data && data->cb) {
107 vpn_provider_connect_cb_t cb = data->cb;
108 void *user_data = data->user_data;
110 /* Make sure we don't invoke this callback twice */
112 data->user_data = NULL;
113 cb(data->provider, user_data, err);
117 data->failed_attempts_privatekey = 0;
120 static void free_private_data(struct ov_private_data *data)
122 if (vpn_provider_get_plugin_data(data->provider) == data)
123 vpn_provider_set_plugin_data(data->provider, NULL);
125 ov_connect_done(data, EIO);
126 vpn_provider_unref(data->provider);
127 g_free(data->dbus_sender);
128 g_free(data->if_name);
129 g_free(data->mgmt_path);
133 struct nameserver_entry {
138 static struct nameserver_entry *ov_append_dns_entries(const char *key,
141 struct nameserver_entry *entry = NULL;
144 if (!g_str_has_prefix(key, "foreign_option_"))
147 options = g_strsplit(value, " ", 3);
149 !strcmp(options[0], "dhcp-option") &&
151 !strcmp(options[1], "DNS") &&
154 entry = g_try_new(struct nameserver_entry, 1);
155 #if defined TIZEN_EXT
165 entry->nameserver = g_strdup(options[2]);
166 entry->id = atoi(key + 15); /* foreign_option_XXX */
174 static char *ov_get_domain_name(const char *key, const char *value)
179 if (!g_str_has_prefix(key, "foreign_option_"))
182 options = g_strsplit(value, " ", 3);
184 !strcmp(options[0], "dhcp-option") &&
186 !strcmp(options[1], "DOMAIN") &&
189 domain = g_strdup(options[2]);
197 static gint cmp_ns(gconstpointer a, gconstpointer b)
199 struct nameserver_entry *entry_a = (struct nameserver_entry *)a;
200 struct nameserver_entry *entry_b = (struct nameserver_entry *)b;
202 if (entry_a->id < entry_b->id)
205 if (entry_a->id > entry_b->id)
211 static void free_ns_entry(gpointer data)
213 struct nameserver_entry *entry = data;
215 g_free(entry->nameserver);
219 static int ov_notify(DBusMessage *msg, struct vpn_provider *provider)
221 DBusMessageIter iter, dict;
222 const char *reason, *key, *value;
223 char *address = NULL, *gateway = NULL, *peer = NULL, *netmask = NULL;
224 struct connman_ipaddress *ipaddress;
225 GSList *nameserver_list = NULL;
226 struct ov_private_data *data = vpn_provider_get_plugin_data(provider);
228 dbus_message_iter_init(msg, &iter);
230 dbus_message_iter_get_basic(&iter, &reason);
231 dbus_message_iter_next(&iter);
234 connman_error("No provider found");
235 return VPN_STATE_FAILURE;
238 DBG("%p %s", vpn_provider_get_name(provider), reason);
240 if (strcmp(reason, "up")) {
241 ov_connect_done(data, EIO);
242 return VPN_STATE_DISCONNECT;
245 dbus_message_iter_recurse(&iter, &dict);
247 while (dbus_message_iter_get_arg_type(&dict) == DBUS_TYPE_DICT_ENTRY) {
248 struct nameserver_entry *ns_entry = NULL;
249 DBusMessageIter entry;
251 dbus_message_iter_recurse(&dict, &entry);
252 dbus_message_iter_get_basic(&entry, &key);
253 dbus_message_iter_next(&entry);
254 dbus_message_iter_get_basic(&entry, &value);
256 DBG("%s = %s", key, value);
258 if (!strcmp(key, "trusted_ip"))
259 gateway = g_strdup(value);
261 if (!strcmp(key, "ifconfig_local"))
262 address = g_strdup(value);
264 if (!strcmp(key, "ifconfig_netmask"))
265 netmask = g_strdup(value);
267 if (!strcmp(key, "ifconfig_remote"))
268 peer = g_strdup(value);
270 if (g_str_has_prefix(key, "route_"))
271 vpn_provider_append_route(provider, key, value);
273 if ((ns_entry = ov_append_dns_entries(key, value)))
274 nameserver_list = g_slist_prepend(nameserver_list,
277 char *domain = ov_get_domain_name(key, value);
279 vpn_provider_set_domain(provider, domain);
284 dbus_message_iter_next(&dict);
287 ipaddress = connman_ipaddress_alloc(AF_INET);
289 g_slist_free_full(nameserver_list, free_ns_entry);
295 return VPN_STATE_FAILURE;
298 connman_ipaddress_set_ipv4(ipaddress, address, netmask, gateway);
299 connman_ipaddress_set_peer(ipaddress, peer);
300 vpn_provider_set_ipaddress(provider, ipaddress);
302 if (nameserver_list) {
303 char *nameservers = NULL;
306 nameserver_list = g_slist_sort(nameserver_list, cmp_ns);
307 for (tmp = nameserver_list; tmp;
308 tmp = g_slist_next(tmp)) {
309 struct nameserver_entry *ns = tmp->data;
312 nameservers = g_strdup(ns->nameserver);
315 str = g_strjoin(" ", nameservers,
316 ns->nameserver, NULL);
322 g_slist_free_full(nameserver_list, free_ns_entry);
324 vpn_provider_set_nameservers(provider, nameservers);
333 connman_ipaddress_free(ipaddress);
335 ov_connect_done(data, 0);
336 return VPN_STATE_CONNECT;
339 static int ov_save(struct vpn_provider *provider, GKeyFile *keyfile)
344 for (i = 0; i < (int)ARRAY_SIZE(ov_options); i++) {
345 if (strncmp(ov_options[i].cm_opt, "OpenVPN.", 8) == 0) {
346 option = vpn_provider_get_string(provider,
347 ov_options[i].cm_opt);
351 g_key_file_set_string(keyfile,
352 vpn_provider_get_save_group(provider),
353 ov_options[i].cm_opt, option);
359 static int task_append_config_data(struct vpn_provider *provider,
360 struct connman_task *task)
365 for (i = 0; i < (int)ARRAY_SIZE(ov_options); i++) {
366 if (!ov_options[i].ov_opt)
369 option = vpn_provider_get_string(provider,
370 ov_options[i].cm_opt);
375 * If the AuthUserPass option is "-", provide the input
376 * via management interface
378 if (!strcmp(ov_options[i].cm_opt, "OpenVPN.AuthUserPass") &&
379 !strcmp(option, "-"))
382 if (connman_task_add_argument(task,
383 ov_options[i].ov_opt,
384 ov_options[i].has_value ? option : NULL) < 0)
392 static void close_management_interface(struct ov_private_data *data)
394 if (data->mgmt_path) {
395 if (unlink(data->mgmt_path) && errno != ENOENT)
396 connman_warn("Unable to unlink management socket %s: "
397 "%d", data->mgmt_path, errno);
399 g_free(data->mgmt_path);
400 data->mgmt_path = NULL;
403 if (data->mgmt_timer_id != 0) {
404 g_source_remove(data->mgmt_timer_id);
405 data->mgmt_timer_id = 0;
408 if (data->mgmt_event_id) {
409 g_source_remove(data->mgmt_event_id);
410 data->mgmt_event_id = 0;
413 if (data->mgmt_channel) {
414 g_io_channel_shutdown(data->mgmt_channel, FALSE, NULL);
415 g_io_channel_unref(data->mgmt_channel);
416 data->mgmt_channel = NULL;
420 static void ov_died(struct connman_task *task, int exit_code, void *user_data)
422 struct ov_private_data *data = user_data;
424 /* Cancel any pending agent requests */
425 connman_agent_cancel(data->provider);
427 close_management_interface(data);
429 vpn_died(task, exit_code, data->provider);
431 free_private_data(data);
434 static int run_connect(struct ov_private_data *data,
435 vpn_provider_connect_cb_t cb, void *user_data)
437 struct vpn_provider *provider = data->provider;
438 struct connman_task *task = data->task;
442 option = vpn_provider_get_string(provider, "OpenVPN.ConfigFile");
445 * Set some default options if user has no config file.
447 option = vpn_provider_get_string(provider, "OpenVPN.TLSAuth");
449 connman_task_add_argument(task, "--tls-auth", option);
450 option = vpn_provider_get_string(provider,
451 "OpenVPN.TLSAuthDir");
453 connman_task_add_argument(task, option, NULL);
456 connman_task_add_argument(task, "--nobind", NULL);
457 connman_task_add_argument(task, "--persist-key", NULL);
458 connman_task_add_argument(task, "--client", NULL);
461 if (data->mgmt_path) {
462 connman_task_add_argument(task, "--management", NULL);
463 connman_task_add_argument(task, data->mgmt_path, NULL);
464 connman_task_add_argument(task, "unix", NULL);
465 connman_task_add_argument(task, "--management-query-passwords",
467 connman_task_add_argument(task, "--auth-retry", "interact");
470 connman_task_add_argument(task, "--syslog", NULL);
472 connman_task_add_argument(task, "--script-security", "2");
474 connman_task_add_argument(task, "--up",
475 SCRIPTDIR "/openvpn-script");
476 connman_task_add_argument(task, "--up-restart", NULL);
478 connman_task_add_argument(task, "--setenv", NULL);
479 connman_task_add_argument(task, "CONNMAN_BUSNAME",
480 dbus_bus_get_unique_name(connection));
482 connman_task_add_argument(task, "--setenv", NULL);
483 connman_task_add_argument(task, "CONNMAN_INTERFACE",
484 CONNMAN_TASK_INTERFACE);
486 connman_task_add_argument(task, "--setenv", NULL);
487 connman_task_add_argument(task, "CONNMAN_PATH",
488 connman_task_get_path(task));
490 connman_task_add_argument(task, "--dev", data->if_name);
491 option = vpn_provider_get_string(provider, "OpenVPN.DeviceType");
493 connman_task_add_argument(task, "--dev-type", option);
496 * Default to tun for backwards compatibility.
498 connman_task_add_argument(task, "--dev-type", "tun");
501 connman_task_add_argument(task, "--persist-tun", NULL);
503 #if !defined TIZEN_EXT
504 connman_task_add_argument(task, "--route-noexec", NULL);
505 connman_task_add_argument(task, "--ifconfig-noexec", NULL);
509 * Disable client restarts because we can't handle this at the
510 * moment. The problem is that when OpenVPN decides to switch
511 * from CONNECTED state to RECONNECTING and then to RESOLVE,
512 * it is not possible to do a DNS lookup. The DNS server is
513 * not accessible through the tunnel anymore and so we end up
514 * trying to resolve the OpenVPN servers address.
516 connman_task_add_argument(task, "--ping-restart", "0");
519 * Disable connetion retrying when OpenVPN is connected over TCP.
520 * With TCP OpenVPN attempts to handle reconnection silently without
521 * reporting the error back when establishing a connection or
522 * reconnecting as succesful one. The latter causes trouble if the
523 * retries are not limited to 1 (no retry) as the interface is up and
524 * connman regards it as the default route and network ceases to work,
527 option = vpn_provider_get_string(provider, "OpenVPN.Proto");
528 if (option && g_str_has_prefix(option, "tcp"))
529 connman_task_add_argument(task, "--connect-retry-max", "1");
531 err = connman_task_run(task, ov_died, data, NULL, NULL, NULL);
534 data->user_data = NULL;
535 connman_error("openvpn failed to start");
538 /* This lets the caller know that the actual result of
539 * the operation will be reported to the callback */
544 static void ov_quote_credential(GString *line, const char *cred)
549 g_string_append_c(line, '"');
551 while (*cred != '\0') {
557 g_string_append_c(line, '\\');
563 g_string_append_c(line, *cred++);
566 g_string_append_c(line, '"');
569 static void ov_return_credentials(struct ov_private_data *data,
570 const char *username, const char *password)
572 GString *reply_string;
576 reply_string = g_string_new(NULL);
578 g_string_append(reply_string, "username \"Auth\" ");
579 ov_quote_credential(reply_string, username);
580 g_string_append_c(reply_string, '\n');
582 g_string_append(reply_string, "password \"Auth\" ");
583 ov_quote_credential(reply_string, password);
584 g_string_append_c(reply_string, '\n');
586 len = reply_string->len;
587 reply = g_string_free(reply_string, FALSE);
589 g_io_channel_write_chars(data->mgmt_channel, reply, len, NULL, NULL);
590 g_io_channel_flush(data->mgmt_channel, NULL);
592 memset(reply, 0, len);
596 static void ov_return_private_key_password(struct ov_private_data *data,
597 const char *privatekeypass)
599 GString *reply_string;
603 reply_string = g_string_new(NULL);
605 g_string_append(reply_string, "password \"Private Key\" ");
606 ov_quote_credential(reply_string, privatekeypass);
607 g_string_append_c(reply_string, '\n');
609 len = reply_string->len;
610 reply = g_string_free(reply_string, FALSE);
612 g_io_channel_write_chars(data->mgmt_channel, reply, len, NULL, NULL);
613 g_io_channel_flush(data->mgmt_channel, NULL);
615 memset(reply, 0, len);
619 static void request_input_append_informational(DBusMessageIter *iter,
622 char *str = "string";
624 connman_dbus_dict_append_basic(iter, "Type",
625 DBUS_TYPE_STRING, &str);
626 str = "informational";
627 connman_dbus_dict_append_basic(iter, "Requirement",
628 DBUS_TYPE_STRING, &str);
631 static void request_input_append_mandatory(DBusMessageIter *iter,
634 char *str = "string";
636 connman_dbus_dict_append_basic(iter, "Type",
637 DBUS_TYPE_STRING, &str);
639 connman_dbus_dict_append_basic(iter, "Requirement",
640 DBUS_TYPE_STRING, &str);
643 static void request_input_append_password(DBusMessageIter *iter,
646 char *str = "password";
648 connman_dbus_dict_append_basic(iter, "Type",
649 DBUS_TYPE_STRING, &str);
651 connman_dbus_dict_append_basic(iter, "Requirement",
652 DBUS_TYPE_STRING, &str);
655 static void request_input_credentials_reply(DBusMessage *reply,
658 struct ov_private_data *data = user_data;
659 char *username = NULL;
660 char *password = NULL;
662 DBusMessageIter iter, dict;
666 connman_info("provider %p", data->provider);
669 * When connmand calls disconnect because of connection timeout no
677 dbus_error_init(&error);
679 err = vpn_agent_check_and_process_reply_error(reply, data->provider,
680 data->task, data->cb, data->user_data);
682 /* Ensure cb is called only once */
684 data->user_data = NULL;
688 if (!vpn_agent_check_reply_has_dict(reply)) {
693 dbus_message_iter_init(reply, &iter);
694 dbus_message_iter_recurse(&iter, &dict);
695 while (dbus_message_iter_get_arg_type(&dict) == DBUS_TYPE_DICT_ENTRY) {
696 DBusMessageIter entry, value;
698 dbus_message_iter_recurse(&dict, &entry);
699 if (dbus_message_iter_get_arg_type(&entry) != DBUS_TYPE_STRING)
702 dbus_message_iter_get_basic(&entry, &key);
704 if (g_str_equal(key, "OpenVPN.Password")) {
705 dbus_message_iter_next(&entry);
706 if (dbus_message_iter_get_arg_type(&entry)
707 != DBUS_TYPE_VARIANT)
709 dbus_message_iter_recurse(&entry, &value);
710 if (dbus_message_iter_get_arg_type(&value)
713 dbus_message_iter_get_basic(&value, &password);
714 vpn_provider_set_string_hide_value(data->provider,
717 } else if (g_str_equal(key, "OpenVPN.Username")) {
718 dbus_message_iter_next(&entry);
719 if (dbus_message_iter_get_arg_type(&entry)
720 != DBUS_TYPE_VARIANT)
722 dbus_message_iter_recurse(&entry, &value);
723 if (dbus_message_iter_get_arg_type(&value)
726 dbus_message_iter_get_basic(&value, &username);
727 vpn_provider_set_string_hide_value(data->provider,
731 dbus_message_iter_next(&dict);
734 if (!password || !username) {
735 vpn_provider_indicate_error(data->provider,
736 VPN_PROVIDER_ERROR_AUTH_FAILED);
741 ov_return_credentials(data, username, password);
746 ov_connect_done(data, err);
749 static int request_credentials_input(struct ov_private_data *data)
751 DBusMessage *message;
752 const char *path, *agent_sender, *agent_path;
753 DBusMessageIter iter;
754 DBusMessageIter dict;
758 agent = connman_agent_get_info(data->dbus_sender, &agent_sender,
760 if (!agent || !agent_path)
763 message = dbus_message_new_method_call(agent_sender, agent_path,
769 dbus_message_iter_init_append(message, &iter);
771 path = vpn_provider_get_path(data->provider);
772 dbus_message_iter_append_basic(&iter,
773 DBUS_TYPE_OBJECT_PATH, &path);
775 connman_dbus_dict_open(&iter, &dict);
777 if (vpn_provider_get_authentication_errors(data->provider))
778 vpn_agent_append_auth_failure(&dict, data->provider, NULL);
780 /* Request temporary properties to pass on to openvpn */
781 connman_dbus_dict_append_dict(&dict, "OpenVPN.Username",
782 request_input_append_mandatory, NULL);
784 connman_dbus_dict_append_dict(&dict, "OpenVPN.Password",
785 request_input_append_password, NULL);
787 vpn_agent_append_host_and_name(&dict, data->provider);
789 connman_dbus_dict_close(&iter, &dict);
791 err = connman_agent_queue_message(data->provider, message,
792 connman_timeout_input_request(),
793 request_input_credentials_reply, data, agent);
795 if (err < 0 && err != -EBUSY) {
796 connman_error("error %d sending agent request", err);
797 dbus_message_unref(message);
802 dbus_message_unref(message);
807 static void request_input_private_key_reply(DBusMessage *reply,
810 struct ov_private_data *data = user_data;
811 const char *privatekeypass = NULL;
813 DBusMessageIter iter, dict;
817 connman_info("provider %p", data->provider);
820 * When connmand calls disconnect because of connection timeout no
828 dbus_error_init(&error);
830 err = vpn_agent_check_and_process_reply_error(reply, data->provider,
831 data->task, data->cb, data->user_data);
833 /* Ensure cb is called only once */
835 data->user_data = NULL;
839 if (!vpn_agent_check_reply_has_dict(reply)) {
844 dbus_message_iter_init(reply, &iter);
845 dbus_message_iter_recurse(&iter, &dict);
846 while (dbus_message_iter_get_arg_type(&dict) == DBUS_TYPE_DICT_ENTRY) {
847 DBusMessageIter entry, value;
849 dbus_message_iter_recurse(&dict, &entry);
850 if (dbus_message_iter_get_arg_type(&entry) != DBUS_TYPE_STRING)
853 dbus_message_iter_get_basic(&entry, &key);
855 if (g_str_equal(key, "OpenVPN.PrivateKeyPassword")) {
856 dbus_message_iter_next(&entry);
857 if (dbus_message_iter_get_arg_type(&entry)
858 != DBUS_TYPE_VARIANT)
860 dbus_message_iter_recurse(&entry, &value);
861 if (dbus_message_iter_get_arg_type(&value)
864 dbus_message_iter_get_basic(&value, &privatekeypass);
865 vpn_provider_set_string_hide_value(data->provider,
866 key, privatekeypass);
870 dbus_message_iter_next(&dict);
873 if (!privatekeypass) {
874 vpn_provider_indicate_error(data->provider,
875 VPN_PROVIDER_ERROR_AUTH_FAILED);
881 ov_return_private_key_password(data, privatekeypass);
886 ov_connect_done(data, err);
889 static int request_private_key_input(struct ov_private_data *data)
891 DBusMessage *message;
892 const char *path, *agent_sender, *agent_path;
893 const char *privatekeypass;
894 DBusMessageIter iter;
895 DBusMessageIter dict;
900 * First check if this is the second attempt to get the key within
901 * this connection. In such case there has been invalid Private Key
902 * Password and it must be reset, and queried from user.
904 if (data->failed_attempts_privatekey) {
905 vpn_provider_set_string_hide_value(data->provider,
906 "OpenVPN.PrivateKeyPassword", NULL);
908 /* If the encrypted Private key password is kept in memory and
909 * use it first. If authentication fails this is cleared,
910 * likewise it is when connman-vpnd is restarted.
912 privatekeypass = vpn_provider_get_string(data->provider,
913 "OpenVPN.PrivateKeyPassword");
914 if (privatekeypass) {
915 ov_return_private_key_password(data, privatekeypass);
920 agent = connman_agent_get_info(data->dbus_sender, &agent_sender,
922 if (!agent || !agent_path)
925 message = dbus_message_new_method_call(agent_sender, agent_path,
931 dbus_message_iter_init_append(message, &iter);
933 path = vpn_provider_get_path(data->provider);
934 dbus_message_iter_append_basic(&iter,
935 DBUS_TYPE_OBJECT_PATH, &path);
937 connman_dbus_dict_open(&iter, &dict);
939 connman_dbus_dict_append_dict(&dict, "OpenVPN.PrivateKeyPassword",
940 request_input_append_password, NULL);
942 vpn_agent_append_host_and_name(&dict, data->provider);
944 /* Do not allow to store or retrieve the encrypted Private Key pass */
945 vpn_agent_append_allow_credential_storage(&dict, false);
946 vpn_agent_append_allow_credential_retrieval(&dict, false);
949 * Indicate to keep credentials, the enc Private Key password should
950 * not affect the credential storing.
952 vpn_agent_append_keep_credentials(&dict, true);
954 connman_dbus_dict_append_dict(&dict, "Enter Private Key password",
955 request_input_append_informational, NULL);
957 connman_dbus_dict_close(&iter, &dict);
959 err = connman_agent_queue_message(data->provider, message,
960 connman_timeout_input_request(),
961 request_input_private_key_reply, data, agent);
963 if (err < 0 && err != -EBUSY) {
964 connman_error("error %d sending agent request", err);
965 dbus_message_unref(message);
970 dbus_message_unref(message);
976 static gboolean ov_management_handle_input(GIOChannel *source,
977 GIOCondition condition, gpointer user_data)
979 struct ov_private_data *data = user_data;
984 if (condition & G_IO_IN) {
986 * Just return if line is not read and str is not allocated.
987 * Condition check handles closing of the channel later.
989 if (g_io_channel_read_line(source, &str, NULL, NULL, NULL) !=
993 str[strlen(str) - 1] = '\0';
994 connman_warn("openvpn request %s", str);
996 if (g_str_has_prefix(str, ">PASSWORD:Need 'Auth'")) {
998 * Request credentials from the user
1000 err = request_credentials_input(data);
1001 if (err != -EINPROGRESS)
1003 } else if (g_str_has_prefix(str,
1004 ">PASSWORD:Need 'Private Key'")) {
1005 err = request_private_key_input(data);
1006 if (err != -EINPROGRESS)
1008 } else if (g_str_has_prefix(str,
1009 ">PASSWORD:Verification Failed: 'Auth'")) {
1011 * Add error only, state change indication causes
1012 * signal to be sent, which is not desired when
1013 * OpenVPN is in interactive mode.
1015 vpn_provider_add_error(data->provider,
1016 VPN_PROVIDER_ERROR_AUTH_FAILED);
1018 * According to the OpenVPN manual about management interface
1019 * https://openvpn.net/community-resources/management-interface/
1020 * this should be received but it does not seem to be reported
1021 * when decrypting private key fails. This requires following
1022 * patch for OpenVPN (at least <= 2.4.5) in order to work:
1023 * https://git.sailfishos.org/mer-core/openvpn/blob/
1024 * 4f4b4af116292a207416c8a990392e35a6fc41af/rpm/privatekey-
1025 * passphrase-handling.diff
1027 } else if (g_str_has_prefix(str, ">PASSWORD:Verification "
1028 "Failed: 'Private Key'")) {
1029 data->failed_attempts_privatekey++;
1033 } else if (condition & (G_IO_ERR | G_IO_HUP)) {
1034 connman_warn("Management channel termination");
1039 close_management_interface(data);
1044 static int ov_management_connect_timer_cb(gpointer user_data)
1046 struct ov_private_data *data = user_data;
1048 if (!data->mgmt_channel) {
1049 int fd = socket(AF_UNIX, SOCK_STREAM, 0);
1051 struct sockaddr_un remote;
1054 memset(&remote, 0, sizeof(remote));
1055 remote.sun_family = AF_UNIX;
1056 g_strlcpy(remote.sun_path, data->mgmt_path,
1057 sizeof(remote.sun_path));
1059 err = connect(fd, (struct sockaddr *)&remote,
1062 data->mgmt_channel = g_io_channel_unix_new(fd);
1063 data->mgmt_event_id =
1064 g_io_add_watch(data->mgmt_channel,
1065 G_IO_IN | G_IO_ERR | G_IO_HUP,
1066 ov_management_handle_input,
1069 connman_warn("Connected management socket");
1070 data->mgmt_timer_id = 0;
1071 return G_SOURCE_REMOVE;
1077 data->connect_attempts++;
1078 if (data->connect_attempts > 30) {
1079 connman_warn("Unable to connect management socket");
1080 data->mgmt_timer_id = 0;
1081 return G_SOURCE_REMOVE;
1084 return G_SOURCE_CONTINUE;
1087 static int ov_connect(struct vpn_provider *provider,
1088 struct connman_task *task, const char *if_name,
1089 vpn_provider_connect_cb_t cb, const char *dbus_sender,
1093 struct ov_private_data *data;
1095 data = g_try_new0(struct ov_private_data, 1);
1099 vpn_provider_set_plugin_data(provider, data);
1100 data->provider = vpn_provider_ref(provider);
1102 data->dbus_sender = g_strdup(dbus_sender);
1103 data->if_name = g_strdup(if_name);
1105 data->user_data = user_data;
1108 * We need to use the management interface to provide
1109 * the user credentials and password for decrypting private key.
1112 /* Use env TMPDIR for creating management socket, fall back to /tmp */
1113 tmpdir = getenv("TMPDIR");
1114 if (!tmpdir || !*tmpdir)
1117 /* Set up the path for the management interface */
1118 data->mgmt_path = g_strconcat(tmpdir, "/connman-vpn-management-",
1119 vpn_provider_get_ident(provider), NULL);
1120 if (unlink(data->mgmt_path) != 0 && errno != ENOENT) {
1121 connman_warn("Unable to unlink management socket %s: %d",
1122 data->mgmt_path, errno);
1125 data->mgmt_timer_id = g_timeout_add(200,
1126 ov_management_connect_timer_cb, data);
1128 task_append_config_data(provider, task);
1130 return run_connect(data, cb, user_data);
1133 static void ov_disconnect(struct vpn_provider *provider)
1138 connman_agent_cancel(provider);
1140 vpn_provider_set_state(provider, VPN_PROVIDER_STATE_DISCONNECT);
1143 static int ov_device_flags(struct vpn_provider *provider)
1147 option = vpn_provider_get_string(provider, "OpenVPN.DeviceType");
1152 if (g_str_equal(option, "tap")) {
1156 if (!g_str_equal(option, "tun")) {
1157 connman_warn("bad OpenVPN.DeviceType value "
1158 "falling back to tun");
1164 static int ov_route_env_parse(struct vpn_provider *provider, const char *key,
1165 int *family, unsigned long *idx,
1166 enum vpn_provider_route_type *type)
1171 if (g_str_has_prefix(key, "route_network_")) {
1172 start = key + strlen("route_network_");
1173 *type = VPN_PROVIDER_ROUTE_TYPE_ADDR;
1174 } else if (g_str_has_prefix(key, "route_netmask_")) {
1175 start = key + strlen("route_netmask_");
1176 *type = VPN_PROVIDER_ROUTE_TYPE_MASK;
1177 } else if (g_str_has_prefix(key, "route_gateway_")) {
1178 start = key + strlen("route_gateway_");
1179 *type = VPN_PROVIDER_ROUTE_TYPE_GW;
1184 *idx = g_ascii_strtoull(start, &end, 10);
1189 static struct vpn_driver vpn_driver = {
1190 .notify = ov_notify,
1191 .connect = ov_connect,
1192 .disconnect = ov_disconnect,
1194 .device_flags = ov_device_flags,
1195 .route_env_parse = ov_route_env_parse,
1198 static int openvpn_init(void)
1200 connection = connman_dbus_get_connection();
1202 return vpn_register("openvpn", &vpn_driver, OPENVPN);
1205 static void openvpn_exit(void)
1207 vpn_unregister("openvpn");
1209 dbus_connection_unref(connection);
1212 CONNMAN_PLUGIN_DEFINE(openvpn, "OpenVPN plugin", VERSION,
1213 CONNMAN_PLUGIN_PRIORITY_DEFAULT, openvpn_init, openvpn_exit)