lib/util: new merged debug system
[Samba.git] / source3 / lib / privileges.c
blob00dfefebc1829d29f385ece01c0240e486329176
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 "dbwrap.h"
26 #include "libcli/security/privileges_private.h"
27 #include "../libcli/security/security.h"
29 #define PRIVPREFIX "PRIV_"
31 typedef struct {
32 uint32_t count;
33 struct dom_sid *list;
34 } SID_LIST;
36 typedef struct {
37 TALLOC_CTX *mem_ctx;
38 uint64_t privilege;
39 SID_LIST sids;
40 } PRIV_SID_LIST;
43 interpret an old style SE_PRIV structure
45 static uint64_t map_old_SE_PRIV(unsigned char *dptr)
47 uint32_t *old_masks = (uint32_t *)dptr;
49 * the old privileges code only ever used up to 0x800, except
50 * for a special case of 'SE_ALL_PRIVS' which was 0xFFFFFFFF
52 if (old_masks[0] == 0xFFFFFFFF) {
53 /* they set all privileges */
54 return SE_ALL_PRIVS;
57 /* the old code used the machine byte order, but we don't know
58 * the byte order of the machine that wrote it. However we can
59 * tell what byte order it was by taking advantage of the fact
60 * that it only ever use up to 0x800
62 if (dptr[0] || dptr[1]) {
63 /* it was little endian */
64 return IVAL(dptr, 0);
67 /* it was either zero or big-endian */
68 return RIVAL(dptr, 0);
72 static bool get_privileges( const struct dom_sid *sid, uint64_t *mask )
74 struct db_context *db = get_account_pol_db();
75 fstring tmp, keystr;
76 TDB_DATA data;
78 /* Fail if the admin has not enable privileges */
80 if ( !lp_enable_privileges() ) {
81 return False;
84 if ( db == NULL )
85 return False;
87 /* PRIV_<SID> (NULL terminated) as the key */
89 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, sid_to_fstring(tmp, sid));
91 data = dbwrap_fetch_bystring( db, talloc_tos(), keystr );
93 if ( !data.dptr ) {
94 DEBUG(3, ("get_privileges: No privileges assigned to SID "
95 "[%s]\n", sid_string_dbg(sid)));
96 return False;
99 if (data.dsize == 4*4) {
100 /* it's an old style SE_PRIV structure. */
101 *mask = map_old_SE_PRIV(data.dptr);
102 } else {
103 if (data.dsize != sizeof( uint64_t ) ) {
104 DEBUG(3, ("get_privileges: Invalid privileges record assigned to SID "
105 "[%s]\n", sid_string_dbg(sid)));
106 return False;
109 *mask = BVAL(data.dptr, 0);
112 TALLOC_FREE(data.dptr);
114 return True;
117 /***************************************************************************
118 Store the privilege mask (set) for a given SID
119 ****************************************************************************/
121 static bool set_privileges( const struct dom_sid *sid, uint64_t mask )
123 struct db_context *db = get_account_pol_db();
124 uint8_t privbuf[8];
125 fstring tmp, keystr;
126 TDB_DATA data;
128 if ( !lp_enable_privileges() )
129 return False;
131 if ( db == NULL )
132 return False;
134 if ( !sid || (sid->num_auths == 0) ) {
135 DEBUG(0,("set_privileges: Refusing to store empty SID!\n"));
136 return False;
139 /* PRIV_<SID> (NULL terminated) as the key */
141 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, sid_to_fstring(tmp, sid));
143 /* This writes the 64 bit bitmask out in little endian format */
144 SBVAL(privbuf,0,mask);
146 data.dptr = privbuf;
147 data.dsize = sizeof(privbuf);
149 return NT_STATUS_IS_OK(dbwrap_store_bystring(db, keystr, data,
150 TDB_REPLACE));
153 /*********************************************************************
154 get a list of all privileges for all sids in the list
155 *********************************************************************/
157 bool get_privileges_for_sids(uint64_t *privileges, struct dom_sid *slist, int scount)
159 uint64_t mask;
160 int i;
161 bool found = False;
163 *privileges = 0;
165 for ( i=0; i<scount; i++ ) {
166 /* don't add unless we actually have a privilege assigned */
168 if ( !get_privileges( &slist[i], &mask ) )
169 continue;
171 DEBUG(5,("get_privileges_for_sids: sid = %s\nPrivilege "
172 "set: 0x%llx\n", sid_string_dbg(&slist[i]),
173 (unsigned long long)mask));
175 *privileges |= mask;
176 found = True;
179 return found;
182 NTSTATUS get_privileges_for_sid_as_set(TALLOC_CTX *mem_ctx, PRIVILEGE_SET **privileges, struct dom_sid *sid)
184 uint64_t mask;
185 if (!get_privileges(sid, &mask)) {
186 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
189 *privileges = talloc_zero(mem_ctx, PRIVILEGE_SET);
190 if (!*privileges) {
191 return NT_STATUS_NO_MEMORY;
194 if (!se_priv_to_privilege_set(*privileges, mask)) {
195 return NT_STATUS_NO_MEMORY;
197 return NT_STATUS_OK;
200 /*********************************************************************
201 traversal functions for privilege_enumerate_accounts
202 *********************************************************************/
204 static int priv_traverse_fn(struct db_record *rec, void *state)
206 PRIV_SID_LIST *priv = (PRIV_SID_LIST *)state;
207 int prefixlen = strlen(PRIVPREFIX);
208 struct dom_sid sid;
209 fstring sid_string;
211 /* check we have a PRIV_+SID entry */
213 if ( strncmp((char *)rec->key.dptr, PRIVPREFIX, prefixlen) != 0)
214 return 0;
216 /* check to see if we are looking for a particular privilege */
218 fstrcpy( sid_string, (char *)&(rec->key.dptr[strlen(PRIVPREFIX)]) );
220 if (priv->privilege != 0) {
221 uint64_t mask;
223 if (rec->value.dsize == 4*4) {
224 mask = map_old_SE_PRIV(rec->value.dptr);
225 } else {
226 if (rec->value.dsize != sizeof( uint64_t ) ) {
227 DEBUG(3, ("get_privileges: Invalid privileges record assigned to SID "
228 "[%s]\n", sid_string));
229 return 0;
231 mask = BVAL(rec->value.dptr, 0);
234 /* if the SID does not have the specified privilege
235 then just return */
237 if ((mask & priv->privilege) == 0) {
238 return 0;
242 /* this is a last ditch safety check to preventing returning
243 and invalid SID (i've somehow run into this on development branches) */
245 if ( strcmp( "S-0-0", sid_string ) == 0 )
246 return 0;
248 if ( !string_to_sid(&sid, sid_string) ) {
249 DEBUG(0,("travsersal_fn_enum__acct: Could not convert SID [%s]\n",
250 sid_string));
251 return 0;
254 if (!NT_STATUS_IS_OK(add_sid_to_array(priv->mem_ctx, &sid,
255 &priv->sids.list,
256 &priv->sids.count)))
258 return 0;
261 return 0;
264 /*********************************************************************
265 Retreive list of privileged SIDs (for _lsa_enumerate_accounts()
266 *********************************************************************/
268 NTSTATUS privilege_enumerate_accounts(struct dom_sid **sids, int *num_sids)
270 struct db_context *db = get_account_pol_db();
271 PRIV_SID_LIST priv;
273 if (db == NULL) {
274 return NT_STATUS_ACCESS_DENIED;
277 ZERO_STRUCT(priv);
279 db->traverse_read(db, priv_traverse_fn, &priv);
281 /* give the memory away; caller will free */
283 *sids = priv.sids.list;
284 *num_sids = priv.sids.count;
286 return NT_STATUS_OK;
289 /*********************************************************************
290 Retrieve list of SIDs granted a particular privilege
291 *********************************************************************/
293 NTSTATUS privilege_enum_sids(enum sec_privilege privilege, TALLOC_CTX *mem_ctx,
294 struct dom_sid **sids, int *num_sids)
296 struct db_context *db = get_account_pol_db();
297 PRIV_SID_LIST priv;
299 if (db == NULL) {
300 return NT_STATUS_ACCESS_DENIED;
303 ZERO_STRUCT(priv);
305 priv.privilege = sec_privilege_mask(privilege);
306 priv.mem_ctx = mem_ctx;
308 db->traverse_read(db, priv_traverse_fn, &priv);
310 /* give the memory away; caller will free */
312 *sids = priv.sids.list;
313 *num_sids = priv.sids.count;
315 return NT_STATUS_OK;
318 /***************************************************************************
319 Add privilege to sid
320 ****************************************************************************/
322 static bool grant_privilege_bitmap(const struct dom_sid *sid, const uint64_t priv_mask)
324 uint64_t old_mask, new_mask;
326 ZERO_STRUCT( old_mask );
327 ZERO_STRUCT( new_mask );
329 if ( get_privileges( sid, &old_mask ) )
330 new_mask = old_mask;
331 else
332 new_mask = 0;
334 new_mask |= priv_mask;
336 DEBUG(10,("grant_privilege: %s\n", sid_string_dbg(sid)));
338 DEBUGADD( 10, ("original privilege mask: 0x%llx\n", (unsigned long long)new_mask));
340 DEBUGADD( 10, ("new privilege mask: 0x%llx\n", (unsigned long long)new_mask));
342 return set_privileges( sid, new_mask );
345 /*********************************************************************
346 Add a privilege based on its name
347 *********************************************************************/
349 bool grant_privilege_by_name(const struct dom_sid *sid, const char *name)
351 uint64_t mask;
353 if (! se_priv_from_name(name, &mask)) {
354 DEBUG(3, ("grant_privilege_by_name: "
355 "No Such Privilege Found (%s)\n", name));
356 return False;
359 return grant_privilege_bitmap( sid, mask );
362 /***************************************************************************
363 Grant a privilege set (list of LUID values) from a sid
364 ****************************************************************************/
366 bool grant_privilege_set(const struct dom_sid *sid, struct lsa_PrivilegeSet *set)
368 uint64_t privilege_mask;
369 if (!privilege_set_to_se_priv(&privilege_mask, set)) {
370 return false;
372 return grant_privilege_bitmap(sid, privilege_mask);
375 /***************************************************************************
376 Remove privilege from sid
377 ****************************************************************************/
379 static bool revoke_privilege_bitmap(const struct dom_sid *sid, const uint64_t priv_mask)
381 uint64_t mask;
383 /* if the user has no privileges, then we can't revoke any */
385 if ( !get_privileges( sid, &mask ) )
386 return True;
388 DEBUG(10,("revoke_privilege: %s\n", sid_string_dbg(sid)));
390 DEBUGADD( 10, ("original privilege mask: 0x%llx\n", (unsigned long long)mask));
392 mask &= ~priv_mask;
394 DEBUGADD( 10, ("new privilege mask: 0x%llx\n", (unsigned long long)mask));
396 return set_privileges( sid, mask );
399 /***************************************************************************
400 Remove a privilege set (list of LUID values) from a sid
401 ****************************************************************************/
403 bool revoke_privilege_set(const struct dom_sid *sid, struct lsa_PrivilegeSet *set)
405 uint64_t privilege_mask;
406 if (!privilege_set_to_se_priv(&privilege_mask, set)) {
407 return false;
409 return revoke_privilege_bitmap(sid, privilege_mask);
412 /*********************************************************************
413 Revoke all privileges
414 *********************************************************************/
416 bool revoke_all_privileges( const struct dom_sid *sid )
418 return revoke_privilege_bitmap( sid, SE_ALL_PRIVS);
421 /*********************************************************************
422 Add a privilege based on its name
423 *********************************************************************/
425 bool revoke_privilege_by_name(const struct dom_sid *sid, const char *name)
427 uint64_t mask;
429 if (! se_priv_from_name(name, &mask)) {
430 DEBUG(3, ("revoke_privilege_by_name: "
431 "No Such Privilege Found (%s)\n", name));
432 return False;
435 return revoke_privilege_bitmap(sid, mask);
439 /***************************************************************************
440 Retrieve the SIDs assigned to a given privilege
441 ****************************************************************************/
443 NTSTATUS privilege_create_account(const struct dom_sid *sid )
445 return ( grant_privilege_bitmap(sid, 0) ? NT_STATUS_OK : NT_STATUS_UNSUCCESSFUL);
448 /***************************************************************************
449 Delete a privileged account
450 ****************************************************************************/
452 NTSTATUS privilege_delete_account(const struct dom_sid *sid)
454 struct db_context *db = get_account_pol_db();
455 fstring tmp, keystr;
457 if (!lp_enable_privileges()) {
458 return NT_STATUS_OK;
461 if (!db) {
462 return NT_STATUS_INVALID_HANDLE;
465 if (!sid || (sid->num_auths == 0)) {
466 return NT_STATUS_INVALID_SID;
469 /* PRIV_<SID> (NULL terminated) as the key */
471 fstr_sprintf(keystr, "%s%s", PRIVPREFIX, sid_to_fstring(tmp, sid));
473 return dbwrap_delete_bystring(db, keystr);
476 /*******************************************************************
477 *******************************************************************/
479 bool is_privileged_sid( const struct dom_sid *sid )
481 uint64_t mask;
483 return get_privileges( sid, &mask );
486 /*******************************************************************
487 *******************************************************************/
489 bool grant_all_privileges( const struct dom_sid *sid )
491 uint64_t mask;
493 se_priv_put_all_privileges(&mask);
495 return grant_privilege_bitmap( sid, mask );