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 /* privilege bitmask */
  32
  33 /* common privilege defines */
  34
  35 #define SE_END                          0x0
  36 #define SE_NONE                         0x0
  37 #define SE_ALL_PRIVS                    (uint64_t)-1
  38
  39
  40 /* defined in lib/privilegs_basic.c */
  41
  42 extern const uint64_t se_priv_all;
  43
  44 extern const uint64_t se_priv_none;
  45 extern const uint64_t se_machine_account;
  46 extern const uint64_t se_print_operator;
  47 extern const uint64_t se_add_users;
  48 extern const uint64_t se_disk_operators;
  49 extern const uint64_t se_remote_shutdown;
  50 extern const uint64_t se_restore;
  51 extern const uint64_t se_take_ownership;
  52
  53
  54 /*
  55  * These are used in Lsa replies (srv_lsa_nt.c)
  56  */
  57
  58 typedef struct {
  59         TALLOC_CTX *mem_ctx;
  60         bool ext_ctx;
  61         uint32_t count;
  62         uint32_t control;
  63         struct lsa_LUIDAttribute *set;
  64 } PRIVILEGE_SET;
  65
  66 typedef struct {
  67         uint64_t privilege_mask;
  68         const char *name;
  69         const char *description;
  70         enum sec_privilege luid;
  71 } PRIVS;
  72
  73 /***************************************************************************
  74  copy an uint64_t structure
  75 ****************************************************************************/
  76
  77 bool se_priv_copy( uint64_t *dst, const uint64_t *src );
  78
  79 /***************************************************************************
  80  put all privileges into a mask
  81 ****************************************************************************/
  82
  83 bool se_priv_put_all_privileges(uint64_t *privilege_mask);
  84
  85 /***************************************************************************
  86  combine 2 uint64_t structures and store the resulting set in mew_mask
  87 ****************************************************************************/
  88
  89 void se_priv_add( uint64_t *privilege_mask, const uint64_t *addpriv );
  90
  91 /***************************************************************************
  92  remove one uint64_t sytucture from another and store the resulting set
  93  in mew_mask
  94 ****************************************************************************/
  95
  96 void se_priv_remove( uint64_t *privilege_mask, const uint64_t *removepriv );
  97
  98 /***************************************************************************
  99  check if 2 uint64_t structure are equal
 100 ****************************************************************************/
 101
 102 bool se_priv_equal( const uint64_t *privilege_mask1, const uint64_t *privilege_mask2 );
 103
 104 /*********************************************************************
 105  Lookup the uint64_t value for a privilege name
 106 *********************************************************************/
 107
 108 bool se_priv_from_name( const char *name, uint64_t *privilege_mask );
 109
 110 /***************************************************************************
 111  dump an uint64_t structure to the log files
 112 ****************************************************************************/
 113
 114 void dump_se_priv( int dbg_cl, int dbg_lvl, const uint64_t *privilege_mask );
 115
 116 /****************************************************************************
 117  check if the privilege is in the privilege list
 118 ****************************************************************************/
 119
 120 bool is_privilege_assigned(const uint64_t *privileges,
 121                            const uint64_t *check);
 122
 123 const char* get_privilege_dispname( const char *name );
 124
 125 /****************************************************************************
 126  Does the user have the specified privilege ?  We only deal with one privilege
 127  at a time here.
 128 *****************************************************************************/
 129
 130 bool user_has_privileges(const struct security_token *token, const uint64_t *privilege_bit);
 131
 132 /****************************************************************************
 133  Does the user have any of the specified privileges ?  We only deal with one privilege
 134  at a time here.
 135 *****************************************************************************/
 136
 137 bool user_has_any_privilege(struct security_token *token, const uint64_t *privilege_mask);
 138
 139 /*******************************************************************
 140  return the number of elements in the privlege array
 141 *******************************************************************/
 142
 143 int count_all_privileges( void );
 144
 145 /*********************************************************************
 146  Generate the struct lsa_LUIDAttribute structure based on a bitmask
 147  The assumption here is that the privilege has already been validated
 148  so we are guaranteed to find it in the list.
 149 *********************************************************************/
 150
 151 struct lsa_LUIDAttribute get_privilege_luid( uint64_t *privilege_mask );
 152 /****************************************************************************
 153  Convert a LUID to a named string
 154 ****************************************************************************/
 155
 156 const char *luid_to_privilege_name(const struct lsa_LUID *set);
 157
 158 bool se_priv_to_privilege_set( PRIVILEGE_SET *set, uint64_t *privilege_mask );
 159 bool privilege_set_to_se_priv( uint64_t *privilege_mask, struct lsa_PrivilegeSet *privset );
 160
 161 /*
 162   map a privilege id to the wire string constant
 163 */
 164 const char *sec_privilege_name(enum sec_privilege privilege);
 165
 166 /*
 167   map a privilege id to a privilege display name. Return NULL if not found
 168
 169   TODO: this should use language mappings
 170 */
 171 const char *sec_privilege_display_name(enum sec_privilege privilege, uint16_t *language);
 172
 173 /*
 174   map a privilege name to a privilege id. Return -1 if not found
 175 */
 176 enum sec_privilege sec_privilege_id(const char *name);
 177
 178 /*
 179   map a privilege name to a privilege id. Return -1 if not found
 180 */
 181 enum sec_privilege sec_privilege_from_mask(uint64_t mask);
 182
 183 /*
 184   map a privilege name to a privilege id. Return -1 if not found
 185 */
 186 enum sec_privilege sec_privilege_from_index(int idx);
 187
 188 /*
 189   return true if a security_token has a particular privilege bit set
 190 */
 191 bool security_token_has_privilege(const struct security_token *token, enum sec_privilege privilege);
 192
 193 /*
 194   set a bit in the privilege mask
 195 */
 196 void security_token_set_privilege(struct security_token *token, enum sec_privilege privilege);
 197
 198 void security_token_debug_privileges(int dbg_lev, const struct security_token *token);
 199
 200 #endif /* PRIVILEGES_H */