2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2004 The OpenLDAP Foundation.
5 * Portions Copyright 1999 Dmitry Kovalev.
6 * Portions Copyright 2002 Pierangelo Mararati.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Dmitry Kovalev for inclusion
19 * by OpenLDAP Software. Additional significant contributors include
24 * The following changes have been addressed:
27 * - re-styled code for better readability
28 * - upgraded backend API to reflect recent changes
29 * - LDAP schema is checked when loading SQL/LDAP mapping
30 * - AttributeDescription/ObjectClass pointers used for more efficient
32 * - bervals used where string length is required often
33 * - atomized write operations by committing at the end of each operation
34 * and defaulting connection closure to rollback
35 * - added LDAP access control to write operations
36 * - fully implemented modrdn (with rdn attrs change, deleteoldrdn,
37 * access check, parent/children check and more)
38 * - added parent access control, children control to delete operation
39 * - added structuralObjectClass operational attribute check and
40 * value return on search
41 * - added hasSubordinate operational attribute on demand
42 * - search limits are appropriately enforced
43 * - function backsql_strcat() has been made more efficient
44 * - concat function has been made configurable by means of a pattern
45 * - added config switches:
46 * - fail_if_no_mapping write operations fail if there is no mapping
47 * - has_ldapinfo_dn_ru overrides autodetect
48 * - concat_pattern a string containing two '?' is used
49 * (note that "?||?" should be more portable
50 * than builtin function "CONCAT(?,?)")
51 * - strcast_func cast of string constants in "SELECT DISTINCT
52 * statements (needed by PostgreSQL)
53 * - upper_needs_cast cast the argument of upper when required
54 * (basically when building dn substring queries)
55 * - added noop control
56 * - added values return filter control
57 * - hasSubordinate can be used in search filters (with limitations)
58 * - eliminated oc->name; use oc->oc->soc_cname instead
61 * - add security checks for SQL statements that can be injected (?)
62 * - re-test with previously supported RDBMs
63 * - replace dn_ru and so with normalized dn (no need for upper() and so
65 * - implement a backsql_normalize() function to replace the upper()
67 * - note that subtree deletion, subtree renaming and so could be easily
68 * implemented (rollback and consistency checks are available :)
69 * - implement "lastmod" and other operational stuff (ldap_entries table ?)
70 * - check how to allow multiple operations with one statement, to remove
71 * BACKSQL_REALLOC_STMT from modify.c (a more recent unixODBC lib?)
78 #include "sql-types.h"
81 * PostgreSQL 7.0 doesn't work without :(
83 #define BACKSQL_REALLOC_STMT
86 * Better use the standard length of 8192 (as of slap.h)?
88 /* #define BACKSQL_MAX_DN_LEN SLAP_LDAPDN_MAXLEN */
89 #define BACKSQL_MAX_DN_LEN 255
92 * define to enable very extensive trace logging (debug only)
97 * define to enable varchars as unique keys in user tables
99 #undef BACKSQL_ARBITRARY_KEY
104 typedef struct backsql_api {
106 int (*ba_dn2odbc)( Operation *op, SlapReply *rs, struct berval *dn );
107 int (*ba_odbc2dn)( Operation *op, SlapReply *rs, struct berval *dn );
108 struct backsql_api *ba_next;
114 typedef struct backsql_entryID {
115 /* #define BACKSQL_ARBITRARY_KEY to allow a non-numeric key.
116 * It is required by some special applications that use
117 * strings as keys for the main table.
118 * In this case, #define BACKSQL_MAX_KEY_LEN consistently
119 * with the key size definition */
120 #ifdef BACKSQL_ARBITRARY_KEY
121 struct berval eid_id;
122 struct berval eid_keyval;
123 #define BACKSQL_MAX_KEY_LEN 64
124 #else /* ! BACKSQL_ARBITRARY_KEY */
125 /* The original numeric key is maintained as default. */
126 unsigned long eid_id;
127 unsigned long eid_keyval;
128 #endif /* ! BACKSQL_ARBITRARY_KEY */
130 unsigned long eid_oc_id;
131 struct berval eid_dn;
132 struct backsql_entryID *eid_next;
135 #ifdef BACKSQL_ARBITRARY_KEY
136 #define BACKSQL_ENTRYID_INIT { BER_BVNULL, BER_BVNULL, 0, BER_BVNULL, NULL }
137 #else /* ! BACKSQL_ARBITRARY_KEY */
138 #define BACKSQL_ENTRYID_INIT { 0, 0, 0, BER_BVNULL, NULL }
139 #endif /* BACKSQL_ARBITRARY_KEY */
142 * "structural" objectClass mapping structure
144 typedef struct backsql_oc_map_rec {
146 * Structure of corresponding LDAP objectClass definition
149 #define BACKSQL_OC_NAME(ocmap) ((ocmap)->bom_oc->soc_cname.bv_val)
151 struct berval bom_keytbl;
152 struct berval bom_keycol;
153 /* expected to return keyval of newly created entry */
154 char *bom_create_proc;
155 /* in case create_proc does not return the keyval of the newly
157 char *bom_create_keyval;
158 /* supposed to expect keyval as parameter and delete
159 * all the attributes as well */
160 char *bom_delete_proc;
161 /* flags whether delete_proc is a function (whether back-sql
162 * should bind first parameter as output for return code) */
163 int bom_expect_return;
164 unsigned long bom_id;
166 } backsql_oc_map_rec;
169 * attributeType mapping structure
171 typedef struct backsql_at_map_rec {
172 /* Description of corresponding LDAP attribute type */
173 AttributeDescription *bam_ad;
174 /* ObjectClass if bam_ad is objectClass */
177 struct berval bam_from_tbls;
178 struct berval bam_join_where;
179 struct berval bam_sel_expr;
181 /* TimesTen, or, if a uppercase function is defined,
182 * an uppercased version of bam_sel_expr */
183 struct berval bam_sel_expr_u;
185 /* supposed to expect 2 binded values: entry keyval
186 * and attr. value to add, like "add_name(?,?,?)" */
188 /* supposed to expect 2 binded values: entry keyval
189 * and attr. value to delete */
190 char *bam_delete_proc;
191 /* for optimization purposes attribute load query
192 * is preconstructed from parts on schemamap load time */
194 /* following flags are bitmasks (first bit used for add_proc,
195 * second - for delete_proc) */
196 /* order of parameters for procedures above;
197 * 1 means "data then keyval", 0 means "keyval then data" */
199 /* flags whether one or more of procedures is a function
200 * (whether back-sql should bind first parameter as output
201 * for return code) */
202 int bam_expect_return;
204 /* next mapping for attribute */
205 struct backsql_at_map_rec *bam_next;
206 } backsql_at_map_rec;
208 #define BACKSQL_AT_MAP_REC_INIT { NULL, NULL, BER_BVC(""), BER_BVC(""), BER_BVNULL, BER_BVNULL, NULL, NULL, NULL, 0, 0, NULL }
210 /* define to uppercase filters only if the matching rule requires it
211 * (currently broken) */
212 /* #define BACKSQL_UPPERCASE_FILTER */
214 #define BACKSQL_AT_CANUPPERCASE(at) ((at)->bam_sel_expr_u.bv_val)
216 /* defines to support bitmasks above */
217 #define BACKSQL_ADD 0x1
218 #define BACKSQL_DEL 0x2
220 #define BACKSQL_IS_ADD(x) ( BACKSQL_ADD & (x) )
221 #define BACKSQL_IS_DEL(x) ( BACKSQL_DEL & (x) )
223 #define BACKSQL_NCMP(v1,v2) ber_bvcmp((v1),(v2))
225 #define BACKSQL_CONCAT
227 * berbuf structure: a berval with a buffer size associated
229 typedef struct berbuf {
230 struct berval bb_val;
234 #define BB_NULL { { 0, NULL }, 0 }
236 typedef struct backsql_srch_info {
241 #define BSQL_SF_ALL_OPER 0x0001
242 #define BSQL_SF_FILTER_HASSUBORDINATE 0x0002
244 struct berval *bsi_base_dn;
246 #define BACKSQL_SCOPE_BASE_LIKE ( LDAP_SCOPE_BASE | 0x1000 )
252 backsql_entryID *bsi_id_list,
254 int bsi_n_candidates;
258 backsql_oc_map_rec *bsi_oc;
259 struct berbuf bsi_sel,
263 ObjectClass *bsi_filter_oc;
265 AttributeName *bsi_attrs;
271 * Backend private data structure
280 * SQL condition for subtree searches differs in syntax:
281 * "LIKE CONCAT('%',?)" or "LIKE '%'+?" or "LIKE '%'||?"
284 struct berval subtree_cond;
285 struct berval children_cond;
286 char *oc_query, *at_query;
287 char *insentry_query,*delentry_query;
289 char *has_children_query;
291 MatchingRule *bi_caseIgnoreMatch;
292 MatchingRule *bi_telephoneNumberMatch;
294 struct berval upper_func;
295 struct berval upper_func_open;
296 struct berval upper_func_close;
297 BerVarray concat_func;
299 unsigned int bsql_flags;
300 #define BSQLF_SCHEMA_LOADED 0x0001
301 #define BSQLF_UPPER_NEEDS_CAST 0x0002
302 #define BSQLF_CREATE_NEEDS_SELECT 0x0004
303 #define BSQLF_FAIL_IF_NO_MAPPING 0x0008
304 #define BSQLF_HAS_LDAPINFO_DN_RU 0x0010
305 #define BSQLF_DONTCHECK_LDAPINFO_DN_RU 0x0020
306 #define BSQLF_USE_REVERSE_DN 0x0040
308 #define BACKSQL_SCHEMA_LOADED(si) \
309 ((si)->bsql_flags & BSQLF_SCHEMA_LOADED)
310 #define BACKSQL_UPPER_NEEDS_CAST(si) \
311 ((si)->bsql_flags & BSQLF_UPPER_NEEDS_CAST)
312 #define BACKSQL_CREATE_NEEDS_SELECT(si) \
313 ((si)->bsql_flags & BSQLF_CREATE_NEEDS_SELECT)
314 #define BACKSQL_FAIL_IF_NO_MAPPING(si) \
315 ((si)->bsql_flags & BSQLF_FAIL_IF_NO_MAPPING)
316 #define BACKSQL_HAS_LDAPINFO_DN_RU(si) \
317 ((si)->bsql_flags & BSQLF_HAS_LDAPINFO_DN_RU)
318 #define BACKSQL_DONTCHECK_LDAPINFO_DN_RU(si) \
319 ((si)->bsql_flags & BSQLF_DONTCHECK_LDAPINFO_DN_RU)
320 #define BACKSQL_USE_REVERSE_DN(si) \
321 ((si)->bsql_flags & BSQLF_USE_REVERSE_DN)
322 #define BACKSQL_CANUPPERCASE(si) \
323 ((si)->upper_func.bv_val)
325 struct berval strcast_func;
329 ldap_pvt_thread_mutex_t dbconn_mutex;
330 ldap_pvt_thread_mutex_t schema_mutex;
336 #define BACKSQL_SUCCESS( rc ) \
337 ( (rc) == SQL_SUCCESS || (rc) == SQL_SUCCESS_WITH_INFO )
339 #define BACKSQL_AVL_STOP 0
340 #define BACKSQL_AVL_CONTINUE 1
342 #endif /* __BACKSQL_H__ */