s3-libads: Add function to search for an element in an array.
[obnox/samba/samba-obnox.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/krb5_errs.c  */
58
59 /* The following definitions come from libads/kerberos_util.c  */
60
61 int ads_kinit_password(ADS_STRUCT *ads);
62
63 /* The following definitions come from libads/ldap.c  */
64
65 bool ads_sitename_match(ADS_STRUCT *ads);
66 bool ads_closest_dc(ADS_STRUCT *ads);
67 ADS_STATUS ads_connect(ADS_STRUCT *ads);
68 ADS_STATUS ads_connect_user_creds(ADS_STRUCT *ads);
69 ADS_STATUS ads_connect_gc(ADS_STRUCT *ads);
70 void ads_disconnect(ADS_STRUCT *ads);
71 ADS_STATUS ads_do_search_all_fn(ADS_STRUCT *ads, const char *bind_path,
72                                 int scope, const char *expr, const char **attrs,
73                                 bool (*fn)(ADS_STRUCT *, char *, void **, void *),
74                                 void *data_area);
75 char *ads_parent_dn(const char *dn);
76 ADS_MODLIST ads_init_mods(TALLOC_CTX *ctx);
77 ADS_STATUS ads_mod_str(TALLOC_CTX *ctx, ADS_MODLIST *mods,
78                        const char *name, const char *val);
79 ADS_STATUS ads_mod_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
80                            const char *name, const char **vals);
81 ADS_STATUS ads_gen_mod(ADS_STRUCT *ads, const char *mod_dn, ADS_MODLIST mods);
82 ADS_STATUS ads_gen_add(ADS_STRUCT *ads, const char *new_dn, ADS_MODLIST mods);
83 ADS_STATUS ads_del_dn(ADS_STRUCT *ads, char *del_dn);
84 char *ads_ou_string(ADS_STRUCT *ads, const char *org_unit);
85 char *ads_default_ou_string(ADS_STRUCT *ads, const char *wknguid);
86 ADS_STATUS ads_add_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
87                                 const char *name, const char **vals);
88 uint32 ads_get_kvno(ADS_STRUCT *ads, const char *account_name);
89 uint32_t ads_get_machine_kvno(ADS_STRUCT *ads, const char *machine_name);
90
91 bool ads_element_in_array(const char **el_array, size_t num_el, const char *el);
92
93 ADS_STATUS ads_get_service_principal_names(TALLOC_CTX *mem_ctx,
94                                            ADS_STRUCT *ads,
95                                            const char *machine_name,
96                                            char ***spn_array,
97                                            size_t *num_spns);
98 ADS_STATUS ads_clear_service_principal_names(ADS_STRUCT *ads, const char *machine_name);
99 ADS_STATUS ads_add_service_principal_name(ADS_STRUCT *ads, const char *machine_name,
100                                           const char *my_fqdn, const char *spn);
101 ADS_STATUS ads_create_machine_acct(ADS_STRUCT *ads, const char *machine_name,
102                                    const char *org_unit);
103 ADS_STATUS ads_move_machine_acct(ADS_STRUCT *ads, const char *machine_name,
104                                  const char *org_unit, bool *moved);
105 int ads_count_replies(ADS_STRUCT *ads, void *res);
106 ADS_STATUS ads_USN(ADS_STRUCT *ads, uint32 *usn);
107 ADS_STATUS ads_current_time(ADS_STRUCT *ads);
108 ADS_STATUS ads_domain_func_level(ADS_STRUCT *ads, uint32 *val);
109 ADS_STATUS ads_domain_sid(ADS_STRUCT *ads, struct dom_sid *sid);
110 ADS_STATUS ads_site_dn(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char **site_name);
111 ADS_STATUS ads_site_dn_for_machine(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char *computer_name, const char **site_dn);
112 ADS_STATUS ads_upn_suffixes(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, char ***suffixes, size_t *num_suffixes);
113 ADS_STATUS ads_get_joinable_ous(ADS_STRUCT *ads,
114                                 TALLOC_CTX *mem_ctx,
115                                 char ***ous,
116                                 size_t *num_ous);
117 ADS_STATUS ads_get_sid_from_extended_dn(TALLOC_CTX *mem_ctx,
118                                         const char *extended_dn,
119                                         enum ads_extended_dn_flags flags,
120                                         struct dom_sid *sid);
121 char* ads_get_dnshostname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
122 char* ads_get_upn( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
123 char* ads_get_samaccountname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
124 ADS_STATUS ads_join_realm(ADS_STRUCT *ads, const char *machine_name,
125                         uint32 account_type, const char *org_unit);
126 ADS_STATUS ads_leave_realm(ADS_STRUCT *ads, const char *hostname);
127 ADS_STATUS ads_find_samaccount(ADS_STRUCT *ads,
128                                TALLOC_CTX *mem_ctx,
129                                const char *samaccountname,
130                                uint32 *uac_ret,
131                                const char **dn_ret);
132 ADS_STATUS ads_config_path(ADS_STRUCT *ads,
133                            TALLOC_CTX *mem_ctx,
134                            char **config_path);
135 const char *ads_get_extended_right_name_by_guid(ADS_STRUCT *ads,
136                                                 const char *config_path,
137                                                 TALLOC_CTX *mem_ctx,
138                                                 const struct GUID *rights_guid);
139 ADS_STATUS ads_check_ou_dn(TALLOC_CTX *mem_ctx,
140                            ADS_STRUCT *ads,
141                            const char **account_ou);
142
143 /* The following definitions come from libads/ldap_printer.c  */
144
145 ADS_STATUS ads_mod_printer_entry(ADS_STRUCT *ads, char *prt_dn,
146                                  TALLOC_CTX *ctx, const ADS_MODLIST *mods);
147 ADS_STATUS ads_add_printer_entry(ADS_STRUCT *ads, char *prt_dn,
148                                         TALLOC_CTX *ctx, ADS_MODLIST *mods);
149 WERROR get_remote_printer_publishing_data(struct rpc_pipe_client *cli,
150                                           TALLOC_CTX *mem_ctx,
151                                           ADS_MODLIST *mods,
152                                           const char *printer);
153
154 /* The following definitions come from libads/ldap_user.c  */
155
156 ADS_STATUS ads_add_user_acct(ADS_STRUCT *ads, const char *user,
157                              const char *container, const char *fullname);
158 ADS_STATUS ads_add_group_acct(ADS_STRUCT *ads, const char *group,
159                               const char *container, const char *comment);
160
161 /* The following definitions come from libads/ldap_utils.c  */
162
163 ADS_STATUS ads_ranged_search(ADS_STRUCT *ads,
164                              TALLOC_CTX *mem_ctx,
165                              int scope,
166                              const char *base,
167                              const char *filter,
168                              void *args,
169                              const char *range_attr,
170                              char ***strings,
171                              size_t *num_strings);
172
173 /* The following definitions come from libads/ndr.c  */
174
175 struct ndr_print;
176 void ndr_print_ads_struct(struct ndr_print *ndr, const char *name, const struct ads_struct *r);
177
178 /* The following definitions come from libads/sasl.c  */
179
180 ADS_STATUS ads_sasl_bind(ADS_STRUCT *ads);
181
182 /* The following definitions come from libads/sasl_wrapping.c  */
183
184 ADS_STATUS ads_setup_sasl_wrapping(ADS_STRUCT *ads,
185                                    const struct ads_saslwrap_ops *ops,
186                                    void *private_data);
187 ADS_STATUS ads_setup_sasl_wrapping(ADS_STRUCT *ads,
188                                    const struct ads_saslwrap_ops *ops,
189                                    void *private_data);
190
191 /* The following definitions come from libads/util.c  */
192
193 ADS_STATUS ads_change_trust_account_password(ADS_STRUCT *ads, char *host_principal);
194
195 #endif /* _LIBADS_ADS_PROTO_H_ */