OpenVPN
init.h
Go to the documentation of this file.
1 /*
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
6  * packet compression.
7  *
8  * Copyright (C) 2002-2018 OpenVPN Inc <sales@openvpn.net>
9  *
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.
13  *
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.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23 
24 #ifndef INIT_H
25 #define INIT_H
26 
27 #include "openvpn.h"
28 
29 /*
30  * Baseline maximum number of events
31  * to wait for.
32  */
33 #define BASE_N_EVENTS 4
34 
35 void context_clear(struct context *c);
36 
37 void context_clear_1(struct context *c);
38 
39 void context_clear_2(struct context *c);
40 
41 void context_init_1(struct context *c);
42 
44 
45 bool init_static(void);
46 
47 void uninit_static(void);
48 
49 #define IVM_LEVEL_1 (1<<0)
50 #define IVM_LEVEL_2 (1<<1)
51 void init_verb_mute(struct context *c, unsigned int flags);
52 
53 void init_options_dev(struct options *options);
54 
55 bool print_openssl_info(const struct options *options);
56 
57 bool do_genkey(const struct options *options);
58 
59 bool do_persist_tuntap(const struct options *options, openvpn_net_ctx_t *ctx);
60 
61 bool possibly_become_daemon(const struct options *options);
62 
63 void pre_setup(const struct options *options);
64 
65 void init_instance_handle_signals(struct context *c, const struct env_set *env, const unsigned int flags);
66 
67 void init_instance(struct context *c, const struct env_set *env, const unsigned int flags);
68 
72 void init_query_passwords(const struct context *c);
73 
74 void do_route(const struct options *options,
75  struct route_list *route_list,
77  const struct tuntap *tt,
78  const struct plugin_list *plugins,
79  struct env_set *es,
80  openvpn_net_ctx_t *ctx);
81 
82 void close_instance(struct context *c);
83 
84 bool do_test_crypto(const struct options *o);
85 
86 void context_gc_free(struct context *c);
87 
88 bool do_up(struct context *c,
89  bool pulled_options,
90  unsigned int option_types_found);
91 
92 unsigned int pull_permission_mask(const struct context *c);
93 
94 const char *format_common_name(struct context *c, struct gc_arena *gc);
95 
96 void reset_coarse_timers(struct context *c);
97 
98 bool do_deferred_options(struct context *c, const unsigned int found);
99 
100 void inherit_context_child(struct context *dest,
101  const struct context *src);
102 
103 void inherit_context_top(struct context *dest,
104  const struct context *src);
105 
106 #define CC_GC_FREE (1<<0)
107 #define CC_USR1_TO_HUP (1<<1)
108 #define CC_HARD_USR1_TO_HUP (1<<2)
109 #define CC_NO_CLOSE (1<<3)
110 
111 void close_context(struct context *c, int sig, unsigned int flags);
112 
113 struct context_buffers *init_context_buffers(const struct frame *frame);
114 
115 void free_context_buffers(struct context_buffers *b);
116 
117 #define ISC_ERRORS (1<<0)
118 #define ISC_SERVER (1<<1)
119 void initialization_sequence_completed(struct context *c, const unsigned int flags);
120 
121 #ifdef ENABLE_MANAGEMENT
122 
123 void init_management(void);
124 
125 bool open_management(struct context *c);
126 
127 void close_management(void);
128 
129 void management_show_net_callback(void *arg, const int msglevel);
130 
131 #endif
132 
133 void init_management_callback_p2p(struct context *c);
134 
135 void uninit_management_callback(void);
136 
137 #ifdef ENABLE_PLUGIN
138 void init_plugins(struct context *c);
139 
140 void open_plugins(struct context *c, const bool import_options, int init_point);
141 
142 #endif
143 
144 void tun_abort(void);
145 
146 void write_pid_file(const char *filename, const char *chroot_dir);
147 void remove_pid_file(void);
148 
149 #endif /* ifndef INIT_H */
void init_instance(struct context *c, const struct env_set *env, const unsigned int flags)
Definition: init.c:4124
Definition: tun.h:151
void tun_abort(void)
Definition: init.c:2144
bool possibly_become_daemon(const struct options *options)
Definition: init.c:1225
Contains all state information for one tunnel.
Definition: openvpn.h:503
Packet geometry parameters.
Definition: mtu.h:93
struct env_set * es
Set of environment variables.
Definition: openvpn.h:526
void init_instance_handle_signals(struct context *c, const struct env_set *env, const unsigned int flags)
Definition: init.c:4102
void initialization_sequence_completed(struct context *c, const unsigned int flags)
Definition: init.c:1597
bool do_genkey(const struct options *options)
Definition: init.c:1101
void init_management_callback_p2p(struct context *c)
Definition: init.c:3990
void init_options_dev(struct options *options)
Definition: init.c:1052
struct signal_info * sig
Internal error signaling object.
Definition: openvpn.h:530
void * openvpn_net_ctx_t
Definition: networking.h:26
struct context_buffers * init_context_buffers(const struct frame *frame)
Definition: init.c:3338
void uninit_static(void)
Definition: init.c:1011
bool init_static(void)
Definition: init.c:782
void close_instance(struct context *c)
Definition: init.c:4436
list flags
bool do_test_crypto(const struct options *o)
Definition: init.c:4739
void close_context(struct context *c, int sig, unsigned int flags)
Definition: init.c:4639
bool print_openssl_info(const struct options *options)
Definition: init.c:1062
bool do_deferred_options(struct context *c, const unsigned int found)
Definition: init.c:2286
void write_pid_file(const char *filename, const char *chroot_dir)
Definition: init.c:4672
bool open_management(struct context *c)
Definition: init.c:4023
bool do_up(struct context *c, bool pulled_options, unsigned int option_types_found)
Definition: init.c:2174
void context_clear_1(struct context *c)
Definition: init.c:79
void uninit_management_callback(void)
Definition: init.c:4087
unsigned int pull_permission_mask(const struct context *c)
Definition: init.c:2251
void context_init_1(struct context *c)
Definition: init.c:694
char * dest
Definition: compat-lz4.h:686
void context_clear(struct context *c)
Definition: init.c:73
void pre_setup(const struct options *options)
Definition: init.c:1361
void init_verb_mute(struct context *c, unsigned int flags)
Definition: init.c:1029
void init_query_passwords(const struct context *c)
Query for private key and auth-user-pass username/passwords.
Definition: init.c:587
void close_management(void)
Definition: init.c:4074
void management_show_net_callback(void *arg, const int msglevel)
Definition: init.c:3937
bool do_persist_tuntap(const struct options *options, openvpn_net_ctx_t *ctx)
Definition: init.c:1184
void inherit_context_top(struct context *dest, const struct context *src)
Definition: init.c:4589
void context_clear_2(struct context *c)
Definition: init.c:85
void context_clear_all_except_first_time(struct context *c)
Definition: init.c:91
struct plugin_list * plugins
List of plug-ins.
Definition: openvpn.h:532
void inherit_context_child(struct context *dest, const struct context *src)
Definition: init.c:4513
void context_gc_free(struct context *c)
Definition: init.c:743
void init_management(void)
Definition: init.c:4014
void init_plugins(struct context *c)
Definition: init.c:3858
void reset_coarse_timers(struct context *c)
Definition: init.c:1389
void remove_pid_file(void)
Definition: init.c:4702
void open_plugins(struct context *c, const bool import_options, int init_point)
Definition: init.c:3868
Garbage collection arena used to keep track of dynamically allocated memory.
Definition: buffer.h:116
void do_route(const struct options *options, struct route_list *route_list, struct route_ipv6_list *route_ipv6_list, const struct tuntap *tt, const struct plugin_list *plugins, struct env_set *es, openvpn_net_ctx_t *ctx)
Definition: init.c:1716
const char * format_common_name(struct context *c, struct gc_arena *gc)
Definition: init.c:1350
struct gc_arena gc
Garbage collection arena for allocations done in the scope of this context structure.
Definition: openvpn.h:522
void free_context_buffers(struct context_buffers *b)
Definition: init.c:3361