libcli/security Remove 'always true' return from se_priv_put_all_privileges
[samba.git] / libcli / security / privileges.h
1 /*
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup
4    Copyright (C) Andrew Tridgell 1992-1997
5    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
6    Copyright (C) Paul Ashton 1997
7    Copyright (C) Simo Sorce 2003
8    Copyright (C) Gerald (Jerry) Carter 2005
9    Copyright (C) Andrew Bartlett 2010
10
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.
15
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.
20
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/>.
23 */
24
25 #ifndef PRIVILEGES_H
26 #define PRIVILEGES_H
27
28 #include "../librpc/gen_ndr/lsa.h"
29 #include "../librpc/gen_ndr/security.h"
30
31 /* common privilege bitmask defines */
32
33 #define SE_NONE                         0x0
34 #define SE_ALL_PRIVS                    (uint64_t)-1
35
36 /*
37  * These are used in Lsa replies (srv_lsa_nt.c)
38  */
39
40 typedef struct {
41         TALLOC_CTX *mem_ctx;
42         bool ext_ctx;
43         uint32_t count;
44         uint32_t control;
45         struct lsa_LUIDAttribute *set;
46 } PRIVILEGE_SET;
47
48 /*
49   return a privilege mask given a privilege id
50 */
51 uint64_t sec_privilege_mask(enum sec_privilege privilege);
52
53 /***************************************************************************
54  put all privileges into a mask
55 ****************************************************************************/
56
57 void se_priv_put_all_privileges(uint64_t *privilege_mask);
58
59 /*********************************************************************
60  Lookup the uint64_t value for a privilege name
61 *********************************************************************/
62
63 bool se_priv_from_name( const char *name, uint64_t *privilege_mask );
64
65 const char* get_privilege_dispname( const char *name );
66
67 /*******************************************************************
68  return the number of elements in the 'short' privlege array (traditional source3 behaviour)
69 *******************************************************************/
70
71 int num_privileges_in_short_list( void );
72
73 /****************************************************************************
74  Convert a LUID to a named string
75 ****************************************************************************/
76
77 bool se_priv_to_privilege_set( PRIVILEGE_SET *set, uint64_t privilege_mask );
78 bool privilege_set_to_se_priv( uint64_t *privilege_mask, struct lsa_PrivilegeSet *privset );
79
80 /*
81   map a privilege id to the wire string constant
82 */
83 const char *sec_privilege_name(enum sec_privilege privilege);
84
85 /*
86   map a privilege id to a privilege display name. Return NULL if not found
87
88   TODO: this should use language mappings
89 */
90 const char *sec_privilege_display_name(enum sec_privilege privilege, uint16_t *language);
91
92 /*
93   map a privilege name to a privilege id. Return -1 if not found
94 */
95 enum sec_privilege sec_privilege_id(const char *name);
96
97 /*
98   assist in walking the table of privileges - return the LUID (low 32 bits) by index
99 */
100 enum sec_privilege sec_privilege_from_index(int idx);
101
102 /*
103   assist in walking the table of privileges - return the string constant by index
104 */
105 const char *sec_privilege_name_from_index(int idx);
106
107 /*
108   return true if a security_token has a particular privilege bit set
109 */
110 bool security_token_has_privilege(const struct security_token *token, enum sec_privilege privilege);
111
112 /*
113   set a bit in the privilege mask
114 */
115 void security_token_set_privilege(struct security_token *token, enum sec_privilege privilege);
116
117 void security_token_debug_privileges(int dbg_lev, const struct security_token *token);
118
119 #endif /* PRIVILEGES_H */