s3:param: make init_locals() static.
[kai/samba.git] / source3 / include / smbldap.h
index 589d01aa6dd592f76149cea731912c7a216fe3f6..ea944cf78ff94c2d8ea7857fb47fa7bd385c35d7 100644 (file)
    Unix SMB/CIFS mplementation.
    LDAP protocol helper functions for SAMBA
    Copyright (C) Gerald Carter                 2001-2003
-    
+
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
-   
+
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
-   
+
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-   
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 */
 
 #ifndef _SMBLDAP_H
 #define _SMBLDAP_H
 
+#include "include/smb_ldap.h"
+
 #ifdef HAVE_LDAP
 
-/* specify schema versions between 2.2. and 3.0 */
-
-#define SCHEMAVER_SAMBAACCOUNT         1
-#define SCHEMAVER_SAMBASAMACCOUNT      2
-
-/* objectclass names */
-
-#define LDAP_OBJ_SAMBASAMACCOUNT       "sambaSamAccount"
-#define LDAP_OBJ_SAMBAACCOUNT          "sambaAccount"
-#define LDAP_OBJ_GROUPMAP              "sambaGroupMapping"
-#define LDAP_OBJ_DOMINFO               "sambaDomain"
-#define LDAP_OBJ_IDPOOL                        "sambaUnixIdPool"
-#define LDAP_OBJ_IDMAP_ENTRY           "sambaIdmapEntry"
-#define LDAP_OBJ_SID_ENTRY             "sambaSidEntry"
-
-#define LDAP_OBJ_ACCOUNT               "account"
-#define LDAP_OBJ_POSIXACCOUNT          "posixAccount"
-#define LDAP_OBJ_POSIXGROUP            "posixGroup"
-#define LDAP_OBJ_OU                    "organizationalUnit"
-
-/* some generic attributes that get reused a lot */
-
-#define LDAP_ATTRIBUTE_SID             "sambaSID"
-#define LDAP_ATTRIBUTE_UIDNUMBER       "uidNumber"
-#define LDAP_ATTRIBUTE_GIDNUMBER       "gidNumber"
-
-/* attribute map table indexes */
-
-#define LDAP_ATTR_LIST_END             0
-#define LDAP_ATTR_UID                  1
-#define LDAP_ATTR_UIDNUMBER            2
-#define LDAP_ATTR_GIDNUMBER            3
-#define LDAP_ATTR_UNIX_HOME            4
-#define LDAP_ATTR_PWD_LAST_SET         5
-#define LDAP_ATTR_PWD_CAN_CHANGE       6
-#define LDAP_ATTR_PWD_MUST_CHANGE      7
-#define LDAP_ATTR_LOGON_TIME           8
-#define LDAP_ATTR_LOGOFF_TIME          9
-#define LDAP_ATTR_KICKOFF_TIME         10
-#define LDAP_ATTR_CN                   11
-#define LDAP_ATTR_DISPLAY_NAME         12
-#define LDAP_ATTR_HOME_PATH            13
-#define LDAP_ATTR_LOGON_SCRIPT         14
-#define LDAP_ATTR_PROFILE_PATH         15
-#define LDAP_ATTR_DESC                 16
-#define LDAP_ATTR_USER_WKS             17
-#define LDAP_ATTR_USER_SID             18
-#define LDAP_ATTR_USER_RID             18
-#define LDAP_ATTR_PRIMARY_GROUP_SID    19
-#define LDAP_ATTR_PRIMARY_GROUP_RID    20
-#define LDAP_ATTR_LMPW                 21
-#define LDAP_ATTR_NTPW                 22
-#define LDAP_ATTR_DOMAIN               23
-#define LDAP_ATTR_OBJCLASS             24
-#define LDAP_ATTR_ACB_INFO             25
-#define LDAP_ATTR_NEXT_USERRID         26
-#define LDAP_ATTR_NEXT_GROUPRID                27
-#define LDAP_ATTR_DOM_SID              28
-#define LDAP_ATTR_HOME_DRIVE           29
-#define LDAP_ATTR_GROUP_SID            30
-#define LDAP_ATTR_GROUP_TYPE           31
-#define LDAP_ATTR_SID                  32
-#define LDAP_ATTR_ALGORITHMIC_RID_BASE  33
-#define LDAP_ATTR_NEXT_RID              34
-
-typedef struct _attrib_map_entry {
-       int             attrib;
-       const char      *name;
-} ATTRIB_MAP_ENTRY;
-
-
-/* structures */
-
-extern ATTRIB_MAP_ENTRY attrib_map_v22[];
-extern ATTRIB_MAP_ENTRY attrib_map_v30[];
-extern ATTRIB_MAP_ENTRY dominfo_attr_list[];
-extern ATTRIB_MAP_ENTRY groupmap_attr_list[];
-extern ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[];
-extern ATTRIB_MAP_ENTRY idpool_attr_list[];
-extern ATTRIB_MAP_ENTRY sidmap_attr_list[];
-
-/* Function declarations -- not included in proto.h so we don't
-   have to worry about LDAP structure types */
-
-const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key );
-char** get_attr_list( ATTRIB_MAP_ENTRY table[] );
-void free_attr_list( char **list );
-void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value);
-void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
-                     LDAPMod ***mods,
-                     const char *attribute, const char *newval);
-BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
-                                  const char *attribute, pstring value);
+#include <talloc.h>
+#include <tevent.h>
 
 /**
  * Struct to keep the state for all the ldap stuff 
@@ -125,18 +35,133 @@ BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
 
 struct smbldap_state {
        LDAP *ldap_struct;
-       time_t last_ping;
+       pid_t pid;
+       time_t last_ping; /* monotonic */
        /* retrive-once info */
        const char *uri;
+
+       /* credentials */
+       bool anonymous;
        char *bind_dn;
        char *bind_secret;
+       int (*bind_callback)(LDAP *ldap_struct, struct smbldap_state *ldap_state, void *data);
+       void *bind_callback_data;
+
+       bool paged_results;
 
        unsigned int num_failures;
+
+       time_t last_use; /* monotonic */
+       struct tevent_context *tevent_context;
+       struct timed_event *idle_event;
+
+       struct timeval last_rebind; /* monotonic */
 };
 
-#endif         /* HAVE_LDAP */
+/* struct used by both pdb_ldap.c and pdb_nds.c */
 
-struct smbldap_state;
+struct ipasam_privates;
 
-#endif /* _SMBLDAP_H */
+struct ldapsam_privates {
+       struct smbldap_state *smbldap_state;
+
+       /* Former statics */
+       LDAPMessage *result;
+       LDAPMessage *entry;
+       int index;
+
+       const char *domain_name;
+       struct dom_sid domain_sid;
 
+       /* configuration items */
+       int schema_ver;
+
+       char *domain_dn;
+
+       /* Is this NDS ldap? */
+       int is_nds_ldap;
+
+       /* Is this IPA ldap? */
+       int is_ipa_ldap;
+       struct ipasam_privates *ipasam_privates;
+
+       /* ldap server location parameter */
+       char *location;
+
+       struct {
+               char *filter;
+               LDAPMessage *result;
+       } search_cache;
+};
+
+/* The following definitions come from lib/smbldap.c  */
+
+NTSTATUS smbldap_init(TALLOC_CTX *mem_ctx,
+                     struct tevent_context *tevent_ctx,
+                     const char *location,
+                     bool anon,
+                     const char *bind_dn,
+                     const char *bind_secret,
+                     struct smbldap_state **smbldap_state);
+
+void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value);
+void smbldap_set_mod_blob(LDAPMod *** modlist, int modop, const char *attribute, const DATA_BLOB *newblob);
+void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
+                     LDAPMod ***mods,
+                     const char *attribute, const char *newval);
+void smbldap_make_mod_blob(LDAP *ldap_struct, LDAPMessage *existing,
+                          LDAPMod ***mods,
+                          const char *attribute, const DATA_BLOB *newblob);
+bool smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
+                                  const char *attribute, char *value,
+                                  int max_len);
+int smbldap_modify(struct smbldap_state *ldap_state,
+                   const char *dn,
+                   LDAPMod *attrs[]);
+int smbldap_start_tls(LDAP *ldap_struct, int version);
+int smbldap_setup_full_conn(LDAP **ldap_struct, const char *uri);
+int smbldap_search(struct smbldap_state *ldap_state,
+                  const char *base, int scope, const char *filter,
+                  const char *attrs[], int attrsonly,
+                  LDAPMessage **res);
+int smbldap_search_paged(struct smbldap_state *ldap_state,
+                        const char *base, int scope, const char *filter,
+                        const char **attrs, int attrsonly, int pagesize,
+                        LDAPMessage **res, void **cookie);
+int smbldap_modify(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[]);
+int smbldap_add(struct smbldap_state *ldap_state, const char *dn, LDAPMod *attrs[]);
+int smbldap_delete(struct smbldap_state *ldap_state, const char *dn);
+int smbldap_extended_operation(struct smbldap_state *ldap_state,
+                              LDAP_CONST char *reqoid, struct berval *reqdata,
+                              LDAPControl **serverctrls, LDAPControl **clientctrls,
+                              char **retoidp, struct berval **retdatap);
+int smbldap_search_suffix (struct smbldap_state *ldap_state,
+                          const char *filter, const char **search_attr,
+                          LDAPMessage ** result);
+void smbldap_free_struct(struct smbldap_state **ldap_state) ;
+bool smbldap_has_control(LDAP *ld, const char *control);
+bool smbldap_has_extension(LDAP *ld, const char *extension);
+bool smbldap_has_naming_context(LDAP *ld, const char *naming_context);
+bool smbldap_set_creds(struct smbldap_state *ldap_state, bool anon, const char *dn, const char *secret);
+char * smbldap_talloc_single_attribute(LDAP *ldap_struct, LDAPMessage *entry,
+                                      const char *attribute,
+                                      TALLOC_CTX *mem_ctx);
+char * smbldap_talloc_first_attribute(LDAP *ldap_struct, LDAPMessage *entry,
+                                     const char *attribute,
+                                     TALLOC_CTX *mem_ctx);
+char * smbldap_talloc_smallest_attribute(LDAP *ldap_struct, LDAPMessage *entry,
+                                        const char *attribute,
+                                        TALLOC_CTX *mem_ctx);
+bool smbldap_talloc_single_blob(TALLOC_CTX *mem_ctx, LDAP *ld,
+                               LDAPMessage *msg, const char *attrib,
+                               DATA_BLOB *blob);
+bool smbldap_pull_sid(LDAP *ld, LDAPMessage *msg, const char *attrib,
+                     struct dom_sid *sid);
+void smbldap_talloc_autofree_ldapmsg(TALLOC_CTX *mem_ctx, LDAPMessage *result);
+void smbldap_talloc_autofree_ldapmod(TALLOC_CTX *mem_ctx, LDAPMod **mod);
+char *smbldap_talloc_dn(TALLOC_CTX *mem_ctx, LDAP *ld,
+                             LDAPMessage *entry);
+
+#endif         /* HAVE_LDAP */
+
+#endif /* _SMBLDAP_H */