lib: Modernize (and fix) a DBG statement
[Samba.git] / source3 / lib / privileges.c
blob5e66222072b25e4f3b178ca20184826ce6fb17ce
1 /*
2 Unix SMB/CIFS implementation.
3 Privileges handling functions
4 Copyright (C) Jean François Micouleau 1998-2001
5 Copyright (C) Simo Sorce 2002-2003
6 Copyright (C) Gerald (Jerry) Carter 2005
7 Copyright (C) Michael Adam 2007
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 #include "includes.h"
25 #include "lib/privileges.h"
26 #include "dbwrap/dbwrap.h"
27 #include "libcli/security/privileges_private.h"
28 #include "../libcli/security/security.h"
29 #include "passdb.h"
30 #include "lib/util/string_wrappers.h"
32 #define PRIVPREFIX "PRIV_"
34 typedef struct {
35 uint32_t count;
36 struct dom_sid *list;
37 } SID_LIST;
39 typedef struct {
40 TALLOC_CTX *mem_ctx;
41 uint64_t privilege;
42 SID_LIST sids;
43 } PRIV_SID_LIST;
46 interpret an old style SE_PRIV structure
48 static uint64_t map_old_SE_PRIV(unsigned char *dptr)
50 uint32_t *old_masks = (uint32_t *)dptr;
52 * the old privileges code only ever used up to 0x800, except
53 * for a special case of 'SE_ALL_PRIVS' which was 0xFFFFFFFF
55 if (old_masks[0] == 0xFFFFFFFF) {
56 /* they set all privileges */
57 return SE_ALL_PRIVS;
60 /* the old code used the machine byte order, but we don't know
61 * the byte order of the machine that wrote it. However we can
62 * tell what byte order it was by taking advantage of the fact
63 * that it only ever use up to 0x800
65 if (dptr[0] || dptr[1]) {
66 /* it was little endian */
67 return IVAL(dptr, 0);
70 /* it was either zero or big-endian */
71 return RIVAL(dptr, 0);
75 static bool get_privileges( const struct dom_sid *sid, uint64_t *mask )
77 struct db_context *db = get_account_pol_db();
78 struct dom_sid_buf tmp;
79 fstring keystr;
80 TDB_DATA data;
81 NTSTATUS status;
83 /* Fail if the admin has not enable privileges */
85 if ( !lp_enable_privileges() ) {
86 return False;
89 if ( db == NULL )
90 return False;
92 /* PRIV_<SID> (NULL terminated) as the key */
94 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, dom_sid_str_buf(sid, &tmp));
96 status = dbwrap_fetch_bystring(db, talloc_tos(), keystr, &data);
98 if (!NT_STATUS_IS_OK(status)) {
99 DEBUG(4, ("get_privileges: No privileges assigned to SID "
100 "[%s]\n", tmp.buf));
101 return False;
104 if (data.dsize == 4*4) {
105 /* it's an old style SE_PRIV structure. */
106 *mask = map_old_SE_PRIV(data.dptr);
107 } else {
108 if (data.dsize != sizeof( uint64_t ) ) {
109 DEBUG(3, ("get_privileges: Invalid privileges record assigned to SID "
110 "[%s]\n", tmp.buf));
111 return False;
114 *mask = BVAL(data.dptr, 0);
117 TALLOC_FREE(data.dptr);
119 return True;
122 /***************************************************************************
123 Store the privilege mask (set) for a given SID
124 ****************************************************************************/
126 static bool set_privileges( const struct dom_sid *sid, uint64_t mask )
128 struct db_context *db = get_account_pol_db();
129 uint8_t privbuf[8];
130 struct dom_sid_buf tmp;
131 fstring keystr;
132 TDB_DATA data = { .dptr = privbuf, .dsize = sizeof(privbuf), };
134 if ( !lp_enable_privileges() )
135 return False;
137 if ( db == NULL )
138 return False;
140 if ( !sid || (sid->num_auths == 0) ) {
141 DEBUG(0,("set_privileges: Refusing to store empty SID!\n"));
142 return False;
145 /* PRIV_<SID> (NULL terminated) as the key */
147 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, dom_sid_str_buf(sid, &tmp));
149 /* This writes the 64 bit bitmask out in little endian format */
150 SBVAL(privbuf,0,mask);
152 return NT_STATUS_IS_OK(dbwrap_store_bystring(db, keystr, data,
153 TDB_REPLACE));
156 /*********************************************************************
157 get a list of all privileges for all sids in the list
158 *********************************************************************/
160 bool get_privileges_for_sids(uint64_t *privileges, struct dom_sid *slist, int scount)
162 uint64_t mask;
163 int i;
164 bool found = False;
166 *privileges = 0;
168 for ( i=0; i<scount; i++ ) {
169 struct dom_sid_buf buf;
171 /* don't add unless we actually have a privilege assigned */
173 if ( !get_privileges( &slist[i], &mask ) )
174 continue;
176 DBG_INFO("sid = %s\nPrivilege set: 0x%"PRIx64"\n",
177 dom_sid_str_buf(&slist[i], &buf),
178 mask);
180 *privileges |= mask;
181 found = True;
184 return found;
187 NTSTATUS get_privileges_for_sid_as_set(TALLOC_CTX *mem_ctx, PRIVILEGE_SET **privileges, struct dom_sid *sid)
189 uint64_t mask;
190 if (!get_privileges(sid, &mask)) {
191 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
194 *privileges = talloc_zero(mem_ctx, PRIVILEGE_SET);
195 if (!*privileges) {
196 return NT_STATUS_NO_MEMORY;
199 if (!se_priv_to_privilege_set(*privileges, mask)) {
200 return NT_STATUS_NO_MEMORY;
202 return NT_STATUS_OK;
205 /*********************************************************************
206 traversal functions for privilege_enumerate_accounts
207 *********************************************************************/
209 static int priv_traverse_fn(struct db_record *rec, void *state)
211 PRIV_SID_LIST *priv = (PRIV_SID_LIST *)state;
212 int prefixlen = strlen(PRIVPREFIX);
213 struct dom_sid sid;
214 fstring sid_string;
215 TDB_DATA key;
217 key = dbwrap_record_get_key(rec);
219 /* check we have a PRIV_+SID entry */
221 if (strncmp((char *)key.dptr, PRIVPREFIX, prefixlen) != 0)
222 return 0;
224 /* check to see if we are looking for a particular privilege */
226 fstrcpy( sid_string, (char *)&(key.dptr[strlen(PRIVPREFIX)]) );
228 if (priv->privilege != 0) {
229 uint64_t mask;
230 TDB_DATA value;
232 value = dbwrap_record_get_value(rec);
234 if (value.dsize == 4*4) {
235 mask = map_old_SE_PRIV(value.dptr);
236 } else {
237 if (value.dsize != sizeof( uint64_t ) ) {
238 DEBUG(3, ("get_privileges: Invalid privileges record assigned to SID "
239 "[%s]\n", sid_string));
240 return 0;
242 mask = BVAL(value.dptr, 0);
245 /* if the SID does not have the specified privilege
246 then just return */
248 if ((mask & priv->privilege) == 0) {
249 return 0;
253 /* this is a last ditch safety check to preventing returning
254 and invalid SID (i've somehow run into this on development branches) */
256 if ( strcmp( "S-0-0", sid_string ) == 0 )
257 return 0;
259 if ( !string_to_sid(&sid, sid_string) ) {
260 DBG_WARNING("Could not convert SID [%s]\n", sid_string);
261 return 0;
264 if (!NT_STATUS_IS_OK(add_sid_to_array(priv->mem_ctx, &sid,
265 &priv->sids.list,
266 &priv->sids.count)))
268 return 0;
271 return 0;
274 /*********************************************************************
275 Retrieve list of privileged SIDs (for _lsa_enumerate_accounts()
276 *********************************************************************/
278 NTSTATUS privilege_enumerate_accounts(struct dom_sid **sids, int *num_sids)
280 struct db_context *db = get_account_pol_db();
281 PRIV_SID_LIST priv;
282 NTSTATUS status;
284 if (db == NULL) {
285 return NT_STATUS_ACCESS_DENIED;
288 ZERO_STRUCT(priv);
290 status = dbwrap_traverse_read(db, priv_traverse_fn, &priv, NULL);
291 if (!NT_STATUS_IS_OK(status)) {
292 return status;
295 /* give the memory away; caller will free */
297 *sids = priv.sids.list;
298 *num_sids = priv.sids.count;
300 return NT_STATUS_OK;
303 /*********************************************************************
304 Retrieve list of SIDs granted a particular privilege
305 *********************************************************************/
307 NTSTATUS privilege_enum_sids(enum sec_privilege privilege, TALLOC_CTX *mem_ctx,
308 struct dom_sid **sids, int *num_sids)
310 struct db_context *db = get_account_pol_db();
311 PRIV_SID_LIST priv;
312 NTSTATUS status;
314 if (db == NULL) {
315 return NT_STATUS_ACCESS_DENIED;
318 ZERO_STRUCT(priv);
320 priv.privilege = sec_privilege_mask(privilege);
321 priv.mem_ctx = mem_ctx;
323 status = dbwrap_traverse_read(db, priv_traverse_fn, &priv, NULL);
324 if (!NT_STATUS_IS_OK(status)) {
325 return status;
328 /* give the memory away; caller will free */
330 *sids = priv.sids.list;
331 *num_sids = priv.sids.count;
333 return NT_STATUS_OK;
336 /***************************************************************************
337 Add privilege to sid
338 ****************************************************************************/
340 static bool grant_privilege_bitmap(const struct dom_sid *sid, const uint64_t priv_mask)
342 uint64_t old_mask, new_mask;
343 struct dom_sid_buf buf;
345 ZERO_STRUCT( old_mask );
346 ZERO_STRUCT( new_mask );
348 if ( get_privileges( sid, &old_mask ) )
349 new_mask = old_mask;
350 else
351 new_mask = 0;
353 new_mask |= priv_mask;
355 DBG_DEBUG("%s\n"
356 "original privilege mask: 0x%"PRIx64"\n"
357 "new privilege mask: 0x%"PRIx64"\n",
358 dom_sid_str_buf(sid, &buf),
359 old_mask,
360 new_mask);
362 return set_privileges( sid, new_mask );
365 /*********************************************************************
366 Add a privilege based on its name
367 *********************************************************************/
369 bool grant_privilege_by_name(const struct dom_sid *sid, const char *name)
371 uint64_t mask;
373 if (! se_priv_from_name(name, &mask)) {
374 DEBUG(3, ("grant_privilege_by_name: "
375 "No Such Privilege Found (%s)\n", name));
376 return False;
379 return grant_privilege_bitmap( sid, mask );
382 /***************************************************************************
383 Grant a privilege set (list of LUID values) from a sid
384 ****************************************************************************/
386 bool grant_privilege_set(const struct dom_sid *sid, struct lsa_PrivilegeSet *set)
388 uint64_t privilege_mask;
389 if (!privilege_set_to_se_priv(&privilege_mask, set)) {
390 return false;
392 return grant_privilege_bitmap(sid, privilege_mask);
395 /***************************************************************************
396 Remove privilege from sid
397 ****************************************************************************/
399 static bool revoke_privilege_bitmap(const struct dom_sid *sid, const uint64_t priv_mask)
401 uint64_t mask;
402 struct dom_sid_buf buf;
404 /* if the user has no privileges, then we can't revoke any */
406 if ( !get_privileges( sid, &mask ) )
407 return True;
409 DEBUG(10,("revoke_privilege: %s\n", dom_sid_str_buf(sid, &buf)));
411 DEBUGADD( 10, ("original privilege mask: 0x%llx\n", (unsigned long long)mask));
413 mask &= ~priv_mask;
415 DEBUGADD( 10, ("new privilege mask: 0x%llx\n", (unsigned long long)mask));
417 return set_privileges( sid, mask );
420 /***************************************************************************
421 Remove a privilege set (list of LUID values) from a sid
422 ****************************************************************************/
424 bool revoke_privilege_set(const struct dom_sid *sid, struct lsa_PrivilegeSet *set)
426 uint64_t privilege_mask;
427 if (!privilege_set_to_se_priv(&privilege_mask, set)) {
428 return false;
430 return revoke_privilege_bitmap(sid, privilege_mask);
433 /*********************************************************************
434 Revoke all privileges
435 *********************************************************************/
437 bool revoke_all_privileges( const struct dom_sid *sid )
439 return revoke_privilege_bitmap( sid, SE_ALL_PRIVS);
442 /*********************************************************************
443 Add a privilege based on its name
444 *********************************************************************/
446 bool revoke_privilege_by_name(const struct dom_sid *sid, const char *name)
448 uint64_t mask;
450 if (! se_priv_from_name(name, &mask)) {
451 DEBUG(3, ("revoke_privilege_by_name: "
452 "No Such Privilege Found (%s)\n", name));
453 return False;
456 return revoke_privilege_bitmap(sid, mask);
460 /***************************************************************************
461 Retrieve the SIDs assigned to a given privilege
462 ****************************************************************************/
464 NTSTATUS privilege_create_account(const struct dom_sid *sid )
466 return ( grant_privilege_bitmap(sid, 0) ? NT_STATUS_OK : NT_STATUS_UNSUCCESSFUL);
469 /***************************************************************************
470 Delete a privileged account
471 ****************************************************************************/
473 NTSTATUS privilege_delete_account(const struct dom_sid *sid)
475 struct db_context *db = get_account_pol_db();
476 struct dom_sid_buf tmp;
477 fstring keystr;
479 if (!lp_enable_privileges()) {
480 return NT_STATUS_OK;
483 if (!db) {
484 return NT_STATUS_INVALID_HANDLE;
487 if (!sid || (sid->num_auths == 0)) {
488 return NT_STATUS_INVALID_SID;
491 /* PRIV_<SID> (NULL terminated) as the key */
493 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, dom_sid_str_buf(sid, &tmp));
495 return dbwrap_delete_bystring(db, keystr);
498 /*******************************************************************
499 *******************************************************************/
501 bool is_privileged_sid( const struct dom_sid *sid )
503 uint64_t mask;
505 return get_privileges( sid, &mask );
508 /*******************************************************************
509 *******************************************************************/
511 bool grant_all_privileges( const struct dom_sid *sid )
513 uint64_t mask;
515 se_priv_put_all_privileges(&mask);
517 return grant_privilege_bitmap( sid, mask );