import HEAD into svn+ssh://svn.samba.org/home/svn/samba/trunk
[metze/old/v3-2-winbind-ndr.git] / source / include / smbldap.h
1 /* 
2    Unix SMB/CIFS mplementation.
3    LDAP protocol helper functions for SAMBA
4    Copyright (C) Gerald Carter                  2001-2003
5     
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10    
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15    
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19    
20 */
21
22 #ifndef _SMBLDAP_H
23 #define _SMBLDAP_H
24
25 #ifdef HAVE_LDAP
26
27 /* specify schema versions between 2.2. and 3.0 */
28
29 #define SCHEMAVER_SAMBAACCOUNT          1
30 #define SCHEMAVER_SAMBASAMACCOUNT       2
31
32 /* objectclass names */
33
34 #define LDAP_OBJ_SAMBASAMACCOUNT        "sambaSamAccount"
35 #define LDAP_OBJ_SAMBAACCOUNT           "sambaAccount"
36 #define LDAP_OBJ_GROUPMAP               "sambaGroupMapping"
37 #define LDAP_OBJ_DOMINFO                "sambaDomain"
38 #define LDAP_OBJ_IDPOOL                 "sambaUnixIdPool"
39 #define LDAP_OBJ_IDMAP_ENTRY            "sambaIdmapEntry"
40 #define LDAP_OBJ_SID_ENTRY              "sambaSidEntry"
41 #define LDAP_OBJ_PRIVILEGE              "sambaPrivilege"
42
43 #define LDAP_OBJ_ACCOUNT                "account"
44 #define LDAP_OBJ_POSIXACCOUNT           "posixAccount"
45 #define LDAP_OBJ_POSIXGROUP             "posixGroup"
46 #define LDAP_OBJ_OU                     "organizationalUnit"
47
48 /* some generic attributes that get reused a lot */
49
50 #define LDAP_ATTRIBUTE_SID              "sambaSID"
51 #define LDAP_ATTRIBUTE_UIDNUMBER        "uidNumber"
52 #define LDAP_ATTRIBUTE_GIDNUMBER        "gidNumber"
53 #define LDAP_ATTRIBUTE_SID_LIST         "sambaSIDList"
54
55 /* attribute map table indexes */
56
57 #define LDAP_ATTR_LIST_END              0
58 #define LDAP_ATTR_UID                   1
59 #define LDAP_ATTR_UIDNUMBER             2
60 #define LDAP_ATTR_GIDNUMBER             3
61 #define LDAP_ATTR_UNIX_HOME             4
62 #define LDAP_ATTR_PWD_LAST_SET          5
63 #define LDAP_ATTR_PWD_CAN_CHANGE        6
64 #define LDAP_ATTR_PWD_MUST_CHANGE       7
65 #define LDAP_ATTR_LOGON_TIME            8
66 #define LDAP_ATTR_LOGOFF_TIME           9
67 #define LDAP_ATTR_KICKOFF_TIME          10
68 #define LDAP_ATTR_CN                    11
69 #define LDAP_ATTR_DISPLAY_NAME          12
70 #define LDAP_ATTR_HOME_PATH             13
71 #define LDAP_ATTR_LOGON_SCRIPT          14
72 #define LDAP_ATTR_PROFILE_PATH          15
73 #define LDAP_ATTR_DESC                  16
74 #define LDAP_ATTR_USER_WKS              17
75 #define LDAP_ATTR_USER_SID              18
76 #define LDAP_ATTR_USER_RID              18
77 #define LDAP_ATTR_PRIMARY_GROUP_SID     19
78 #define LDAP_ATTR_PRIMARY_GROUP_RID     20
79 #define LDAP_ATTR_LMPW                  21
80 #define LDAP_ATTR_NTPW                  22
81 #define LDAP_ATTR_DOMAIN                23
82 #define LDAP_ATTR_OBJCLASS              24
83 #define LDAP_ATTR_ACB_INFO              25
84 #define LDAP_ATTR_NEXT_USERRID          26
85 #define LDAP_ATTR_NEXT_GROUPRID         27
86 #define LDAP_ATTR_DOM_SID               28
87 #define LDAP_ATTR_HOME_DRIVE            29
88 #define LDAP_ATTR_GROUP_SID             30
89 #define LDAP_ATTR_GROUP_TYPE            31
90 #define LDAP_ATTR_SID                   32
91 #define LDAP_ATTR_ALGORITHMIC_RID_BASE  33
92 #define LDAP_ATTR_NEXT_RID              34
93 #define LDAP_ATTR_BAD_PASSWORD_COUNT    35
94 #define LDAP_ATTR_LOGON_COUNT           36
95 #define LDAP_ATTR_MUNGED_DIAL           37
96 #define LDAP_ATTR_BAD_PASSWORD_TIME     38
97 #define LDAP_ATTR_MOD_TIMESTAMP         39
98 #define LDAP_ATTR_SID_LIST              40
99
100 typedef struct _attrib_map_entry {
101         int             attrib;
102         const char      *name;
103 } ATTRIB_MAP_ENTRY;
104
105
106 /* structures */
107
108 extern ATTRIB_MAP_ENTRY attrib_map_v22[];
109 extern ATTRIB_MAP_ENTRY attrib_map_v30[];
110 extern ATTRIB_MAP_ENTRY dominfo_attr_list[];
111 extern ATTRIB_MAP_ENTRY groupmap_attr_list[];
112 extern ATTRIB_MAP_ENTRY privilege_attr_list[];
113 extern ATTRIB_MAP_ENTRY groupmap_attr_list_to_delete[];
114 extern ATTRIB_MAP_ENTRY idpool_attr_list[];
115 extern ATTRIB_MAP_ENTRY sidmap_attr_list[];
116
117 /* Function declarations -- not included in proto.h so we don't
118    have to worry about LDAP structure types */
119
120 const char* get_attr_key2string( ATTRIB_MAP_ENTRY table[], int key );
121 char** get_attr_list( ATTRIB_MAP_ENTRY table[] );
122 void free_attr_list( char **list );
123 void smbldap_set_mod (LDAPMod *** modlist, int modop, const char *attribute, const char *value);
124 void smbldap_make_mod(LDAP *ldap_struct, LDAPMessage *existing,
125                       LDAPMod ***mods,
126                       const char *attribute, const char *newval);
127 BOOL smbldap_get_single_attribute (LDAP * ldap_struct, LDAPMessage * entry,
128                                    const char *attribute, char *value,
129                                    int max_len);
130 BOOL smbldap_get_single_pstring (LDAP * ldap_struct, LDAPMessage * entry,
131                                  const char *attribute, pstring value);
132
133 /**
134  * Struct to keep the state for all the ldap stuff 
135  *
136  */
137
138 struct smbldap_state {
139         LDAP *ldap_struct;
140         time_t last_ping;
141         /* retrive-once info */
142         const char *uri;
143         char *bind_dn;
144         char *bind_secret;
145
146         unsigned int num_failures;
147
148         time_t last_use;
149         smb_event_id_t event_id;
150
151         struct timeval last_rebind;
152 };
153
154 #endif  /* HAVE_LDAP */
155
156 struct smbldap_state;
157
158 #endif  /* _SMBLDAP_H */
159