3934c1cfe27a480b92a0177e8719daa88c23794e
[samba.git] / source3 / libads / ads_proto.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  ads (active directory) utility library
4  *
5  *  Copyright (C) Andrew Bartlett                       2001
6  *  Copyright (C) Andrew Tridgell                       2001
7  *  Copyright (C) Remus Koos (remuskoos@yahoo.com)      2001
8  *  Copyright (C) Alexey Kotovich                       2002
9  *  Copyright (C) Jim McDonough <jmcd@us.ibm.com>       2002-2003
10  *  Copyright (C) Luke Howard                           2003
11  *  Copyright (C) Guenther Deschner                     2003-2008
12  *  Copyright (C) Rakesh Patel                          2004
13  *  Copyright (C) Dan Perry                             2004
14  *  Copyright (C) Jeremy Allison                        2004
15  *  Copyright (C) Gerald Carter                         2006
16  *  Copyright (C) Stefan Metzmacher                     2007
17  *
18  *  This program is free software; you can redistribute it and/or modify
19  *  it under the terms of the GNU General Public License as published by
20  *  the Free Software Foundation; either version 3 of the License, or
21  *  (at your option) any later version.
22  *
23  *  This program is distributed in the hope that it will be useful,
24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  *  GNU General Public License for more details.
27  *
28  *  You should have received a copy of the GNU General Public License
29  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
30  */
31
32 #ifndef _LIBADS_ADS_PROTO_H_
33 #define _LIBADS_ADS_PROTO_H_
34
35 /* The following definitions come from libads/ads_struct.c  */
36
37 char *ads_build_path(const char *realm, const char *sep, const char *field, int reverse);
38 char *ads_build_dn(const char *realm);
39 char *ads_build_domain(const char *dn);
40 ADS_STRUCT *ads_init(const char *realm,
41                      const char *workgroup,
42                      const char *ldap_server);
43 bool ads_set_sasl_wrap_flags(ADS_STRUCT *ads, int flags);
44 void ads_destroy(ADS_STRUCT **ads);
45
46 /* The following definitions come from libads/disp_sec.c  */
47
48 void ads_disp_sd(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, struct security_descriptor *sd);
49
50 /* The following definitions come from libads/kerberos_keytab.c  */
51
52 int ads_keytab_add_entry(ADS_STRUCT *ads, const char *srvPrinc);
53 int ads_keytab_flush(ADS_STRUCT *ads);
54 int ads_keytab_create_default(ADS_STRUCT *ads);
55 int ads_keytab_list(const char *keytab_name);
56
57 /* The following definitions come from libads/net_ads_setspn.c  */
58 bool ads_setspn_list(ADS_STRUCT *ads, const char *machine);
59 bool ads_setspn_add(ADS_STRUCT *ads, const char *machine_name,
60                     const char * spn);
61 bool ads_setspn_delete(ADS_STRUCT *ads, const char *machine_name,
62                        const char * spn);
63
64 /* The following definitions come from libads/krb5_errs.c  */
65
66 /* The following definitions come from libads/kerberos_util.c  */
67
68 int ads_kinit_password(ADS_STRUCT *ads);
69
70 /* The following definitions come from libads/ldap.c  */
71
72 bool ads_sitename_match(ADS_STRUCT *ads);
73 bool ads_closest_dc(ADS_STRUCT *ads);
74 ADS_STATUS ads_connect(ADS_STRUCT *ads);
75 ADS_STATUS ads_connect_user_creds(ADS_STRUCT *ads);
76 void ads_disconnect(ADS_STRUCT *ads);
77 ADS_STATUS ads_do_search_all_fn(ADS_STRUCT *ads, const char *bind_path,
78                                 int scope, const char *expr, const char **attrs,
79                                 bool (*fn)(ADS_STRUCT *, char *, void **, void *),
80                                 void *data_area);
81 char *ads_parent_dn(const char *dn);
82 ADS_MODLIST ads_init_mods(TALLOC_CTX *ctx);
83 ADS_STATUS ads_mod_str(TALLOC_CTX *ctx, ADS_MODLIST *mods,
84                        const char *name, const char *val);
85 ADS_STATUS ads_mod_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
86                            const char *name, const char **vals);
87 ADS_STATUS ads_gen_mod(ADS_STRUCT *ads, const char *mod_dn, ADS_MODLIST mods);
88 ADS_STATUS ads_gen_add(ADS_STRUCT *ads, const char *new_dn, ADS_MODLIST mods);
89 ADS_STATUS ads_del_dn(ADS_STRUCT *ads, char *del_dn);
90 char *ads_ou_string(ADS_STRUCT *ads, const char *org_unit);
91 char *ads_default_ou_string(ADS_STRUCT *ads, const char *wknguid);
92 ADS_STATUS ads_add_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
93                                 const char *name, const char **vals);
94 uint32_t ads_get_kvno(ADS_STRUCT *ads, const char *account_name);
95 uint32_t ads_get_machine_kvno(ADS_STRUCT *ads, const char *machine_name);
96
97 bool ads_element_in_array(const char **el_array, size_t num_el, const char *el);
98
99 ADS_STATUS ads_get_service_principal_names(TALLOC_CTX *mem_ctx,
100                                            ADS_STRUCT *ads,
101                                            const char *machine_name,
102                                            char ***spn_array,
103                                            size_t *num_spns);
104 ADS_STATUS ads_clear_service_principal_names(ADS_STRUCT *ads, const char *machine_name);
105 ADS_STATUS ads_add_service_principal_names(ADS_STRUCT *ads, const char *machine_name,
106                                           const char **spns);
107 ADS_STATUS ads_create_machine_acct(ADS_STRUCT *ads,
108                                    const char *machine_name,
109                                    const char *org_unit,
110                                    uint32_t etype_list);
111 ADS_STATUS ads_move_machine_acct(ADS_STRUCT *ads, const char *machine_name,
112                                  const char *org_unit, bool *moved);
113 int ads_count_replies(ADS_STRUCT *ads, void *res);
114 ADS_STATUS ads_USN(ADS_STRUCT *ads, uint32_t *usn);
115 ADS_STATUS ads_current_time(ADS_STRUCT *ads);
116 ADS_STATUS ads_domain_func_level(ADS_STRUCT *ads, uint32_t *val);
117 ADS_STATUS ads_domain_sid(ADS_STRUCT *ads, struct dom_sid *sid);
118 ADS_STATUS ads_site_dn(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char **site_name);
119 ADS_STATUS ads_site_dn_for_machine(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char *computer_name, const char **site_dn);
120 ADS_STATUS ads_upn_suffixes(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, char ***suffixes, size_t *num_suffixes);
121 ADS_STATUS ads_get_joinable_ous(ADS_STRUCT *ads,
122                                 TALLOC_CTX *mem_ctx,
123                                 char ***ous,
124                                 size_t *num_ous);
125 ADS_STATUS ads_get_sid_from_extended_dn(TALLOC_CTX *mem_ctx,
126                                         const char *extended_dn,
127                                         enum ads_extended_dn_flags flags,
128                                         struct dom_sid *sid);
129 char* ads_get_dnshostname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
130 char* ads_get_upn( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
131 bool ads_has_samaccountname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
132 ADS_STATUS ads_join_realm(ADS_STRUCT *ads, const char *machine_name,
133                         uint32_t account_type, const char *org_unit);
134 ADS_STATUS ads_leave_realm(ADS_STRUCT *ads, const char *hostname);
135 ADS_STATUS ads_find_samaccount(ADS_STRUCT *ads,
136                                TALLOC_CTX *mem_ctx,
137                                const char *samaccountname,
138                                uint32_t *uac_ret,
139                                const char **dn_ret);
140 ADS_STATUS ads_config_path(ADS_STRUCT *ads,
141                            TALLOC_CTX *mem_ctx,
142                            char **config_path);
143 const char *ads_get_extended_right_name_by_guid(ADS_STRUCT *ads,
144                                                 const char *config_path,
145                                                 TALLOC_CTX *mem_ctx,
146                                                 const struct GUID *rights_guid);
147 ADS_STATUS ads_check_ou_dn(TALLOC_CTX *mem_ctx,
148                            ADS_STRUCT *ads,
149                            const char **account_ou);
150
151 /* The following definitions come from libads/ldap_printer.c  */
152
153 ADS_STATUS ads_mod_printer_entry(ADS_STRUCT *ads, char *prt_dn,
154                                  TALLOC_CTX *ctx, const ADS_MODLIST *mods);
155 ADS_STATUS ads_add_printer_entry(ADS_STRUCT *ads, char *prt_dn,
156                                         TALLOC_CTX *ctx, ADS_MODLIST *mods);
157 WERROR get_remote_printer_publishing_data(struct rpc_pipe_client *cli,
158                                           TALLOC_CTX *mem_ctx,
159                                           ADS_MODLIST *mods,
160                                           const char *printer);
161
162 /* The following definitions come from libads/ldap_user.c  */
163
164 ADS_STATUS ads_add_user_acct(ADS_STRUCT *ads, const char *user,
165                              const char *container, const char *fullname);
166 ADS_STATUS ads_add_group_acct(ADS_STRUCT *ads, const char *group,
167                               const char *container, const char *comment);
168
169 /* The following definitions come from libads/ldap_utils.c  */
170
171 ADS_STATUS ads_ranged_search(ADS_STRUCT *ads,
172                              TALLOC_CTX *mem_ctx,
173                              int scope,
174                              const char *base,
175                              const char *filter,
176                              void *args,
177                              const char *range_attr,
178                              char ***strings,
179                              size_t *num_strings);
180
181 /* The following definitions come from libads/ndr.c  */
182
183 struct ndr_print;
184 void ndr_print_ads_struct(struct ndr_print *ndr, const char *name, const struct ads_struct *r);
185
186 /* The following definitions come from libads/sasl.c  */
187
188 ADS_STATUS ads_sasl_bind(ADS_STRUCT *ads);
189
190 /* The following definitions come from libads/sasl_wrapping.c  */
191
192 ADS_STATUS ads_setup_sasl_wrapping(struct ads_saslwrap *wrap, LDAP *ld,
193                                    const struct ads_saslwrap_ops *ops,
194                                    void *private_data);
195 void ndr_print_ads_saslwrap_struct(struct ndr_print *ndr,
196                                    const char *name,
197                                    const struct ads_saslwrap *r);
198
199 /* The following definitions come from libads/util.c  */
200
201 ADS_STATUS ads_change_trust_account_password(ADS_STRUCT *ads, char *host_principal);
202
203 struct spn_struct {
204         const char *serviceclass;
205         const char *servicename;
206         const char *host;
207         int32_t port;
208 };
209
210 /* parse a windows style SPN, returns NULL if parsing fails */
211 struct spn_struct *parse_spn(TALLOC_CTX *ctx, const char *srvprinc);
212
213 #endif /* _LIBADS_ADS_PROTO_H_ */