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 /*
  67   return a privilege mask given a privilege id
  68 */
  69 uint64_t sec_privilege_mask(enum sec_privilege privilege);
  70
  71 /***************************************************************************
  72  copy an uint64_t structure
  73 ****************************************************************************/
  74
  75 bool se_priv_copy( uint64_t *dst, const uint64_t *src );
  76
  77 /***************************************************************************
  78  put all privileges into a mask
  79 ****************************************************************************/
  80
  81 bool se_priv_put_all_privileges(uint64_t *privilege_mask);
  82
  83 /*********************************************************************
  84  Lookup the uint64_t value for a privilege name
  85 *********************************************************************/
  86
  87 bool se_priv_from_name( const char *name, uint64_t *privilege_mask );
  88
  89 /****************************************************************************
  90  check if the privilege is in the privilege list
  91 ****************************************************************************/
  92
  93 bool is_privilege_assigned(const uint64_t *privileges,
  94                            const uint64_t *check);
  95
  96 const char* get_privilege_dispname( const char *name );
  97
  98 /****************************************************************************
  99  Does the user have the specified privilege ?  We only deal with one privilege
 100  at a time here.
 101 *****************************************************************************/
 102
 103 bool user_has_privileges(const struct security_token *token, const uint64_t *privilege_bit);
 104
 105 /****************************************************************************
 106  Does the user have any of the specified privileges ?  We only deal with one privilege
 107  at a time here.
 108 *****************************************************************************/
 109
 110 bool user_has_any_privilege(struct security_token *token, const uint64_t *privilege_mask);
 111
 112 /*******************************************************************
 113  return the number of elements in the 'short' privlege array (traditional source3 behaviour)
 114 *******************************************************************/
 115
 116 int num_privileges_in_short_list( void );
 117
 118 /****************************************************************************
 119  Convert a LUID to a named string
 120 ****************************************************************************/
 121
 122 bool se_priv_to_privilege_set( PRIVILEGE_SET *set, uint64_t privilege_mask );
 123 bool privilege_set_to_se_priv( uint64_t *privilege_mask, struct lsa_PrivilegeSet *privset );
 124
 125 /*
 126   map a privilege id to the wire string constant
 127 */
 128 const char *sec_privilege_name(enum sec_privilege privilege);
 129
 130 /*
 131   map a privilege id to a privilege display name. Return NULL if not found
 132
 133   TODO: this should use language mappings
 134 */
 135 const char *sec_privilege_display_name(enum sec_privilege privilege, uint16_t *language);
 136
 137 /*
 138   map a privilege name to a privilege id. Return -1 if not found
 139 */
 140 enum sec_privilege sec_privilege_id(const char *name);
 141
 142 /*
 143   map a privilege name to a privilege id. Return -1 if not found
 144 */
 145 enum sec_privilege sec_privilege_from_mask(uint64_t mask);
 146
 147 /*
 148   assist in walking the table of privileges - return the LUID (low 32 bits) by index
 149 */
 150 enum sec_privilege sec_privilege_from_index(int idx);
 151
 152 /*
 153   assist in walking the table of privileges - return the string constant by index
 154 */
 155 const char *sec_privilege_name_from_index(int idx);
 156
 157 /*
 158   return true if a security_token has a particular privilege bit set
 159 */
 160 bool security_token_has_privilege(const struct security_token *token, enum sec_privilege privilege);
 161
 162 /*
 163   set a bit in the privilege mask
 164 */
 165 void security_token_set_privilege(struct security_token *token, enum sec_privilege privilege);
 166
 167 void security_token_debug_privileges(int dbg_lev, const struct security_token *token);
 168
 169 #endif /* PRIVILEGES_H */