param: add do_section to s3 helpers
[kai/samba-autobuild/.git] / lib / param / loadparm.h
1 /*
2    Unix SMB/CIFS implementation.
3
4    type definitions for loadparm
5
6    Copyright (C) Karl Auer 1993-1998
7
8    Largely re-written by Andrew Tridgell, September 1994
9
10    Copyright (C) Simo Sorce 2001
11    Copyright (C) Alexander Bokovoy 2002
12    Copyright (C) Stefan (metze) Metzmacher 2002
13    Copyright (C) Jim McDonough (jmcd@us.ibm.com)  2003.
14    Copyright (C) James Myers 2003 <myersjj@samba.org>
15
16    This program is free software; you can redistribute it and/or modify
17    it under the terms of the GNU General Public License as published by
18    the Free Software Foundation; either version 3 of the License, or
19    (at your option) any later version.
20
21    This program is distributed in the hope that it will be useful,
22    but WITHOUT ANY WARRANTY; without even the implied warranty of
23    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24    GNU General Public License for more details.
25
26    You should have received a copy of the GNU General Public License
27    along with this program.  If not, see <http://www.gnu.org/licenses/>.
28 */
29
30 #ifndef _LOADPARM_H
31 #define _LOADPARM_H
32
33 #include "../lib/util/parmlist.h"
34
35 /* the following are used by loadparm for option lists */
36 typedef enum {
37         P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
38         P_STRING,P_USTRING,P_ENUM,P_BYTES,P_CMDLIST,P_SEP
39 } parm_type;
40
41 typedef enum {
42         P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
43 } parm_class;
44
45 struct enum_list {
46         int value;
47         const char *name;
48 };
49
50 struct loadparm_service;
51 struct loadparm_context {
52         const char *szConfigFile;
53         struct loadparm_global *globals;
54         struct loadparm_service **services;
55         struct loadparm_service *sDefault;
56         struct smb_iconv_handle *iconv_handle;
57         int iNumServices;
58         struct loadparm_service *currentService;
59         bool bInGlobalSection;
60         struct file_lists *file_lists;
61         unsigned int *flags;
62         bool loaded;
63         bool refuse_free;
64         bool global; /* Is this the global context, which may set
65                       * global variables such as debug level etc? */
66         const struct loadparm_s3_helpers *s3_fns;
67 };
68
69 struct parm_struct {
70         const char *label;
71         parm_type type;
72         parm_class p_class;
73         offset_t offset;
74         bool (*special)(struct loadparm_context *lpcfg_ctx,
75                         int snum, const char *, char **);
76         const struct enum_list *enum_list;
77         unsigned flags;
78         union {
79                 bool bvalue;
80                 int ivalue;
81                 char *svalue;
82                 char cvalue;
83                 char **lvalue;
84         } def;
85 };
86
87 extern struct parm_struct parm_table[];
88
89 struct file_lists {
90         struct file_lists *next;
91         char *name;
92         char *subfname;
93         time_t modtime;
94 };
95
96 /* The following flags are used in SWAT */
97 #define FLAG_BASIC      0x0001 /* Display only in BASIC view */
98 #define FLAG_SHARE      0x0002 /* file sharing options */
99 #define FLAG_PRINT      0x0004 /* printing options */
100 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
101 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
102 #define FLAG_ADVANCED   0x0020 /* Parameters that will be visible in advanced view */
103 #define FLAG_DEVELOPER  0x0040 /* No longer used */
104 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
105 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
106 #define FLAG_META       0x8000 /* A meta directive - not a real parameter */
107 #define FLAG_CMDLINE    0x10000 /* option has been overridden */
108 #define FLAG_DEFAULT    0x20000 /* this option was a default */
109
110 /* This defines the section name in the configuration file that will
111    refer to the special "printers" service */
112 #ifndef PRINTERS_NAME
113 #define PRINTERS_NAME "printers"
114 #endif
115
116 /* This defines the section name in the configuration file that will
117    refer to the special "homes" service */
118 #ifndef HOMES_NAME
119 #define HOMES_NAME "homes"
120 #endif
121
122 /* This defines the section name in the configuration file that will contain */
123 /* global parameters - that is, parameters relating to the whole server, not */
124 /* just services. This name is then reserved, and may not be used as a       */
125 /* a service name. It will default to "global" if not defined here.          */
126 #ifndef GLOBAL_NAME
127 #define GLOBAL_NAME "global"
128 #define GLOBAL_NAME2 "globals"
129 #endif
130
131 /* The default workgroup - usually overridden in smb.conf */
132 #ifndef DEFAULT_WORKGROUP
133 #define DEFAULT_WORKGROUP "WORKGROUP"
134 #endif
135
136 /* types of configuration backends for loadparm */
137 #define CONFIG_BACKEND_FILE 0
138 #define CONFIG_BACKEND_REGISTRY 1
139
140 /*
141    Do you want session setups at user level security with a invalid
142    password to be rejected or allowed in as guest? WinNT rejects them
143    but it can be a pain as it means "net view" needs to use a password
144
145    You have 3 choices in the setting of map_to_guest:
146
147    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
148    are rejected. This is the default.
149
150    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
151    are rejected, unless the username does not exist, in which case it
152    is treated as a guest login
153
154    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
155    are treated as a guest login
156
157    Note that map_to_guest only has an effect in user or server
158    level security.
159 */
160
161 #define NEVER_MAP_TO_GUEST              0
162 #define MAP_TO_GUEST_ON_BAD_USER        1
163 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
164 #define MAP_TO_GUEST_ON_BAD_UID         3
165
166 /*
167  * This should be under the HAVE_KRB5 flag but since they're used
168  * in lp_kerberos_method(), they ned to be always available
169  * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
170  * so they remain accurate.
171  */
172
173 #define KERBEROS_VERIFY_SECRETS 0
174 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
175 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
176 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
177
178 /* ACL compatibility */
179 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
180
181 /* printing types */
182 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
183                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
184                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
185 #if defined(DEVELOPER) || defined(ENABLE_SELFTEST)
186 ,PRINT_TEST,PRINT_VLP
187 #endif /* DEVELOPER */
188 };
189
190
191
192
193 /* ads auth control flags */
194 #define ADS_AUTH_DISABLE_KERBEROS 0x0001
195 #define ADS_AUTH_NO_BIND          0x0002
196 #define ADS_AUTH_ANON_BIND        0x0004
197 #define ADS_AUTH_SIMPLE_BIND      0x0008
198 #define ADS_AUTH_ALLOW_NTLMSSP    0x0010
199 #define ADS_AUTH_SASL_SIGN        0x0020
200 #define ADS_AUTH_SASL_SEAL        0x0040
201 #define ADS_AUTH_SASL_FORCE       0x0080
202 #define ADS_AUTH_USER_CREDS       0x0100
203
204 /* DNS update settings */
205 enum dns_update_settings {DNS_UPDATE_OFF, DNS_UPDATE_ON, DNS_UPDATE_SIGNED};
206
207 /* LDAP SSL options */
208 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
209
210 /* LDAP PASSWD SYNC methods */
211 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
212
213 /* map readonly options */
214 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
215
216 /* case handling */
217 enum case_handling {CASE_LOWER,CASE_UPPER};
218
219 /*
220  * Default passwd chat script.
221  */
222 #ifndef DEFAULT_PASSWD_CHAT
223 #define DEFAULT_PASSWD_CHAT "*new*password* %n\\n *new*password* %n\\n *changed*"
224 #endif
225
226 /* Max number of jobs per print queue. */
227 #ifndef PRINT_MAX_JOBID
228 #define PRINT_MAX_JOBID 10000
229 #endif
230
231 /* the default guest account - allow override via CFLAGS */
232 #ifndef GUEST_ACCOUNT
233 #define GUEST_ACCOUNT "nobody"
234 #endif
235
236 /* SMB2 defaults */
237 #define DEFAULT_SMB2_MAX_READ (1024*1024)
238 #define DEFAULT_SMB2_MAX_WRITE (1024*1024)
239 #define DEFAULT_SMB2_MAX_TRANSACT (1024*1024)
240 #define DEFAULT_SMB2_MAX_CREDITS 8192
241
242 #define LOADPARM_EXTRA_LOCALS                                           \
243         bool valid;                                                     \
244         int usershare;                                                  \
245         struct timespec usershare_last_mod;                             \
246         int iMaxPrintJobs;                                              \
247         char *szCopy;                                                   \
248         char *szService;                                                \
249         char *szInclude;                                                \
250         bool bWidelinks;                                                \
251         bool bAvailable;                                                        \
252         struct parmlist_entry *param_opt;                               \
253         struct bitmap *copymap;                                         \
254         char dummy[3];          /* for alignment */
255
256 #include "lib/param/param_local.h"
257
258 #define LOADPARM_EXTRA_GLOBALS \
259         struct parmlist_entry *param_opt;                               \
260         char *realm_original;                                           \
261         int iminreceivefile;                                            \
262         char *szPrintcapname;                                           \
263         int CupsEncrypt;                                                \
264         int  iPreferredMaster;                                          \
265         char *szLdapMachineSuffix;                                      \
266         char *szLdapUserSuffix;                                         \
267         char *szLdapIdmapSuffix;                                        \
268         char *szLdapGroupSuffix;                                        \
269         char *szIdmapUID;                                               \
270         char *szIdmapGID;                                               \
271         char *szIdmapBackend;                                           \
272         int winbindMaxDomainConnections;                                \
273         int ismb2_max_credits;
274
275 const char* server_role_str(uint32_t role);
276 int lp_find_server_role(int server_role, int security, int domain_logons, int domain_master);
277 int lp_find_security(int server_role, int security);
278 bool lp_is_security_and_server_role_valid(int server_role, int security);
279
280 struct loadparm_global * get_globals(void);
281 char * lp_string(TALLOC_CTX *, const char *);
282 bool lp_string_set(char **, const char *);
283 int getservicebyname(const char *, struct loadparm_service *);
284 bool lp_include(struct loadparm_context *, int, const char *, char **);
285 void init_printer_values(TALLOC_CTX *, struct loadparm_service *);
286 bool lp_do_section(const char *pszSectionName, void *userdata);
287
288 int num_parameters(void);
289
290 #endif /* _LOADPARM_H */