summaryrefslogtreecommitdiffstats
path: root/database/eurephiadb.c
blob: 7046dae7cb87936c9b1c3f7a59e743908d292360 (plain)
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
/* eurephiadb.c  --  Loads and initialises the database driver
 *
 *  GPLv2 only - Copyright (C) 2008 - 2013
 *               David Sommerseth <dazo@users.sourceforge.net>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; version 2
 *  of the License.
 *
 *  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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 */

/**
 * @file   eurephiadb.c
 * @author David Sommerseth <dazo@users.sourceforge.net>
 * @date   2008-08-06
 *
 * @brief  Handles loading and initialising of the database drivers
 *
 */

#include <stdio.h>
#include <string.h>
#include <dlfcn.h>

#include "eurephia_nullsafe.h"
#include "eurephiadb_driver.h"
#include "eurephia_log.h"
#include "eurephia_getsym.h"


/**
 * Unloads the database driver
 *
 * @param ctx eurephiaCTX
 *
 * @return Returns always 1.
 */
int eDBlink_close(eurephiaCTX *ctx)
{
        if( ctx == NULL ) {
                return 1;
        }

        eurephia_log(ctx, LOG_INFO, 3, "Unloading eurephia database driver");
        if( ctx->eurephia_driver != NULL ) {
                dlclose(ctx->eurephia_driver);
                ctx->eurephia_driver = NULL;
        }
        return 1;
}


/**
 * Loads and initialises the database driver.
 *
 * @param ctx      eurephiaCTX to which the database driver will be associated with
 * @param dbdriver Full path to the driver file (.so)
 * @param minver   The required minimum API level of the driver
 *
 * @return Returns 1 on success, otherwise 0.
 */
int eDBlink_init(eurephiaCTX *ctx, const char *dbdriver, const int minver)
{
        int apiver = -1;
        if( dbdriver == NULL ) {
                eurephia_log(ctx, LOG_FATAL, 0, "No eurephia database driver configured.  "
                             "eurephia authentication will not be available");
                return 0;
        }
        eurephia_log(ctx, LOG_INFO, 2, "Loading eurephia database driver: %s", dbdriver);

        ctx->eurephia_driver = dlopen(dbdriver, RTLD_NOW);
        if( ctx->eurephia_driver == NULL ) {
                eurephia_log(ctx, LOG_FATAL, 0, "Could not open the eurephia database driver (%s)", dbdriver);
                eurephia_log(ctx, LOG_FATAL, 1, "dlopen error: %s", dlerror());
                return 0;
        }

        // Find mandatory functions containing driver information
        eDB_DriverVersion = eGetSym(ctx, ctx->eurephia_driver, "eDB_DriverVersion");
        eDB_DriverAPIVersion = eGetSym(ctx, ctx->eurephia_driver, "eDB_DriverAPIVersion");

        eurephia_log(ctx, LOG_INFO, 1, "Driver loaded: %s (API version %i)",
                     eDB_DriverVersion(), eDB_DriverAPIVersion());

        // Check that we are using at least a new enough driver
        if( eDB_DriverAPIVersion() < minver ) {
                eurephia_log(ctx, LOG_FATAL, 0,
                             "The requested eurephia database driver is too old.  This program needs "
                             "API version %i, but this driver only supports API version %i.\n",
                             minver, eDB_DriverAPIVersion());
                return 0;
        }

        // Configure functions contained in the driver, defined by API version
        apiver = (eDB_DriverAPIVersion() > minver ? minver : eDB_DriverAPIVersion());
        switch( apiver ) {
        case -1:
                eurephia_log(ctx, LOG_FATAL, 0, "Something unexpected happened - apiver==-1");
                ctx->fatal_error = 1;
                break;

        default:
                eurephia_log(ctx, LOG_WARNING, 0,
                             "eurephia database driver API is newer than the running eurephia version.  Consider "
                             "to upgrade eurephia to take advantage of newer features in the driver.");

        case 4:
                eDBauth_GetAuthMethod          = eGetSym(ctx, ctx->eurephia_driver, "eDBauth_GetAuthMethod");
                eDBget_plugins                 = eGetSym(ctx, ctx->eurephia_driver, "eDBget_plugins");
                eDBadminPlugins                = eGetSym(ctx, ctx->eurephia_driver, "eDBadminPlugins");

        case 3:
                eDBregister_vpnclientaddr      = eGetSym(ctx, ctx->eurephia_driver, "eDBregister_vpnclientaddr");

        case 2:
#ifdef ENABLE_EUREPHIADM
                if( (ctx->context_type != ECTX_NO_PRIVILEGES) && (ctx->context_type != ECTX_PLUGIN_AUTH) ) {
                        // These functions are only available in admin context
                        eDBadminAuthenticate      = eGetSym(ctx, ctx->eurephia_driver, "eDBadminAuthenticate");
                        eDBadminConfiguration     = eGetSym(ctx, ctx->eurephia_driver, "eDBadminConfiguration");
                        eDBadminUserAccount       = eGetSym(ctx, ctx->eurephia_driver, "eDBadminUserAccount");
                        eDBadminCertificate       = eGetSym(ctx, ctx->eurephia_driver, "eDBadminCertificate");
                        eDBadminUserCertsLink     = eGetSym(ctx, ctx->eurephia_driver, "eDBadminUserCertsLink");
                        eDBadminAccessLevel       = eGetSym(ctx, ctx->eurephia_driver,  "eDBadminAccessLevel");
                        eDBadminFirewallProfiles  = eGetSym(ctx, ctx->eurephia_driver,
                                                            "eDBadminFirewallProfiles");
                        eDBadminGetLastlog        = eGetSym(ctx, ctx->eurephia_driver, "eDBadminGetLastlog");
                        eDBadminAttemptsLog       = eGetSym(ctx, ctx->eurephia_driver, "eDBadminAttemptsLog");
                        eDBadminBlacklist         = eGetSym(ctx, ctx->eurephia_driver, "eDBadminBlacklist");
                }
#endif

        case 1:
                // Setup eDBlink functions
                eDBconnect                     = eGetSym(ctx, ctx->eurephia_driver, "eDBconnect");
                eDBdisconnect                  = eGetSym(ctx, ctx->eurephia_driver, "eDBdisconnect");

                eDBauth_TLS                    = eGetSym(ctx, ctx->eurephia_driver, "eDBauth_TLS");

                eDBauth_user                   = eGetSym(ctx, ctx->eurephia_driver, "eDBauth_user");
                eDBget_uid                     = eGetSym(ctx, ctx->eurephia_driver, "eDBget_uid");

                eDBblacklist_check             = eGetSym(ctx, ctx->eurephia_driver, "eDBblacklist_check");
                eDBregister_attempt            = eGetSym(ctx, ctx->eurephia_driver, "eDBregister_attempt");

                eDBregister_login              = eGetSym(ctx, ctx->eurephia_driver, "eDBregister_login");

                // If api version is 3, this function is replaced by eDBregister_vpnclientaddr()
                eDBregister_vpnmacaddr         = (apiver < 3 ?
                                                  eGetSym(ctx, ctx->eurephia_driver, "eDBregister_vpnmacaddr") : NULL);
                eDBregister_logout             = eGetSym(ctx, ctx->eurephia_driver, "eDBregister_logout");

                eDBget_firewall_profile        = eGetSym(ctx, ctx->eurephia_driver, "eDBget_firewall_profile");
                eDBget_blacklisted_ip          = eGetSym(ctx, ctx->eurephia_driver, "eDBget_blacklisted_ip");

                eDBget_sessionkey_seed         = eGetSym(ctx, ctx->eurephia_driver, "eDBget_sessionkey_seed");
                eDBget_sessionkey_macaddr      = eGetSym(ctx, ctx->eurephia_driver, "eDBget_sessionkey_macaddr");
                eDBcheck_sessionkey_uniqueness = eGetSym(ctx, ctx->eurephia_driver,
                                                         "eDBcheck_sessionkey_uniqueness");

                eDBregister_sessionkey         = eGetSym(ctx, ctx->eurephia_driver, "eDBregister_sessionkey");
                eDBload_sessiondata            = eGetSym(ctx, ctx->eurephia_driver, "eDBload_sessiondata");
                eDBstore_session_value         = eGetSym(ctx, ctx->eurephia_driver, "eDBstore_session_value");
                eDBdestroy_session             = eGetSym(ctx, ctx->eurephia_driver, "eDBdestroy_session");
                break;
        }
        if( ctx->fatal_error > 0 ) {
                eurephia_log(ctx, LOG_FATAL, 0, "The eurephia database driver is not correctly initialised.  "
                             "eurephia authentication will not be available");
                eDBlink_close(ctx);
                return 0;
        }
        return 1;
}


/**
 * Frees the memory allocated by the eDBauth_GetAuthMethod() function
 *
 * @param eurephiaCTX*         Pointer to the global eurephia context
 * @param eDBauthMethodResult* Pointer to the result to be freed
 *
 */
void eDBauth_FreeAuthMethodResult(eurephiaCTX *ctx, eDBauthMethodResult *res)
{
        if( res == NULL ) {
                return;
        }
        free_nullsafe(ctx, res->username);
        memset(res, 0, sizeof(eDBauthMethodResult));
        free_nullsafe(ctx, res);
}