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_ALL_PRIVS                    (uint64_t)-1
  34
  35 /*
  36  * These are used in Lsa replies (srv_lsa_nt.c)
  37  */
  38
  39 typedef struct {
  40         TALLOC_CTX *mem_ctx;
  41         bool ext_ctx;
  42         uint32_t count;
  43         uint32_t control;
  44         struct lsa_LUIDAttribute *set;
  45 } PRIVILEGE_SET;
  46
  47 const char* get_privilege_dispname( const char *name );
  48
  49 /*******************************************************************
  50  return the number of elements in the 'short' privlege array (traditional source3 behaviour)
  51 *******************************************************************/
  52
  53 int num_privileges_in_short_list( void );
  54
  55 /*
  56   map a privilege id to the wire string constant
  57 */
  58 const char *sec_privilege_name(enum sec_privilege privilege);
  59
  60 /*
  61   map a privilege id to a privilege display name. Return NULL if not found
  62
  63   TODO: this should use language mappings
  64 */
  65 const char *sec_privilege_display_name(enum sec_privilege privilege, uint16_t *language);
  66
  67 /*
  68   map a privilege name to a privilege id. Return -1 if not found
  69 */
  70 enum sec_privilege sec_privilege_id(const char *name);
  71
  72 /*
  73   map a 'right' name to it's bitmap value. Return 0 if not found
  74 */
  75 uint32_t sec_right_bit(const char *name);
  76
  77 /*
  78   assist in walking the table of privileges - return the LUID (low 32 bits) by index
  79 */
  80 enum sec_privilege sec_privilege_from_index(int idx);
  81
  82 /*
  83   assist in walking the table of privileges - return the string constant by index
  84 */
  85 const char *sec_privilege_name_from_index(int idx);
  86
  87 /*
  88   return true if a security_token has a particular privilege bit set
  89 */
  90 bool security_token_has_privilege(const struct security_token *token, enum sec_privilege privilege);
  91
  92
  93 /**
  94  * @brief Check if the security token has system privileges.
  95  *
  96  * @param[in]  token    The token to check.
  97  *
  98  * @return              True if the token has system privileges, false if not.
  99  */
 100 bool security_token_system_privilege(const struct security_token *token);
 101
 102 /*
 103   set a bit in the privilege mask
 104 */
 105 void security_token_set_privilege(struct security_token *token, enum sec_privilege privilege);
 106 /*
 107   set a bit in the rights mask
 108 */
 109 void security_token_set_right_bit(struct security_token *token, uint32_t right_bit);
 110
 111 void security_token_debug_privileges(int dbg_class, int dbg_lev, const struct security_token *token);
 112
 113 #endif /* PRIVILEGES_H */