990a4c491d3385669a7beb249f537b812e3563cc
[obnox/samba/samba-obnox.git] / 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 "librpc/gen_ndr/security.h"
27
28 /* Some well-known SIDs */
29 extern const struct dom_sid global_sid_World_Domain;
30 extern const struct dom_sid global_sid_World;
31 extern const struct dom_sid global_sid_Local_Authority;
32 extern const struct dom_sid global_sid_Creator_Owner_Domain;
33 extern const struct dom_sid global_sid_NT_Authority;
34 extern const struct dom_sid global_sid_Enterprise_DCs;
35 extern const struct dom_sid global_sid_System;
36 extern const struct dom_sid global_sid_NULL;
37 extern const struct dom_sid global_sid_Authenticated_Users;
38 extern const struct dom_sid global_sid_Network;
39 extern const struct dom_sid global_sid_Creator_Owner;
40 extern const struct dom_sid global_sid_Creator_Group;
41 extern const struct dom_sid global_sid_Owner_Rights;
42 extern const struct dom_sid global_sid_Anonymous;
43 extern const struct dom_sid global_sid_Builtin;
44 extern const struct dom_sid global_sid_Builtin_Administrators;
45 extern const struct dom_sid global_sid_Builtin_Users;
46 extern const struct dom_sid global_sid_Builtin_Guests;
47 extern const struct dom_sid global_sid_Builtin_Power_Users;
48 extern const struct dom_sid global_sid_Builtin_Account_Operators;
49 extern const struct dom_sid global_sid_Builtin_Server_Operators;
50 extern const struct dom_sid global_sid_Builtin_Print_Operators;
51 extern const struct dom_sid global_sid_Builtin_Backup_Operators;
52 extern const struct dom_sid global_sid_Builtin_Replicator;
53 extern const struct dom_sid global_sid_Builtin_PreWin2kAccess;
54 extern const struct dom_sid global_sid_Unix_Users;
55 extern const struct dom_sid global_sid_Unix_Groups;
56 extern const struct dom_sid global_sid_Unix_NFS;
57 extern const struct dom_sid global_sid_Unix_NFS_Users;
58 extern const struct dom_sid global_sid_Unix_NFS_Groups;
59 extern const struct dom_sid global_sid_Unix_NFS_Mode;
60 extern const struct dom_sid global_sid_Unix_NFS_Other;
61
62 int dom_sid_compare_auth(const struct dom_sid *sid1,
63                          const struct dom_sid *sid2);
64 int dom_sid_compare(const struct dom_sid *sid1, const struct dom_sid *sid2);
65 int dom_sid_compare_domain(const struct dom_sid *sid1,
66                            const struct dom_sid *sid2);
67 bool dom_sid_equal(const struct dom_sid *sid1, const struct dom_sid *sid2);
68 bool sid_append_rid(struct dom_sid *sid, uint32_t rid);
69 bool string_to_sid(struct dom_sid *sidout, const char *sidstr);
70 bool dom_sid_parse_endp(const char *sidstr,struct dom_sid *sidout,
71                         const char **endp);
72 bool dom_sid_parse(const char *sidstr, struct dom_sid *ret);
73 struct dom_sid *dom_sid_parse_talloc(TALLOC_CTX *mem_ctx, const char *sidstr);
74 struct dom_sid *dom_sid_parse_length(TALLOC_CTX *mem_ctx, const DATA_BLOB *sid);
75 struct dom_sid *dom_sid_dup(TALLOC_CTX *mem_ctx, const struct dom_sid *dom_sid);
76 struct dom_sid *dom_sid_add_rid(TALLOC_CTX *mem_ctx,
77                                 const struct dom_sid *domain_sid,
78                                 uint32_t rid);
79 NTSTATUS dom_sid_split_rid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
80                            struct dom_sid **domain, uint32_t *rid);
81 bool dom_sid_in_domain(const struct dom_sid *domain_sid,
82                        const struct dom_sid *sid);
83
84 #define DOM_SID_STR_BUFLEN (15*11+25)
85 int dom_sid_string_buf(const struct dom_sid *sid, char *buf, int buflen);
86 char *dom_sid_string(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
87
88
89 const char *sid_type_lookup(uint32_t sid_type);
90 const struct security_token *get_system_token(void);
91 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid);
92 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid);
93 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid);
94 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid);
95 void sid_copy(struct dom_sid *dst, const struct dom_sid *src);
96 bool sid_parse(const uint8_t *inbuf, size_t len, struct dom_sid *sid);
97 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2);
98 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
99                           struct dom_sid **sids, uint32_t *num);
100 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
101                                  struct dom_sid **sids, uint32_t *num_sids);
102 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
103                         uint32_t *num);
104 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
105                              uint32_t rid, uint32_t **pp_rids, size_t *p_num);
106 bool is_null_sid(const struct dom_sid *sid);
107
108 #endif /*_DOM_SID_H_*/
109