docs: Add very basic samba manpage.
[Samba/gebeck_regimport.git] / source3 / utils / testparm.c
bloba9793ab4cd764e4fb59a2638778d15341a2d0881
1 /*
2 Unix SMB/CIFS implementation.
3 Test validity of smb.conf
4 Copyright (C) Karl Auer 1993, 1994-1998
6 Extensively modified by Andrew Tridgell, 1995
7 Converted to popt by Jelmer Vernooij (jelmer@nl.linux.org), 2002
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
24 * Testbed for loadparm.c/params.c
26 * This module simply loads a specified configuration file and
27 * if successful, dumps it's contents to stdout. Note that the
28 * operation is performed with DEBUGLEVEL at 3.
30 * Useful for a quick 'syntax check' of a configuration file.
34 #include "includes.h"
35 #include "system/filesys.h"
36 #include "popt_common.h"
37 #include "lib/param/loadparm.h"
39 /*******************************************************************
40 Check if a directory exists.
41 ********************************************************************/
43 static bool directory_exist_stat(const char *dname,SMB_STRUCT_STAT *st)
45 SMB_STRUCT_STAT st2;
46 bool ret;
48 if (!st)
49 st = &st2;
51 if (sys_stat(dname, st, false) != 0)
52 return(False);
54 ret = S_ISDIR(st->st_ex_mode);
55 if(!ret)
56 errno = ENOTDIR;
57 return ret;
60 /***********************************************
61 Here we do a set of 'hard coded' checks for bad
62 configuration settings.
63 ************************************************/
65 static int do_global_checks(void)
67 int ret = 0;
68 SMB_STRUCT_STAT st;
70 if (lp_security() >= SEC_DOMAIN && !lp_encrypted_passwords()) {
71 fprintf(stderr, "ERROR: in 'security=domain' mode the 'encrypt passwords' parameter must always be set to 'true'.\n");
72 ret = 1;
75 if (lp_we_are_a_wins_server() && lp_wins_server_list()) {
76 fprintf(stderr, "ERROR: both 'wins support = true' and 'wins server = <server list>' \
77 cannot be set in the smb.conf file. nmbd will abort with this setting.\n");
78 ret = 1;
81 if (strequal(lp_workgroup(), lp_netbios_name())) {
82 fprintf(stderr, "WARNING: 'workgroup' and 'netbios name' " \
83 "must differ.\n");
84 ret = 1;
87 if (!directory_exist_stat(lp_lockdir(), &st)) {
88 fprintf(stderr, "ERROR: lock directory %s does not exist\n",
89 lp_lockdir());
90 ret = 1;
91 } else if ((st.st_ex_mode & 0777) != 0755) {
92 fprintf(stderr, "WARNING: lock directory %s should have permissions 0755 for browsing to work\n",
93 lp_lockdir());
94 ret = 1;
97 if (!directory_exist_stat(lp_statedir(), &st)) {
98 fprintf(stderr, "ERROR: state directory %s does not exist\n",
99 lp_statedir());
100 ret = 1;
101 } else if ((st.st_ex_mode & 0777) != 0755) {
102 fprintf(stderr, "WARNING: state directory %s should have permissions 0755 for browsing to work\n",
103 lp_statedir());
104 ret = 1;
107 if (!directory_exist_stat(lp_cachedir(), &st)) {
108 fprintf(stderr, "ERROR: cache directory %s does not exist\n",
109 lp_cachedir());
110 ret = 1;
111 } else if ((st.st_ex_mode & 0777) != 0755) {
112 fprintf(stderr, "WARNING: cache directory %s should have permissions 0755 for browsing to work\n",
113 lp_cachedir());
114 ret = 1;
117 if (!directory_exist_stat(lp_piddir(), &st)) {
118 fprintf(stderr, "ERROR: pid directory %s does not exist\n",
119 lp_piddir());
120 ret = 1;
123 if (lp_passdb_expand_explicit()) {
124 fprintf(stderr, "WARNING: passdb expand explicit = yes is "
125 "deprecated\n");
129 * Password server sanity checks.
132 if((lp_security() >= SEC_DOMAIN) && !*lp_passwordserver()) {
133 const char *sec_setting;
134 if(lp_security() == SEC_DOMAIN)
135 sec_setting = "domain";
136 else if(lp_security() == SEC_ADS)
137 sec_setting = "ads";
138 else
139 sec_setting = "";
141 fprintf(stderr, "ERROR: The setting 'security=%s' requires the 'password server' parameter be set\n"
142 "to the default value * or a valid password server.\n", sec_setting );
143 ret = 1;
146 if((lp_security() >= SEC_DOMAIN) && (strcmp(lp_passwordserver(), "*") != 0)) {
147 const char *sec_setting;
148 if(lp_security() == SEC_DOMAIN)
149 sec_setting = "domain";
150 else if(lp_security() == SEC_ADS)
151 sec_setting = "ads";
152 else
153 sec_setting = "";
155 fprintf(stderr, "WARNING: The setting 'security=%s' should NOT be combined with the 'password server' parameter.\n"
156 "(by default Samba will discover the correct DC to contact automatically).\n", sec_setting );
160 * Password chat sanity checks.
163 if(lp_security() == SEC_USER && lp_unix_password_sync()) {
166 * Check that we have a valid lp_passwd_program() if not using pam.
169 #ifdef WITH_PAM
170 if (!lp_pam_password_change()) {
171 #endif
173 if((lp_passwd_program(talloc_tos()) == NULL) ||
174 (strlen(lp_passwd_program(talloc_tos())) == 0))
176 fprintf( stderr, "ERROR: the 'unix password sync' parameter is set and there is no valid 'passwd program' \
177 parameter.\n" );
178 ret = 1;
179 } else {
180 const char *passwd_prog;
181 char *truncated_prog = NULL;
182 const char *p;
184 passwd_prog = lp_passwd_program(talloc_tos());
185 p = passwd_prog;
186 next_token_talloc(talloc_tos(),
188 &truncated_prog, NULL);
189 if (truncated_prog && access(truncated_prog, F_OK) == -1) {
190 fprintf(stderr, "ERROR: the 'unix password sync' parameter is set and the 'passwd program' (%s) \
191 cannot be executed (error was %s).\n", truncated_prog, strerror(errno) );
192 ret = 1;
196 #ifdef WITH_PAM
198 #endif
200 if(lp_passwd_chat(talloc_tos()) == NULL) {
201 fprintf(stderr, "ERROR: the 'unix password sync' parameter is set and there is no valid 'passwd chat' \
202 parameter.\n");
203 ret = 1;
206 if ((lp_passwd_program(talloc_tos()) != NULL) &&
207 (strlen(lp_passwd_program(talloc_tos())) > 0))
209 /* check if there's a %u parameter present */
210 if(strstr_m(lp_passwd_program(talloc_tos()), "%u") == NULL) {
211 fprintf(stderr, "ERROR: the 'passwd program' (%s) requires a '%%u' parameter.\n", lp_passwd_program(talloc_tos()));
212 ret = 1;
217 * Check that we have a valid script and that it hasn't
218 * been written to expect the old password.
221 if(lp_encrypted_passwords()) {
222 if(strstr_m( lp_passwd_chat(talloc_tos()), "%o")!=NULL) {
223 fprintf(stderr, "ERROR: the 'passwd chat' script [%s] expects to use the old plaintext password \
224 via the %%o substitution. With encrypted passwords this is not possible.\n", lp_passwd_chat(talloc_tos()) );
225 ret = 1;
230 if (strlen(lp_winbind_separator()) != 1) {
231 fprintf(stderr,"ERROR: the 'winbind separator' parameter must be a single character.\n");
232 ret = 1;
235 if (*lp_winbind_separator() == '+') {
236 fprintf(stderr,"'winbind separator = +' might cause problems with group membership.\n");
239 if (lp_algorithmic_rid_base() < BASE_RID) {
240 /* Try to prevent admin foot-shooting, we can't put algorithmic
241 rids below 1000, that's the 'well known RIDs' on NT */
242 fprintf(stderr,"'algorithmic rid base' must be equal to or above %lu\n", BASE_RID);
245 if (lp_algorithmic_rid_base() & 1) {
246 fprintf(stderr,"'algorithmic rid base' must be even.\n");
249 #ifndef HAVE_DLOPEN
250 if (lp_preload_modules()) {
251 fprintf(stderr,"WARNING: 'preload modules = ' set while loading plugins not supported.\n");
253 #endif
255 if (!lp_passdb_backend()) {
256 fprintf(stderr,"ERROR: passdb backend must have a value or be left out\n");
259 if (lp_os_level() > 255) {
260 fprintf(stderr,"WARNING: Maximum value for 'os level' is 255!\n");
263 if (strequal(lp_dos_charset(), "UTF8") || strequal(lp_dos_charset(), "UTF-8")) {
264 fprintf(stderr, "ERROR: 'dos charset' must not be UTF8\n");
265 ret = 1;
268 return ret;
272 * per-share logic tests
274 static void do_per_share_checks(int s)
276 const char **deny_list = lp_hostsdeny(s);
277 const char **allow_list = lp_hostsallow(s);
278 int i;
280 if(deny_list) {
281 for (i=0; deny_list[i]; i++) {
282 char *hasstar = strchr_m(deny_list[i], '*');
283 char *hasquery = strchr_m(deny_list[i], '?');
284 if(hasstar || hasquery) {
285 fprintf(stderr,"Invalid character %c in hosts deny list (%s) for service %s.\n",
286 hasstar ? *hasstar : *hasquery, deny_list[i], lp_servicename(talloc_tos(), s) );
291 if(allow_list) {
292 for (i=0; allow_list[i]; i++) {
293 char *hasstar = strchr_m(allow_list[i], '*');
294 char *hasquery = strchr_m(allow_list[i], '?');
295 if(hasstar || hasquery) {
296 fprintf(stderr,"Invalid character %c in hosts allow list (%s) for service %s.\n",
297 hasstar ? *hasstar : *hasquery, allow_list[i], lp_servicename(talloc_tos(), s) );
302 if(lp_level2_oplocks(s) && !lp_oplocks(s)) {
303 fprintf(stderr,"Invalid combination of parameters for service %s. \
304 Level II oplocks can only be set if oplocks are also set.\n",
305 lp_servicename(talloc_tos(), s) );
308 if (!lp_store_dos_attributes(s) && lp_map_hidden(s)
309 && !(lp_create_mask(s) & S_IXOTH))
311 fprintf(stderr,"Invalid combination of parameters for service "
312 "%s. Map hidden can only work if create mask includes "
313 "octal 01 (S_IXOTH).\n", lp_servicename(talloc_tos(), s));
315 if (!lp_store_dos_attributes(s) && lp_map_hidden(s)
316 && (lp_force_create_mode(s) & S_IXOTH))
318 fprintf(stderr,"Invalid combination of parameters for service "
319 "%s. Map hidden can only work if force create mode "
320 "excludes octal 01 (S_IXOTH).\n", lp_servicename(talloc_tos(), s));
322 if (!lp_store_dos_attributes(s) && lp_map_system(s)
323 && !(lp_create_mask(s) & S_IXGRP))
325 fprintf(stderr,"Invalid combination of parameters for service "
326 "%s. Map system can only work if create mask includes "
327 "octal 010 (S_IXGRP).\n", lp_servicename(talloc_tos(), s));
329 if (!lp_store_dos_attributes(s) && lp_map_system(s)
330 && (lp_force_create_mode(s) & S_IXGRP))
332 fprintf(stderr,"Invalid combination of parameters for service "
333 "%s. Map system can only work if force create mode "
334 "excludes octal 010 (S_IXGRP).\n", lp_servicename(talloc_tos(), s));
336 if (lp_printing(s) == PRINT_CUPS && *(lp_printcommand(talloc_tos(), s)) != '\0') {
337 fprintf(stderr,"Warning: Service %s defines a print command, but \
338 rameter is ignored when using CUPS libraries.\n",
339 lp_servicename(talloc_tos(), s) );
343 int main(int argc, const char *argv[])
345 const char *config_file = get_dyn_CONFIGFILE();
346 int s;
347 static int silent_mode = False;
348 static int show_all_parameters = False;
349 int ret = 0;
350 poptContext pc;
351 static char *parameter_name = NULL;
352 static const char *section_name = NULL;
353 const char *cname;
354 const char *caddr;
355 static int show_defaults;
356 static int skip_logic_checks = 0;
358 struct poptOption long_options[] = {
359 POPT_AUTOHELP
360 {"suppress-prompt", 's', POPT_ARG_VAL, &silent_mode, 1, "Suppress prompt for enter"},
361 {"verbose", 'v', POPT_ARG_NONE, &show_defaults, 1, "Show default options too"},
362 {"skip-logic-checks", 'l', POPT_ARG_NONE, &skip_logic_checks, 1, "Skip the global checks"},
363 {"show-all-parameters", '\0', POPT_ARG_VAL, &show_all_parameters, True, "Show the parameters, type, possible values" },
364 {"parameter-name", '\0', POPT_ARG_STRING, &parameter_name, 0, "Limit testparm to a named parameter" },
365 {"section-name", '\0', POPT_ARG_STRING, &section_name, 0, "Limit testparm to a named section" },
366 POPT_COMMON_VERSION
367 POPT_COMMON_DEBUGLEVEL
368 POPT_COMMON_OPTION
369 POPT_TABLEEND
372 TALLOC_CTX *frame = talloc_stackframe();
374 load_case_tables();
376 * Set the default debug level to 2.
377 * Allow it to be overridden by the command line,
378 * not by smb.conf.
380 lp_set_cmdline("log level", "2");
382 pc = poptGetContext(NULL, argc, argv, long_options,
383 POPT_CONTEXT_KEEP_FIRST);
384 poptSetOtherOptionHelp(pc, "[OPTION...] <config-file> [host-name] [host-ip]");
386 while(poptGetNextOpt(pc) != -1);
388 if (show_all_parameters) {
389 show_parameter_list();
390 exit(0);
393 setup_logging(poptGetArg(pc), DEBUG_STDERR);
395 if (poptPeekArg(pc))
396 config_file = poptGetArg(pc);
398 cname = poptGetArg(pc);
399 caddr = poptGetArg(pc);
401 poptFreeContext(pc);
403 if ( cname && ! caddr ) {
404 printf ( "ERROR: You must specify both a machine name and an IP address.\n" );
405 ret = 1;
406 goto done;
409 fprintf(stderr,"Load smb config files from %s\n",config_file);
411 if (!lp_load_with_registry_shares(config_file,False,True,False,True)) {
412 fprintf(stderr,"Error loading services.\n");
413 ret = 1;
414 goto done;
417 fprintf(stderr,"Loaded services file OK.\n");
419 if (skip_logic_checks == 0) {
420 ret = do_global_checks();
423 for (s=0;s<1000;s++) {
424 if (VALID_SNUM(s))
425 if (strlen(lp_servicename(talloc_tos(), s)) > 12) {
426 fprintf(stderr, "WARNING: You have some share names that are longer than 12 characters.\n" );
427 fprintf(stderr, "These may not be accessible to some older clients.\n" );
428 fprintf(stderr, "(Eg. Windows9x, WindowsMe, and smbclient prior to Samba 3.0.)\n" );
429 break;
433 for (s=0;s<1000;s++) {
434 if (VALID_SNUM(s) && (skip_logic_checks == 0)) {
435 do_per_share_checks(s);
440 if (!section_name && !parameter_name) {
441 fprintf(stderr,"Server role: %s\n", server_role_str(lp_server_role()));
444 if (!cname) {
445 if (!silent_mode) {
446 fprintf(stderr,"Press enter to see a dump of your service definitions\n");
447 fflush(stdout);
448 getc(stdin);
450 if (parameter_name || section_name) {
451 bool isGlobal = False;
452 s = GLOBAL_SECTION_SNUM;
454 if (!section_name) {
455 section_name = GLOBAL_NAME;
456 isGlobal = True;
457 } else if ((isGlobal=!strwicmp(section_name, GLOBAL_NAME)) == 0 &&
458 (s=lp_servicenumber(section_name)) == -1) {
459 fprintf(stderr,"Unknown section %s\n",
460 section_name);
461 ret = 1;
462 goto done;
464 if (parameter_name) {
465 if (!dump_a_parameter( s, parameter_name, stdout, isGlobal)) {
466 fprintf(stderr,"Parameter %s unknown for section %s\n",
467 parameter_name, section_name);
468 ret = 1;
469 goto done;
471 } else {
472 if (isGlobal == True)
473 lp_dump(stdout, show_defaults, 0);
474 else
475 lp_dump_one(stdout, show_defaults, s);
477 goto done;
480 lp_dump(stdout, show_defaults, lp_numservices());
483 if(cname && caddr){
484 /* this is totally ugly, a real `quick' hack */
485 for (s=0;s<1000;s++) {
486 if (VALID_SNUM(s)) {
487 if (allow_access(lp_hostsdeny(-1), lp_hostsallow(-1), cname, caddr)
488 && allow_access(lp_hostsdeny(s), lp_hostsallow(s), cname, caddr)) {
489 fprintf(stderr,"Allow connection from %s (%s) to %s\n",
490 cname,caddr,lp_servicename(talloc_tos(), s));
491 } else {
492 fprintf(stderr,"Deny connection from %s (%s) to %s\n",
493 cname,caddr,lp_servicename(talloc_tos(), s));
499 done:
500 gfree_loadparm();
501 TALLOC_FREE(frame);
502 return ret;