source3/libads/ads_ldap_protos.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    ads (active directory) utility library
   4    Copyright (C) Andrew Tridgell 2001
   5    Copyright (C) Remus Koos 2001
   6    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2002
   7    Copyright (C) Guenther Deschner 2005
   8    Copyright (C) Gerald Carter 2006
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #ifndef _LIBADS_ADS_LDAP_PROTOS_H_
  25 #define _LIBADS_ADS_LDAP_PROTOS_H_
  26
  27 #ifdef HAVE_LDAP_INIT_FD
  28 int ldap_init_fd(ber_socket_t fd, int proto, char *uri, LDAP **ldp);
  29 #endif
  30
  31 /*
  32  * Prototypes for ads
  33  */
  34
  35 LDAP *ldap_open_with_timeout(const char *server,
  36                              struct sockaddr_storage *ss,
  37                              int port, unsigned int to);
  38 void ads_msgfree(ADS_STRUCT *ads, LDAPMessage *msg);
  39 char *ads_get_dn(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, LDAPMessage *msg);
  40
  41 char *ads_pull_string(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx, LDAPMessage *msg,
  42                       const char *field);
  43 char **ads_pull_strings(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx,
  44                         LDAPMessage *msg, const char *field,
  45                         size_t *num_values);
  46 char **ads_pull_strings_range(ADS_STRUCT *ads,
  47                               TALLOC_CTX *mem_ctx,
  48                               LDAPMessage *msg, const char *field,
  49                               char **current_strings,
  50                               const char **next_attribute,
  51                               size_t *num_strings,
  52                               bool *more_strings);
  53 bool ads_pull_uint32(ADS_STRUCT *ads, LDAPMessage *msg, const char *field,
  54                      uint32_t *v);
  55 bool ads_pull_guid(ADS_STRUCT *ads, LDAPMessage *msg, struct GUID *guid);
  56 bool ads_pull_sid(ADS_STRUCT *ads, LDAPMessage *msg, const char *field,
  57                   struct dom_sid *sid);
  58 int ads_pull_sids(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx,
  59                   LDAPMessage *msg, const char *field, struct dom_sid **sids);
  60 bool ads_pull_sd(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx,
  61                  LDAPMessage *msg, const char *field, struct security_descriptor **sd);
  62 char *ads_pull_username(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx,
  63                         LDAPMessage *msg);
  64 ADS_STATUS ads_find_machine_acct(ADS_STRUCT *ads, LDAPMessage **res,
  65                                  const char *machine);
  66 ADS_STATUS ads_find_printer_on_server(ADS_STRUCT *ads, LDAPMessage **res,
  67                                       const char *printer,
  68                                       const char *servername);
  69 ADS_STATUS ads_find_printers(ADS_STRUCT *ads, LDAPMessage **res);
  70 ADS_STATUS ads_find_user_acct(ADS_STRUCT *ads, LDAPMessage **res,
  71                               const char *user);
  72
  73 ADS_STATUS ads_do_search(ADS_STRUCT *ads, const char *bind_path, int scope,
  74                          const char *expr,
  75                          const char **attrs, LDAPMessage **res);
  76 ADS_STATUS ads_search(ADS_STRUCT *ads, LDAPMessage **res,
  77                       const char *expr, const char **attrs);
  78 ADS_STATUS ads_search_dn(ADS_STRUCT *ads, LDAPMessage **res,
  79                          const char *dn, const char **attrs);
  80 void ads_set_reconnect_fn(ADS_STRUCT *ads,
  81                           NTSTATUS (*fn)(struct ads_struct *ads,
  82                                          void *private_data,
  83                                          TALLOC_CTX *mem_ctx,
  84                                          struct cli_credentials **creds),
  85                           void *private_data);
  86 ADS_STATUS ads_do_search_all_args(ADS_STRUCT *ads, const char *bind_path,
  87                                   int scope, const char *expr,
  88                                   const char **attrs, void *args,
  89                                   LDAPMessage **res);
  90 ADS_STATUS ads_do_search_all(ADS_STRUCT *ads, const char *bind_path,
  91                              int scope, const char *expr,
  92                              const char **attrs, LDAPMessage **res);
  93 ADS_STATUS ads_do_search_retry(ADS_STRUCT *ads, const char *bind_path,
  94                                int scope,
  95                                const char *expr,
  96                                const char **attrs, LDAPMessage **res);
  97 ADS_STATUS ads_search_retry(ADS_STRUCT *ads, LDAPMessage **res,
  98                             const char *expr, const char **attrs);
  99 ADS_STATUS ads_search_retry_dn(ADS_STRUCT *ads, LDAPMessage **res,
 100                                const char *dn,
 101                                const char **attrs);
 102 ADS_STATUS ads_search_retry_extended_dn_ranged(ADS_STRUCT *ads, TALLOC_CTX *mem_ctx,
 103                                                 const char *dn,
 104                                                 const char **attrs,
 105                                                 enum ads_extended_dn_flags flags,
 106                                                 char ***strings,
 107                                                 size_t *num_strings);
 108 ADS_STATUS ads_search_retry_sid(ADS_STRUCT *ads, LDAPMessage **res,
 109                                 const struct dom_sid *sid,
 110                                 const char **attrs);
 111
 112
 113 LDAPMessage *ads_first_entry(ADS_STRUCT *ads, LDAPMessage *res);
 114 LDAPMessage *ads_next_entry(ADS_STRUCT *ads, LDAPMessage *res);
 115 LDAPMessage *ads_first_message(ADS_STRUCT *ads, LDAPMessage *res);
 116 LDAPMessage *ads_next_message(ADS_STRUCT *ads, LDAPMessage *res);
 117 void ads_process_results(ADS_STRUCT *ads, LDAPMessage *res,
 118                          bool (*fn)(ADS_STRUCT *,char *, void **, void *),
 119                          void *data_area);
 120 void ads_dump(ADS_STRUCT *ads, LDAPMessage *res);
 121
 122 struct GROUP_POLICY_OBJECT;
 123 ADS_STATUS ads_parse_gpo(ADS_STRUCT *ads,
 124                          TALLOC_CTX *mem_ctx,
 125                          LDAPMessage *res,
 126                          const char *gpo_dn,
 127                          struct GROUP_POLICY_OBJECT *gpo);
 128 ADS_STATUS ads_search_retry_dn_sd_flags(ADS_STRUCT *ads, LDAPMessage **res,
 129                                          uint32_t sd_flags,
 130                                          const char *dn,
 131                                          const char **attrs);
 132 ADS_STATUS ads_do_search_all_sd_flags(ADS_STRUCT *ads, const char *bind_path,
 133                                        int scope, const char *expr,
 134                                        const char **attrs, uint32_t sd_flags,
 135                                        LDAPMessage **res);
 136 ADS_STATUS ads_get_tokensids(ADS_STRUCT *ads,
 137                               TALLOC_CTX *mem_ctx,
 138                               const char *dn,
 139                               struct dom_sid *user_sid,
 140                               struct dom_sid *primary_group_sid,
 141                               struct dom_sid **sids,
 142                               size_t *num_sids);
 143 ADS_STATUS ads_get_joinable_ous(ADS_STRUCT *ads,
 144                                 TALLOC_CTX *mem_ctx,
 145                                 char ***ous,
 146                                 size_t *num_ous);
 147
 148 #endif /* _LIBADS_ADS_LDAP_PROTOS_H_ */