libcli/security/dom_sid.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4
   5    Copyright (C) Stefan (metze) Metzmacher      2002-2004
   6    Copyright (C) Andrew Tridgell                1992-2004
   7    Copyright (C) Jeremy Allison                 1999
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _DOM_SID_H_
  24 #define _DOM_SID_H_
  25
  26 #include "replace.h"
  27 #include <talloc.h>
  28 #include "lib/util/data_blob.h"
  29 #include "librpc/gen_ndr/security.h"
  30
  31 /* Some well-known SIDs */
  32 extern const struct dom_sid global_sid_World_Domain;
  33 extern const struct dom_sid global_sid_World;
  34 extern const struct dom_sid global_sid_Local_Authority;
  35 extern const struct dom_sid global_sid_Creator_Owner_Domain;
  36 extern const struct dom_sid global_sid_NT_Authority;
  37 extern const struct dom_sid global_sid_Enterprise_DCs;
  38 extern const struct dom_sid global_sid_System;
  39 extern const struct dom_sid global_sid_NULL;
  40 extern const struct dom_sid global_sid_Authenticated_Users;
  41 extern const struct dom_sid global_sid_Network;
  42 extern const struct dom_sid global_sid_Asserted_Identity;
  43 extern const struct dom_sid global_sid_Asserted_Identity_Service;
  44 extern const struct dom_sid global_sid_Asserted_Identity_Authentication_Authority;
  45 extern const struct dom_sid global_sid_Creator_Owner;
  46 extern const struct dom_sid global_sid_Creator_Group;
  47 extern const struct dom_sid global_sid_Owner_Rights;
  48 extern const struct dom_sid global_sid_Anonymous;
  49 extern const struct dom_sid global_sid_Builtin;
  50 extern const struct dom_sid global_sid_Builtin_Administrators;
  51 extern const struct dom_sid global_sid_Builtin_Users;
  52 extern const struct dom_sid global_sid_Builtin_Guests;
  53 extern const struct dom_sid global_sid_Builtin_Power_Users;
  54 extern const struct dom_sid global_sid_Builtin_Account_Operators;
  55 extern const struct dom_sid global_sid_Builtin_Server_Operators;
  56 extern const struct dom_sid global_sid_Builtin_Print_Operators;
  57 extern const struct dom_sid global_sid_Builtin_Backup_Operators;
  58 extern const struct dom_sid global_sid_Builtin_Replicator;
  59 extern const struct dom_sid global_sid_Builtin_PreWin2kAccess;
  60 extern const struct dom_sid global_sid_Unix_Users;
  61 extern const struct dom_sid global_sid_Unix_Groups;
  62 extern const struct dom_sid global_sid_Unix_NFS;
  63 extern const struct dom_sid global_sid_Unix_NFS_Users;
  64 extern const struct dom_sid global_sid_Unix_NFS_Groups;
  65 extern const struct dom_sid global_sid_Unix_NFS_Mode;
  66 extern const struct dom_sid global_sid_Unix_NFS_Other;
  67 extern const struct dom_sid global_sid_Samba_SMB3;
  68
  69 enum lsa_SidType;
  70
  71 NTSTATUS dom_sid_lookup_predefined_name(const char *name,
  72                                         const struct dom_sid **sid,
  73                                         enum lsa_SidType *type,
  74                                         const struct dom_sid **authority_sid,
  75                                         const char **authority_name);
  76 NTSTATUS dom_sid_lookup_predefined_sid(const struct dom_sid *sid,
  77                                        const char **name,
  78                                        enum lsa_SidType *type,
  79                                        const struct dom_sid **authority_sid,
  80                                        const char **authority_name);
  81 bool dom_sid_lookup_is_predefined_domain(const char *domain);
  82
  83 int dom_sid_compare_auth(const struct dom_sid *sid1,
  84                          const struct dom_sid *sid2);
  85 int dom_sid_compare(const struct dom_sid *sid1, const struct dom_sid *sid2);
  86 int dom_sid_compare_domain(const struct dom_sid *sid1,
  87                            const struct dom_sid *sid2);
  88 bool dom_sid_equal(const struct dom_sid *sid1, const struct dom_sid *sid2);
  89 bool sid_append_rid(struct dom_sid *sid, uint32_t rid);
  90 bool string_to_sid(struct dom_sid *sidout, const char *sidstr);
  91 bool dom_sid_parse_endp(const char *sidstr,struct dom_sid *sidout,
  92                         const char **endp);
  93 bool dom_sid_parse(const char *sidstr, struct dom_sid *ret);
  94 struct dom_sid *dom_sid_parse_talloc(TALLOC_CTX *mem_ctx, const char *sidstr);
  95 struct dom_sid *dom_sid_parse_length(TALLOC_CTX *mem_ctx, const DATA_BLOB *sid);
  96 struct dom_sid *dom_sid_dup(TALLOC_CTX *mem_ctx, const struct dom_sid *dom_sid);
  97 struct dom_sid *dom_sid_add_rid(TALLOC_CTX *mem_ctx,
  98                                 const struct dom_sid *domain_sid,
  99                                 uint32_t rid);
 100 NTSTATUS dom_sid_split_rid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 101                            struct dom_sid **domain, uint32_t *rid);
 102 bool dom_sid_in_domain(const struct dom_sid *domain_sid,
 103                        const struct dom_sid *sid);
 104 bool dom_sid_is_valid_account_domain(const struct dom_sid *sid);
 105
 106 #define DOM_SID_STR_BUFLEN (15*11+25)
 107 char *dom_sid_string(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
 108
 109 struct dom_sid_buf { char buf[DOM_SID_STR_BUFLEN]; };
 110 char *dom_sid_str_buf(const struct dom_sid *sid, struct dom_sid_buf *dst);
 111
 112 const char *sid_type_lookup(uint32_t sid_type);
 113 const struct security_token *get_system_token(void);
 114 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid);
 115 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid);
 116 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid);
 117 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid);
 118 void sid_copy(struct dom_sid *dst, const struct dom_sid *src);
 119 ssize_t sid_parse(const uint8_t *inbuf, size_t len, struct dom_sid *sid);
 120 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2);
 121 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 122                           struct dom_sid **sids, uint32_t *num);
 123 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
 124                                  struct dom_sid **sids, uint32_t *num_sids);
 125 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
 126                         uint32_t *num);
 127 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
 128                              uint32_t rid, uint32_t **pp_rids, size_t *p_num);
 129 bool is_null_sid(const struct dom_sid *sid);
 130
 131 #endif /*_DOM_SID_H_*/
 132