mirror of
https://git.openldap.org/openldap/openldap.git
synced 2024-12-21 03:10:25 +08:00
314 lines
10 KiB
C
314 lines
10 KiB
C
/* $OpenLDAP$ */
|
|
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
|
|
*
|
|
* Copyright 1999-2020 The OpenLDAP Foundation.
|
|
* Portions Copyright 1999 Dmitry Kovalev.
|
|
* Portions Copyright 2002 Pierangelo Mararati.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted only as authorized by the OpenLDAP
|
|
* Public License.
|
|
*
|
|
* A copy of this license is available in the file LICENSE in the
|
|
* top-level directory of the distribution or, alternatively, at
|
|
* <http://www.OpenLDAP.org/license.html>.
|
|
*/
|
|
/* ACKNOWLEDGEMENTS:
|
|
* This work was initially developed by Dmitry Kovalev for inclusion
|
|
* by OpenLDAP Software. Additional significant contributors include
|
|
* Pierangelo Masarati
|
|
*/
|
|
|
|
/*
|
|
* The following changes have been addressed:
|
|
*
|
|
* Enhancements:
|
|
* - re-styled code for better readability
|
|
* - upgraded backend API to reflect recent changes
|
|
* - LDAP schema is checked when loading SQL/LDAP mapping
|
|
* - AttributeDescription/ObjectClass pointers used for more efficient
|
|
* mapping lookup
|
|
* - bervals used where string length is required often
|
|
* - atomized write operations by committing at the end of each operation
|
|
* and defaulting connection closure to rollback
|
|
* - added LDAP access control to write operations
|
|
* - fully implemented modrdn (with rdn attrs change, deleteoldrdn,
|
|
* access check, parent/children check and more)
|
|
* - added parent access control, children control to delete operation
|
|
* - added structuralObjectClass operational attribute check and
|
|
* value return on search
|
|
* - added hasSubordinate operational attribute on demand
|
|
* - search limits are appropriately enforced
|
|
* - function backsql_strcat() has been made more efficient
|
|
* - concat function has been made configurable by means of a pattern
|
|
* - added config switches:
|
|
* - fail_if_no_mapping write operations fail if there is no mapping
|
|
* - has_ldapinfo_dn_ru overrides autodetect
|
|
* - concat_pattern a string containing two '?' is used
|
|
* (note that "?||?" should be more portable
|
|
* than builtin function "CONCAT(?,?)")
|
|
* - strcast_func cast of string constants in "SELECT DISTINCT
|
|
* statements (needed by PostgreSQL)
|
|
* - upper_needs_cast cast the argument of upper when required
|
|
* (basically when building dn substring queries)
|
|
* - added noop control
|
|
* - added values return filter control
|
|
* - hasSubordinate can be used in search filters (with limitations)
|
|
* - eliminated oc->name; use oc->oc->soc_cname instead
|
|
*
|
|
* Todo:
|
|
* - add security checks for SQL statements that can be injected (?)
|
|
* - re-test with previously supported RDBMs
|
|
* - replace dn_ru and so with normalized dn (no need for upper() and so
|
|
* in dn match)
|
|
* - implement a backsql_normalize() function to replace the upper()
|
|
* conversion routines
|
|
* - note that subtree deletion, subtree renaming and so could be easily
|
|
* implemented (rollback and consistency checks are available :)
|
|
* - implement "lastmod" and other operational stuff (ldap_entries table ?)
|
|
* - check how to allow multiple operations with one statement, to remove
|
|
* BACKSQL_REALLOC_STMT from modify.c (a more recent unixODBC lib?)
|
|
*/
|
|
|
|
#ifndef PROTO_SQL_H
|
|
#define PROTO_SQL_H
|
|
|
|
#include "back-sql.h"
|
|
|
|
/*
|
|
* add.c
|
|
*/
|
|
int backsql_modify_delete_all_values(
|
|
Operation *op,
|
|
SlapReply *rs,
|
|
SQLHDBC dbh,
|
|
backsql_entryID *e_id,
|
|
backsql_at_map_rec *at );
|
|
|
|
int backsql_modify_internal(
|
|
Operation *op,
|
|
SlapReply *rs,
|
|
SQLHDBC dbh,
|
|
backsql_oc_map_rec *oc,
|
|
backsql_entryID *e_id,
|
|
Modifications *modlist );
|
|
|
|
/*
|
|
* api.c
|
|
*/
|
|
int backsql_api_config( backsql_info *bi, const char *name,
|
|
int argc, char *argv[] );
|
|
int backsql_api_destroy( backsql_info *bi );
|
|
int backsql_api_register( backsql_api *ba );
|
|
int backsql_api_dn2odbc( Operation *op, SlapReply *rs, struct berval *dn );
|
|
int backsql_api_odbc2dn( Operation *op, SlapReply *rs, struct berval *dn );
|
|
|
|
/*
|
|
* entry-id.c
|
|
*/
|
|
#ifdef BACKSQL_ARBITRARY_KEY
|
|
extern struct berval backsql_baseObject_bv;
|
|
#endif /* BACKSQL_ARBITRARY_KEY */
|
|
|
|
/* stores in *id the ID in table ldap_entries corresponding to DN, if any */
|
|
extern int
|
|
backsql_dn2id( Operation *op, SlapReply *rs, SQLHDBC dbh,
|
|
struct berval *ndn, backsql_entryID *id,
|
|
int matched, int muck );
|
|
|
|
/* stores in *nchildren the count of children for an entry */
|
|
extern int
|
|
backsql_count_children( Operation *op, SQLHDBC dbh,
|
|
struct berval *dn, unsigned long *nchildren );
|
|
|
|
/* returns LDAP_COMPARE_TRUE/LDAP_COMPARE_FALSE if the entry corresponding
|
|
* to DN has/has not children */
|
|
extern int
|
|
backsql_has_children( Operation *op, SQLHDBC dbh, struct berval *dn );
|
|
|
|
/* free *id and return next in list */
|
|
extern backsql_entryID *
|
|
backsql_free_entryID( backsql_entryID *id, int freeit, void *ctx );
|
|
|
|
/* turn an ID into an entry */
|
|
extern int
|
|
backsql_id2entry( backsql_srch_info *bsi, backsql_entryID *id );
|
|
|
|
/* duplicate an entryID */
|
|
extern backsql_entryID *
|
|
backsql_entryID_dup( backsql_entryID *eid, void *ctx );
|
|
|
|
/*
|
|
* operational.c
|
|
*/
|
|
|
|
Attribute *backsql_operational_entryUUID( backsql_info *bi, backsql_entryID *id );
|
|
|
|
Attribute *backsql_operational_entryCSN( Operation *op );
|
|
|
|
/*
|
|
* schema-map.c
|
|
*/
|
|
|
|
int backsql_load_schema_map( backsql_info *si, SQLHDBC dbh );
|
|
|
|
backsql_oc_map_rec *backsql_oc2oc( backsql_info *si, ObjectClass *oc );
|
|
|
|
backsql_oc_map_rec *backsql_id2oc( backsql_info *si, unsigned long id );
|
|
|
|
backsql_oc_map_rec * backsql_name2oc( backsql_info *si,
|
|
struct berval *oc_name );
|
|
|
|
backsql_at_map_rec *backsql_ad2at( backsql_oc_map_rec *objclass,
|
|
AttributeDescription *ad );
|
|
|
|
int backsql_supad2at( backsql_oc_map_rec *objclass,
|
|
AttributeDescription *supad, backsql_at_map_rec ***pret );
|
|
|
|
int backsql_destroy_schema_map( backsql_info *si );
|
|
|
|
/*
|
|
* search.c
|
|
*/
|
|
|
|
int backsql_init_search( backsql_srch_info *bsi,
|
|
struct berval *nbase, int scope,
|
|
time_t stoptime, Filter *filter, SQLHDBC dbh,
|
|
Operation *op, SlapReply *rs, AttributeName *attrs,
|
|
unsigned flags );
|
|
|
|
void backsql_entry_clean( Operation *op, Entry *e );
|
|
|
|
/*
|
|
* sql-wrap.h
|
|
*/
|
|
|
|
RETCODE backsql_Prepare( SQLHDBC dbh, SQLHSTMT *sth, const char* query, int timeout );
|
|
|
|
#define backsql_BindParamStr( sth, par_ind, io, str, maxlen ) \
|
|
SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
|
|
(io), SQL_C_CHAR, SQL_VARCHAR, \
|
|
(SQLULEN)(maxlen), 0, (SQLPOINTER)(str), \
|
|
(SQLLEN)(maxlen), NULL )
|
|
|
|
#define backsql_BindParamBerVal( sth, par_ind, io, bv ) \
|
|
SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
|
|
(io), SQL_C_CHAR, SQL_VARCHAR, \
|
|
(SQLULEN)(bv)->bv_len, 0, \
|
|
(SQLPOINTER)(bv)->bv_val, \
|
|
(SQLLEN)(bv)->bv_len, NULL )
|
|
|
|
#define backsql_BindParamInt( sth, par_ind, io, val ) \
|
|
SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
|
|
(io), SQL_C_ULONG, SQL_INTEGER, \
|
|
0, 0, (SQLPOINTER)(val), 0, (SQLLEN*)NULL )
|
|
|
|
#define backsql_BindParamNumID( sth, par_ind, io, val ) \
|
|
SQLBindParameter( (sth), (SQLUSMALLINT)(par_ind), \
|
|
(io), BACKSQL_C_NUMID, SQL_INTEGER, \
|
|
0, 0, (SQLPOINTER)(val), 0, (SQLLEN*)NULL )
|
|
|
|
#ifdef BACKSQL_ARBITRARY_KEY
|
|
#define backsql_BindParamID( sth, par_ind, io, id ) \
|
|
backsql_BindParamBerVal( (sth), (par_ind), (io), (id) )
|
|
#else /* ! BACKSQL_ARBITRARY_KEY */
|
|
#define backsql_BindParamID( sth, par_ind, io, id ) \
|
|
backsql_BindParamNumID( (sth), (par_ind), (io), (id) )
|
|
#endif /* ! BACKSQL_ARBITRARY_KEY */
|
|
|
|
RETCODE backsql_BindRowAsStrings_x( SQLHSTMT sth, BACKSQL_ROW_NTS *row, void *ctx );
|
|
|
|
RETCODE backsql_BindRowAsStrings( SQLHSTMT sth, BACKSQL_ROW_NTS *row );
|
|
|
|
RETCODE backsql_FreeRow_x( BACKSQL_ROW_NTS *row, void *ctx );
|
|
|
|
RETCODE backsql_FreeRow( BACKSQL_ROW_NTS *row );
|
|
|
|
void backsql_PrintErrors( SQLHENV henv, SQLHDBC hdbc, SQLHSTMT sth, int rc );
|
|
|
|
int backsql_conn_destroy( backsql_info *bi );
|
|
|
|
int backsql_init_db_env( backsql_info *si );
|
|
|
|
int backsql_free_db_env( backsql_info *si );
|
|
|
|
int backsql_get_db_conn( Operation *op, SQLHDBC *dbh );
|
|
|
|
int backsql_free_db_conn( Operation *op, SQLHDBC dbh );
|
|
|
|
/*
|
|
* util.c
|
|
*/
|
|
|
|
extern const char
|
|
backsql_def_oc_query[],
|
|
backsql_def_needs_select_oc_query[],
|
|
backsql_def_at_query[],
|
|
backsql_def_delentry_stmt[],
|
|
backsql_def_renentry_stmt[],
|
|
backsql_def_insentry_stmt[],
|
|
backsql_def_delobjclasses_stmt[],
|
|
backsql_def_subtree_cond[],
|
|
backsql_def_upper_subtree_cond[],
|
|
backsql_id_query[],
|
|
backsql_def_concat_func[],
|
|
backsql_check_dn_ru_query[];
|
|
|
|
struct berbuf * backsql_strcat_x( struct berbuf *dest, void *memctx, ... );
|
|
struct berbuf * backsql_strfcat_x( struct berbuf *dest, void *memctx, const char *fmt, ... );
|
|
|
|
int backsql_entry_addattr( Entry *e, AttributeDescription *ad,
|
|
struct berval *at_val, void *memctx );
|
|
|
|
int backsql_merge_from_clause( backsql_info *bi, struct berbuf *dest_from,
|
|
struct berval *src_from );
|
|
|
|
int backsql_split_pattern( const char *pattern, BerVarray *split_pattern,
|
|
int expected );
|
|
|
|
int backsql_prepare_pattern( BerVarray split_pattern, BerVarray values,
|
|
struct berval *res );
|
|
|
|
int backsql_entryUUID( backsql_info *bi, backsql_entryID *id,
|
|
struct berval *entryUUID, void *memctx );
|
|
int backsql_entryUUID_decode( struct berval *entryUUID, unsigned long *oc_id,
|
|
#ifdef BACKSQL_ARBITRARY_KEY
|
|
struct berval *keyval
|
|
#else /* ! BACKSQL_ARBITRARY_KEY */
|
|
unsigned long *keyval
|
|
#endif /* ! BACKSQL_ARBITRARY_KEY */
|
|
);
|
|
|
|
/*
|
|
* former external.h
|
|
*/
|
|
|
|
extern BI_init sql_back_initialize;
|
|
|
|
extern BI_destroy backsql_destroy;
|
|
|
|
extern BI_db_init backsql_db_init;
|
|
extern BI_db_open backsql_db_open;
|
|
extern BI_db_close backsql_db_close;
|
|
extern BI_db_destroy backsql_db_destroy;
|
|
extern BI_db_config backsql_db_config;
|
|
|
|
extern BI_op_bind backsql_bind;
|
|
extern BI_op_search backsql_search;
|
|
extern BI_op_compare backsql_compare;
|
|
extern BI_op_modify backsql_modify;
|
|
extern BI_op_modrdn backsql_modrdn;
|
|
extern BI_op_add backsql_add;
|
|
extern BI_op_delete backsql_delete;
|
|
|
|
extern BI_operational backsql_operational;
|
|
extern BI_entry_get_rw backsql_entry_get;
|
|
extern BI_entry_release_rw backsql_entry_release;
|
|
|
|
extern BI_connection_destroy backsql_connection_destroy;
|
|
|
|
int backsql_init_cf( BackendInfo * bi );
|
|
|
|
#endif /* PROTO_SQL_H */
|