winsup/cygwin/security.h

   1 /* security.h: security declarations
   2
   3    Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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 SD_MIN_SIZE (sizeof (SECURITY_DESCRIPTOR) + MAX_DACL_LEN (1))
  24 #define ACL_DEFAULT_SIZE 3072
  25 #define NO_SID ((PSID)NULL)
  26
  27 #ifndef SE_CREATE_TOKEN_PRIVILEGE
  28 #define SE_CREATE_TOKEN_PRIVILEGE            2UL
  29 #define SE_ASSIGNPRIMARYTOKEN_PRIVILEGE      3UL
  30 #define SE_LOCK_MEMORY_PRIVILEGE             4UL
  31 #define SE_INCREASE_QUOTA_PRIVILEGE          5UL
  32 #define SE_MACHINE_ACCOUNT_PRIVILEGE         6UL
  33 #define SE_TCB_PRIVILEGE                     7UL
  34 #define SE_SECURITY_PRIVILEGE                8UL
  35 #define SE_TAKE_OWNERSHIP_PRIVILEGE          9UL
  36 #define SE_LOAD_DRIVER_PRIVILEGE            10UL
  37 #define SE_SYSTEM_PROFILE_PRIVILEGE         11UL
  38 #define SE_SYSTEMTIME_PRIVILEGE             12UL
  39 #define SE_PROF_SINGLE_PROCESS_PRIVILEGE    13UL
  40 #define SE_INC_BASE_PRIORITY_PRIVILEGE      14UL
  41 #define SE_CREATE_PAGEFILE_PRIVILEGE        15UL
  42 #define SE_CREATE_PERMANENT_PRIVILEGE       16UL
  43 #define SE_BACKUP_PRIVILEGE                 17UL
  44 #define SE_RESTORE_PRIVILEGE                18UL
  45 #define SE_SHUTDOWN_PRIVILEGE               19UL
  46 #define SE_DEBUG_PRIVILEGE                  20UL
  47 #define SE_AUDIT_PRIVILEGE                  21UL
  48 #define SE_SYSTEM_ENVIRONMENT_PRIVILEGE     22UL
  49 #define SE_CHANGE_NOTIFY_PRIVILEGE          23UL
  50 #define SE_REMOTE_SHUTDOWN_PRIVILEGE        24UL
  51 /* Starting with Windows 2000 */
  52 #define SE_UNDOCK_PRIVILEGE                 25UL
  53 #define SE_SYNC_AGENT_PRIVILEGE             26UL
  54 #define SE_ENABLE_DELEGATION_PRIVILEGE      27UL
  55 #define SE_MANAGE_VOLUME_PRIVILEGE          28UL
  56 /* Starting with Windows 2000 SP4, XP SP2, 2003 Server */
  57 #define SE_IMPERSONATE_PRIVILEGE            29UL
  58 #define SE_CREATE_GLOBAL_PRIVILEGE          30UL
  59 /* Starting with Vista */
  60 #define SE_TRUSTED_CREDMAN_ACCESS_PRIVILEGE 31UL
  61 #define SE_RELABEL_PRIVILEGE                32UL
  62 #define SE_INCREASE_WORKING_SET_PRIVILEGE   33UL
  63 #define SE_TIME_ZONE_PRIVILEGE              34UL
  64 #define SE_CREATE_SYMBOLIC_LINK_PRIVILEGE   35UL
  65
  66 #define SE_MAX_WELL_KNOWN_PRIVILEGE SE_CREATE_SYMBOLIC_LINK_PRIVILEGE
  67
  68 #endif /* ! SE_CREATE_TOKEN_PRIVILEGE */
  69
  70 /* Added for debugging purposes. */
  71 typedef struct {
  72   BYTE  Revision;
  73   BYTE  SubAuthorityCount;
  74   SID_IDENTIFIER_AUTHORITY IdentifierAuthority;
  75   DWORD SubAuthority[8];
  76 } DBGSID, *PDBGSID;
  77
  78 /* Macro to define variable length SID structures */
  79 #define MKSID(name, comment, authority, count, rid...) \
  80 static NO_COPY struct  { \
  81   BYTE  Revision; \
  82   BYTE  SubAuthorityCount; \
  83   SID_IDENTIFIER_AUTHORITY IdentifierAuthority; \
  84   DWORD SubAuthority[count]; \
  85 } name##_struct = { SID_REVISION, count, {authority}, {rid}}; \
  86 cygpsid NO_COPY name = (PSID) &name##_struct;
  87
  88 #define FILE_READ_BITS   (FILE_READ_DATA | GENERIC_READ | GENERIC_ALL)
  89 #define FILE_WRITE_BITS  (FILE_WRITE_DATA | GENERIC_WRITE | GENERIC_ALL)
  90 #define FILE_EXEC_BITS   (FILE_EXECUTE | GENERIC_EXECUTE | GENERIC_ALL)
  91
  92 class cygpsid {
  93 protected:
  94   PSID psid;
  95 public:
  96   cygpsid () {}
  97   cygpsid (PSID nsid) { psid = nsid; }
  98   operator PSID () const { return psid; }
  99   const PSID operator= (PSID nsid) { return psid = nsid;}
 100   __uid32_t get_id (BOOL search_grp, int *type = NULL);
 101   int get_uid () { return get_id (FALSE); }
 102   int get_gid () { return get_id (TRUE); }
 103
 104   PWCHAR string (PWCHAR nsidstr) const;
 105   char *string (char *nsidstr) const;
 106
 107   bool operator== (const PSID nsid) const
 108     {
 109       if (!psid || !nsid)
 110         return nsid == psid;
 111       return EqualSid (psid, nsid);
 112     }
 113   bool operator!= (const PSID nsid) const
 114     { return !(*this == nsid); }
 115   bool operator== (const char *nsidstr) const;
 116   bool operator!= (const char *nsidstr) const
 117     { return !(*this == nsidstr); }
 118
 119   void debug_print (const char *prefix = NULL) const
 120     {
 121       char buf[256] __attribute__ ((unused));
 122       debug_printf ("%s %s", prefix ?: "", string (buf) ?: "NULL");
 123     }
 124 };
 125
 126 class cygsid : public cygpsid {
 127   char sbuf[MAX_SID_LEN];
 128   bool well_known_sid;
 129
 130   const PSID getfromstr (const char *nsidstr, bool well_known);
 131   PSID get_sid (DWORD s, DWORD cnt, DWORD *r, bool well_known);
 132
 133   inline const PSID assign (const PSID nsid, bool well_known)
 134     {
 135       if (!nsid)
 136         psid = NO_SID;
 137       else
 138         {
 139           psid = (PSID) sbuf;
 140           CopySid (MAX_SID_LEN, psid, nsid);
 141           well_known_sid = well_known;
 142         }
 143       return psid;
 144     }
 145
 146 public:
 147   inline operator const PSID () { return psid; }
 148   inline bool is_well_known_sid () { return well_known_sid; }
 149
 150   /* Both, = and *= are assignment operators.  = creates a "normal" SID,
 151      *= marks the SID as being a well-known SID.  This difference is
 152      important when creating a SID list for LSA authentication. */
 153   inline const PSID operator= (cygsid &nsid)
 154     { return assign (nsid, nsid.well_known_sid); }
 155   inline const PSID operator= (const PSID nsid)
 156     { return assign (nsid, false); }
 157   inline const PSID operator= (const char *nsidstr)
 158     { return getfromstr (nsidstr, false); }
 159   inline const PSID operator*= (cygsid &nsid)
 160     { return assign (nsid, true); }
 161   inline const PSID operator*= (const PSID nsid)
 162     { return assign (nsid, true); }
 163   inline const PSID operator*= (const char *nsidstr)
 164     { return getfromstr (nsidstr, true); }
 165
 166   inline cygsid () : cygpsid ((PSID) sbuf), well_known_sid (false) {}
 167   inline cygsid (const PSID nsid) { *this = nsid; }
 168   inline cygsid (const char *nstrsid) { *this = nstrsid; }
 169
 170   inline PSID set () { return psid = (PSID) sbuf; }
 171
 172   BOOL getfrompw (const struct passwd *pw);
 173   BOOL getfromgr (const struct __group32 *gr);
 174
 175   void debug_print (const char *prefix = NULL) const
 176     {
 177       char buf[256] __attribute__ ((unused));
 178       debug_printf ("%s %s%s", prefix ?: "", string (buf) ?: "NULL", well_known_sid ? " (*)" : " (+)");
 179     }
 180 };
 181
 182 typedef enum { cygsidlist_empty, cygsidlist_alloc, cygsidlist_auto } cygsidlist_type;
 183 class cygsidlist {
 184   int maxcnt;
 185   int cnt;
 186
 187   BOOL add (const PSID nsi, bool well_known); /* Only with auto for now */
 188
 189 public:
 190   cygsid *sids;
 191   cygsidlist_type type;
 192
 193   cygsidlist (cygsidlist_type t, int m)
 194   : maxcnt (m), cnt (0), type (t)
 195     {
 196       if (t == cygsidlist_alloc)
 197         sids = alloc_sids (m);
 198       else
 199         sids = new cygsid [m];
 200     }
 201   ~cygsidlist () { if (type == cygsidlist_auto) delete [] sids; }
 202
 203   BOOL addfromgr (struct __group32 *gr) /* Only with alloc */
 204     { return sids[cnt].getfromgr (gr) && ++cnt; }
 205
 206   /* += adds a "normal" SID, *= adds a well-known SID.  See comment in class
 207      cygsid above. */
 208   BOOL operator+= (cygsid &si) { return add ((PSID) si, false); }
 209   BOOL operator+= (const char *sidstr) { cygsid nsi (sidstr);
 210                                          return add ((PSID) nsi, false); }
 211   BOOL operator+= (const PSID psid) { return add (psid, false); }
 212   BOOL operator*= (cygsid &si) { return add ((PSID) si, true); }
 213   BOOL operator*= (const char *sidstr) { cygsid nsi (sidstr);
 214                                          return add ((PSID) nsi, true); }
 215   BOOL operator*= (const PSID psid) { return add (psid, true); }
 216
 217   void count (int ncnt)
 218     { cnt = ncnt; }
 219   int count () const { return cnt; }
 220   int non_well_known_count () const
 221     {
 222       int wcnt = 0;
 223       for (int i = 0; i < cnt; ++i)
 224         if (!sids[i].is_well_known_sid ())
 225           ++wcnt;
 226       return wcnt;
 227     }
 228
 229   int position (const PSID sid) const
 230     {
 231       for (int i = 0; i < cnt; ++i)
 232         if (sids[i] == sid)
 233           return i;
 234       return -1;
 235     }
 236
 237   int next_non_well_known_sid (int idx)
 238     {
 239       while (++idx < cnt)
 240         if (!sids[idx].is_well_known_sid ())
 241           return idx;
 242       return -1;
 243     }
 244   BOOL contains (const PSID sid) const { return position (sid) >= 0; }
 245   cygsid *alloc_sids (int n);
 246   void free_sids ();
 247   void debug_print (const char *prefix = NULL) const
 248     {
 249       debug_printf ("-- begin sidlist ---");
 250       if (!cnt)
 251         debug_printf ("No elements");
 252       for (int i = 0; i < cnt; ++i)
 253         sids[i].debug_print (prefix);
 254       debug_printf ("-- ende sidlist ---");
 255     }
 256 };
 257
 258 /* Wrapper class to allow simple deleting of buffer space allocated
 259    by read_sd() */
 260 class security_descriptor {
 261 protected:
 262   PSECURITY_DESCRIPTOR psd;
 263   DWORD sd_size;
 264 public:
 265   security_descriptor () : psd (NULL), sd_size (0) {}
 266   ~security_descriptor () { free (); }
 267
 268   PSECURITY_DESCRIPTOR malloc (size_t nsize);
 269   PSECURITY_DESCRIPTOR realloc (size_t nsize);
 270   void free ();
 271
 272   inline DWORD size () const { return sd_size; }
 273   inline DWORD copy (void *buf, DWORD buf_size) const {
 274     if (buf_size < size ())
 275       return sd_size;
 276     memcpy (buf, psd, sd_size);
 277     return 0;
 278   }
 279   inline operator const PSECURITY_DESCRIPTOR () { return psd; }
 280   inline operator PSECURITY_DESCRIPTOR *() { return &psd; }
 281 };
 282
 283 class user_groups {
 284 public:
 285   cygsid pgsid;
 286   cygsidlist sgsids;
 287   BOOL ischanged;
 288
 289   BOOL issetgroups () const { return (sgsids.type == cygsidlist_alloc); }
 290   void update_supp (const cygsidlist &newsids)
 291     {
 292       sgsids.free_sids ();
 293       sgsids = newsids;
 294       ischanged = TRUE;
 295     }
 296   void clear_supp ()
 297     {
 298       if (issetgroups ())
 299         {
 300           sgsids.free_sids ();
 301           ischanged = TRUE;
 302         }
 303     }
 304   void update_pgrp (const PSID sid)
 305     {
 306       pgsid = sid;
 307       ischanged = TRUE;
 308     }
 309 };
 310
 311 extern cygpsid well_known_null_sid;
 312 extern cygpsid well_known_world_sid;
 313 extern cygpsid well_known_local_sid;
 314 extern cygpsid well_known_creator_owner_sid;
 315 extern cygpsid well_known_creator_group_sid;
 316 extern cygpsid well_known_dialup_sid;
 317 extern cygpsid well_known_network_sid;
 318 extern cygpsid well_known_batch_sid;
 319 extern cygpsid well_known_interactive_sid;
 320 extern cygpsid well_known_service_sid;
 321 extern cygpsid well_known_authenticated_users_sid;
 322 extern cygpsid well_known_this_org_sid;
 323 extern cygpsid well_known_system_sid;
 324 extern cygpsid well_known_admins_sid;
 325 extern cygpsid fake_logon_sid;
 326 extern cygpsid mandatory_medium_integrity_sid;
 327 extern cygpsid mandatory_high_integrity_sid;
 328 extern cygpsid mandatory_system_integrity_sid;
 329
 330 bool privilege_luid (const PWCHAR pname, LUID *luid);
 331
 332 inline BOOL
 333 legal_sid_type (SID_NAME_USE type)
 334 {
 335   return type == SidTypeUser  || type == SidTypeGroup
 336       || type == SidTypeAlias || type == SidTypeWellKnownGroup;
 337 }
 338
 339 /* File manipulation */
 340 int __stdcall get_file_attribute (HANDLE, path_conv &, mode_t *,
 341                                   __uid32_t *, __gid32_t *);
 342 int __stdcall set_file_attribute (HANDLE, path_conv &,
 343                                   __uid32_t, __gid32_t, int);
 344 int __stdcall get_reg_attribute (HKEY hkey, mode_t *, __uid32_t *, __gid32_t *);
 345 LONG __stdcall get_file_sd (HANDLE fh, path_conv &, security_descriptor &sd);
 346 LONG __stdcall set_file_sd (HANDLE fh, path_conv &, security_descriptor &sd);
 347 bool __stdcall add_access_allowed_ace (PACL acl, int offset, DWORD attributes, PSID sid, size_t &len_add, DWORD inherit);
 348 bool __stdcall add_access_denied_ace (PACL acl, int offset, DWORD attributes, PSID sid, size_t &len_add, DWORD inherit);
 349 int __stdcall check_file_access (path_conv &, int);
 350 int __stdcall check_registry_access (HANDLE, int);
 351
 352 void set_security_attribute (path_conv &pc, int attribute,
 353                              PSECURITY_ATTRIBUTES psa,
 354                              security_descriptor &sd_buf);
 355
 356 bool get_sids_info (cygpsid, cygpsid, __uid32_t * , __gid32_t *);
 357
 358 /* sec_acl.cc */
 359 struct __acl32;
 360 extern "C" int aclsort32 (int, int, __acl32 *);
 361 extern "C" int acl32 (const char *, int, int, __acl32 *);
 362 int getacl (HANDLE, path_conv &, int, __acl32 *);
 363 int setacl (HANDLE, path_conv &, int, __acl32 *, bool &);
 364
 365 struct _UNICODE_STRING;
 366 void __stdcall str2buf2uni (_UNICODE_STRING &, WCHAR *, const char *) __attribute__ ((regparm (3)));
 367 void __stdcall str2uni_cat (_UNICODE_STRING &, const char *) __attribute__ ((regparm (2)));
 368
 369 /* Function creating a token by calling NtCreateToken. */
 370 HANDLE create_token (cygsid &usersid, user_groups &groups, struct passwd * pw);
 371 /* LSA authentication function. */
 372 HANDLE lsaauth (cygsid &, user_groups &, struct passwd *);
 373 /* LSA private key storage authentication, same as when using service logons. */
 374 HANDLE lsaprivkeyauth (struct passwd *pw);
 375 /* Verify an existing token */
 376 bool verify_token (HANDLE token, cygsid &usersid, user_groups &groups, bool *pintern = NULL);
 377 /* Get groups of a user */
 378 bool get_server_groups (cygsidlist &grp_list, PSID usersid, struct passwd *pw);
 379
 380 /* Extract U-domain\user field from passwd entry. */
 381 void extract_nt_dom_user (const struct passwd *pw, PWCHAR domain, PWCHAR user);
 382 /* Get default logonserver for a domain. */
 383 bool get_logon_server (PWCHAR domain, PWCHAR wserver, bool rediscovery);
 384
 385 HANDLE open_local_policy (ACCESS_MASK access);
 386
 387 /* sec_helper.cc: Security helper functions. */
 388 int set_privilege (HANDLE token, DWORD privilege, bool enable);
 389 void set_cygwin_privileges (HANDLE token);
 390
 391 #define _push_thread_privilege(_priv, _val, _check) { \
 392     HANDLE _dup_token = NULL; \
 393     HANDLE _token = (cygheap->user.issetuid () && (_check)) \
 394                     ? cygheap->user.primary_token () : hProcToken; \
 395     if (!DuplicateTokenEx (_token, MAXIMUM_ALLOWED, NULL, \
 396                            SecurityImpersonation, TokenImpersonation, \
 397                            &_dup_token)) \
 398       debug_printf ("DuplicateTokenEx: %E"); \
 399     else if (!ImpersonateLoggedOnUser (_dup_token)) \
 400       debug_printf ("ImpersonateLoggedOnUser: %E"); \
 401     else \
 402       set_privilege (_dup_token, (_priv), (_val));
 403
 404 #define push_thread_privilege(_priv, _val) _push_thread_privilege(_priv,_val,1)
 405 #define push_self_privilege(_priv, _val)   _push_thread_privilege(_priv,_val,0)
 406
 407 #define pop_thread_privilege() \
 408     if (_dup_token) \
 409       { \
 410         if (!cygheap->user.issetuid ()) \
 411           RevertToSelf (); \
 412         else \
 413           cygheap->user.reimpersonate (); \
 414         CloseHandle (_dup_token); \
 415       } \
 416   }
 417
 418 #define pop_self_privilege()               pop_thread_privilege()
 419
 420 /* shared.cc: */
 421 /* Retrieve a security descriptor that allows all access */
 422 SECURITY_DESCRIPTOR *__stdcall get_null_sd ();
 423
 424 /* Various types of security attributes for use in Create* functions. */
 425 extern SECURITY_ATTRIBUTES sec_none, sec_none_nih, sec_all, sec_all_nih;
 426 extern SECURITY_ATTRIBUTES *__stdcall __sec_user (PVOID sa_buf, PSID sid1, PSID sid2,
 427                                                   DWORD access2, BOOL inherit)
 428   __attribute__ ((regparm (3)));
 429 extern PSECURITY_DESCRIPTOR _everyone_sd (void *buf, ACCESS_MASK access);
 430 #define everyone_sd(access)     (_everyone_sd (alloca (SD_MIN_SIZE), (access)))
 431
 432 extern bool sec_acl (PACL acl, bool original, bool admins, PSID sid1 = NO_SID,
 433                      PSID sid2 = NO_SID, DWORD access2 = 0);
 434
 435 ssize_t __stdcall read_ea (HANDLE hdl, path_conv &pc, const char *name,
 436                            char *value, size_t size);
 437 int __stdcall write_ea (HANDLE hdl, path_conv &pc, const char *name,
 438                         const char *value, size_t size, int flags);
 439
 440 /* Note: sid1 is usually (read: currently always) the current user's
 441    effective sid (cygheap->user.sid ()). */
 442 extern inline SECURITY_ATTRIBUTES *
 443 sec_user_nih (SECURITY_ATTRIBUTES *sa_buf, PSID sid1, PSID sid2 = NULL,
 444               DWORD access2 = 0)
 445 {
 446   return __sec_user (sa_buf, sid1, sid2, access2, FALSE);
 447 }
 448
 449 extern inline SECURITY_ATTRIBUTES *
 450 sec_user (SECURITY_ATTRIBUTES *sa_buf, PSID sid1, PSID sid2 = NULL,
 451           DWORD access2 = 0)
 452 {
 453   return __sec_user (sa_buf, sid1, sid2, access2, TRUE);
 454 }
 455 #endif /*_SECURITY_H*/