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 struct cli_credentials;
  36
  37 enum ads_sasl_state_e {
  38         ADS_SASL_PLAIN = 0,
  39         ADS_SASL_SIGN,
  40         ADS_SASL_SEAL,
  41 };
  42
  43 /* The following definitions come from libads/ads_struct.c  */
  44
  45 ADS_STATUS ads_build_path(const char *realm,
  46                           const char *sep,
  47                           const char *field,
  48                           int reverse,
  49                           char **_path);
  50 ADS_STATUS ads_build_dn(const char *realm, TALLOC_CTX *mem_ctx, char **_dn);
  51 char *ads_build_domain(const char *dn);
  52 ADS_STRUCT *ads_init(TALLOC_CTX *mem_ctx,
  53                      const char *realm,
  54                      const char *workgroup,
  55                      const char *ldap_server,
  56                      enum ads_sasl_state_e sasl_state);
  57 bool ads_set_sasl_wrap_flags(ADS_STRUCT *ads, unsigned flags);
  58
  59 /* The following definitions come from libads/disp_sec.c  */
  60
  61 void ads_disp_sd(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, struct security_descriptor *sd);
  62
  63 /* The following definitions come from libads/kerberos_keytab.c  */
  64
  65 int ads_keytab_flush(ADS_STRUCT *ads);
  66 int ads_keytab_list(const char *keytab_name);
  67
  68 /* The following definitions come from libads/net_ads_setspn.c  */
  69 bool ads_setspn_list(ADS_STRUCT *ads, const char *machine);
  70 bool ads_setspn_add(ADS_STRUCT *ads, const char *machine_name,
  71                     const char * spn);
  72 bool ads_setspn_delete(ADS_STRUCT *ads, const char *machine_name,
  73                        const char * spn);
  74
  75 /* The following definitions come from libads/krb5_errs.c  */
  76
  77 /* The following definitions come from libads/ldap.c  */
  78
  79 bool ads_sitename_match(ADS_STRUCT *ads);
  80 bool ads_closest_dc(ADS_STRUCT *ads);
  81 ADS_STATUS ads_connect_cldap_only(ADS_STRUCT *ads);
  82 ADS_STATUS ads_connect_creds(ADS_STRUCT *ads, struct cli_credentials *creds);
  83 ADS_STATUS ads_connect_simple_anon(ADS_STRUCT *ads);
  84 ADS_STATUS ads_connect_machine(ADS_STRUCT *ads);
  85 ADS_STATUS ads_connect(ADS_STRUCT *ads);
  86 ADS_STATUS ads_connect_user_creds(ADS_STRUCT *ads);
  87 void ads_zero_ldap(ADS_STRUCT *ads);
  88 void ads_disconnect(ADS_STRUCT *ads);
  89 ADS_STATUS ads_do_search_all_fn(ADS_STRUCT *ads, const char *bind_path,
  90                                 int scope, const char *expr, const char **attrs,
  91                                 bool (*fn)(ADS_STRUCT *, char *, void **, void *),
  92                                 void *data_area);
  93 char *ads_parent_dn(const char *dn);
  94 ADS_MODLIST ads_init_mods(TALLOC_CTX *ctx);
  95 ADS_STATUS ads_mod_str(TALLOC_CTX *ctx, ADS_MODLIST *mods,
  96                        const char *name, const char *val);
  97 ADS_STATUS ads_mod_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
  98                            const char *name, const char **vals);
  99 ADS_STATUS ads_gen_mod(ADS_STRUCT *ads, const char *mod_dn, ADS_MODLIST mods);
 100 ADS_STATUS ads_gen_add(ADS_STRUCT *ads, const char *new_dn, ADS_MODLIST mods);
 101 ADS_STATUS ads_del_dn(ADS_STRUCT *ads, char *del_dn);
 102 char *ads_ou_string(ADS_STRUCT *ads, const char *org_unit);
 103 char *ads_default_ou_string(ADS_STRUCT *ads, const char *wknguid);
 104 ADS_STATUS ads_add_strlist(TALLOC_CTX *ctx, ADS_MODLIST *mods,
 105                                 const char *name, const char **vals);
 106
 107 bool ads_element_in_array(const char **el_array, size_t num_el, const char *el);
 108
 109 ADS_STATUS ads_get_service_principal_names(TALLOC_CTX *mem_ctx,
 110                                            ADS_STRUCT *ads,
 111                                            const char *machine_name,
 112                                            char ***spn_array,
 113                                            size_t *num_spns);
 114 ADS_STATUS ads_clear_service_principal_names(ADS_STRUCT *ads, const char *machine_name);
 115 ADS_STATUS ads_add_service_principal_names(ADS_STRUCT *ads, const char *machine_name,
 116                                           const char **spns);
 117 ADS_STATUS ads_create_machine_acct(ADS_STRUCT *ads,
 118                                    const char *machine_name,
 119                                    const char *machine_password,
 120                                    const char *org_unit,
 121                                    uint32_t etype_list,
 122                                    const char *dns_domain_name);
 123 ADS_STATUS ads_move_machine_acct(ADS_STRUCT *ads, const char *machine_name,
 124                                  const char *org_unit, bool *moved);
 125 int ads_count_replies(ADS_STRUCT *ads, void *res);
 126 ADS_STATUS ads_USN(ADS_STRUCT *ads, uint32_t *usn);
 127 ADS_STATUS ads_current_time(ADS_STRUCT *ads);
 128 ADS_STATUS ads_domain_func_level(ADS_STRUCT *ads, uint32_t *val);
 129 ADS_STATUS ads_domain_sid(ADS_STRUCT *ads, struct dom_sid *sid);
 130 ADS_STATUS ads_site_dn(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char **site_name);
 131 ADS_STATUS ads_site_dn_for_machine(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, const char *computer_name, const char **site_dn);
 132 ADS_STATUS ads_upn_suffixes(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, char ***suffixes, size_t *num_suffixes);
 133 ADS_STATUS ads_get_joinable_ous(ADS_STRUCT *ads,
 134                                 TALLOC_CTX *mem_ctx,
 135                                 char ***ous,
 136                                 size_t *num_ous);
 137 ADS_STATUS ads_get_sid_from_extended_dn(TALLOC_CTX *mem_ctx,
 138                                         const char *extended_dn,
 139                                         enum ads_extended_dn_flags flags,
 140                                         struct dom_sid *sid);
 141 char* ads_get_upn( ADS_STRUCT *ads, TALLOC_CTX *ctx, const char *machine_name );
 142 ADS_STATUS ads_join_realm(ADS_STRUCT *ads, const char *machine_name,
 143                         uint32_t account_type, const char *org_unit);
 144 ADS_STATUS ads_leave_realm(ADS_STRUCT *ads, const char *hostname);
 145 ADS_STATUS ads_find_samaccount(ADS_STRUCT *ads,
 146                                TALLOC_CTX *mem_ctx,
 147                                const char *samaccountname,
 148                                uint32_t *uac_ret,
 149                                const char **dn_ret);
 150 ADS_STATUS ads_config_path(ADS_STRUCT *ads,
 151                            TALLOC_CTX *mem_ctx,
 152                            char **config_path);
 153 const char *ads_get_extended_right_name_by_guid(ADS_STRUCT *ads,
 154                                                 const char *config_path,
 155                                                 TALLOC_CTX *mem_ctx,
 156                                                 const struct GUID *rights_guid);
 157 ADS_STATUS ads_check_ou_dn(TALLOC_CTX *mem_ctx,
 158                            ADS_STRUCT *ads,
 159                            const char **account_ou);
 160
 161 /* The following definitions come from libads/ldap_printer.c  */
 162
 163 ADS_STATUS ads_mod_printer_entry(ADS_STRUCT *ads, char *prt_dn,
 164                                  TALLOC_CTX *ctx, const ADS_MODLIST *mods);
 165 ADS_STATUS ads_add_printer_entry(ADS_STRUCT *ads, char *prt_dn,
 166                                         TALLOC_CTX *ctx, ADS_MODLIST *mods);
 167 WERROR get_remote_printer_publishing_data(struct rpc_pipe_client *cli,
 168                                           TALLOC_CTX *mem_ctx,
 169                                           ADS_MODLIST *mods,
 170                                           const char *printer);
 171
 172 /* The following definitions come from libads/ldap_user.c  */
 173
 174 ADS_STATUS ads_add_user_acct(ADS_STRUCT *ads, const char *user,
 175                              const char *container, const char *fullname);
 176 ADS_STATUS ads_add_group_acct(ADS_STRUCT *ads, const char *group,
 177                               const char *container, const char *comment);
 178
 179 /* The following definitions come from libads/ldap_utils.c  */
 180
 181 ADS_STATUS ads_ranged_search(ADS_STRUCT *ads,
 182                              TALLOC_CTX *mem_ctx,
 183                              int scope,
 184                              const char *base,
 185                              const char *filter,
 186                              void *args,
 187                              const char *range_attr,
 188                              char ***strings,
 189                              size_t *num_strings);
 190
 191 /* The following definitions come from libads/sasl.c  */
 192
 193 NTSTATUS ads_simple_creds(TALLOC_CTX *mem_ctx,
 194                           const char *account_domain,
 195                           const char *account_name,
 196                           const char *password,
 197                           struct cli_credentials **_creds);
 198 ADS_STATUS ads_sasl_bind(ADS_STRUCT *ads, struct cli_credentials *creds);
 199
 200 /* The following definitions come from libads/sasl_wrapping.c  */
 201
 202 ADS_STATUS ads_setup_sasl_wrapping(struct ads_saslwrap *wrap, LDAP *ld,
 203                                    const struct ads_saslwrap_ops *ops,
 204                                    void *private_data);
 205 void ndr_print_ads_saslwrap_struct(struct ndr_print *ndr,
 206                                    const char *name,
 207                                    const struct ads_saslwrap *r);
 208
 209 /* The following definitions come from libads/tls_wrapping.c  */
 210
 211 void ndr_print_ads_tlswrap_struct(struct ndr_print *ndr,
 212                                    const char *name,
 213                                    const struct ads_tlswrap *r);
 214 ADS_STATUS ads_setup_tls_wrapping(struct ads_tlswrap *wrap,
 215                                   LDAP *ld,
 216                                   const char *server_name);
 217 const DATA_BLOB *ads_tls_channel_bindings(struct ads_tlswrap *wrap);
 218
 219 /* The following definitions come from libads/util.c  */
 220
 221 ADS_STATUS ads_change_trust_account_password(ADS_STRUCT *ads, char *host_principal);
 222
 223 struct spn_struct {
 224         const char *serviceclass;
 225         const char *servicename;
 226         const char *host;
 227         int32_t port;
 228 };
 229
 230 /* parse a windows style SPN, returns NULL if parsing fails */
 231 struct spn_struct *parse_spn(TALLOC_CTX *ctx, const char *srvprinc);
 232
 233 NTSTATUS sync_pw2keytabs(void);
 234
 235 #endif /* _LIBADS_ADS_PROTO_H_ */