/* refint.c - referential integrity module */ /* $OpenLDAP$ */ /* This work is part of OpenLDAP Software . * * Copyright 2004-2006 The OpenLDAP Foundation. * Portions Copyright 2004 Symas Corporation. * 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 * . */ /* ACKNOWLEDGEMENTS: * This work was initially developed by Symas Corp. for inclusion in * OpenLDAP Software. This work was sponsored by Hewlett-Packard. */ #include "portable.h" /* This module maintains referential integrity for a set of * DN-valued attributes by searching for all references to a given * DN whenever the DN is changed or its entry is deleted, and making * the appropriate update. * * Updates are performed using the database rootdn in a separate task * to allow the original operation to complete immediately. */ #ifdef SLAPD_OVER_REFINT #include #include #include #include "slap.h" #include "config.h" #include "ldap_rq.h" static slap_overinst refint; /* The DN to use in the ModifiersName for all refint updates */ static BerValue refint_dn = BER_BVC("cn=Referential Integrity Overlay"); static BerValue refint_ndn = BER_BVC("cn=referential integrity overlay"); typedef struct refint_attrs_s { struct refint_attrs_s *next; AttributeDescription *attr; } refint_attrs; typedef struct dependents_s { struct dependents_s *next; BerValue dn; /* target dn */ BerValue ndn; refint_attrs *attrs; } dependent_data; typedef struct refint_q { struct refint_q *next; struct refint_data_s *rdata; dependent_data *attrs; /* entries and attrs returned from callback */ BackendDB *db; BerValue olddn; BerValue oldndn; BerValue newdn; BerValue newndn; } refint_q; typedef struct refint_data_s { const char *message; /* breadcrumbs */ struct refint_attrs_s *attrs; /* list of known attrs */ BerValue dn; /* basedn in parent, */ BerValue nothing; /* the nothing value, if needed */ BerValue nnothing; /* normalized nothingness */ struct re_s *qtask; refint_q *qhead; refint_q *qtail; ldap_pvt_thread_mutex_t qmutex; } refint_data; #define RUNQ_INTERVAL 36000 /* a long time */ enum { REFINT_ATTRS = 1, REFINT_NOTHING }; static ConfigDriver refint_cf_gen; static ConfigTable refintcfg[] = { { "refint_attributes", "attribute...", 2, 0, 0, ARG_MAGIC|REFINT_ATTRS, refint_cf_gen, "( OLcfgOvAt:11.1 NAME 'olcRefintAttribute' " "DESC 'Attributes for referential integrity' " "SYNTAX OMsDirectoryString )", NULL, NULL }, { "refint_nothing", "string", 2, 2, 0, ARG_DN|ARG_MAGIC|REFINT_NOTHING, refint_cf_gen, "( OLcfgOvAt:11.2 NAME 'olcRefintNothing' " "DESC 'Replacement DN to supply when needed' " "SYNTAX OMsDN SINGLE-VALUE )", NULL, NULL }, { NULL, NULL, 0, 0, 0, ARG_IGNORED } }; static ConfigOCs refintocs[] = { { "( OLcfgOvOc:11.1 " "NAME 'olcRefintConfig' " "DESC 'Referential integrity configuration' " "SUP olcOverlayConfig " "MAY ( olcRefintAttribute $ olcRefintNothing ) )", Cft_Overlay, refintcfg }, { NULL, 0, NULL } }; static int refint_cf_gen(ConfigArgs *c) { slap_overinst *on = (slap_overinst *)c->bi; refint_data *dd = (refint_data *)on->on_bi.bi_private; refint_attrs *ip, *pip, **pipp = NULL; AttributeDescription *ad; const char *text; int rc = ARG_BAD_CONF; int i; switch ( c->op ) { case SLAP_CONFIG_EMIT: switch ( c->type ) { case REFINT_ATTRS: ip = dd->attrs; while ( ip ) { value_add_one( &c->rvalue_vals, &ip->attr->ad_cname ); ip = ip->next; } rc = 0; break; case REFINT_NOTHING: if ( !BER_BVISEMPTY( &dd->nothing )) { rc = value_add_one( &c->rvalue_vals, &dd->nothing ); if ( rc ) return rc; rc = value_add_one( &c->rvalue_nvals, &dd->nnothing ); return rc; } rc = 0; break; default: abort (); } break; case LDAP_MOD_DELETE: switch ( c->type ) { case REFINT_ATTRS: pipp = &dd->attrs; if ( c->valx < 0 ) { ip = *pipp; *pipp = NULL; while ( ip ) { pip = ip; ip = ip->next; ch_free ( pip ); } } else { /* delete from linked list */ for ( i=0; i < c->valx; ++i ) { pipp = &(*pipp)->next; } ip = *pipp; *pipp = (*pipp)->next; /* AttributeDescriptions are global so * shouldn't be freed here... */ ch_free ( ip ); } rc = 0; break; case REFINT_NOTHING: if ( dd->nothing.bv_val ) ber_memfree ( dd->nothing.bv_val ); if ( dd->nnothing.bv_val ) ber_memfree ( dd->nnothing.bv_val ); dd->nothing.bv_len = 0; dd->nnothing.bv_len = 0; rc = 0; break; default: abort (); } break; case SLAP_CONFIG_ADD: /* fallthrough to LDAP_MOD_ADD */ case LDAP_MOD_ADD: switch ( c->type ) { case REFINT_ATTRS: rc = 0; for ( i=1; i < c->argc; ++i ) { ad = NULL; if ( slap_str2ad ( c->argv[i], &ad, &text ) == LDAP_SUCCESS) { ip = ch_malloc ( sizeof ( refint_attrs ) ); ip->attr = ad; ip->next = dd->attrs; dd->attrs = ip; } else { Debug ( LDAP_DEBUG_CONFIG, "refint add: <%s>: %s\n", c->argv[i], text, NULL ); strncpy ( c->msg, text, SLAP_TEXT_BUFLEN-1 ); c->msg[SLAP_TEXT_BUFLEN-1] = '\0'; rc = ARG_BAD_CONF; } } break; case REFINT_NOTHING: if ( dd->nothing.bv_val ) ber_memfree ( dd->nothing.bv_val ); if ( dd->nnothing.bv_val ) ber_memfree ( dd->nnothing.bv_val ); dd->nothing = c->value_dn; dd->nnothing = c->value_ndn; rc = 0; break; default: abort (); } break; default: abort (); } return rc; } /* ** allocate new refint_data; ** store in on_bi.bi_private; ** */ static int refint_db_init( BackendDB *be ) { slap_overinst *on = (slap_overinst *)be->bd_info; refint_data *id = ch_calloc(1,sizeof(refint_data)); id->message = "_init"; on->on_bi.bi_private = id; ldap_pvt_thread_mutex_init( &id->qmutex ); return(0); } static int refint_db_destroy( BackendDB *be ) { slap_overinst *on = (slap_overinst *)be->bd_info; if ( on->on_bi.bi_private ) { refint_data *id = on->on_bi.bi_private; on->on_bi.bi_private = NULL; ldap_pvt_thread_mutex_destroy( &id->qmutex ); ch_free( id ); } return(0); } /* ** initialize, copy basedn if not already set ** */ static int refint_open( BackendDB *be ) { slap_overinst *on = (slap_overinst *)be->bd_info; refint_data *id = on->on_bi.bi_private; id->message = "_open"; if ( BER_BVISNULL( &id->dn )) { if ( BER_BVISNULL( &be->be_nsuffix[0] )) return -1; ber_dupbv( &id->dn, &be->be_nsuffix[0] ); } return(0); } /* ** foreach configured attribute: ** free it; ** free our basedn; ** (do not) free id->message; ** reset on_bi.bi_private; ** free our config data; ** */ static int refint_close( BackendDB *be ) { slap_overinst *on = (slap_overinst *) be->bd_info; refint_data *id = on->on_bi.bi_private; refint_attrs *ii, *ij; id->message = "_close"; for(ii = id->attrs; ii; ii = ij) { ij = ii->next; ch_free(ii); } ch_free(id->dn.bv_val); ch_free(id->nothing.bv_val); ch_free(id->nnothing.bv_val); memset( id, 0, sizeof(*id)); return(0); } /* ** search callback ** generates a list of Attributes from search results */ static int refint_search_cb( Operation *op, SlapReply *rs ) { Attribute *a; BerVarray b = NULL; refint_q *rq = op->o_callback->sc_private; refint_data *dd = rq->rdata; refint_attrs *ia, *da = dd->attrs, *na; dependent_data *ip; int i; Debug(LDAP_DEBUG_TRACE, "refint_search_cb <%s>\n", rs->sr_entry ? rs->sr_entry->e_name.bv_val : "NOTHING", 0, 0); if (rs->sr_type != REP_SEARCH || !rs->sr_entry) return(0); /* ** foreach configured attribute type: ** if this attr exists in the search result, ** and it has a value matching the target: ** allocate an attr; ** if this is a delete and there's only one value: ** allocate the same attr again; ** */ ip = op->o_tmpalloc(sizeof(dependent_data), op->o_tmpmemctx ); ber_dupbv_x( &ip->dn, &rs->sr_entry->e_name, op->o_tmpmemctx ); ber_dupbv_x( &ip->ndn, &rs->sr_entry->e_nname, op->o_tmpmemctx ); ip->next = rq->attrs; rq->attrs = ip; ip->attrs = NULL; for(ia = da; ia; ia = ia->next) { if ( (a = attr_find(rs->sr_entry->e_attrs, ia->attr) ) ) for(i = 0, b = a->a_nvals; b[i].bv_val; i++) if(bvmatch(&rq->oldndn, &b[i])) { na = op->o_tmpalloc(sizeof( refint_attrs ), op->o_tmpmemctx ); na->next = ip->attrs; ip->attrs = na; na->attr = ia->attr; /* If this is a delete and there's only one value, and * we have a nothing DN configured, allocate the attr again. */ if(!b[1].bv_val && BER_BVISEMPTY( &rq->newdn ) && dd->nothing.bv_val) { na = op->o_tmpalloc(sizeof( refint_attrs ), op->o_tmpmemctx ); na->next = ip->attrs; ip->attrs = na; na->attr = ia->attr; } Debug(LDAP_DEBUG_TRACE, "refint_search_cb: %s: %s\n", a->a_desc->ad_cname.bv_val, rq->olddn.bv_val, 0); break; } } return(0); } static void * refint_qtask( void *ctx, void *arg ) { struct re_s *rtask = arg; refint_data *id = rtask->arg; Connection conn = {0}; OperationBuffer opbuf; Operation *op; SlapReply rs = {REP_RESULT}; slap_callback cb = { NULL, NULL, NULL, NULL }; Filter ftop, *fptr; refint_q *rq; dependent_data *dp; refint_attrs *ra, *ip; int rc; op = (Operation *) &opbuf; connection_fake_init( &conn, op, ctx ); /* ** build a search filter for all configured attributes; ** populate our Operation; ** pass our data (attr list, dn) to backend via sc_private; ** call the backend search function; ** nb: (|(one=thing)) is valid, but do smart formatting anyway; ** nb: 16 is arbitrarily a dozen or so extra bytes; ** */ ftop.f_choice = LDAP_FILTER_OR; ftop.f_next = NULL; ftop.f_or = NULL; op->ors_filter = &ftop; for(ip = id->attrs; ip; ip = ip->next) { fptr = op->o_tmpalloc( sizeof(Filter) + sizeof(AttributeAssertion), op->o_tmpmemctx ); fptr->f_choice = LDAP_FILTER_EQUALITY; fptr->f_ava = (AttributeAssertion *)(fptr+1); fptr->f_ava->aa_desc = ip->attr; fptr->f_next = ftop.f_or; ftop.f_or = fptr; } for (;;) { /* Dequeue an op */ ldap_pvt_thread_mutex_lock( &id->qmutex ); rq = id->qhead; if ( rq ) { id->qhead = rq->next; if ( !id->qhead ) id->qtail = NULL; } ldap_pvt_thread_mutex_unlock( &id->qmutex ); if ( !rq ) break; for (fptr = ftop.f_or; fptr; fptr=fptr->f_next ) fptr->f_av_value = rq->oldndn; filter2bv_x( op, op->ors_filter, &op->ors_filterstr ); /* callback gets the searched dn instead */ cb.sc_private = rq; cb.sc_response = refint_search_cb; op->o_callback = &cb; op->o_tag = LDAP_REQ_SEARCH; op->ors_scope = LDAP_SCOPE_SUBTREE; op->ors_deref = LDAP_DEREF_NEVER; op->ors_limit = NULL; op->ors_slimit = SLAP_NO_LIMIT; op->ors_tlimit = SLAP_NO_LIMIT; /* no attrs! */ op->ors_attrs = slap_anlist_no_attrs; op->o_req_ndn = id->dn; op->o_req_dn = id->dn; op->o_bd = rq->db; op->o_dn = op->o_bd->be_rootdn; op->o_ndn = op->o_bd->be_rootndn; slap_op_time( &op->o_time, &op->o_tincr ); /* search */ rc = op->o_bd->be_search(op, &rs); op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx ); if(rc != LDAP_SUCCESS) { Debug( LDAP_DEBUG_TRACE, "refint_response: search failed: %d\n", rc, 0, 0 ); continue; } /* safety? paranoid just in case */ if(!cb.sc_private) { Debug( LDAP_DEBUG_TRACE, "refint_response: callback wiped out sc_private?!\n", 0, 0, 0 ); continue; } /* Set up the Modify requests */ cb.sc_response = &slap_null_cb; op->o_tag = LDAP_REQ_MODIFY; /* ** [our search callback builds a list of attrs] ** foreach attr: ** make sure its dn has a backend; ** build Modification* chain; ** call the backend modify function; ** */ for(dp = rq->attrs; dp; dp = dp->next) { Modifications *m, *first = NULL; op->orm_modlist = NULL; op->o_req_dn = dp->dn; op->o_req_ndn = dp->ndn; op->o_bd = select_backend(&dp->ndn, 0, 1); if(!op->o_bd) { Debug( LDAP_DEBUG_TRACE, "refint_response: no backend for DN %s!\n", dp->dn.bv_val, 0, 0 ); goto done; } rs.sr_type = REP_RESULT; for (ra = dp->attrs; ra; ra = dp->attrs) { dp->attrs = ra->next; /* Set our ModifiersName */ if ( SLAP_LASTMOD( op->o_bd )) { m = op->o_tmpalloc( sizeof(Modifications) + 4*sizeof(BerValue), op->o_tmpmemctx ); m->sml_next = op->orm_modlist; if ( !first ) first = m; op->orm_modlist = m; m->sml_op = LDAP_MOD_REPLACE; m->sml_flags = SLAP_MOD_INTERNAL; m->sml_desc = slap_schema.si_ad_modifiersName; m->sml_type = m->sml_desc->ad_cname; m->sml_values = (BerVarray)(m+1); m->sml_nvalues = m->sml_values+2; BER_BVZERO( &m->sml_values[1] ); BER_BVZERO( &m->sml_nvalues[1] ); m->sml_values[0] = refint_dn; m->sml_nvalues[0] = refint_ndn; } if ( !BER_BVISEMPTY( &rq->newdn ) || ( ra->next && ra->attr == ra->next->attr )) { m = op->o_tmpalloc( sizeof(Modifications) + 4*sizeof(BerValue), op->o_tmpmemctx ); m->sml_next = op->orm_modlist; if ( !first ) first = m; op->orm_modlist = m; m->sml_op = LDAP_MOD_ADD; m->sml_flags = 0; m->sml_desc = ra->attr; m->sml_type = ra->attr->ad_cname; m->sml_values = (BerVarray)(m+1); m->sml_nvalues = m->sml_values+2; BER_BVZERO( &m->sml_values[1] ); BER_BVZERO( &m->sml_nvalues[1] ); if ( BER_BVISEMPTY( &rq->newdn )) { op->o_tmpfree( ra, op->o_tmpmemctx ); ra = dp->attrs; dp->attrs = ra->next; m->sml_values[0] = id->nothing; m->sml_nvalues[0] = id->nnothing; } else { m->sml_values[0] = rq->newdn; m->sml_nvalues[0] = rq->newndn; } } m = op->o_tmpalloc( sizeof(Modifications) + 4*sizeof(BerValue), op->o_tmpmemctx ); m->sml_next = op->orm_modlist; op->orm_modlist = m; if ( !first ) first = m; m->sml_op = LDAP_MOD_DELETE; m->sml_flags = 0; m->sml_desc = ra->attr; m->sml_type = ra->attr->ad_cname; m->sml_values = (BerVarray)(m+1); m->sml_nvalues = m->sml_values+2; m->sml_values[0] = rq->olddn; m->sml_nvalues[0] = rq->oldndn; BER_BVZERO( &m->sml_values[1] ); BER_BVZERO( &m->sml_nvalues[1] ); op->o_tmpfree( ra, op->o_tmpmemctx ); } op->o_dn = op->o_bd->be_rootdn; op->o_ndn = op->o_bd->be_rootndn; slap_op_time( &op->o_time, &op->o_tincr ); if((rc = op->o_bd->be_modify(op, &rs)) != LDAP_SUCCESS) { Debug( LDAP_DEBUG_TRACE, "refint_response: dependent modify failed: %d\n", rs.sr_err, 0, 0 ); } while (( m = op->orm_modlist )) { op->orm_modlist = m->sml_next; op->o_tmpfree( m, op->o_tmpmemctx ); if ( m == first ) break; } slap_mods_free( op->orm_modlist, 1 ); op->o_tmpfree( dp->ndn.bv_val, op->o_tmpmemctx ); op->o_tmpfree( dp->dn.bv_val, op->o_tmpmemctx ); op->o_tmpfree( dp, op->o_tmpmemctx ); } done: if ( !BER_BVISNULL( &rq->newndn )) { ch_free( rq->newndn.bv_val ); ch_free( rq->newdn.bv_val ); } ch_free( rq->oldndn.bv_val ); ch_free( rq->olddn.bv_val ); ch_free( rq ); } /* wait until we get explicitly scheduled again */ ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex ); ldap_pvt_runqueue_stoptask( &slapd_rq, id->qtask ); ldap_pvt_runqueue_resched( &slapd_rq,id->qtask, 1 ); ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex ); return NULL; } /* ** refint_response ** search for matching records and modify them */ static int refint_response( Operation *op, SlapReply *rs ) { slap_overinst *on = (slap_overinst *) op->o_bd->bd_info; refint_data *id = on->on_bi.bi_private; BerValue pdn; int rc, ac; refint_q *rq; BackendDB *db; refint_attrs *ip; id->message = "_refint_response"; /* If the main op failed or is not a Delete or ModRdn, ignore it */ if (( op->o_tag != LDAP_REQ_DELETE && op->o_tag != LDAP_REQ_MODRDN ) || rs->sr_err != LDAP_SUCCESS ) return SLAP_CB_CONTINUE; /* ** validate (and count) the list of attrs; ** */ for(ip = id->attrs, ac = 0; ip; ip = ip->next, ac++); if(!ac) { Debug( LDAP_DEBUG_TRACE, "refint_response called without any attributes\n", 0, 0, 0 ); return SLAP_CB_CONTINUE; } /* ** find the backend that matches our configured basedn; ** make sure it exists and has search and modify methods; ** */ db = select_backend(&id->dn, 0, 1); if(db) { if (!db->be_search || !db->be_modify) { Debug( LDAP_DEBUG_TRACE, "refint_response: backend missing search and/or modify\n", 0, 0, 0 ); return SLAP_CB_CONTINUE; } } else { Debug( LDAP_DEBUG_TRACE, "refint_response: no backend for our baseDN %s??\n", id->dn.bv_val, 0, 0 ); return SLAP_CB_CONTINUE; } rq = ch_calloc( 1, sizeof( refint_q )); ber_dupbv( &rq->olddn, &op->o_req_dn ); ber_dupbv( &rq->oldndn, &op->o_req_ndn ); rq->db = db; rq->rdata = id; if(op->o_tag == LDAP_REQ_MODRDN) { if ( op->oq_modrdn.rs_newSup ) { pdn = *op->oq_modrdn.rs_newSup; } else { dnParent( &op->o_req_dn, &pdn ); } build_new_dn( &rq->newdn, &pdn, &op->orr_newrdn, NULL ); if ( op->oq_modrdn.rs_nnewSup ) { pdn = *op->oq_modrdn.rs_nnewSup; } else { dnParent( &op->o_req_ndn, &pdn ); } build_new_dn( &rq->newndn, &pdn, &op->orr_nnewrdn, NULL ); } ldap_pvt_thread_mutex_lock( &id->qmutex ); if ( id->qtail ) { id->qtail->next = rq; } else { id->qhead = rq; } id->qtail = rq; ldap_pvt_thread_mutex_unlock( &id->qmutex ); ac = 0; ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex ); if ( !id->qtask ) { id->qtask = ldap_pvt_runqueue_insert( &slapd_rq, RUNQ_INTERVAL, refint_qtask, id, "refint_qtask", op->o_bd->be_suffix[0].bv_val ); ac = 1; } else { if ( !ldap_pvt_runqueue_isrunning( &slapd_rq, id->qtask ) && !id->qtask->next_sched.tv_sec ) { id->qtask->interval.tv_sec = 0; ldap_pvt_runqueue_resched( &slapd_rq, id->qtask, 0 ); id->qtask->interval.tv_sec = RUNQ_INTERVAL; ac = 1; } } ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex ); if ( ac ) slap_wake_listener(); return SLAP_CB_CONTINUE; } /* ** init_module is last so the symbols resolve "for free" -- ** it expects to be called automagically during dynamic module initialization */ int refint_initialize() { int rc; /* statically declared just after the #includes at top */ refint.on_bi.bi_type = "refint"; refint.on_bi.bi_db_init = refint_db_init; refint.on_bi.bi_db_destroy = refint_db_destroy; refint.on_bi.bi_db_open = refint_open; refint.on_bi.bi_db_close = refint_close; refint.on_response = refint_response; refint.on_bi.bi_cf_ocs = refintocs; rc = config_register_schema ( refintcfg, refintocs ); if ( rc ) return rc; return(overlay_register(&refint)); } #if SLAPD_OVER_REFINT == SLAPD_MOD_DYNAMIC && defined(PIC) int init_module(int argc, char *argv[]) { return refint_initialize(); } #endif #endif /* SLAPD_OVER_REFINT */