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 void ads_disconnect(ADS_STRUCT *ads);
  70 ADS_STATUS ads_do_search_all_fn(ADS_STRUCT *ads, const char *bind_path,
  71                                 int scope, const char *expr, const char **attrs,
  72                                 bool (*fn)(ADS_STRUCT *, char *, void **, void *),
  73                                 void *data_area);
  74 char *ads_parent_dn(const char *dn);
  75 ADS_MODLIST ads_init_mods(TALLOC_CTX *ctx);
  76 ADS_STATUS ads_mod_str(TALLOC_CTX *ctx, ADS_MODLIST *mods,
  77                        const char *name, const char *val);
  78 ADS_STATUS ads_mod_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
  79                            const char *name, const char **vals);
  80 ADS_STATUS ads_gen_mod(ADS_STRUCT *ads, const char *mod_dn, ADS_MODLIST mods);
  81 ADS_STATUS ads_gen_add(ADS_STRUCT *ads, const char *new_dn, ADS_MODLIST mods);
  82 ADS_STATUS ads_del_dn(ADS_STRUCT *ads, char *del_dn);
  83 char *ads_ou_string(ADS_STRUCT *ads, const char *org_unit);
  84 char *ads_default_ou_string(ADS_STRUCT *ads, const char *wknguid);
  85 ADS_STATUS ads_add_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
  86                                 const char *name, const char **vals);
  87 uint32_t ads_get_kvno(ADS_STRUCT *ads, const char *account_name);
  88 uint32_t ads_get_machine_kvno(ADS_STRUCT *ads, const char *machine_name);
  89
  90 bool ads_element_in_array(const char **el_array, size_t num_el, const char *el);
  91
  92 ADS_STATUS ads_get_service_principal_names(TALLOC_CTX *mem_ctx,
  93                                            ADS_STRUCT *ads,
  94                                            const char *machine_name,
  95                                            char ***spn_array,
  96                                            size_t *num_spns);
  97 ADS_STATUS ads_clear_service_principal_names(ADS_STRUCT *ads, const char *machine_name);
  98 ADS_STATUS ads_add_service_principal_name(ADS_STRUCT *ads, const char *machine_name,
  99                                           const char *my_fqdn, const char *spn);
 100 ADS_STATUS ads_create_machine_acct(ADS_STRUCT *ads,
 101                                    const char *machine_name,
 102                                    const char *org_unit,
 103                                    uint32_t etype_list);
 104 ADS_STATUS ads_move_machine_acct(ADS_STRUCT *ads, const char *machine_name,
 105                                  const char *org_unit, bool *moved);
 106 int ads_count_replies(ADS_STRUCT *ads, void *res);
 107 ADS_STATUS ads_USN(ADS_STRUCT *ads, uint32_t *usn);
 108 ADS_STATUS ads_current_time(ADS_STRUCT *ads);
 109 ADS_STATUS ads_domain_func_level(ADS_STRUCT *ads, uint32_t *val);
 110 ADS_STATUS ads_domain_sid(ADS_STRUCT *ads, struct dom_sid *sid);
 111 ADS_STATUS ads_site_dn(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char **site_name);
 112 ADS_STATUS ads_site_dn_for_machine(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char *computer_name, const char **site_dn);
 113 ADS_STATUS ads_upn_suffixes(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, char ***suffixes, size_t *num_suffixes);
 114 ADS_STATUS ads_get_joinable_ous(ADS_STRUCT *ads,
 115                                 TALLOC_CTX *mem_ctx,
 116                                 char ***ous,
 117                                 size_t *num_ous);
 118 ADS_STATUS ads_get_sid_from_extended_dn(TALLOC_CTX *mem_ctx,
 119                                         const char *extended_dn,
 120                                         enum ads_extended_dn_flags flags,
 121                                         struct dom_sid *sid);
 122 char* ads_get_dnshostname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
 123 char* ads_get_upn( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
 124 bool ads_has_samaccountname( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
 125 ADS_STATUS ads_join_realm(ADS_STRUCT *ads, const char *machine_name,
 126                         uint32_t account_type, const char *org_unit);
 127 ADS_STATUS ads_leave_realm(ADS_STRUCT *ads, const char *hostname);
 128 ADS_STATUS ads_find_samaccount(ADS_STRUCT *ads,
 129                                TALLOC_CTX *mem_ctx,
 130                                const char *samaccountname,
 131                                uint32_t *uac_ret,
 132                                const char **dn_ret);
 133 ADS_STATUS ads_config_path(ADS_STRUCT *ads,
 134                            TALLOC_CTX *mem_ctx,
 135                            char **config_path);
 136 const char *ads_get_extended_right_name_by_guid(ADS_STRUCT *ads,
 137                                                 const char *config_path,
 138                                                 TALLOC_CTX *mem_ctx,
 139                                                 const struct GUID *rights_guid);
 140 ADS_STATUS ads_check_ou_dn(TALLOC_CTX *mem_ctx,
 141                            ADS_STRUCT *ads,
 142                            const char **account_ou);
 143
 144 /* The following definitions come from libads/ldap_printer.c  */
 145
 146 ADS_STATUS ads_mod_printer_entry(ADS_STRUCT *ads, char *prt_dn,
 147                                  TALLOC_CTX *ctx, const ADS_MODLIST *mods);
 148 ADS_STATUS ads_add_printer_entry(ADS_STRUCT *ads, char *prt_dn,
 149                                         TALLOC_CTX *ctx, ADS_MODLIST *mods);
 150 WERROR get_remote_printer_publishing_data(struct rpc_pipe_client *cli,
 151                                           TALLOC_CTX *mem_ctx,
 152                                           ADS_MODLIST *mods,
 153                                           const char *printer);
 154
 155 /* The following definitions come from libads/ldap_user.c  */
 156
 157 ADS_STATUS ads_add_user_acct(ADS_STRUCT *ads, const char *user,
 158                              const char *container, const char *fullname);
 159 ADS_STATUS ads_add_group_acct(ADS_STRUCT *ads, const char *group,
 160                               const char *container, const char *comment);
 161
 162 /* The following definitions come from libads/ldap_utils.c  */
 163
 164 ADS_STATUS ads_ranged_search(ADS_STRUCT *ads,
 165                              TALLOC_CTX *mem_ctx,
 166                              int scope,
 167                              const char *base,
 168                              const char *filter,
 169                              void *args,
 170                              const char *range_attr,
 171                              char ***strings,
 172                              size_t *num_strings);
 173
 174 /* The following definitions come from libads/ndr.c  */
 175
 176 struct ndr_print;
 177 void ndr_print_ads_struct(struct ndr_print *ndr, const char *name, const struct ads_struct *r);
 178
 179 /* The following definitions come from libads/sasl.c  */
 180
 181 ADS_STATUS ads_sasl_bind(ADS_STRUCT *ads);
 182
 183 /* The following definitions come from libads/sasl_wrapping.c  */
 184
 185 ADS_STATUS ads_setup_sasl_wrapping(struct ads_saslwrap *wrap, LDAP *ld,
 186                                    const struct ads_saslwrap_ops *ops,
 187                                    void *private_data);
 188 void ndr_print_ads_saslwrap_struct(struct ndr_print *ndr,
 189                                    const char *name,
 190                                    const struct ads_saslwrap *r);
 191
 192 /* The following definitions come from libads/util.c  */
 193
 194 ADS_STATUS ads_change_trust_account_password(ADS_STRUCT *ads, char *host_principal);
 195
 196 struct spn_struct {
 197         const char *serviceclass;
 198         const char *servicename;
 199         const char *host;
 200         int32_t port;
 201 };
 202
 203 /* parse a windows style SPN, returns NULL if parsing fails */
 204 struct spn_struct *parse_spn(TALLOC_CTX *ctx, const char *srvprinc);
 205
 206 #endif /* _LIBADS_ADS_PROTO_H_ */