docs: man ldb.3: Add missing meta data.
[Samba/vl.git] / libcli / security / dom_sid.h
blobc4a417b64a6532287f74fbea4200317c53a74173
1 /*
2 Unix SMB/CIFS implementation.
3 Samba utility functions
5 Copyright (C) Stefan (metze) Metzmacher 2002-2004
6 Copyright (C) Andrew Tridgell 1992-2004
7 Copyright (C) Jeremy Allison 1999
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.
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.
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/>.
23 #ifndef _DOM_SID_H_
24 #define _DOM_SID_H_
26 #include "librpc/gen_ndr/security.h"
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;
57 int dom_sid_compare_auth(const struct dom_sid *sid1,
58 const struct dom_sid *sid2);
59 int dom_sid_compare(const struct dom_sid *sid1, const struct dom_sid *sid2);
60 int dom_sid_compare_domain(const struct dom_sid *sid1,
61 const struct dom_sid *sid2);
62 bool dom_sid_equal(const struct dom_sid *sid1, const struct dom_sid *sid2);
63 bool sid_append_rid(struct dom_sid *sid, uint32_t rid);
64 bool string_to_sid(struct dom_sid *sidout, const char *sidstr);
65 bool dom_sid_parse_endp(const char *sidstr,struct dom_sid *sidout,
66 const char **endp);
67 bool dom_sid_parse(const char *sidstr, struct dom_sid *ret);
68 struct dom_sid *dom_sid_parse_talloc(TALLOC_CTX *mem_ctx, const char *sidstr);
69 struct dom_sid *dom_sid_parse_length(TALLOC_CTX *mem_ctx, const DATA_BLOB *sid);
70 struct dom_sid *dom_sid_dup(TALLOC_CTX *mem_ctx, const struct dom_sid *dom_sid);
71 struct dom_sid *dom_sid_add_rid(TALLOC_CTX *mem_ctx,
72 const struct dom_sid *domain_sid,
73 uint32_t rid);
74 NTSTATUS dom_sid_split_rid(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
75 struct dom_sid **domain, uint32_t *rid);
76 bool dom_sid_in_domain(const struct dom_sid *domain_sid,
77 const struct dom_sid *sid);
79 #define DOM_SID_STR_BUFLEN (15*11+25)
80 int dom_sid_string_buf(const struct dom_sid *sid, char *buf, int buflen);
81 char *dom_sid_string(TALLOC_CTX *mem_ctx, const struct dom_sid *sid);
84 const char *sid_type_lookup(uint32_t sid_type);
85 const struct security_token *get_system_token(void);
86 bool sid_compose(struct dom_sid *dst, const struct dom_sid *domain_sid, uint32_t rid);
87 bool sid_split_rid(struct dom_sid *sid, uint32_t *rid);
88 bool sid_peek_rid(const struct dom_sid *sid, uint32_t *rid);
89 bool sid_peek_check_rid(const struct dom_sid *exp_dom_sid, const struct dom_sid *sid, uint32_t *rid);
90 void sid_copy(struct dom_sid *dst, const struct dom_sid *src);
91 bool sid_blob_parse(DATA_BLOB in, struct dom_sid *sid);
92 bool sid_parse(const char *inbuf, size_t len, struct dom_sid *sid);
93 int sid_compare_domain(const struct dom_sid *sid1, const struct dom_sid *sid2);
94 NTSTATUS add_sid_to_array(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
95 struct dom_sid **sids, uint32_t *num);
96 NTSTATUS add_sid_to_array_unique(TALLOC_CTX *mem_ctx, const struct dom_sid *sid,
97 struct dom_sid **sids, uint32_t *num_sids);
98 void del_sid_from_array(const struct dom_sid *sid, struct dom_sid **sids,
99 uint32_t *num);
100 bool add_rid_to_array_unique(TALLOC_CTX *mem_ctx,
101 uint32_t rid, uint32_t **pp_rids, size_t *p_num);
102 bool is_null_sid(const struct dom_sid *sid);
104 #endif /*_DOM_SID_H_*/