lib:util: Make loading of modules more secure
[metze/samba/wip.git] / lib / util / modules.c
1 /*
2    Unix SMB/CIFS implementation.
3    Samba utility functions
4    Copyright (C) Jelmer Vernooij 2002-2003,2005-2007
5    Copyright (C) Stefan (metze) Metzmacher 2003
6    Copyright (C) Andrew Bartlett 2011
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "includes.h"
23 #include "dynconfig/dynconfig.h"
24 #include "lib/util/samba_modules.h"
25 #include "system/filesys.h"
26 #include "system/dir.h"
27
28 /**
29  * Obtain the init function from a shared library file
30  */
31 init_module_fn load_module(const char *path, bool is_probe, void **handle_out)
32 {
33         void *handle;
34         void *init_fn;
35         char *error;
36
37         /* This should be a WAF build, where modules should be built
38          * with no undefined symbols and are already linked against
39          * the libraries that they are loaded by */
40         handle = dlopen(path, RTLD_NOW);
41
42         /* This call should reset any possible non-fatal errors that
43            occurred since last call to dl* functions */
44         error = dlerror();
45
46         if (handle == NULL) {
47                 int level = is_probe ? 5 : 0;
48                 DEBUG(level, ("Error loading module '%s': %s\n", path, error ? error : ""));
49                 return NULL;
50         }
51
52         init_fn = (init_module_fn)dlsym(handle, SAMBA_INIT_MODULE);
53
54         /* we could check dlerror() to determine if it worked, because
55            dlsym() can validly return NULL, but what would we do with
56            a NULL pointer as a module init function? */
57
58         if (init_fn == NULL) {
59                 DEBUG(0, ("Unable to find %s() in %s: %s\n",
60                           SAMBA_INIT_MODULE, path, dlerror()));
61                 DEBUG(1, ("Loading module '%s' failed\n", path));
62                 dlclose(handle);
63                 return NULL;
64         }
65
66         if (handle_out) {
67                 *handle_out = handle;
68         }
69
70         return (init_module_fn)init_fn;
71 }
72
73 /**
74  * Obtain list of init functions from the modules in the specified
75  * directory
76  */
77 static init_module_fn *load_modules(TALLOC_CTX *mem_ctx, const char *path)
78 {
79         DIR *dir;
80         struct dirent *entry;
81         char *filename;
82         int success = 0;
83         init_module_fn *ret = talloc_array(mem_ctx, init_module_fn, 2);
84
85         ret[0] = NULL;
86
87         dir = opendir(path);
88         if (dir == NULL) {
89                 talloc_free(ret);
90                 return NULL;
91         }
92
93         while((entry = readdir(dir))) {
94                 if (ISDOT(entry->d_name) || ISDOTDOT(entry->d_name))
95                         continue;
96
97                 filename = talloc_asprintf(mem_ctx, "%s/%s", path, entry->d_name);
98
99                 ret[success] = load_module(filename, true, NULL);
100                 if (ret[success]) {
101                         ret = talloc_realloc(mem_ctx, ret, init_module_fn, success+2);
102                         success++;
103                         ret[success] = NULL;
104                 }
105
106                 talloc_free(filename);
107         }
108
109         closedir(dir);
110
111         return ret;
112 }
113
114 /**
115  * Run the specified init functions.
116  *
117  * @return true if all functions ran successfully, false otherwise
118  */
119 bool run_init_functions(TALLOC_CTX *ctx, init_module_fn *fns)
120 {
121         int i;
122         bool ret = true;
123
124         if (fns == NULL)
125                 return true;
126
127         for (i = 0; fns[i]; i++) { ret &= (bool)NT_STATUS_IS_OK(fns[i](ctx)); }
128
129         return ret;
130 }
131
132 /**
133  * Load the initialization functions from DSO files for a specific subsystem.
134  *
135  * Will return an array of function pointers to initialization functions
136  */
137
138 init_module_fn *load_samba_modules(TALLOC_CTX *mem_ctx, const char *subsystem)
139 {
140         char *path = modules_path(mem_ctx, subsystem);
141         init_module_fn *ret;
142
143         ret = load_modules(mem_ctx, path);
144
145         talloc_free(path);
146
147         return ret;
148 }
149
150 static NTSTATUS load_module_absolute_path(const char *module_path,
151                                           bool is_probe)
152 {
153         void *handle;
154         init_module_fn init;
155         NTSTATUS status;
156
157         DBG_INFO("%s module '%s'\n",
158                  is_probe ? "Probing" : "Loading",
159                  module_path);
160
161         init = load_module(module_path, is_probe, &handle);
162         if (init == NULL) {
163                 return NT_STATUS_UNSUCCESSFUL;
164         }
165
166         DBG_NOTICE("Module '%s' loaded\n", module_path);
167
168         status = init(NULL);
169         if (!NT_STATUS_IS_OK(status)) {
170                 DBG_ERR("Module '%s' initialization failed: %s\n",
171                         module_path,
172                         get_friendly_nt_error_msg(status));
173                 dlclose(handle);
174                 return status;
175         }
176
177         return NT_STATUS_OK;
178 }
179
180 /* Load all modules in list and return number of
181  * modules that has been successfully loaded */
182 int smb_load_all_modules_absoute_path(const char **modules)
183 {
184         int i;
185         int success = 0;
186
187         for(i = 0; modules[i] != NULL; i++) {
188                 const char *module = modules[i];
189                 NTSTATUS status;
190
191                 if (module[0] != '/') {
192                         continue;
193                 }
194
195                 status = load_module_absolute_path(module, false);
196                 if (NT_STATUS_IS_OK(status)) {
197                         success++;
198                 }
199         }
200
201         DEBUG(2, ("%d modules successfully loaded\n", success));
202
203         return success;
204 }
205
206 /**
207  * @brief Check if a module exist and load it.
208  *
209  * @param[in]  subsystem  The name of the subsystem the module belongs too.
210  *
211  * @param[in]  module     The name of the module
212  *
213  * @return  A NTSTATUS code
214  */
215 NTSTATUS smb_probe_module(const char *subsystem, const char *module)
216 {
217         NTSTATUS status;
218         char *module_path = NULL;
219         TALLOC_CTX *tmp_ctx = talloc_stackframe();
220
221         if (subsystem == NULL) {
222                 status = NT_STATUS_INVALID_PARAMETER;
223                 goto done;
224         }
225         if (module == NULL) {
226                 status = NT_STATUS_INVALID_PARAMETER;
227                 goto done;
228         }
229
230         if (strchr(module, '/')) {
231                 status = NT_STATUS_INVALID_PARAMETER;
232                 goto done;
233         }
234
235         module_path = talloc_asprintf(tmp_ctx,
236                                       "%s/%s.%s",
237                                       modules_path(tmp_ctx, subsystem),
238                                       module,
239                                       shlib_ext());
240         if (module_path == NULL) {
241                 status = NT_STATUS_NO_MEMORY;
242                 goto done;
243         }
244
245         status = load_module_absolute_path(module_path, true);
246
247 done:
248         TALLOC_FREE(tmp_ctx);
249         return status;
250 }
251
252 /**
253  * @brief Check if a module exist and load it.
254  *
255  * Warning: Using this function can have security implecations!
256  *
257  * @param[in]  subsystem  The name of the subsystem the module belongs too.
258  *
259  * @param[in]  module     Load a module using an abolute path.
260  *
261  * @return  A NTSTATUS code
262  */
263 NTSTATUS smb_probe_module_absolute_path(const char *module)
264 {
265         if (module == NULL) {
266                 return NT_STATUS_INVALID_PARAMETER;
267         }
268         if (module[0] != '/') {
269                 return NT_STATUS_INVALID_PARAMETER;
270         }
271
272         return load_module_absolute_path(module, true);
273 }
274
275 /**
276  * @brief Load a module.
277  *
278  * @param[in]  subsystem  The name of the subsystem the module belongs too.
279  *
280  * @param[in]  module     Check if a module exists and load it.
281  *
282  * @return  A NTSTATUS code
283  */
284 NTSTATUS smb_load_module(const char *subsystem, const char *module)
285 {
286         NTSTATUS status;
287         char *module_path = NULL;
288         TALLOC_CTX *tmp_ctx = talloc_stackframe();
289
290         if (subsystem == NULL) {
291                 status = NT_STATUS_INVALID_PARAMETER;
292                 goto done;
293         }
294         if (module == NULL) {
295                 status = NT_STATUS_INVALID_PARAMETER;
296                 goto done;
297         }
298
299         if (strchr(module, '/')) {
300                 status = NT_STATUS_INVALID_PARAMETER;
301                 goto done;
302         }
303
304         module_path = talloc_asprintf(tmp_ctx,
305                                       "%s/%s.%s",
306                                       modules_path(tmp_ctx, subsystem),
307                                       module,
308                                       shlib_ext());
309         if (module_path == NULL) {
310                 status = NT_STATUS_NO_MEMORY;
311                 goto done;
312         }
313
314         status = load_module_absolute_path(module_path, false);
315
316 done:
317         TALLOC_FREE(tmp_ctx);
318         return status;
319 }