winsup/cygwin/security.h

   1 /* security.h: security declarations
   2
   3    Copyright 2000, 2001, 2002, 2003, 2004, 2005 Red Hat, Inc.
   4
   5 This file is part of Cygwin.
   6
   7 This software is a copyrighted work licensed under the terms of the
   8 Cygwin license.  Please consult the file "CYGWIN_LICENSE" for
   9 details. */
  10
  11 #ifndef _SECURITY_H
  12 #define _SECURITY_H
  13
  14 #include <accctrl.h>
  15
  16 #define DEFAULT_UID DOMAIN_USER_RID_ADMIN
  17 #define UNKNOWN_UID 400 /* Non conflicting number */
  18 #define UNKNOWN_GID 401
  19
  20 #define MAX_SID_LEN 40
  21 #define MAX_DACL_LEN(n) (sizeof (ACL) \
  22                    + (n) * (sizeof (ACCESS_ALLOWED_ACE) - sizeof (DWORD) + MAX_SID_LEN))
  23 #define ACL_DEFAULT_SIZE 3072
  24 #define NO_SID ((PSID)NULL)
  25
  26 /* Macro to define variable length SID structures */
  27 #define SID(name, comment, authority, count, rid...) \
  28 static NO_COPY struct  { \
  29   BYTE  Revision; \
  30   BYTE  SubAuthorityCount; \
  31   SID_IDENTIFIER_AUTHORITY IdentifierAuthority; \
  32   DWORD SubAuthority[count]; \
  33 } name##_struct = { SID_REVISION, count, {authority}, {rid}}; \
  34 cygpsid NO_COPY name = (PSID) &name##_struct;
  35
  36 #define FILE_READ_BITS   (FILE_READ_DATA | GENERIC_READ | GENERIC_ALL)
  37 #define FILE_WRITE_BITS  (FILE_WRITE_DATA | GENERIC_WRITE | GENERIC_ALL)
  38 #define FILE_EXEC_BITS   (FILE_EXECUTE | GENERIC_EXECUTE | GENERIC_ALL)
  39
  40 class cygpsid {
  41 protected:
  42   PSID psid;
  43 public:
  44   cygpsid () {}
  45   cygpsid (PSID nsid) { psid = nsid; }
  46   operator const PSID () { return psid; }
  47   const PSID operator= (PSID nsid) { return psid = nsid;}
  48   __uid32_t get_id (BOOL search_grp, int *type = NULL);
  49   int get_uid () { return get_id (FALSE); }
  50   int get_gid () { return get_id (TRUE); }
  51
  52   char *string (char *nsidstr) const;
  53
  54   bool operator== (const PSID nsid) const
  55     {
  56       if (!psid || !nsid)
  57         return nsid == psid;
  58       return EqualSid (psid, nsid);
  59     }
  60   bool operator!= (const PSID nsid) const
  61     { return !(*this == nsid); }
  62   bool operator== (const char *nsidstr) const;
  63   bool operator!= (const char *nsidstr) const
  64     { return !(*this == nsidstr); }
  65
  66   void debug_print (const char *prefix = NULL) const
  67     {
  68       char buf[256] __attribute__ ((unused));
  69       debug_printf ("%s %s", prefix ?: "", string (buf) ?: "NULL");
  70     }
  71 };
  72
  73 class cygsid : public cygpsid {
  74   char sbuf[MAX_SID_LEN];
  75
  76   const PSID getfromstr (const char *nsidstr);
  77   PSID get_sid (DWORD s, DWORD cnt, DWORD *r);
  78
  79   inline const PSID assign (const PSID nsid)
  80     {
  81       if (!nsid)
  82         psid = NO_SID;
  83       else
  84         {
  85           psid = (PSID) sbuf;
  86           CopySid (MAX_SID_LEN, psid, nsid);
  87         }
  88       return psid;
  89     }
  90
  91 public:
  92   inline operator const PSID () { return psid; }
  93
  94   inline const PSID operator= (cygsid &nsid)
  95     { return assign (nsid); }
  96   inline const PSID operator= (const PSID nsid)
  97     { return assign (nsid); }
  98   inline const PSID operator= (const char *nsidstr)
  99     { return getfromstr (nsidstr); }
 100
 101   inline cygsid () : cygpsid ((PSID) sbuf) {}
 102   inline cygsid (const PSID nsid) { *this = nsid; }
 103   inline cygsid (const char *nstrsid) { *this = nstrsid; }
 104
 105   inline PSID set () { return psid = (PSID) sbuf; }
 106
 107   BOOL getfrompw (const struct passwd *pw);
 108   BOOL getfromgr (const struct __group32 *gr);
 109 };
 110
 111 typedef enum { cygsidlist_empty, cygsidlist_alloc, cygsidlist_auto } cygsidlist_type;
 112 class cygsidlist {
 113   int maxcount;
 114 public:
 115   int count;
 116   cygsid *sids;
 117   cygsidlist_type type;
 118
 119   cygsidlist (cygsidlist_type t, int m)
 120     {
 121       type = t;
 122       count = 0;
 123       maxcount = m;
 124       if (t == cygsidlist_alloc)
 125         sids = alloc_sids (m);
 126       else
 127         sids = new cygsid [m];
 128     }
 129   ~cygsidlist () { if (type == cygsidlist_auto) delete [] sids; }
 130
 131   BOOL add (const PSID nsi) /* Only with auto for now */
 132     {
 133       if (count >= maxcount)
 134         {
 135           cygsid *tmp = new cygsid [ 2 * maxcount];
 136           if (!tmp)
 137             return FALSE;
 138           maxcount *= 2;
 139           for (int i = 0; i < count; ++i)
 140             tmp[i] = sids[i];
 141           delete [] sids;
 142           sids = tmp;
 143         }
 144       sids[count++] = nsi;
 145       return TRUE;
 146     }
 147   BOOL add (cygsid &nsi) { return add ((PSID) nsi); }
 148   BOOL add (const char *sidstr)
 149     { cygsid nsi (sidstr); return add (nsi); }
 150   BOOL addfromgr (struct __group32 *gr) /* Only with alloc */
 151     { return sids[count].getfromgr (gr)
 152              && (contains (sids[count]) || ++count); }
 153
 154   BOOL operator+= (cygsid &si) { return add (si); }
 155   BOOL operator+= (const char *sidstr) { return add (sidstr); }
 156   BOOL operator+= (const PSID psid) { return add (psid); }
 157
 158   int position (const PSID sid) const
 159     {
 160       for (int i = 0; i < count; ++i)
 161         if (sids[i] == sid)
 162           return i;
 163       return -1;
 164     }
 165
 166   BOOL contains (const PSID sid) const { return position (sid) >= 0; }
 167   cygsid *alloc_sids (int n);
 168   void free_sids ();
 169   void debug_print (const char *prefix = NULL) const
 170     {
 171       debug_printf ("-- begin sidlist ---");
 172       if (!count)
 173         debug_printf ("No elements");
 174       for (int i = 0; i < count; ++i)
 175         sids[i].debug_print (prefix);
 176       debug_printf ("-- ende sidlist ---");
 177     }
 178 };
 179
 180 /* Wrapper class to allow simple deleting of buffer space allocated
 181    by read_sd() */
 182 class security_descriptor {
 183 protected:
 184   PSECURITY_DESCRIPTOR psd;
 185   DWORD sd_size;
 186 public:
 187   security_descriptor () : psd (NULL), sd_size (0) {}
 188   ~security_descriptor () { free (); }
 189
 190   PSECURITY_DESCRIPTOR malloc (size_t nsize);
 191   PSECURITY_DESCRIPTOR realloc (size_t nsize);
 192   void free (void);
 193
 194   inline DWORD size (void) const { return sd_size; }
 195   inline operator const PSECURITY_DESCRIPTOR () { return psd; }
 196 };
 197
 198 class user_groups {
 199 public:
 200   cygsid pgsid;
 201   cygsidlist sgsids;
 202   BOOL ischanged;
 203
 204   BOOL issetgroups () const { return (sgsids.type == cygsidlist_alloc); }
 205   void update_supp (const cygsidlist &newsids)
 206     {
 207       sgsids.free_sids ();
 208       sgsids = newsids;
 209       ischanged = TRUE;
 210     }
 211   void clear_supp ()
 212     {
 213       if (issetgroups ())
 214         {
 215           sgsids.free_sids ();
 216           ischanged = TRUE;
 217         }
 218     }
 219   void update_pgrp (const PSID sid)
 220     {
 221       pgsid = sid;
 222       ischanged = TRUE;
 223     }
 224 };
 225
 226 extern cygpsid well_known_null_sid;
 227 extern cygpsid well_known_world_sid;
 228 extern cygpsid well_known_local_sid;
 229 extern cygpsid well_known_creator_owner_sid;
 230 extern cygpsid well_known_creator_group_sid;
 231 extern cygpsid well_known_dialup_sid;
 232 extern cygpsid well_known_network_sid;
 233 extern cygpsid well_known_batch_sid;
 234 extern cygpsid well_known_interactive_sid;
 235 extern cygpsid well_known_service_sid;
 236 extern cygpsid well_known_authenticated_users_sid;
 237 extern cygpsid well_known_system_sid;
 238 extern cygpsid well_known_admins_sid;
 239
 240 /* Order must be same as cygpriv in sec_helper.cc. */
 241 enum cygpriv_idx {
 242   SE_CREATE_TOKEN_PRIV = 0,
 243   SE_ASSIGNPRIMARYTOKEN_PRIV,
 244   SE_LOCK_MEMORY_PRIV,
 245   SE_INCREASE_QUOTA_PRIV,
 246   SE_UNSOLICITED_INPUT_PRIV,
 247   SE_MACHINE_ACCOUNT_PRIV,
 248   SE_TCB_PRIV,
 249   SE_SECURITY_PRIV,
 250   SE_TAKE_OWNERSHIP_PRIV,
 251   SE_LOAD_DRIVER_PRIV,
 252   SE_SYSTEM_PROFILE_PRIV,
 253   SE_SYSTEMTIME_PRIV,
 254   SE_PROF_SINGLE_PROCESS_PRIV,
 255   SE_INC_BASE_PRIORITY_PRIV,
 256   SE_CREATE_PAGEFILE_PRIV,
 257   SE_CREATE_PERMANENT_PRIV,
 258   SE_BACKUP_PRIV,
 259   SE_RESTORE_PRIV,
 260   SE_SHUTDOWN_PRIV,
 261   SE_DEBUG_PRIV,
 262   SE_AUDIT_PRIV,
 263   SE_SYSTEM_ENVIRONMENT_PRIV,
 264   SE_CHANGE_NOTIFY_PRIV,
 265   SE_REMOTE_SHUTDOWN_PRIV,
 266   SE_CREATE_GLOBAL_PRIV,
 267   SE_UNDOCK_PRIV,
 268   SE_MANAGE_VOLUME_PRIV,
 269   SE_IMPERSONATE_PRIV,
 270   SE_ENABLE_DELEGATION_PRIV,
 271   SE_SYNC_AGENT_PRIV,
 272
 273   SE_NUM_PRIVS
 274 };
 275
 276 const LUID *privilege_luid (enum cygpriv_idx idx);
 277 const LUID *privilege_luid_by_name (const char *pname);
 278 const char *privilege_name (enum cygpriv_idx idx);
 279
 280 inline BOOL
 281 legal_sid_type (SID_NAME_USE type)
 282 {
 283   return type == SidTypeUser  || type == SidTypeGroup
 284       || type == SidTypeAlias || type == SidTypeWellKnownGroup;
 285 }
 286
 287 extern bool allow_ntea;
 288 extern bool allow_ntsec;
 289 extern bool allow_smbntsec;
 290 extern bool allow_traverse;
 291
 292 /* File manipulation */
 293 int __stdcall get_file_attribute (int, HANDLE, const char *, mode_t *,
 294                                   __uid32_t * = NULL, __gid32_t * = NULL);
 295 int __stdcall set_file_attribute (bool, HANDLE, const char *, int);
 296 int __stdcall set_file_attribute (bool, HANDLE, const char *, __uid32_t, __gid32_t, int);
 297 int __stdcall get_nt_object_security (HANDLE, SE_OBJECT_TYPE,
 298                                       security_descriptor &);
 299 int __stdcall get_object_attribute (HANDLE handle, SE_OBJECT_TYPE object_type, mode_t *,
 300                                   __uid32_t * = NULL, __gid32_t * = NULL);
 301 LONG __stdcall read_sd (const char *file, security_descriptor &sd);
 302 LONG __stdcall write_sd (HANDLE fh, const char *file, security_descriptor &sd);
 303 bool __stdcall add_access_allowed_ace (PACL acl, int offset, DWORD attributes, PSID sid, size_t &len_add, DWORD inherit);
 304 bool __stdcall add_access_denied_ace (PACL acl, int offset, DWORD attributes, PSID sid, size_t &len_add, DWORD inherit);
 305 int __stdcall check_file_access (const char *, int);
 306
 307 void set_security_attribute (int attribute, PSECURITY_ATTRIBUTES psa,
 308                              security_descriptor &sd_buf);
 309
 310 bool get_sids_info (cygpsid, cygpsid, __uid32_t * , __gid32_t *);
 311
 312 /* sec_acl.cc */
 313 struct __acl32;
 314 extern "C" int aclsort32 (int, int, __acl32 *);
 315 extern "C" int acl32 (const char *, int, int, __acl32 *);
 316 int getacl (HANDLE, const char *, DWORD, int, __acl32 *);
 317 int setacl (HANDLE, const char *, int, __acl32 *);
 318
 319 struct _UNICODE_STRING;
 320 void __stdcall str2buf2uni (_UNICODE_STRING &, WCHAR *, const char *) __attribute__ ((regparm (3)));
 321 void __stdcall str2uni_cat (_UNICODE_STRING &, const char *) __attribute__ ((regparm (2)));
 322
 323 /* Try a subauthentication. */
 324 HANDLE subauth (struct passwd *pw);
 325 /* Try creating a token directly. */
 326 HANDLE create_token (cygsid &usersid, user_groups &groups, struct passwd * pw);
 327 /* Verify an existing token */
 328 bool verify_token (HANDLE token, cygsid &usersid, user_groups &groups, bool *pintern = NULL);
 329
 330 /* Extract U-domain\user field from passwd entry. */
 331 void extract_nt_dom_user (const struct passwd *pw, char *domain, char *user);
 332 /* Get default logonserver for a domain. */
 333 bool get_logon_server (const char * domain, char * server, WCHAR *wserver = NULL);
 334
 335 /* sec_helper.cc: Security helper functions. */
 336 int set_privilege (HANDLE token, enum cygpriv_idx privilege, bool enable);
 337 void set_cygwin_privileges (HANDLE token);
 338
 339 #define set_process_privilege(p,v) set_privilege (hProcImpToken, (p), (v))
 340
 341 #define _push_thread_privilege(_priv, _val, _check) { \
 342     HANDLE _token = NULL, _dup_token = NULL; \
 343     if (wincap.has_security ()) \
 344       { \
 345         _token = (cygheap->user.issetuid () && (_check)) \
 346                  ? cygheap->user.token () : hProcImpToken; \
 347         if (!DuplicateTokenEx (_token, MAXIMUM_ALLOWED, NULL, \
 348                                SecurityImpersonation, TokenImpersonation, \
 349                                &_dup_token)) \
 350           debug_printf ("DuplicateTokenEx: %E"); \
 351         else if (!ImpersonateLoggedOnUser (_dup_token)) \
 352           debug_printf ("ImpersonateLoggedOnUser: %E"); \
 353         else \
 354           set_privilege (_dup_token, (_priv), (_val)); \
 355       }
 356 #define push_thread_privilege(_priv, _val) _push_thread_privilege(_priv,_val,1)
 357 #define push_self_privilege(_priv, _val)   _push_thread_privilege(_priv,_val,0)
 358
 359 #define pop_thread_privilege() \
 360     if (_dup_token) \
 361       { \
 362         ImpersonateLoggedOnUser (_token); \
 363         CloseHandle (_dup_token); \
 364       } \
 365   }
 366 #define pop_self_privilege()               pop_thread_privilege()
 367
 368 /* shared.cc: */
 369 /* Retrieve a security descriptor that allows all access */
 370 SECURITY_DESCRIPTOR *__stdcall get_null_sd (void);
 371
 372 /* Various types of security attributes for use in Create* functions. */
 373 extern SECURITY_ATTRIBUTES sec_none, sec_none_nih, sec_all, sec_all_nih;
 374 extern SECURITY_ATTRIBUTES *__stdcall __sec_user (PVOID sa_buf, PSID sid1, PSID sid2,
 375                                                   DWORD access2, BOOL inherit)
 376   __attribute__ ((regparm (3)));
 377 extern bool sec_acl (PACL acl, bool original, bool admins, PSID sid1 = NO_SID,
 378                      PSID sid2 = NO_SID, DWORD access2 = 0);
 379
 380 int __stdcall NTReadEA (const char *file, const char *attrname, char *buf, int len);
 381 BOOL __stdcall NTWriteEA (const char *file, const char *attrname, const char *buf, int len);
 382
 383 extern inline SECURITY_ATTRIBUTES *
 384 sec_user_nih (char sa_buf[], PSID sid1 = NULL, PSID sid2 = NULL, DWORD access2 = 0)
 385 {
 386   return __sec_user (sa_buf, sid1, sid2, access2, FALSE);
 387 }
 388
 389 extern inline SECURITY_ATTRIBUTES *
 390 sec_user (char sa_buf[], PSID sid1 = NULL, PSID sid2 = NULL, DWORD access2 = 0)
 391 {
 392   return __sec_user (sa_buf, sid1, sid2, access2, TRUE);
 393 }
 394 #endif /*_SECURITY_H*/