5 * Copyright (C) 2007-2013 Intel Corporation. All rights reserved.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef __VPN_PROVIDER_H
23 #define __VPN_PROVIDER_H
35 * @title: Provider premitives
36 * @short_description: Functions for handling providers
39 enum vpn_provider_type {
40 VPN_PROVIDER_TYPE_UNKNOWN = 0,
41 VPN_PROVIDER_TYPE_VPN = 1,
44 enum vpn_provider_state {
45 VPN_PROVIDER_STATE_UNKNOWN = 0,
46 VPN_PROVIDER_STATE_IDLE = 1,
47 VPN_PROVIDER_STATE_CONNECT = 2,
48 VPN_PROVIDER_STATE_READY = 3,
49 VPN_PROVIDER_STATE_DISCONNECT = 4,
50 VPN_PROVIDER_STATE_FAILURE = 5,
53 enum vpn_provider_error {
54 VPN_PROVIDER_ERROR_UNKNOWN = 0,
55 VPN_PROVIDER_ERROR_CONNECT_FAILED = 1,
56 VPN_PROVIDER_ERROR_LOGIN_FAILED = 2,
57 VPN_PROVIDER_ERROR_AUTH_FAILED = 3,
60 enum vpn_provider_route_type {
61 VPN_PROVIDER_ROUTE_TYPE_NONE = 0,
62 VPN_PROVIDER_ROUTE_TYPE_MASK = 1,
63 VPN_PROVIDER_ROUTE_TYPE_ADDR = 2,
64 VPN_PROVIDER_ROUTE_TYPE_GW = 3,
68 struct connman_ipaddress;
70 #define vpn_provider_ref(provider) \
71 vpn_provider_ref_debug(provider, __FILE__, __LINE__, __func__)
73 #define vpn_provider_unref(provider) \
74 vpn_provider_unref_debug(provider, __FILE__, __LINE__, __func__)
77 vpn_provider_ref_debug(struct vpn_provider *provider,
78 const char *file, int line, const char *caller);
79 void vpn_provider_unref_debug(struct vpn_provider *provider,
80 const char *file, int line, const char *caller);
82 int vpn_provider_set_string(struct vpn_provider *provider,
83 const char *key, const char *value);
84 int vpn_provider_set_string_hide_value(struct vpn_provider *provider,
85 const char *key, const char *value);
86 const char *vpn_provider_get_string(struct vpn_provider *provider,
89 int vpn_provider_set_state(struct vpn_provider *provider,
90 enum vpn_provider_state state);
92 int vpn_provider_indicate_error(struct vpn_provider *provider,
93 enum vpn_provider_error error);
95 void vpn_provider_set_index(struct vpn_provider *provider, int index);
96 int vpn_provider_get_index(struct vpn_provider *provider);
98 void vpn_provider_set_data(struct vpn_provider *provider, void *data);
99 void *vpn_provider_get_data(struct vpn_provider *provider);
100 int vpn_provider_set_ipaddress(struct vpn_provider *provider,
101 struct connman_ipaddress *ipaddress);
102 int vpn_provider_set_pac(struct vpn_provider *provider,
104 int vpn_provider_set_domain(struct vpn_provider *provider,
106 int vpn_provider_set_nameservers(struct vpn_provider *provider,
107 const char *nameservers);
108 int vpn_provider_append_route(struct vpn_provider *provider,
109 const char *key, const char *value);
111 const char *vpn_provider_get_driver_name(struct vpn_provider *provider);
112 const char *vpn_provider_get_save_group(struct vpn_provider *provider);
114 const char *vpn_provider_get_name(struct vpn_provider *provider);
115 const char *vpn_provider_get_host(struct vpn_provider *provider);
116 const char *vpn_provider_get_path(struct vpn_provider *provider);
117 void vpn_provider_change_address(struct vpn_provider *provider);
118 void vpn_provider_clear_address(struct vpn_provider *provider, int family);
120 typedef void (* vpn_provider_connect_cb_t) (struct vpn_provider *provider,
121 void *user_data, int error);
123 typedef void (* vpn_provider_auth_cb_t) (struct vpn_provider *provider,
124 const char *authenticator,
125 const char *error, void *user_data);
127 typedef void (* vpn_provider_password_cb_t) (struct vpn_provider *provider,
128 const char *username,
129 const char *password,
130 const char *error, void *user_data);
132 struct vpn_provider_driver {
134 enum vpn_provider_type type;
135 int (*probe) (struct vpn_provider *provider);
136 int (*remove) (struct vpn_provider *provider);
137 int (*connect) (struct vpn_provider *provider,
138 vpn_provider_connect_cb_t cb, const char *dbus_sender,
140 int (*disconnect) (struct vpn_provider *provider);
141 int (*save) (struct vpn_provider *provider, GKeyFile *keyfile);
142 int (*set_state)(struct vpn_provider *provider,
143 enum vpn_provider_state state);
144 int (*route_env_parse) (struct vpn_provider *provider, const char *key,
145 int *family, unsigned long *idx,
146 enum vpn_provider_route_type *type);
149 int vpn_provider_driver_register(struct vpn_provider_driver *driver);
150 void vpn_provider_driver_unregister(struct vpn_provider_driver *driver);
156 #endif /* __VPN_PROVIDER_H */