2
* OpenVPN -- An application to securely tunnel IP networks
3
* over a single TCP/UDP port, with support for SSL/TLS-based
4
* session authentication and key exchange,
5
* packet encryption, packet authentication, and
8
* Copyright (C) 2002-2010 OpenVPN Technologies, Inc. <sales@openvpn.net>
10
* This program is free software; you can redistribute it and/or modify
11
* it under the terms of the GNU General Public License version 2
12
* as published by the Free Software Foundation.
14
* This program is distributed in the hope that it will be useful,
15
* but WITHOUT ANY WARRANTY; without even the implied warranty of
16
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
* GNU General Public License for more details.
19
* You should have received a copy of the GNU General Public License
20
* along with this program (see the file COPYING included with this
21
* distribution); if not, write to the Free Software Foundation, Inc.,
22
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
37
#include "forward-inline.h"
38
#include "pf-inline.h"
40
/*#define MULTI_DEBUG_EVENT_LOOP*/
42
#ifdef MULTI_DEBUG_EVENT_LOOP
44
id (struct multi_instance *mi)
47
return tls_common_name (mi->context.c2.tls_multi, false);
53
#ifdef MANAGEMENT_DEF_AUTH
55
set_cc_config (struct multi_instance *mi, struct buffer_list *cc_config)
58
buffer_list_free (mi->cc_config);
59
mi->cc_config = cc_config;
64
learn_address_script (const struct multi_context *m,
65
const struct multi_instance *mi,
67
const struct mroute_addr *addr)
69
struct gc_arena gc = gc_new ();
72
struct plugin_list *plugins;
74
/* get environmental variable source */
75
if (mi && mi->context.c2.es)
76
es = mi->context.c2.es;
78
es = env_set_create (&gc);
80
/* get plugin source */
82
plugins = mi->context.plugins;
84
plugins = m->top.plugins;
86
if (plugin_defined (plugins, OPENVPN_PLUGIN_LEARN_ADDRESS))
88
struct argv argv = argv_new ();
89
argv_printf (&argv, "%s %s",
91
mroute_addr_print (addr, &gc));
93
argv_printf_cat (&argv, "%s", tls_common_name (mi->context.c2.tls_multi, false));
94
if (plugin_call (plugins, OPENVPN_PLUGIN_LEARN_ADDRESS, &argv, NULL, es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
96
msg (M_WARN, "WARNING: learn-address plugin call failed");
102
if (m->top.options.learn_address_script)
104
struct argv argv = argv_new ();
105
setenv_str (es, "script_type", "learn-address");
106
argv_printf (&argv, "%sc %s %s",
107
m->top.options.learn_address_script,
109
mroute_addr_print (addr, &gc));
111
argv_printf_cat (&argv, "%s", tls_common_name (mi->context.c2.tls_multi, false));
112
if (!openvpn_run_script (&argv, es, 0, "--learn-address"))
122
multi_ifconfig_pool_persist (struct multi_context *m, bool force)
124
/* write pool data to file */
126
&& m->top.c1.ifconfig_pool_persist
127
&& (force || ifconfig_pool_write_trigger (m->top.c1.ifconfig_pool_persist)))
129
ifconfig_pool_write (m->top.c1.ifconfig_pool_persist, m->ifconfig_pool);
134
multi_reap_range (const struct multi_context *m,
138
struct gc_arena gc = gc_new ();
139
struct hash_iterator hi;
140
struct hash_element *he;
142
if (start_bucket < 0)
145
end_bucket = hash_n_buckets (m->vhash);
148
dmsg (D_MULTI_DEBUG, "MULTI: REAP range %d -> %d", start_bucket, end_bucket);
149
hash_iterator_init_range (m->vhash, &hi, start_bucket, end_bucket);
150
while ((he = hash_iterator_next (&hi)) != NULL)
152
struct multi_route *r = (struct multi_route *) he->value;
153
if (!multi_route_defined (m, r))
155
dmsg (D_MULTI_DEBUG, "MULTI: REAP DEL %s",
156
mroute_addr_print (&r->addr, &gc));
157
learn_address_script (m, NULL, "delete", &r->addr);
159
hash_iterator_delete_element (&hi);
162
hash_iterator_free (&hi);
167
multi_reap_all (const struct multi_context *m)
169
multi_reap_range (m, -1, 0);
172
static struct multi_reap *
173
multi_reap_new (int buckets_per_pass)
175
struct multi_reap *mr;
176
ALLOC_OBJ (mr, struct multi_reap);
178
mr->buckets_per_pass = buckets_per_pass;
184
multi_reap_process_dowork (const struct multi_context *m)
186
struct multi_reap *mr = m->reaper;
187
if (mr->bucket_base >= hash_n_buckets (m->vhash))
189
multi_reap_range (m, mr->bucket_base, mr->bucket_base + mr->buckets_per_pass);
190
mr->bucket_base += mr->buckets_per_pass;
195
multi_reap_free (struct multi_reap *mr)
201
* How many buckets in vhash to reap per pass.
204
reap_buckets_per_pass (int n_buckets)
206
return constrain_int (n_buckets / REAP_DIVISOR, REAP_MIN, REAP_MAX);
209
#ifdef MANAGEMENT_DEF_AUTH
212
cid_hash_function (const void *key, uint32_t iv)
214
const unsigned long *k = (const unsigned long *)key;
215
return (uint32_t) *k;
219
cid_compare_function (const void *key1, const void *key2)
221
const unsigned long *k1 = (const unsigned long *)key1;
222
const unsigned long *k2 = (const unsigned long *)key2;
229
* Main initialization function, init multi_context object.
232
multi_init (struct multi_context *m, struct context *t, bool tcp_mode, int thread_mode)
234
int dev = DEV_TYPE_UNDEF;
236
msg (D_MULTI_LOW, "MULTI: multi_init called, r=%d v=%d",
237
t->options.real_hash_size,
238
t->options.virtual_hash_size);
241
* Get tun/tap/null device type
243
dev = dev_type_enum (t->options.dev, t->options.dev_type);
246
* Init our multi_context object.
250
m->thread_mode = thread_mode;
253
* Real address hash table (source port number is
254
* considered to be part of the address). Used
255
* to determine which client sent an incoming packet
256
* which is seen on the TCP/UDP socket.
258
m->hash = hash_init (t->options.real_hash_size,
260
mroute_addr_hash_function,
261
mroute_addr_compare_function);
264
* Virtual address hash table. Used to determine
265
* which client to route a packet to.
267
m->vhash = hash_init (t->options.virtual_hash_size,
269
mroute_addr_hash_function,
270
mroute_addr_compare_function);
273
* This hash table is a clone of m->hash but with a
274
* bucket size of one so that it can be used
275
* for fast iteration through the list.
277
m->iter = hash_init (1,
279
mroute_addr_hash_function,
280
mroute_addr_compare_function);
282
#ifdef MANAGEMENT_DEF_AUTH
283
m->cid_hash = hash_init (t->options.real_hash_size,
286
cid_compare_function);
290
* This is our scheduler, for time-based wakeup
293
m->schedule = schedule_init ();
296
* Limit frequency of incoming connections to control
299
m->new_connection_limiter = frequency_limit_init (t->options.cf_max,
303
* Allocate broadcast/multicast buffer list
305
m->mbuf = mbuf_init (t->options.n_bcast_buf);
308
* Different status file format options are available
310
m->status_file_version = t->options.status_file_version;
313
* Possibly allocate an ifconfig pool, do it
314
* differently based on whether a tun or tap style
317
if (t->options.ifconfig_pool_defined)
319
if (dev == DEV_TYPE_TAP)
321
m->ifconfig_pool = ifconfig_pool_init (IFCONFIG_POOL_INDIV,
322
t->options.ifconfig_pool_start,
323
t->options.ifconfig_pool_end,
324
t->options.duplicate_cn);
326
else if (dev == DEV_TYPE_TUN)
328
m->ifconfig_pool = ifconfig_pool_init (
329
(t->options.topology == TOP_NET30) ? IFCONFIG_POOL_30NET : IFCONFIG_POOL_INDIV,
330
t->options.ifconfig_pool_start,
331
t->options.ifconfig_pool_end,
332
t->options.duplicate_cn);
339
/* reload pool data from file */
340
if (t->c1.ifconfig_pool_persist)
341
ifconfig_pool_read (t->c1.ifconfig_pool_persist, m->ifconfig_pool);
345
* Help us keep track of routing table.
347
m->route_helper = mroute_helper_init (MULTI_CACHE_ROUTE_TTL);
350
* Initialize route and instance reaper.
352
m->reaper = multi_reap_new (reap_buckets_per_pass (t->options.virtual_hash_size));
355
* Get local ifconfig address
358
ASSERT (t->c1.tuntap);
359
mroute_extract_in_addr_t (&m->local, t->c1.tuntap->local);
364
m->max_clients = t->options.max_clients;
367
* Initialize multi-socket TCP I/O wait object
370
m->mtcp = multi_tcp_init (t->options.max_clients, &m->max_clients);
371
m->tcp_queue_limit = t->options.tcp_queue_limit;
374
* Allow client <-> client communication, without going through
375
* tun/tap interface and network stack?
377
m->enable_c2c = t->options.enable_c2c;
381
multi_instance_string (const struct multi_instance *mi, bool null, struct gc_arena *gc)
385
struct buffer out = alloc_buf_gc (256, gc);
386
const char *cn = tls_common_name (mi->context.c2.tls_multi, true);
389
buf_printf (&out, "%s/", cn);
390
buf_printf (&out, "%s", mroute_addr_print (&mi->real, gc));
400
generate_prefix (struct multi_instance *mi)
402
mi->msg_prefix = multi_instance_string (mi, true, &mi->gc);
407
ungenerate_prefix (struct multi_instance *mi)
409
mi->msg_prefix = NULL;
414
mi_prefix (const struct multi_instance *mi)
416
if (mi && mi->msg_prefix)
417
return mi->msg_prefix;
423
* Tell the route helper about deleted iroutes so
424
* that it can update its mask of currently used
428
multi_del_iroutes (struct multi_context *m,
429
struct multi_instance *mi)
431
const struct iroute *ir;
432
if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN)
434
for (ir = mi->context.options.iroutes; ir != NULL; ir = ir->next)
435
mroute_helper_del_iroute (m->route_helper, ir);
440
setenv_stats (struct context *c)
442
setenv_counter (c->c2.es, "bytes_received", c->c2.link_read_bytes);
443
setenv_counter (c->c2.es, "bytes_sent", c->c2.link_write_bytes);
447
multi_client_disconnect_setenv (struct multi_context *m,
448
struct multi_instance *mi)
450
/* setenv client real IP address */
451
setenv_trusted (mi->context.c2.es, get_link_socket_info (&mi->context));
454
setenv_stats (&mi->context);
456
/* setenv connection duration */
458
const unsigned int duration = (unsigned int) now - mi->created;
459
setenv_unsigned (mi->context.c2.es, "time_duration", duration);
464
multi_client_disconnect_script (struct multi_context *m,
465
struct multi_instance *mi)
467
if ((mi->context.c2.context_auth == CAS_SUCCEEDED && mi->connection_established_flag)
468
|| mi->context.c2.context_auth == CAS_PARTIAL)
470
multi_client_disconnect_setenv (m, mi);
472
if (plugin_defined (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_DISCONNECT))
474
if (plugin_call (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_DISCONNECT, NULL, NULL, mi->context.c2.es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
475
msg (M_WARN, "WARNING: client-disconnect plugin call failed");
478
if (mi->context.options.client_disconnect_script)
480
struct argv argv = argv_new ();
481
setenv_str (mi->context.c2.es, "script_type", "client-disconnect");
482
argv_printf (&argv, "%sc", mi->context.options.client_disconnect_script);
483
openvpn_run_script (&argv, mi->context.c2.es, 0, "--client-disconnect");
486
#ifdef MANAGEMENT_DEF_AUTH
488
management_notify_client_close (management, &mi->context.c2.mda_context, mi->context.c2.es);
495
multi_close_instance (struct multi_context *m,
496
struct multi_instance *mi,
499
perf_push (PERF_MULTI_CLOSE_INSTANCE);
504
dmsg (D_MULTI_DEBUG, "MULTI: multi_close_instance called");
506
/* adjust current client connection count */
507
m->n_clients += mi->n_clients_delta;
508
mi->n_clients_delta = 0;
510
/* prevent dangling pointers */
511
if (m->pending == mi)
512
multi_set_pending (m, NULL);
513
if (m->earliest_wakeup == mi)
514
m->earliest_wakeup = NULL;
518
if (mi->did_real_hash)
520
ASSERT (hash_remove (m->hash, &mi->real));
524
ASSERT (hash_remove (m->iter, &mi->real));
526
#ifdef MANAGEMENT_DEF_AUTH
527
if (mi->did_cid_hash)
529
ASSERT (hash_remove (m->cid_hash, &mi->context.c2.mda_context.cid));
533
schedule_remove_entry (m->schedule, (struct schedule_entry *) mi);
535
ifconfig_pool_release (m->ifconfig_pool, mi->vaddr_handle, false);
539
multi_del_iroutes (m, mi);
540
mi->did_iroutes = false;
544
multi_tcp_dereference_instance (m->mtcp, mi);
546
mbuf_dereference_instance (m->mbuf, mi);
549
#ifdef MANAGEMENT_DEF_AUTH
550
set_cc_config (mi, NULL);
553
multi_client_disconnect_script (m, mi);
555
if (mi->did_open_context)
556
close_context (&mi->context, SIGTERM, CC_GC_FREE);
558
multi_tcp_instance_specific_free (mi);
560
ungenerate_prefix (mi);
563
* Don't actually delete the instance memory allocation yet,
564
* because virtual routes may still point to it. Let the
565
* vhash reaper deal with it.
567
multi_instance_dec_refcount (mi);
573
* Called on shutdown or restart.
576
multi_uninit (struct multi_context *m)
578
if (m->thread_mode & MC_WORK_THREAD)
581
m->thread_mode = MC_UNDEF;
583
else if (m->thread_mode)
587
struct hash_iterator hi;
588
struct hash_element *he;
590
hash_iterator_init (m->iter, &hi);
591
while ((he = hash_iterator_next (&hi)))
593
struct multi_instance *mi = (struct multi_instance *) he->value;
594
mi->did_iter = false;
595
multi_close_instance (m, mi, true);
597
hash_iterator_free (&hi);
602
hash_free (m->vhash);
604
#ifdef MANAGEMENT_DEF_AUTH
605
hash_free (m->cid_hash);
609
schedule_free (m->schedule);
611
ifconfig_pool_free (m->ifconfig_pool);
612
frequency_limit_free (m->new_connection_limiter);
613
multi_reap_free (m->reaper);
614
mroute_helper_free (m->route_helper);
615
multi_tcp_free (m->mtcp);
616
m->thread_mode = MC_UNDEF;
622
* Create a client instance object for a newly connected client.
624
struct multi_instance *
625
multi_create_instance (struct multi_context *m, const struct mroute_addr *real)
627
struct gc_arena gc = gc_new ();
628
struct multi_instance *mi;
630
perf_push (PERF_MULTI_CREATE_INSTANCE);
632
msg (D_MULTI_LOW, "MULTI: multi_create_instance called");
634
ALLOC_OBJ_CLEAR (mi, struct multi_instance);
637
multi_instance_inc_refcount (mi);
638
mi->vaddr_handle = -1;
640
mroute_addr_init (&mi->real);
645
generate_prefix (mi);
648
mi->did_open_context = true;
649
inherit_context_child (&mi->context, &m->top);
650
if (IS_SIG (&mi->context))
653
mi->context.c2.context_auth = CAS_PENDING;
655
if (hash_n_elements (m->hash) >= m->max_clients)
657
msg (D_MULTI_ERRORS, "MULTI: new incoming connection would exceed maximum number of clients (%d)", m->max_clients);
661
if (!real) /* TCP mode? */
663
if (!multi_tcp_instance_specific_init (m, mi))
665
generate_prefix (mi);
668
if (!hash_add (m->iter, &mi->real, mi, false))
670
msg (D_MULTI_LOW, "MULTI: unable to add real address [%s] to iterator hash table",
671
mroute_addr_print (&mi->real, &gc));
676
#ifdef MANAGEMENT_DEF_AUTH
678
mi->context.c2.mda_context.cid = m->cid_counter++;
679
} while (!hash_add (m->cid_hash, &mi->context.c2.mda_context.cid, mi, false));
680
mi->did_cid_hash = true;
683
mi->context.c2.push_reply_deferred = true;
685
if (!multi_process_post (m, mi, MPP_PRE_SELECT))
687
msg (D_MULTI_ERRORS, "MULTI: signal occurred during client instance initialization");
696
multi_close_instance (m, mi, false);
703
* Dump tables -- triggered by SIGUSR2.
704
* If status file is defined, write to file.
705
* If status file is NULL, write to syslog.
708
multi_print_status (struct multi_context *m, struct status_output *so, const int version)
712
struct gc_arena gc_top = gc_new ();
713
struct hash_iterator hi;
714
const struct hash_element *he;
718
if (version == 1) /* WAS: m->status_file_version */
721
* Status file version 1
723
status_printf (so, "OpenVPN CLIENT LIST");
724
status_printf (so, "Updated,%s", time_string (0, 0, false, &gc_top));
725
status_printf (so, "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since");
726
hash_iterator_init (m->hash, &hi);
727
while ((he = hash_iterator_next (&hi)))
729
struct gc_arena gc = gc_new ();
730
const struct multi_instance *mi = (struct multi_instance *) he->value;
734
status_printf (so, "%s,%s," counter_format "," counter_format ",%s",
735
tls_common_name (mi->context.c2.tls_multi, false),
736
mroute_addr_print (&mi->real, &gc),
737
mi->context.c2.link_read_bytes,
738
mi->context.c2.link_write_bytes,
739
time_string (mi->created, 0, false, &gc));
743
hash_iterator_free (&hi);
745
status_printf (so, "ROUTING TABLE");
746
status_printf (so, "Virtual Address,Common Name,Real Address,Last Ref");
747
hash_iterator_init (m->vhash, &hi);
748
while ((he = hash_iterator_next (&hi)))
750
struct gc_arena gc = gc_new ();
751
const struct multi_route *route = (struct multi_route *) he->value;
753
if (multi_route_defined (m, route))
755
const struct multi_instance *mi = route->instance;
756
const struct mroute_addr *ma = &route->addr;
757
char flags[2] = {0, 0};
759
if (route->flags & MULTI_ROUTE_CACHE)
761
status_printf (so, "%s%s,%s,%s,%s",
762
mroute_addr_print (ma, &gc),
764
tls_common_name (mi->context.c2.tls_multi, false),
765
mroute_addr_print (&mi->real, &gc),
766
time_string (route->last_reference, 0, false, &gc));
770
hash_iterator_free (&hi);
772
status_printf (so, "GLOBAL STATS");
774
status_printf (so, "Max bcast/mcast queue length,%d",
775
mbuf_maximum_queued (m->mbuf));
777
status_printf (so, "END");
779
else if (version == 2 || version == 3)
781
const char sep = (version == 3) ? '\t' : ',';
784
* Status file version 2 and 3
786
status_printf (so, "TITLE%c%s", sep, title_string);
787
status_printf (so, "TIME%c%s%c%u", sep, time_string (now, 0, false, &gc_top), sep, (unsigned int)now);
788
status_printf (so, "HEADER%cCLIENT_LIST%cCommon Name%cReal Address%cVirtual Address%cBytes Received%cBytes Sent%cConnected Since%cConnected Since (time_t)",
789
sep, sep, sep, sep, sep, sep, sep, sep);
790
hash_iterator_init (m->hash, &hi);
791
while ((he = hash_iterator_next (&hi)))
793
struct gc_arena gc = gc_new ();
794
const struct multi_instance *mi = (struct multi_instance *) he->value;
798
status_printf (so, "CLIENT_LIST%c%s%c%s%c%s%c" counter_format "%c" counter_format "%c%s%c%u",
799
sep, tls_common_name (mi->context.c2.tls_multi, false),
800
sep, mroute_addr_print (&mi->real, &gc),
801
sep, print_in_addr_t (mi->reporting_addr, IA_EMPTY_IF_UNDEF, &gc),
802
sep, mi->context.c2.link_read_bytes,
803
sep, mi->context.c2.link_write_bytes,
804
sep, time_string (mi->created, 0, false, &gc),
805
sep, (unsigned int)mi->created);
809
hash_iterator_free (&hi);
811
status_printf (so, "HEADER%cROUTING_TABLE%cVirtual Address%cCommon Name%cReal Address%cLast Ref%cLast Ref (time_t)",
812
sep, sep, sep, sep, sep, sep);
813
hash_iterator_init (m->vhash, &hi);
814
while ((he = hash_iterator_next (&hi)))
816
struct gc_arena gc = gc_new ();
817
const struct multi_route *route = (struct multi_route *) he->value;
819
if (multi_route_defined (m, route))
821
const struct multi_instance *mi = route->instance;
822
const struct mroute_addr *ma = &route->addr;
823
char flags[2] = {0, 0};
825
if (route->flags & MULTI_ROUTE_CACHE)
827
status_printf (so, "ROUTING_TABLE%c%s%s%c%s%c%s%c%s%c%u",
828
sep, mroute_addr_print (ma, &gc), flags,
829
sep, tls_common_name (mi->context.c2.tls_multi, false),
830
sep, mroute_addr_print (&mi->real, &gc),
831
sep, time_string (route->last_reference, 0, false, &gc),
832
sep, (unsigned int)route->last_reference);
836
hash_iterator_free (&hi);
839
status_printf (so, "GLOBAL_STATS%cMax bcast/mcast queue length%c%d",
840
sep, sep, mbuf_maximum_queued (m->mbuf));
842
status_printf (so, "END");
846
status_printf (so, "ERROR: bad status format version number");
849
#ifdef PACKET_TRUNCATION_CHECK
851
status_printf (so, "HEADER,ERRORS,Common Name,TUN Read Trunc,TUN Write Trunc,Pre-encrypt Trunc,Post-decrypt Trunc");
852
hash_iterator_init (m->hash, &hi);
853
while ((he = hash_iterator_next (&hi)))
855
struct gc_arena gc = gc_new ();
856
const struct multi_instance *mi = (struct multi_instance *) he->value;
860
status_printf (so, "ERRORS,%s," counter_format "," counter_format "," counter_format "," counter_format,
861
tls_common_name (mi->context.c2.tls_multi, false),
862
m->top.c2.n_trunc_tun_read,
863
mi->context.c2.n_trunc_tun_write,
864
mi->context.c2.n_trunc_pre_encrypt,
865
mi->context.c2.n_trunc_post_decrypt);
869
hash_iterator_free (&hi);
879
* Learn a virtual address or route.
880
* The learn will fail if the learn address
881
* script/plugin fails. In this case the
882
* return value may be != mi.
883
* Return the instance which owns this route,
886
static struct multi_instance *
887
multi_learn_addr (struct multi_context *m,
888
struct multi_instance *mi,
889
const struct mroute_addr *addr,
890
const unsigned int flags)
892
struct hash_element *he;
893
const uint32_t hv = hash_value (m->vhash, addr);
894
struct hash_bucket *bucket = hash_bucket (m->vhash, hv);
895
struct multi_route *oldroute = NULL;
896
struct multi_instance *owner = NULL;
898
/* if route currently exists, get the instance which owns it */
899
he = hash_lookup_fast (m->vhash, bucket, addr, hv);
901
oldroute = (struct multi_route *) he->value;
902
if (oldroute && multi_route_defined (m, oldroute))
903
owner = oldroute->instance;
905
/* do we need to add address to hash table? */
906
if ((!owner || owner != mi)
907
&& mroute_learnable_address (addr)
908
&& !mroute_addr_equal (addr, &m->local))
910
struct gc_arena gc = gc_new ();
911
struct multi_route *newroute;
912
bool learn_succeeded = false;
914
ALLOC_OBJ (newroute, struct multi_route);
915
newroute->addr = *addr;
916
newroute->instance = mi;
917
newroute->flags = flags;
918
newroute->last_reference = now;
919
newroute->cache_generation = 0;
921
/* The cache is invalidated when cache_generation is incremented */
922
if (flags & MULTI_ROUTE_CACHE)
923
newroute->cache_generation = m->route_helper->cache_generation;
925
if (oldroute) /* route already exists? */
927
if (route_quota_test (m, mi) && learn_address_script (m, mi, "update", &newroute->addr))
929
learn_succeeded = true;
931
multi_instance_inc_refcount (mi);
932
route_quota_inc (mi);
934
/* delete old route */
935
multi_route_del (oldroute);
937
/* modify hash table entry, replacing old route */
938
he->key = &newroute->addr;
939
he->value = newroute;
944
if (route_quota_test (m, mi) && learn_address_script (m, mi, "add", &newroute->addr))
946
learn_succeeded = true;
948
multi_instance_inc_refcount (mi);
949
route_quota_inc (mi);
952
hash_add_fast (m->vhash, bucket, &newroute->addr, hv, newroute);
956
msg (D_MULTI_LOW, "MULTI: Learn%s: %s -> %s",
957
learn_succeeded ? "" : " FAILED",
958
mroute_addr_print (&newroute->addr, &gc),
959
multi_instance_string (mi, false, &gc));
961
if (!learn_succeeded)
971
* Get client instance based on virtual address.
973
static struct multi_instance *
974
multi_get_instance_by_virtual_addr (struct multi_context *m,
975
const struct mroute_addr *addr,
978
struct multi_route *route;
979
struct multi_instance *ret = NULL;
981
/* check for local address */
982
if (mroute_addr_equal (addr, &m->local))
985
route = (struct multi_route *) hash_lookup (m->vhash, addr);
987
/* does host route (possible cached) exist? */
988
if (route && multi_route_defined (m, route))
990
struct multi_instance *mi = route->instance;
991
route->last_reference = now;
994
else if (cidr_routing) /* do we need to regenerate a host route cache entry? */
996
struct mroute_helper *rh = m->route_helper;
997
struct mroute_addr tryaddr;
1000
/* cycle through each CIDR length */
1001
for (i = 0; i < rh->n_net_len; ++i)
1004
tryaddr.type |= MR_WITH_NETBITS;
1005
tryaddr.netbits = rh->net_len[i];
1006
mroute_addr_mask_host_bits (&tryaddr);
1008
/* look up a possible route with netbits netmask */
1009
route = (struct multi_route *) hash_lookup (m->vhash, &tryaddr);
1011
if (route && multi_route_defined (m, route))
1013
/* found an applicable route, cache host route */
1014
struct multi_instance *mi = route->instance;
1015
multi_learn_addr (m, mi, addr, MULTI_ROUTE_CACHE|MULTI_ROUTE_AGEABLE);
1023
if (check_debug_level (D_MULTI_DEBUG))
1025
struct gc_arena gc = gc_new ();
1026
const char *addr_text = mroute_addr_print (addr, &gc);
1029
dmsg (D_MULTI_DEBUG, "GET INST BY VIRT: %s -> %s via %s",
1031
multi_instance_string (ret, false, &gc),
1032
mroute_addr_print (&route->addr, &gc));
1036
dmsg (D_MULTI_DEBUG, "GET INST BY VIRT: %s [failed]",
1043
ASSERT (!(ret && ret->halt));
1048
* Helper function to multi_learn_addr().
1050
static struct multi_instance *
1051
multi_learn_in_addr_t (struct multi_context *m,
1052
struct multi_instance *mi,
1054
int netbits, /* -1 if host route, otherwise # of network bits in address */
1057
struct openvpn_sockaddr remote_si;
1058
struct mroute_addr addr;
1061
remote_si.sa.sin_family = AF_INET;
1062
remote_si.sa.sin_addr.s_addr = htonl (a);
1063
ASSERT (mroute_extract_openvpn_sockaddr (&addr, &remote_si, false));
1067
addr.type |= MR_WITH_NETBITS;
1068
addr.netbits = (uint8_t) netbits;
1072
struct multi_instance *owner = multi_learn_addr (m, mi, &addr, 0);
1073
#ifdef MANAGEMENT_DEF_AUTH
1074
if (management && owner)
1075
management_learn_addr (management, &mi->context.c2.mda_context, &addr, primary);
1082
* A new client has connected, add routes (server -> client)
1083
* to internal routing table.
1086
multi_add_iroutes (struct multi_context *m,
1087
struct multi_instance *mi)
1089
struct gc_arena gc = gc_new ();
1090
const struct iroute *ir;
1091
if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN)
1093
mi->did_iroutes = true;
1094
for (ir = mi->context.options.iroutes; ir != NULL; ir = ir->next)
1096
if (ir->netbits >= 0)
1097
msg (D_MULTI_LOW, "MULTI: internal route %s/%d -> %s",
1098
print_in_addr_t (ir->network, 0, &gc),
1100
multi_instance_string (mi, false, &gc));
1102
msg (D_MULTI_LOW, "MULTI: internal route %s -> %s",
1103
print_in_addr_t (ir->network, 0, &gc),
1104
multi_instance_string (mi, false, &gc));
1106
mroute_helper_add_iroute (m->route_helper, ir);
1108
multi_learn_in_addr_t (m, mi, ir->network, ir->netbits, false);
1115
* Given an instance (new_mi), delete all other instances which use the
1119
multi_delete_dup (struct multi_context *m, struct multi_instance *new_mi)
1123
const char *new_cn = tls_common_name (new_mi->context.c2.tls_multi, true);
1126
struct hash_iterator hi;
1127
struct hash_element *he;
1130
hash_iterator_init (m->iter, &hi);
1131
while ((he = hash_iterator_next (&hi)))
1133
struct multi_instance *mi = (struct multi_instance *) he->value;
1134
if (mi != new_mi && !mi->halt)
1136
const char *cn = tls_common_name (mi->context.c2.tls_multi, true);
1137
if (cn && !strcmp (cn, new_cn))
1139
mi->did_iter = false;
1140
multi_close_instance (m, mi, false);
1141
hash_iterator_delete_element (&hi);
1146
hash_iterator_free (&hi);
1149
msg (D_MULTI_LOW, "MULTI: new connection by client '%s' will cause previous active sessions by this client to be dropped. Remember to use the --duplicate-cn option if you want multiple clients using the same certificate or username to concurrently connect.", new_cn);
1155
* Ensure that endpoint to be pushed to client
1156
* complies with --ifconfig-push-constraint directive.
1159
ifconfig_push_constraint_satisfied (const struct context *c)
1161
const struct options *o = &c->options;
1162
if (o->push_ifconfig_constraint_defined && c->c2.push_ifconfig_defined)
1163
return (o->push_ifconfig_constraint_netmask & c->c2.push_ifconfig_local) == o->push_ifconfig_constraint_network;
1169
* Select a virtual address for a new client instance.
1170
* Use an --ifconfig-push directive, if given (static IP).
1171
* Otherwise use an --ifconfig-pool address (dynamic IP).
1174
multi_select_virtual_addr (struct multi_context *m, struct multi_instance *mi)
1176
struct gc_arena gc = gc_new ();
1179
* If ifconfig addresses were set by dynamic config file,
1180
* release pool addresses, otherwise keep them.
1182
if (mi->context.options.push_ifconfig_defined)
1184
/* ifconfig addresses were set statically,
1185
release dynamic allocation */
1186
if (mi->vaddr_handle >= 0)
1188
ifconfig_pool_release (m->ifconfig_pool, mi->vaddr_handle, true);
1189
mi->vaddr_handle = -1;
1192
mi->context.c2.push_ifconfig_defined = true;
1193
mi->context.c2.push_ifconfig_local = mi->context.options.push_ifconfig_local;
1194
mi->context.c2.push_ifconfig_remote_netmask = mi->context.options.push_ifconfig_remote_netmask;
1196
else if (m->ifconfig_pool && mi->vaddr_handle < 0) /* otherwise, choose a pool address */
1198
in_addr_t local=0, remote=0;
1199
const char *cn = NULL;
1201
if (!mi->context.options.duplicate_cn)
1202
cn = tls_common_name (mi->context.c2.tls_multi, true);
1204
mi->vaddr_handle = ifconfig_pool_acquire (m->ifconfig_pool, &local, &remote, cn);
1205
if (mi->vaddr_handle >= 0)
1207
const int tunnel_type = TUNNEL_TYPE (mi->context.c1.tuntap);
1208
const int tunnel_topology = TUNNEL_TOPOLOGY (mi->context.c1.tuntap);
1210
/* set push_ifconfig_remote_netmask from pool ifconfig address(es) */
1211
mi->context.c2.push_ifconfig_local = remote;
1212
if (tunnel_type == DEV_TYPE_TAP || (tunnel_type == DEV_TYPE_TUN && tunnel_topology == TOP_SUBNET))
1214
mi->context.c2.push_ifconfig_remote_netmask = mi->context.options.ifconfig_pool_netmask;
1215
if (!mi->context.c2.push_ifconfig_remote_netmask)
1216
mi->context.c2.push_ifconfig_remote_netmask = mi->context.c1.tuntap->remote_netmask;
1218
else if (tunnel_type == DEV_TYPE_TUN)
1220
if (tunnel_topology == TOP_P2P)
1221
mi->context.c2.push_ifconfig_remote_netmask = mi->context.c1.tuntap->local;
1222
else if (tunnel_topology == TOP_NET30)
1223
mi->context.c2.push_ifconfig_remote_netmask = local;
1226
if (mi->context.c2.push_ifconfig_remote_netmask)
1227
mi->context.c2.push_ifconfig_defined = true;
1229
msg (D_MULTI_ERRORS, "MULTI: no --ifconfig-pool netmask parameter is available to push to %s",
1230
multi_instance_string (mi, false, &gc));
1234
msg (D_MULTI_ERRORS, "MULTI: no free --ifconfig-pool addresses are available");
1241
* Set virtual address environmental variables.
1244
multi_set_virtual_addr_env (struct multi_context *m, struct multi_instance *mi)
1246
setenv_del (mi->context.c2.es, "ifconfig_pool_local_ip");
1247
setenv_del (mi->context.c2.es, "ifconfig_pool_remote_ip");
1248
setenv_del (mi->context.c2.es, "ifconfig_pool_netmask");
1250
if (mi->context.c2.push_ifconfig_defined)
1252
const int tunnel_type = TUNNEL_TYPE (mi->context.c1.tuntap);
1253
const int tunnel_topology = TUNNEL_TOPOLOGY (mi->context.c1.tuntap);
1255
setenv_in_addr_t (mi->context.c2.es,
1256
"ifconfig_pool_remote_ip",
1257
mi->context.c2.push_ifconfig_local,
1260
if (tunnel_type == DEV_TYPE_TAP || (tunnel_type == DEV_TYPE_TUN && tunnel_topology == TOP_SUBNET))
1262
setenv_in_addr_t (mi->context.c2.es,
1263
"ifconfig_pool_netmask",
1264
mi->context.c2.push_ifconfig_remote_netmask,
1267
else if (tunnel_type == DEV_TYPE_TUN)
1269
setenv_in_addr_t (mi->context.c2.es,
1270
"ifconfig_pool_local_ip",
1271
mi->context.c2.push_ifconfig_remote_netmask,
1278
* Called after client-connect script is called
1281
multi_client_connect_post (struct multi_context *m,
1282
struct multi_instance *mi,
1283
const char *dc_file,
1284
unsigned int option_permissions_mask,
1285
unsigned int *option_types_found)
1287
/* Did script generate a dynamic config file? */
1288
if (test_file (dc_file))
1290
options_server_import (&mi->context.options,
1292
D_IMPORT_ERRORS|M_OPTERR,
1293
option_permissions_mask,
1297
if (!delete_file (dc_file))
1298
msg (D_MULTI_ERRORS, "MULTI: problem deleting temporary file: %s",
1302
* If the --client-connect script generates a config file
1303
* with an --ifconfig-push directive, it will override any
1304
* --ifconfig-push directive from the --client-config-dir
1305
* directory or any --ifconfig-pool dynamic address.
1307
multi_select_virtual_addr (m, mi);
1308
multi_set_virtual_addr_env (m, mi);
1312
#ifdef ENABLE_PLUGIN
1315
* Called after client-connect plug-in is called
1318
multi_client_connect_post_plugin (struct multi_context *m,
1319
struct multi_instance *mi,
1320
const struct plugin_return *pr,
1321
unsigned int option_permissions_mask,
1322
unsigned int *option_types_found)
1324
struct plugin_return config;
1326
plugin_return_get_column (pr, &config, "config");
1328
/* Did script generate a dynamic config file? */
1329
if (plugin_return_defined (&config))
1332
for (i = 0; i < config.n; ++i)
1334
if (config.list[i] && config.list[i]->value)
1335
options_string_import (&mi->context.options,
1336
config.list[i]->value,
1337
D_IMPORT_ERRORS|M_OPTERR,
1338
option_permissions_mask,
1344
* If the --client-connect script generates a config file
1345
* with an --ifconfig-push directive, it will override any
1346
* --ifconfig-push directive from the --client-config-dir
1347
* directory or any --ifconfig-pool dynamic address.
1349
multi_select_virtual_addr (m, mi);
1350
multi_set_virtual_addr_env (m, mi);
1356
#ifdef MANAGEMENT_DEF_AUTH
1359
* Called to load management-derived client-connect config
1362
multi_client_connect_mda (struct multi_context *m,
1363
struct multi_instance *mi,
1364
const struct buffer_list *config,
1365
unsigned int option_permissions_mask,
1366
unsigned int *option_types_found)
1370
struct buffer_entry *be;
1372
for (be = config->head; be != NULL; be = be->next)
1374
const char *opt = BSTR(&be->buf);
1375
options_string_import (&mi->context.options,
1377
D_IMPORT_ERRORS|M_OPTERR,
1378
option_permissions_mask,
1384
* If the --client-connect script generates a config file
1385
* with an --ifconfig-push directive, it will override any
1386
* --ifconfig-push directive from the --client-config-dir
1387
* directory or any --ifconfig-pool dynamic address.
1389
multi_select_virtual_addr (m, mi);
1390
multi_set_virtual_addr_env (m, mi);
1397
multi_client_connect_setenv (struct multi_context *m,
1398
struct multi_instance *mi)
1400
struct gc_arena gc = gc_new ();
1402
/* setenv incoming cert common name for script */
1403
setenv_str (mi->context.c2.es, "common_name", tls_common_name (mi->context.c2.tls_multi, true));
1405
/* setenv client real IP address */
1406
setenv_trusted (mi->context.c2.es, get_link_socket_info (&mi->context));
1408
/* setenv client virtual IP address */
1409
multi_set_virtual_addr_env (m, mi);
1411
/* setenv connection time */
1413
const char *created_ascii = time_string (mi->created, 0, false, &gc);
1414
setenv_str (mi->context.c2.es, "time_ascii", created_ascii);
1415
setenv_unsigned (mi->context.c2.es, "time_unix", (unsigned int)mi->created);
1422
* Called as soon as the SSL/TLS connection authenticates.
1424
* Instance-specific directives to be processed:
1426
* iroute start-ip end-ip
1427
* ifconfig-push local remote-netmask
1431
multi_connection_established (struct multi_context *m, struct multi_instance *mi)
1433
if (tls_authentication_status (mi->context.c2.tls_multi, 0) == TLS_AUTHENTICATION_SUCCEEDED)
1435
struct gc_arena gc = gc_new ();
1436
unsigned int option_types_found = 0;
1438
const unsigned int option_permissions_mask =
1448
int cc_succeeded = true; /* client connect script status */
1449
int cc_succeeded_count = 0;
1451
ASSERT (mi->context.c1.tuntap);
1453
/* lock down the common name and cert hashes so they can't change during future TLS renegotiations */
1454
tls_lock_common_name (mi->context.c2.tls_multi);
1455
tls_lock_cert_hash_set (mi->context.c2.tls_multi);
1457
/* generate a msg() prefix for this client instance */
1458
generate_prefix (mi);
1460
/* delete instances of previous clients with same common-name */
1461
if (!mi->context.options.duplicate_cn)
1462
multi_delete_dup (m, mi);
1464
/* reset pool handle to null */
1465
mi->vaddr_handle = -1;
1468
* Try to source a dynamic config file from the
1469
* --client-config-dir directory.
1471
if (mi->context.options.client_config_dir)
1473
const char *ccd_file;
1475
ccd_file = gen_path (mi->context.options.client_config_dir,
1476
tls_common_name (mi->context.c2.tls_multi, false),
1479
/* try common-name file */
1480
if (test_file (ccd_file))
1482
options_server_import (&mi->context.options,
1484
D_IMPORT_ERRORS|M_OPTERR,
1485
option_permissions_mask,
1486
&option_types_found,
1489
else /* try default file */
1491
ccd_file = gen_path (mi->context.options.client_config_dir,
1495
if (test_file (ccd_file))
1497
options_server_import (&mi->context.options,
1499
D_IMPORT_ERRORS|M_OPTERR,
1500
option_permissions_mask,
1501
&option_types_found,
1508
* Select a virtual address from either --ifconfig-push in --client-config-dir file
1509
* or --ifconfig-pool.
1511
multi_select_virtual_addr (m, mi);
1513
/* do --client-connect setenvs */
1514
multi_client_connect_setenv (m, mi);
1516
#ifdef ENABLE_PLUGIN
1518
* Call client-connect plug-in.
1521
/* deprecated callback, use a file for passing back return info */
1522
if (plugin_defined (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT))
1524
struct argv argv = argv_new ();
1525
const char *dc_file = create_temp_file (mi->context.options.tmp_dir, "cc", &gc);
1528
cc_succeeded = false;
1529
goto script_depr_failed;
1532
argv_printf (&argv, "%s", dc_file);
1533
if (plugin_call (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT, &argv, NULL, mi->context.c2.es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
1535
msg (M_WARN, "WARNING: client-connect plugin call failed");
1536
cc_succeeded = false;
1540
multi_client_connect_post (m, mi, dc_file, option_permissions_mask, &option_types_found);
1541
++cc_succeeded_count;
1547
/* V2 callback, use a plugin_return struct for passing back return info */
1548
if (plugin_defined (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT_V2))
1550
struct plugin_return pr;
1552
plugin_return_init (&pr);
1554
if (plugin_call (mi->context.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT_V2, NULL, &pr, mi->context.c2.es) != OPENVPN_PLUGIN_FUNC_SUCCESS)
1556
msg (M_WARN, "WARNING: client-connect-v2 plugin call failed");
1557
cc_succeeded = false;
1561
multi_client_connect_post_plugin (m, mi, &pr, option_permissions_mask, &option_types_found);
1562
++cc_succeeded_count;
1565
plugin_return_free (&pr);
1570
* Run --client-connect script.
1572
if (mi->context.options.client_connect_script && cc_succeeded)
1574
struct argv argv = argv_new ();
1575
const char *dc_file = NULL;
1577
setenv_str (mi->context.c2.es, "script_type", "client-connect");
1579
dc_file = create_temp_file (mi->context.options.tmp_dir, "cc", &gc);
1581
cc_succeeded = false;
1585
argv_printf (&argv, "%sc %s",
1586
mi->context.options.client_connect_script,
1589
if (openvpn_run_script (&argv, mi->context.c2.es, 0, "--client-connect"))
1591
multi_client_connect_post (m, mi, dc_file, option_permissions_mask, &option_types_found);
1592
++cc_succeeded_count;
1595
cc_succeeded = false;
1601
* Check for client-connect script left by management interface client
1603
#ifdef MANAGEMENT_DEF_AUTH
1604
if (cc_succeeded && mi->cc_config)
1606
multi_client_connect_mda (m, mi, mi->cc_config, option_permissions_mask, &option_types_found);
1607
++cc_succeeded_count;
1612
* Check for "disable" directive in client-config-dir file
1613
* or config file generated by --client-connect script.
1615
if (mi->context.options.disable)
1617
msg (D_MULTI_ERRORS, "MULTI: client has been rejected due to 'disable' directive");
1618
cc_succeeded = false;
1624
* Process sourced options.
1626
do_deferred_options (&mi->context, option_types_found);
1629
* make sure we got ifconfig settings from somewhere
1631
if (!mi->context.c2.push_ifconfig_defined)
1633
msg (D_MULTI_ERRORS, "MULTI: no dynamic or static remote --ifconfig address is available for %s",
1634
multi_instance_string (mi, false, &gc));
1638
* make sure that ifconfig settings comply with constraints
1640
if (!ifconfig_push_constraint_satisfied (&mi->context))
1642
/* JYFIXME -- this should cause the connection to fail */
1643
msg (D_MULTI_ERRORS, "MULTI ERROR: primary virtual IP for %s (%s) violates tunnel network/netmask constraint (%s/%s)",
1644
multi_instance_string (mi, false, &gc),
1645
print_in_addr_t (mi->context.c2.push_ifconfig_local, 0, &gc),
1646
print_in_addr_t (mi->context.options.push_ifconfig_constraint_network, 0, &gc),
1647
print_in_addr_t (mi->context.options.push_ifconfig_constraint_netmask, 0, &gc));
1651
* For routed tunnels, set up internal route to endpoint
1652
* plus add all iroute routes.
1654
if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN)
1656
if (mi->context.c2.push_ifconfig_defined)
1658
multi_learn_in_addr_t (m, mi, mi->context.c2.push_ifconfig_local, -1, true);
1659
msg (D_MULTI_LOW, "MULTI: primary virtual IP for %s: %s",
1660
multi_instance_string (mi, false, &gc),
1661
print_in_addr_t (mi->context.c2.push_ifconfig_local, 0, &gc));
1664
/* add routes locally, pointing to new client, if
1665
--iroute options have been specified */
1666
multi_add_iroutes (m, mi);
1669
* iroutes represent subnets which are "owned" by a particular
1670
* client. Therefore, do not actually push a route to a client
1671
* if it matches one of the client's iroutes.
1673
remove_iroutes_from_push_route_list (&mi->context.options);
1675
else if (mi->context.options.iroutes)
1677
msg (D_MULTI_ERRORS, "MULTI: --iroute options rejected for %s -- iroute only works with tun-style tunnels",
1678
multi_instance_string (mi, false, &gc));
1681
/* set our client's VPN endpoint for status reporting purposes */
1682
mi->reporting_addr = mi->context.c2.push_ifconfig_local;
1684
/* set context-level authentication flag */
1685
mi->context.c2.context_auth = CAS_SUCCEEDED;
1689
/* set context-level authentication flag */
1690
mi->context.c2.context_auth = cc_succeeded_count ? CAS_PARTIAL : CAS_FAILED;
1693
/* set flag so we don't get called again */
1694
mi->connection_established_flag = true;
1696
/* increment number of current authenticated clients */
1698
--mi->n_clients_delta;
1700
#ifdef MANAGEMENT_DEF_AUTH
1702
management_connection_established (management, &mi->context.c2.mda_context, mi->context.c2.es);
1709
* Reply now to client's PUSH_REQUEST query
1711
mi->context.c2.push_reply_deferred = false;
1715
* Add a mbuf buffer to a particular
1719
multi_add_mbuf (struct multi_context *m,
1720
struct multi_instance *mi,
1721
struct mbuf_buffer *mb)
1723
if (multi_output_queue_ready (m, mi))
1725
struct mbuf_item item;
1728
mbuf_add_item (m->mbuf, &item);
1732
msg (D_MULTI_DROPPED, "MULTI: packet dropped due to output saturation (multi_add_mbuf)");
1737
* Add a packet to a client instance output queue.
1740
multi_unicast (struct multi_context *m,
1741
const struct buffer *buf,
1742
struct multi_instance *mi)
1744
struct mbuf_buffer *mb;
1748
mb = mbuf_alloc_buf (buf);
1749
mb->flags = MF_UNICAST;
1750
multi_add_mbuf (m, mi, mb);
1756
* Broadcast a packet to all clients.
1759
multi_bcast (struct multi_context *m,
1760
const struct buffer *buf,
1761
const struct multi_instance *sender_instance,
1762
const struct mroute_addr *sender_addr)
1764
struct hash_iterator hi;
1765
struct hash_element *he;
1766
struct multi_instance *mi;
1767
struct mbuf_buffer *mb;
1771
perf_push (PERF_MULTI_BCAST);
1772
#ifdef MULTI_DEBUG_EVENT_LOOP
1773
printf ("BCAST len=%d\n", BLEN (buf));
1775
mb = mbuf_alloc_buf (buf);
1776
hash_iterator_init (m->iter, &hi);
1778
while ((he = hash_iterator_next (&hi)))
1780
mi = (struct multi_instance *) he->value;
1781
if (mi != sender_instance && !mi->halt)
1784
if (sender_instance)
1786
if (!pf_c2c_test (&sender_instance->context, &mi->context, "bcast_c2c"))
1788
msg (D_PF_DROPPED_BCAST, "PF: client[%s] -> client[%s] packet dropped by BCAST packet filter",
1789
mi_prefix (sender_instance),
1796
if (!pf_addr_test (&mi->context, sender_addr, "bcast_src_addr"))
1798
struct gc_arena gc = gc_new ();
1799
msg (D_PF_DROPPED_BCAST, "PF: addr[%s] -> client[%s] packet dropped by BCAST packet filter",
1800
mroute_addr_print_ex (sender_addr, MAPF_SHOW_ARP, &gc),
1807
multi_add_mbuf (m, mi, mb);
1811
hash_iterator_free (&hi);
1818
* Given a time delta, indicating that we wish to be
1819
* awoken by the scheduler at time now + delta, figure
1820
* a sigma parameter (in microseconds) that represents
1821
* a sort of fuzz factor around delta, so that we're
1822
* really telling the scheduler to wake us up any time
1823
* between now + delta - sigma and now + delta + sigma.
1825
* The sigma parameter helps the scheduler to run more efficiently.
1826
* Sigma should be no larger than TV_WITHIN_SIGMA_MAX_USEC
1828
static inline unsigned int
1829
compute_wakeup_sigma (const struct timeval *delta)
1831
if (delta->tv_sec < 1)
1833
/* if < 1 sec, fuzz = # of microseconds / 8 */
1834
return delta->tv_usec >> 3;
1838
/* if < 10 minutes, fuzz = 13.1% of timeout */
1839
if (delta->tv_sec < 600)
1840
return delta->tv_sec << 17;
1842
return 120000000; /* if >= 10 minutes, fuzz = 2 minutes */
1847
multi_schedule_context_wakeup (struct multi_context *m, struct multi_instance *mi)
1849
/* calculate an absolute wakeup time */
1850
ASSERT (!openvpn_gettimeofday (&mi->wakeup, NULL));
1851
tv_add (&mi->wakeup, &mi->context.c2.timeval);
1853
/* tell scheduler to wake us up at some point in the future */
1854
schedule_add_entry (m->schedule,
1855
(struct schedule_entry *) mi,
1857
compute_wakeup_sigma (&mi->context.c2.timeval));
1861
* Figure instance-specific timers, convert
1862
* earliest to absolute time in mi->wakeup,
1863
* call scheduler with our future wakeup time.
1865
* Also close context on signal.
1868
multi_process_post (struct multi_context *m, struct multi_instance *mi, const unsigned int flags)
1872
if (!IS_SIG (&mi->context) && ((flags & MPP_PRE_SELECT) || ((flags & MPP_CONDITIONAL_PRE_SELECT) && !ANY_OUT (&mi->context))))
1874
/* figure timeouts and fetch possible outgoing
1875
to_link packets (such as ping or TLS control) */
1876
pre_select (&mi->context);
1878
if (!IS_SIG (&mi->context))
1880
/* tell scheduler to wake us up at some point in the future */
1881
multi_schedule_context_wakeup(m, mi);
1883
/* connection is "established" when SSL/TLS key negotiation succeeds
1884
and (if specified) auth user/pass succeeds */
1885
if (!mi->connection_established_flag && CONNECTION_ESTABLISHED (&mi->context))
1886
multi_connection_established (m, mi);
1890
if (IS_SIG (&mi->context))
1892
if (flags & MPP_CLOSE_ON_SIGNAL)
1894
multi_close_instance_on_signal (m, mi);
1900
/* continue to pend on output? */
1901
multi_set_pending (m, ANY_OUT (&mi->context) ? mi : NULL);
1903
#ifdef MULTI_DEBUG_EVENT_LOOP
1904
printf ("POST %s[%d] to=%d lo=%d/%d w=%d/%d\n",
1906
(int) (mi == m->pending),
1907
mi ? mi->context.c2.to_tun.len : -1,
1908
mi ? mi->context.c2.to_link.len : -1,
1909
(mi && mi->context.c2.fragment) ? mi->context.c2.fragment->outgoing.len : -1,
1910
(int)mi->context.c2.timeval.tv_sec,
1911
(int)mi->context.c2.timeval.tv_usec);
1915
if ((flags & MPP_RECORD_TOUCH) && m->mpp_touched)
1916
*m->mpp_touched = mi;
1922
* Process packets in the TCP/UDP socket -> TUN/TAP interface direction,
1923
* i.e. client -> server direction.
1926
multi_process_incoming_link (struct multi_context *m, struct multi_instance *instance, const unsigned int mpp_flags)
1928
struct gc_arena gc = gc_new ();
1931
struct mroute_addr src, dest;
1932
unsigned int mroute_flags;
1933
struct multi_instance *mi;
1941
#ifdef MULTI_DEBUG_EVENT_LOOP
1942
printf ("TCP/UDP -> TUN [%d]\n", BLEN (&m->top.c2.buf));
1944
multi_set_pending (m, multi_get_create_instance_udp (m));
1947
multi_set_pending (m, instance);
1951
set_prefix (m->pending);
1953
/* get instance context */
1954
c = &m->pending->context;
1958
/* transfer packet pointer from top-level context buffer to instance */
1959
c->c2.buf = m->top.c2.buf;
1961
/* transfer from-addr from top-level context buffer to instance */
1962
c->c2.from = m->top.c2.from;
1965
if (BLEN (&c->c2.buf) > 0)
1967
/* decrypt in instance context */
1968
process_incoming_link (c);
1970
if (TUNNEL_TYPE (m->top.c1.tuntap) == DEV_TYPE_TUN)
1972
/* extract packet source and dest addresses */
1973
mroute_flags = mroute_extract_addr_from_packet (&src,
1980
/* drop packet if extract failed */
1981
if (!(mroute_flags & MROUTE_EXTRACT_SUCCEEDED))
1983
c->c2.to_tun.len = 0;
1985
/* make sure that source address is associated with this client */
1986
else if (multi_get_instance_by_virtual_addr (m, &src, true) != m->pending)
1988
msg (D_MULTI_DROPPED, "MULTI: bad source address from client [%s], packet dropped",
1989
mroute_addr_print (&src, &gc));
1990
c->c2.to_tun.len = 0;
1992
/* client-to-client communication enabled? */
1993
else if (m->enable_c2c)
1996
if (mroute_flags & MROUTE_EXTRACT_MCAST)
1998
/* for now, treat multicast as broadcast */
1999
multi_bcast (m, &c->c2.to_tun, m->pending, NULL);
2001
else /* possible client to client routing */
2003
ASSERT (!(mroute_flags & MROUTE_EXTRACT_BCAST));
2004
mi = multi_get_instance_by_virtual_addr (m, &dest, true);
2006
/* if dest addr is a known client, route to it */
2010
if (!pf_c2c_test (c, &mi->context, "tun_c2c"))
2012
msg (D_PF_DROPPED, "PF: client -> client[%s] packet dropped by TUN packet filter",
2018
multi_unicast (m, &c->c2.to_tun, mi);
2019
register_activity (c, BLEN(&c->c2.to_tun));
2021
c->c2.to_tun.len = 0;
2026
if (c->c2.to_tun.len && !pf_addr_test (c, &dest, "tun_dest_addr"))
2028
msg (D_PF_DROPPED, "PF: client -> addr[%s] packet dropped by TUN packet filter",
2029
mroute_addr_print_ex (&dest, MAPF_SHOW_ARP, &gc));
2030
c->c2.to_tun.len = 0;
2034
else if (TUNNEL_TYPE (m->top.c1.tuntap) == DEV_TYPE_TAP)
2037
struct mroute_addr edest;
2038
mroute_addr_reset (&edest);
2040
/* extract packet source and dest addresses */
2041
mroute_flags = mroute_extract_addr_from_packet (&src,
2052
if (mroute_flags & MROUTE_EXTRACT_SUCCEEDED)
2054
if (multi_learn_addr (m, m->pending, &src, 0) == m->pending)
2056
/* check for broadcast */
2059
if (mroute_flags & (MROUTE_EXTRACT_BCAST|MROUTE_EXTRACT_MCAST))
2061
multi_bcast (m, &c->c2.to_tun, m->pending, NULL);
2063
else /* try client-to-client routing */
2065
mi = multi_get_instance_by_virtual_addr (m, &dest, false);
2067
/* if dest addr is a known client, route to it */
2071
if (!pf_c2c_test (c, &mi->context, "tap_c2c"))
2073
msg (D_PF_DROPPED, "PF: client -> client[%s] packet dropped by TAP packet filter",
2079
multi_unicast (m, &c->c2.to_tun, mi);
2080
register_activity (c, BLEN(&c->c2.to_tun));
2082
c->c2.to_tun.len = 0;
2087
if (c->c2.to_tun.len && !pf_addr_test (c, &edest, "tap_dest_addr"))
2089
msg (D_PF_DROPPED, "PF: client -> addr[%s] packet dropped by TAP packet filter",
2090
mroute_addr_print_ex (&edest, MAPF_SHOW_ARP, &gc));
2091
c->c2.to_tun.len = 0;
2097
msg (D_MULTI_DROPPED, "MULTI: bad source address from client [%s], packet dropped",
2098
mroute_addr_print (&src, &gc));
2099
c->c2.to_tun.len = 0;
2104
c->c2.to_tun.len = 0;
2109
/* postprocess and set wakeup */
2110
ret = multi_process_post (m, m->pending, mpp_flags);
2120
* Process packets in the TUN/TAP interface -> TCP/UDP socket direction,
2121
* i.e. server -> client direction.
2124
multi_process_incoming_tun (struct multi_context *m, const unsigned int mpp_flags)
2126
struct gc_arena gc = gc_new ();
2129
if (BLEN (&m->top.c2.buf) > 0)
2131
unsigned int mroute_flags;
2132
struct mroute_addr src, dest;
2133
const int dev_type = TUNNEL_TYPE (m->top.c1.tuntap);
2136
struct mroute_addr esrc, *e1, *e2;
2137
if (dev_type == DEV_TYPE_TUN)
2145
mroute_addr_reset (&esrc);
2149
#ifdef MULTI_DEBUG_EVENT_LOOP
2150
printf ("TUN -> TCP/UDP [%d]\n", BLEN (&m->top.c2.buf));
2157
* Route an incoming tun/tap packet to
2158
* the appropriate multi_instance object.
2161
mroute_flags = mroute_extract_addr_from_packet (&src,
2172
if (mroute_flags & MROUTE_EXTRACT_SUCCEEDED)
2176
/* broadcast or multicast dest addr? */
2177
if (mroute_flags & (MROUTE_EXTRACT_BCAST|MROUTE_EXTRACT_MCAST))
2179
/* for now, treat multicast as broadcast */
2181
multi_bcast (m, &m->top.c2.buf, NULL, e2);
2183
multi_bcast (m, &m->top.c2.buf, NULL, NULL);
2188
multi_set_pending (m, multi_get_instance_by_virtual_addr (m, &dest, dev_type == DEV_TYPE_TUN));
2192
/* get instance context */
2193
c = &m->pending->context;
2195
set_prefix (m->pending);
2198
if (!pf_addr_test (c, e2, "tun_tap_src_addr"))
2200
msg (D_PF_DROPPED, "PF: addr[%s] -> client packet dropped by packet filter",
2201
mroute_addr_print_ex (&src, MAPF_SHOW_ARP, &gc));
2202
buf_reset_len (&c->c2.buf);
2207
if (multi_output_queue_ready (m, m->pending))
2209
/* transfer packet pointer from top-level context buffer to instance */
2210
c->c2.buf = m->top.c2.buf;
2215
msg (D_MULTI_DROPPED, "MULTI: packet dropped due to output saturation (multi_process_incoming_tun)");
2216
buf_reset_len (&c->c2.buf);
2220
/* encrypt in instance context */
2221
process_incoming_tun (c);
2223
/* postprocess and set wakeup */
2224
ret = multi_process_post (m, m->pending, mpp_flags);
2236
* Process a possible client-to-client/bcast/mcast message in the
2239
struct multi_instance *
2240
multi_get_queue (struct mbuf_set *ms)
2242
struct mbuf_item item;
2244
if (mbuf_extract_item (ms, &item)) /* cleartext IP packet */
2246
unsigned int pipv4_flags = PIPV4_PASSTOS;
2248
set_prefix (item.instance);
2249
item.instance->context.c2.buf = item.buffer->buf;
2250
if (item.buffer->flags & MF_UNICAST) /* --mssfix doesn't make sense for broadcast or multicast */
2251
pipv4_flags |= PIPV4_MSSFIX;
2252
process_ipv4_header (&item.instance->context, pipv4_flags, &item.instance->context.c2.buf);
2253
encrypt_sign (&item.instance->context, true);
2254
mbuf_free_buf (item.buffer);
2256
dmsg (D_MULTI_DEBUG, "MULTI: C2C/MCAST/BCAST");
2259
return item.instance;
2268
* Called when an I/O wait times out. Usually means that a particular
2269
* client instance object needs timer-based service.
2272
multi_process_timeout (struct multi_context *m, const unsigned int mpp_flags)
2276
#ifdef MULTI_DEBUG_EVENT_LOOP
2277
printf ("%s -> TIMEOUT\n", id(m->earliest_wakeup));
2280
/* instance marked for wakeup? */
2281
if (m->earliest_wakeup)
2283
set_prefix (m->earliest_wakeup);
2284
ret = multi_process_post (m, m->earliest_wakeup, mpp_flags);
2285
m->earliest_wakeup = NULL;
2292
* Drop a TUN/TAP outgoing packet..
2295
multi_process_drop_outgoing_tun (struct multi_context *m, const unsigned int mpp_flags)
2297
struct multi_instance *mi = m->pending;
2303
msg (D_MULTI_ERRORS, "MULTI: Outgoing TUN queue full, dropped packet len=%d",
2304
mi->context.c2.to_tun.len);
2306
buf_reset (&mi->context.c2.to_tun);
2308
multi_process_post (m, mi, mpp_flags);
2313
* Per-client route quota management
2317
route_quota_exceeded (const struct multi_context *m, const struct multi_instance *mi)
2319
struct gc_arena gc = gc_new ();
2320
msg (D_ROUTE_QUOTA, "MULTI ROUTE: route quota (%d) exceeded for %s (see --max-routes-per-client option)",
2321
mi->context.options.max_routes_per_client,
2322
multi_instance_string (mi, false, &gc));
2328
* Flood clients with random packets
2331
gremlin_flood_clients (struct multi_context *m)
2333
const int level = GREMLIN_PACKET_FLOOD_LEVEL (m->top.options.gremlin);
2336
struct gc_arena gc = gc_new ();
2337
struct buffer buf = alloc_buf_gc (BUF_SIZE (&m->top.c2.frame), &gc);
2338
struct packet_flood_parms parm = get_packet_flood_parms (level);
2341
ASSERT (buf_init (&buf, FRAME_HEADROOM (&m->top.c2.frame)));
2342
parm.packet_size = min_int (parm.packet_size, MAX_RW_SIZE_TUN (&m->top.c2.frame));
2344
msg (D_GREMLIN, "GREMLIN_FLOOD_CLIENTS: flooding clients with %d packets of size %d",
2348
for (i = 0; i < parm.packet_size; ++i)
2349
ASSERT (buf_write_u8 (&buf, get_random () & 0xFF));
2351
for (i = 0; i < parm.n_packets; ++i)
2352
multi_bcast (m, &buf, NULL, NULL);
2360
* Process timers in the top-level context
2363
multi_process_per_second_timers_dowork (struct multi_context *m)
2365
/* possibly reap instances/routes in vhash */
2366
multi_reap_process (m);
2368
/* possibly print to status log */
2369
if (m->top.c1.status_output)
2371
if (status_trigger (m->top.c1.status_output))
2372
multi_print_status (m, m->top.c1.status_output, m->status_file_version);
2375
/* possibly flush ifconfig-pool file */
2376
multi_ifconfig_pool_persist (m, false);
2379
gremlin_flood_clients (m);
2384
multi_top_init (struct multi_context *m, const struct context *top, const bool alloc_buffers)
2386
inherit_context_top (&m->top, top);
2387
m->top.c2.buffers = NULL;
2389
m->top.c2.buffers = init_context_buffers (&top->c2.frame);
2393
multi_top_free (struct multi_context *m)
2395
close_context (&m->top, -1, CC_GC_FREE);
2396
free_context_buffers (m->top.c2.buffers);
2400
* Return true if event loop should break,
2401
* false if it should continue.
2404
multi_process_signal (struct multi_context *m)
2406
if (m->top.sig->signal_received == SIGUSR2)
2408
struct status_output *so = status_open (NULL, 0, M_INFO, NULL, 0);
2409
multi_print_status (m, so, m->status_file_version);
2411
m->top.sig->signal_received = 0;
2418
* Called when an instance should be closed due to the
2419
* reception of a soft signal.
2422
multi_close_instance_on_signal (struct multi_context *m, struct multi_instance *mi)
2424
remap_signal (&mi->context);
2426
print_signal (mi->context.sig, "client-instance", D_MULTI_LOW);
2428
multi_close_instance (m, mi, false);
2432
multi_signal_instance (struct multi_context *m, struct multi_instance *mi, const int sig)
2434
mi->context.sig->signal_received = sig;
2435
multi_close_instance_on_signal (m, mi);
2439
* Management subsystem callbacks
2442
#ifdef ENABLE_MANAGEMENT
2445
management_callback_status (void *arg, const int version, struct status_output *so)
2447
struct multi_context *m = (struct multi_context *) arg;
2450
multi_print_status (m, so, m->status_file_version);
2452
multi_print_status (m, so, version);
2456
management_callback_n_clients (void *arg)
2458
struct multi_context *m = (struct multi_context *) arg;
2459
return m->n_clients;
2463
management_callback_kill_by_cn (void *arg, const char *del_cn)
2465
struct multi_context *m = (struct multi_context *) arg;
2466
struct hash_iterator hi;
2467
struct hash_element *he;
2470
hash_iterator_init (m->iter, &hi);
2471
while ((he = hash_iterator_next (&hi)))
2473
struct multi_instance *mi = (struct multi_instance *) he->value;
2476
const char *cn = tls_common_name (mi->context.c2.tls_multi, false);
2477
if (cn && !strcmp (cn, del_cn))
2479
multi_signal_instance (m, mi, SIGTERM);
2484
hash_iterator_free (&hi);
2489
management_callback_kill_by_addr (void *arg, const in_addr_t addr, const int port)
2491
struct multi_context *m = (struct multi_context *) arg;
2492
struct hash_iterator hi;
2493
struct hash_element *he;
2494
struct openvpn_sockaddr saddr;
2495
struct mroute_addr maddr;
2499
saddr.sa.sin_family = AF_INET;
2500
saddr.sa.sin_addr.s_addr = htonl (addr);
2501
saddr.sa.sin_port = htons (port);
2502
if (mroute_extract_openvpn_sockaddr (&maddr, &saddr, true))
2504
hash_iterator_init (m->iter, &hi);
2505
while ((he = hash_iterator_next (&hi)))
2507
struct multi_instance *mi = (struct multi_instance *) he->value;
2508
if (!mi->halt && mroute_addr_equal (&maddr, &mi->real))
2510
multi_signal_instance (m, mi, SIGTERM);
2514
hash_iterator_free (&hi);
2520
management_delete_event (void *arg, event_t event)
2522
struct multi_context *m = (struct multi_context *) arg;
2524
multi_tcp_delete_event (m->mtcp, event);
2529
#ifdef MANAGEMENT_DEF_AUTH
2531
static struct multi_instance *
2532
lookup_by_cid (struct multi_context *m, const unsigned long cid)
2536
struct multi_instance *mi = (struct multi_instance *) hash_lookup (m->cid_hash, &cid);
2537
if (mi && !mi->halt)
2544
management_kill_by_cid (void *arg, const unsigned long cid)
2546
struct multi_context *m = (struct multi_context *) arg;
2547
struct multi_instance *mi = lookup_by_cid (m, cid);
2550
send_restart (&mi->context); /* was: multi_signal_instance (m, mi, SIGTERM); */
2558
management_client_auth (void *arg,
2559
const unsigned long cid,
2560
const unsigned int mda_key_id,
2563
const char *client_reason,
2564
struct buffer_list *cc_config) /* ownership transferred */
2566
struct multi_context *m = (struct multi_context *) arg;
2567
struct multi_instance *mi = lookup_by_cid (m, cid);
2568
bool cc_config_owned = true;
2573
ret = tls_authenticate_key (mi->context.c2.tls_multi, mda_key_id, auth, client_reason);
2578
if (!mi->connection_established_flag)
2580
set_cc_config (mi, cc_config);
2581
cc_config_owned = false;
2587
msg (D_MULTI_LOW, "MULTI: connection rejected: %s, CLI:%s", reason, np(client_reason));
2588
if (mi->connection_established_flag)
2590
send_auth_failed (&mi->context, client_reason); /* mid-session reauth failed */
2591
multi_schedule_context_wakeup(m, mi);
2596
if (cc_config_owned && cc_config)
2597
buffer_list_free (cc_config);
2602
management_get_peer_info (void *arg, const unsigned long cid)
2604
struct multi_context *m = (struct multi_context *) arg;
2605
struct multi_instance *mi = lookup_by_cid (m, cid);
2609
ret = tls_get_peer_info (mi->context.c2.tls_multi);
2616
#ifdef MANAGEMENT_PF
2618
management_client_pf (void *arg,
2619
const unsigned long cid,
2620
struct buffer_list *pf_config) /* ownership transferred */
2622
struct multi_context *m = (struct multi_context *) arg;
2623
struct multi_instance *mi = lookup_by_cid (m, cid);
2626
if (mi && pf_config)
2627
ret = pf_load_from_buffer_list (&mi->context, pf_config);
2630
buffer_list_free (pf_config);
2636
init_management_callback_multi (struct multi_context *m)
2638
#ifdef ENABLE_MANAGEMENT
2641
struct management_callback cb;
2644
cb.flags = MCF_SERVER;
2645
cb.status = management_callback_status;
2646
cb.show_net = management_show_net_callback;
2647
cb.kill_by_cn = management_callback_kill_by_cn;
2648
cb.kill_by_addr = management_callback_kill_by_addr;
2649
cb.delete_event = management_delete_event;
2650
cb.n_clients = management_callback_n_clients;
2651
#ifdef MANAGEMENT_DEF_AUTH
2652
cb.kill_by_cid = management_kill_by_cid;
2653
cb.client_auth = management_client_auth;
2654
cb.get_peer_info = management_get_peer_info;
2656
#ifdef MANAGEMENT_PF
2657
cb.client_pf = management_client_pf;
2659
management_set_callback (management, &cb);
2665
uninit_management_callback_multi (struct multi_context *m)
2667
uninit_management_callback ();
2671
* Top level event loop.
2674
tunnel_server (struct context *top)
2676
ASSERT (top->options.mode == MODE_SERVER);
2678
switch (top->options.ce.proto) {
2680
tunnel_server_udp (top);
2682
case PROTO_TCPv4_SERVER:
2683
tunnel_server_tcp (top);
2691
static void dummy(void) {}
2692
#endif /* P2MP_SERVER */
added
removed
.pc/jjo-ipv6-support.patch/multi.c
