python:tests: Don’t needlessly create single‐element tuple
[Samba.git] / lib / param / util.c
blob8d862ad67689d5d0679ff47dd70b5c37dbc7918a
1 /*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Jeremy Allison 2001-2002
6 Copyright (C) Simo Sorce 2001
7 Copyright (C) Jim McDonough (jmcd@us.ibm.com) 2003.
8 Copyright (C) James J Myers 2003
9 Copyright (C) Jelmer Vernooij 2005-2007
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "includes.h"
26 #include "dynconfig/dynconfig.h"
27 #include "system/network.h"
28 #include "system/filesys.h"
29 #include "system/dir.h"
30 #include "param/param.h"
31 #include "libds/common/roles.h"
32 #include "tdb.h"
34 /**
35 * @file
36 * @brief Misc utility functions
40 bool lpcfg_is_mydomain(struct loadparm_context *lp_ctx,
41 const char *domain)
43 return strequal(lpcfg_workgroup(lp_ctx), domain);
46 bool lpcfg_is_my_domain_or_realm(struct loadparm_context *lp_ctx,
47 const char *domain)
49 return strequal(lpcfg_workgroup(lp_ctx), domain) ||
50 strequal(lpcfg_realm(lp_ctx), domain);
53 /**
54 see if a string matches either our primary or one of our secondary
55 netbios aliases. do a case insensitive match
57 bool lpcfg_is_myname(struct loadparm_context *lp_ctx, const char *name)
59 const char **aliases;
60 int i;
62 if (strcasecmp_m(name, lpcfg_netbios_name(lp_ctx)) == 0) {
63 return true;
66 aliases = lpcfg_netbios_aliases(lp_ctx);
67 for (i=0; aliases && aliases[i]; i++) {
68 if (strcasecmp_m(name, aliases[i]) == 0) {
69 return true;
73 return false;
76 static char *lpcfg_common_path(TALLOC_CTX* mem_ctx,
77 const char *parent,
78 const char *name)
80 char *fname, *dname;
81 bool ok;
83 if (name == NULL) {
84 return NULL;
86 if (name[0] == 0 || name[0] == '/' || strstr(name, ":/")) {
87 return talloc_strdup(mem_ctx, name);
90 dname = talloc_strdup(mem_ctx, parent);
91 if (dname == NULL) {
92 return NULL;
94 trim_string(dname,"","/");
96 ok = directory_create_or_exist(dname, 0755);
97 if (!ok) {
98 DEBUG(1, ("Unable to create directory %s for file %s. "
99 "Error was %s\n", dname, name, strerror(errno)));
100 return NULL;
103 fname = talloc_asprintf(mem_ctx, "%s/%s", dname, name);
104 if (fname == NULL) {
105 return dname;
107 talloc_free(dname);
109 return fname;
114 A useful function for returning a path in the Samba lock directory.
116 char *lpcfg_lock_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
117 const char *name)
119 return lpcfg_common_path(mem_ctx, lpcfg_lock_directory(lp_ctx), name);
123 A useful function for returning a path in the Samba state directory.
125 char *lpcfg_state_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
126 const char *name)
128 return lpcfg_common_path(mem_ctx, lpcfg_state_directory(lp_ctx), name);
132 A useful function for returning a path in the Samba cache directory.
134 char *lpcfg_cache_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
135 const char *name)
137 return lpcfg_common_path(mem_ctx, lpcfg_cache_directory(lp_ctx), name);
141 * @brief Returns an absolute path to a file in the directory containing the current config file
143 * @param name File to find, relative to the config file directory.
145 * @retval Pointer to a talloc'ed string containing the full path.
148 char *lpcfg_config_path(TALLOC_CTX* mem_ctx, struct loadparm_context *lp_ctx,
149 const char *name)
151 char *fname, *config_dir, *p;
152 config_dir = talloc_strdup(mem_ctx, lpcfg_configfile(lp_ctx));
153 if (config_dir == NULL) {
154 config_dir = talloc_strdup(mem_ctx, lp_default_path());
156 p = strrchr(config_dir, '/');
157 if (p == NULL) {
158 talloc_free(config_dir);
159 config_dir = talloc_strdup(mem_ctx, ".");
160 if (config_dir == NULL) {
161 return NULL;
163 } else {
164 p[0] = '\0';
166 fname = talloc_asprintf(mem_ctx, "%s/%s", config_dir, name);
167 talloc_free(config_dir);
168 return fname;
172 * @brief Returns an absolute path to a file in the Samba private directory.
174 * @param name File to find, relative to PRIVATEDIR.
175 * if name is not relative, then use it as-is
177 * @retval Pointer to a talloc'ed string containing the full path.
179 char *lpcfg_private_path(TALLOC_CTX* mem_ctx,
180 struct loadparm_context *lp_ctx,
181 const char *name)
183 char *fname;
184 if (name == NULL) {
185 return NULL;
187 if (name[0] == 0 || name[0] == '/' || strstr(name, ":/")) {
188 return talloc_strdup(mem_ctx, name);
190 fname = talloc_asprintf(mem_ctx, "%s/%s", lpcfg_private_dir(lp_ctx), name);
191 return fname;
195 * @brief Returns an absolute path to a NTDB or TDB file in the Samba
196 * private directory.
198 * @param name File to find, relative to PRIVATEDIR, without .tdb extension.
200 * @retval Pointer to a talloc'ed string containing the full path, for
201 * use with dbwrap_local_open().
203 char *lpcfg_private_db_path(TALLOC_CTX *mem_ctx,
204 struct loadparm_context *lp_ctx,
205 const char *name)
207 return talloc_asprintf(mem_ctx, "%s/%s.tdb",
208 lpcfg_private_dir(lp_ctx), name);
212 return a path in the smbd.tmp directory, where all temporary file
213 for smbd go. If NULL is passed for name then return the directory
214 path itself
216 char *smbd_tmp_path(TALLOC_CTX *mem_ctx,
217 struct loadparm_context *lp_ctx,
218 const char *name)
220 char *fname, *dname;
221 bool ok;
223 dname = lpcfg_private_path(mem_ctx, lp_ctx, "smbd.tmp");
224 if (dname == NULL) {
225 return NULL;
228 ok = directory_create_or_exist(dname, 0755);
229 if (!ok) {
230 return NULL;
233 if (name == NULL) {
234 return dname;
237 fname = talloc_asprintf(mem_ctx, "%s/%s", dname, name);
238 if (fname == NULL) {
239 return dname;
241 talloc_free(dname);
243 return fname;
246 const char *lpcfg_imessaging_path(TALLOC_CTX *mem_ctx,
247 struct loadparm_context *lp_ctx)
249 return smbd_tmp_path(mem_ctx, lp_ctx, "msg");
252 const char *lpcfg_sam_name(struct loadparm_context *lp_ctx)
254 switch (lpcfg_server_role(lp_ctx)) {
255 case ROLE_DOMAIN_BDC:
256 case ROLE_DOMAIN_PDC:
257 case ROLE_ACTIVE_DIRECTORY_DC:
258 case ROLE_IPA_DC:
259 return lpcfg_workgroup(lp_ctx);
260 default:
261 return lpcfg_netbios_name(lp_ctx);
265 const char *lpcfg_sam_dnsname(struct loadparm_context *lp_ctx)
267 switch (lpcfg_server_role(lp_ctx)) {
268 case ROLE_ACTIVE_DIRECTORY_DC:
269 case ROLE_IPA_DC:
270 return lpcfg_dnsdomain(lp_ctx);
271 default:
272 return NULL;
276 static int
277 tdb_fetch_lifetime_fn(TDB_DATA key, TDB_DATA data, void *private_data)
279 if (data.dsize < 256) {
280 long *result = private_data;
281 char tmp[data.dsize + 1];
282 memcpy(tmp, data.dptr, data.dsize);
283 tmp[data.dsize] = '\0';
284 *result = atol(tmp);
285 return 0;
287 return -1;
290 static long tdb_fetch_lifetime(struct tdb_context *tdb,
291 const char *keystr)
293 long result = -1;
294 int ret;
296 ret = tdb_parse_record(
297 tdb,
298 (TDB_DATA){
299 .dptr = discard_const_p(uint8_t, keystr),
300 .dsize = strlen(keystr),
302 tdb_fetch_lifetime_fn,
303 &result);
304 if (ret == -1) {
305 return -1;
307 return result;
310 void lpcfg_default_kdc_policy(TALLOC_CTX *mem_ctx,
311 struct loadparm_context *lp_ctx,
312 time_t *svc_tkt_lifetime,
313 time_t *usr_tkt_lifetime,
314 time_t *renewal_lifetime)
316 long val;
317 TDB_CONTEXT *ctx = NULL;
318 const char *kdc_tdb = NULL;
320 kdc_tdb = lpcfg_cache_path(mem_ctx, lp_ctx, "gpo.tdb");
321 if (kdc_tdb)
322 ctx = tdb_open(kdc_tdb, 0, TDB_DEFAULT, O_RDWR, 0600);
324 if (!ctx || ( val = tdb_fetch_lifetime(ctx, "kdc:service_ticket_lifetime") ) == -1 )
325 val = lpcfg_parm_long(lp_ctx, NULL, "kdc", "service ticket lifetime", 10);
326 *svc_tkt_lifetime = val * 60 * 60;
328 if (!ctx || ( val = tdb_fetch_lifetime(ctx, "kdc:user_ticket_lifetime") ) == -1 )
329 val = lpcfg_parm_long(lp_ctx, NULL, "kdc", "user ticket lifetime", 10);
330 *usr_tkt_lifetime = val * 60 * 60;
332 if (!ctx || ( val = tdb_fetch_lifetime(ctx, "kdc:renewal_lifetime") ) == -1 )
333 val = lpcfg_parm_long(lp_ctx, NULL, "kdc", "renewal lifetime", 24 * 7);
334 *renewal_lifetime = val * 60 * 60;
336 if (ctx != NULL) {
337 tdb_close(ctx);
338 ctx = NULL;