/
openconnect.h
367 lines (316 loc) · 13.3 KB
/
openconnect.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
/*
* OpenConnect (SSL + DTLS) VPN client
*
* Copyright © 2008-2012 Intel Corporation.
* Copyright © 2008 Nick Andrew <nick@nick-andrew.net>
* Copyright © 2013 John Morrissey <jwm@horde.net>
*
* Author: David Woodhouse <dwmw2@infradead.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* version 2.1, 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to:
*
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*/
#ifndef __OPENCONNECT_H__
#define __OPENCONNECT_H__
#include <stdint.h>
#include <sys/types.h>
#include <unistd.h>
#define OPENCONNECT_API_VERSION_MAJOR 3
#define OPENCONNECT_API_VERSION_MINOR 0
/*
* API version 3.0:
* - Change oc_form_opt_select->choices to an array of pointers
* - Add oc_form_opt->flags
* - Add OC_FORM_RESULT_* and oc_auth_form->authgroup_*
*
* API version 2.2:
* - Add openconnect_set_token_mode(), openconnect_has_oath_support()
* - Deprecate openconnect_set_stoken_mode()
*
* API version 2.1:
* - Add openconnect_set_reported_os()
* - Add openconnect_set_stoken_mode(), openconnect_has_stoken_support()
*
* API version 2.0:
* - OPENCONNECT_X509 is now an opaque type.
* - Add openconnect_has_pkcs11_support(), openconnect_has_tss_blob_support()
* - Rename openconnect_init_openssl() -> openconnect_init_ssl()
* - Rename openconnect_vpninfo_new_with_cbdata() -> openconnect_vpninfo_new()
* and kill the old openconnect_vpninfo_new() and its callback types.
*
* API version 1.5:
* - Add openconnect_get_cert_details(), openconnect_get_cert_DER().
*
* API version 1.4:
* - Add openconnect_set_cancel_fd()
*
* API version 1.3:
* - Add openconnect_set_cert_expiry_warning() to change from default 60 days
*
* API version 1.2:
* - Add openconnect_vpninfo_new_with_cbdata()
*
* API version 1.1:
* - Add openconnect_vpninfo_free()
*
* API version 1.0:
* - Initial version
*/
/* Before API version 1.4 (OpenConnect 3.19) this macro didn't exist.
* Somewhat ironic, that the API version check itself needs to be
* conditionally used depending on the API version. A very simple way
* for users to handle this with an approximately correct answer is
* #include <openconnect.h>
* #ifndef OPENCONNECT_CHECK_VER
* #define OPENCONNECT_CHECK_VER(x,y) 0
* #endif
*/
#define OPENCONNECT_CHECK_VER(maj, min) \
(OPENCONNECT_API_VERSION_MAJOR > (maj) || \
(OPENCONNECT_API_VERSION_MAJOR == (maj) && \
OPENCONNECT_API_VERSION_MINOR >= (min)))
/****************************************************************************/
/* Authentication form processing */
#define OC_FORM_OPT_TEXT 1
#define OC_FORM_OPT_PASSWORD 2
#define OC_FORM_OPT_SELECT 3
#define OC_FORM_OPT_HIDDEN 4
#define OC_FORM_OPT_TOKEN 5
#define OC_FORM_RESULT_ERR -1
#define OC_FORM_RESULT_OK 0
#define OC_FORM_RESULT_CANCELLED 1
#define OC_FORM_RESULT_NEWGROUP 2
#ifdef __OPENCONNECT_PRIVATE__
#define OC_FORM_RESULT_LOGGEDIN 255
#define OC_FORM_OPT_SECOND_AUTH 0x8000
#endif
#define OC_FORM_OPT_IGNORE 0x0001
#define OC_FORM_OPT_NUMERIC 0x0002
/* char * fields are static (owned by XML parser) and don't need to be
freed by the form handling code -- except for value, which for TEXT
and PASSWORD options is allocated by process_form() when
interacting with the user and must be freed. */
struct oc_form_opt {
struct oc_form_opt *next;
int type;
char *name;
char *label;
char *value;
unsigned int flags;
void *reserved;
};
/* All fields are static, owned by the XML parser */
struct oc_choice {
char *name;
char *label;
char *auth_type;
char *override_name;
char *override_label;
#ifdef __OPENCONNECT_PRIVATE__
int second_auth;
char *secondary_username;
int secondary_username_editable;
int noaaa;
#endif
};
struct oc_form_opt_select {
struct oc_form_opt form;
int nr_choices;
struct oc_choice **choices;
};
/* All char * fields are static, owned by the XML parser */
struct oc_auth_form {
char *banner;
char *message;
char *error;
char *auth_id;
char *method;
char *action;
struct oc_form_opt *opts;
struct oc_form_opt_select *authgroup_opt;
int authgroup_selection;
};
struct oc_split_include {
char *route;
struct oc_split_include *next;
};
struct oc_ip_info {
const char *addr;
const char *netmask;
const char *addr6;
const char *netmask6;
const char *dns[3];
const char *nbns[3];
const char *domain;
const char *proxy_pac;
int mtu;
struct oc_split_include *split_dns;
struct oc_split_include *split_includes;
struct oc_split_include *split_excludes;
};
/****************************************************************************/
#define PRG_ERR 0
#define PRG_INFO 1
#define PRG_DEBUG 2
#define PRG_TRACE 3
/* byte commands to write into the cmd_fd */
#define OC_CMD_CANCEL 'x'
#define OC_CMD_PAUSE 'p'
#define RECONNECT_INTERVAL_MIN 10
#define RECONNECT_INTERVAL_MAX 100
struct openconnect_info;
#define OPENCONNECT_X509 void
typedef enum {
OC_TOKEN_MODE_NONE,
OC_TOKEN_MODE_STOKEN,
OC_TOKEN_MODE_TOTP,
} oc_token_mode_t;
/* Unless otherwise specified, all functions which set strings will take
ownership of those strings and the library will free them later in
openconnect_vpninfo_free() */
/* The buffer 'buf' must be at least 41 bytes. It will receive a hex string
with trailing NUL, representing the SHA1 fingerprint of the certificate. */
int openconnect_get_cert_sha1(struct openconnect_info *vpninfo,
OPENCONNECT_X509 *cert, char *buf);
char *openconnect_get_cert_details(struct openconnect_info *vpninfo,
OPENCONNECT_X509 *cert);
/* Returns the length of the created DER output, in a newly-allocated buffer
that will need to be freed by the caller. */
int openconnect_get_cert_DER(struct openconnect_info *vpninfo,
OPENCONNECT_X509 *cert, unsigned char **buf);
int openconnect_set_http_proxy(struct openconnect_info *vpninfo, char *proxy);
int openconnect_passphrase_from_fsid(struct openconnect_info *vpninfo);
int openconnect_obtain_cookie(struct openconnect_info *vpninfo);
void openconnect_init_ssl(void);
char *openconnect_get_hostname(struct openconnect_info *);
void openconnect_set_hostname(struct openconnect_info *, char *);
char *openconnect_get_urlpath(struct openconnect_info *);
void openconnect_set_urlpath(struct openconnect_info *, char *);
/* These functions do *not* take ownership of the string; it is parsed
and then discarded. */
int openconnect_set_token_mode(struct openconnect_info *,
oc_token_mode_t, const char *token_str);
/* Legacy stoken-only function; do not use */
int openconnect_set_stoken_mode(struct openconnect_info *, int, const char *);
/* This function does *not* take ownership of the string; it's copied
into a static buffer in the vpninfo. The size must be 41 bytes,
since that's the size of a 20-byte SHA1 represented as hex with
a trailing NUL. */
void openconnect_set_xmlsha1(struct openconnect_info *, const char *, int size);
void openconnect_set_cafile(struct openconnect_info *, char *);
void openconnect_setup_csd(struct openconnect_info *, uid_t, int silent, char *wrapper);
int openconnect_set_reported_os(struct openconnect_info *, const char *os);
void openconnect_set_client_cert(struct openconnect_info *, char *cert, char *sslkey);
void openconnect_set_server_cert_sha1(struct openconnect_info *, char *);
const char *openconnect_get_ifname(struct openconnect_info *);
void openconnect_set_reqmtu(struct openconnect_info *, int reqmtu);
/* This is *not* yours and must not be destroyed with X509_free(). It
* will be valid when a cookie has been obtained successfully, and will
* be valid until the connection is destroyed or another attempt it made
* to use it. */
OPENCONNECT_X509 *openconnect_get_peer_cert(struct openconnect_info *);
int openconnect_get_port(struct openconnect_info *);
char *openconnect_get_cookie(struct openconnect_info *);
void openconnect_clear_cookie(struct openconnect_info *);
void openconnect_reset_ssl(struct openconnect_info *vpninfo);
int openconnect_parse_url(struct openconnect_info *vpninfo, char *url);
void openconnect_set_cert_expiry_warning(struct openconnect_info *vpninfo,
int seconds);
/* If this is set, then openconnect_obtain_cookie() will abort and return
failure if the file descriptor is readable. Typically a user may create
a pair of pipes with the pipe(2) system call, hand the readable one to
this function, and then write a byte to the other end if it ever wants
to cancel the connection. This way, a multi-threaded UI (which will be
running openconnect_obtain_cookie() in a separate thread since it blocks)
has the ability to cancel that call, reap its thread and free the
vpninfo structure (or retry). An 'fd' argument of -1 will render the
cancellation mechanism inactive. */
void openconnect_set_cancel_fd(struct openconnect_info *vpninfo, int fd);
/* Create a nonblocking pipe used to send cancellations and other commands
to the library. This returns a file descriptor to the write side of
the pipe. Both sides will be closed by openconnect_vpninfo_free().
This replaces openconnect_set_cancel_fd(). */
int openconnect_setup_cmd_pipe(struct openconnect_info *vpninfo);
const char *openconnect_get_version(void);
/* Open CSTP connection; on success, IP information will be available. */
int openconnect_make_cstp_connection(struct openconnect_info *vpninfo);
/* Create a tun device through the OS kernel (typical use case). Both
strings are optional and can be NULL if desired. */
int openconnect_setup_tun_device(struct openconnect_info *vpninfo, char *vpnc_script, char *ifname);
/* Pass traffic to a script program (no tun device). */
int openconnect_setup_tun_script(struct openconnect_info *vpninfo, char *tun_script);
/* Caller will provide a file descriptor for the tunnel traffic. */
int openconnect_setup_tun_fd(struct openconnect_info *vpninfo, int tun_fd);
/* Optional call to enable DTLS on the connection. */
int openconnect_setup_dtls(struct openconnect_info *vpninfo, int dtls_attempt_period);
/* Start the main loop; exits if OC_CMD_CANCEL is received on cmd_fd or
the remote site aborts. */
int openconnect_mainloop(struct openconnect_info *vpninfo,
int reconnect_timeout,
int reconnect_interval);
/* The first (privdata) argument to each of these functions is either
the privdata argument provided to openconnect_vpninfo_new_with_cbdata(),
or if that argument was NULL then it'll be the vpninfo itself. */
/* When the server's certificate fails validation via the normal means,
this function is called with the offending certificate along with
a textual reason for the failure (which may not be translated, if
it comes directly from OpenSSL, but will be if it is rejected for
"certificate does not match hostname", because that check is done
in OpenConnect and *is* translated). The function shall return zero
if the certificate is (or has in the past been) explicitly accepted
by the user, and non-zero to abort the connection. */
typedef int (*openconnect_validate_peer_cert_vfn) (void *privdata,
OPENCONNECT_X509 *cert,
const char *reason);
/* On a successful connection, the server may provide us with a new XML
configuration file. This contains the list of servers that can be
chosen by the user to connect to, amongst other stuff that we mostly
ignore. By "new", we mean that the SHA1 indicated by the server does
not match the SHA1 set with the openconnect_set_xmlsha1() above. If
they don't match, or openconnect_set_xmlsha1() has not been called,
then the new XML is downloaded and this function is invoked. */
typedef int (*openconnect_write_new_config_vfn) (void *privdata, char *buf,
int buflen);
/* Handle an authentication form, requesting input from the user.
* Return value:
* < 0, on error
* = 0, when form was parsed and POST required
* = 1, when response was cancelled by user
*/
typedef int (*openconnect_process_auth_form_vfn) (void *privdata,
struct oc_auth_form *form);
/* Logging output which the user *may* want to see. */
typedef void __attribute__ ((format(printf, 3, 4)))
(*openconnect_progress_vfn) (void *privdata, int level,
const char *fmt, ...);
struct openconnect_info *openconnect_vpninfo_new(char *useragent,
openconnect_validate_peer_cert_vfn,
openconnect_write_new_config_vfn,
openconnect_process_auth_form_vfn,
openconnect_progress_vfn,
void *privdata);
void openconnect_vpninfo_free(struct openconnect_info *vpninfo);
/* SSL certificate capabilities. openconnect_has_pkcs11_support() means that we
can accept PKCS#11 URLs in place of filenames, for the certificate and key. */
int openconnect_has_pkcs11_support(void);
/* The OpenSSL TPM ENGINE stores keys in a PEM file labelled with the string
-----BEGIN TSS KEY BLOB-----. GnuTLS may learn to support this format too,
in the near future. */
int openconnect_has_tss_blob_support(void);
/* Software token capabilities. */
int openconnect_has_stoken_support(void);
int openconnect_has_oath_support(void);
#endif /* __OPENCONNECT_H__ */