]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/back-null/null.c
Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4
[openldap] / servers / slapd / back-null / null.c
index 8d8127785201b0e2a53d0be60826bc0e71511a7d..d358587f854a15fddca30713ce36bb6194225579 100644 (file)
@@ -1,7 +1,21 @@
 /* null.c - the null backend */
-/*
- * Copyright 2002 The OpenLDAP Foundation, All Rights Reserved.
- * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
+/* $OpenLDAP$ */
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ *
+ * Copyright 2002-2012 The OpenLDAP Foundation.
+ * 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 originally developed by Hallvard Furuseth for inclusion
+ * in OpenLDAP Software.
  */
 
 #include "portable.h"
 #include <ac/string.h>
 
 #include "slap.h"
-#include "external.h"
+#include "config.h"
 
 struct null_info {
-       int bind_allowed;
+       int     ni_bind_allowed;
+       ID      ni_nextid;
 };
 
-int
-null_back_bind(
-       Backend                 *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *dn,
-       struct berval   *ndn,
-       int                             method,
-       struct berval   *cred,
-       struct berval   *edn
-)
+static ConfigDriver null_cf_gen;
+
+static ConfigTable nullcfg[] = {
+       { "bind", "true|FALSE", 1, 2, 0, ARG_ON_OFF|ARG_MAGIC,
+               null_cf_gen,
+               "( OLcfgDbAt:8.1 NAME 'olcDbBindAllowed' "
+               "DESC 'Allow binds to this database' "
+               "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
+       { NULL, NULL, 0, 0, 0, ARG_IGNORED,
+               NULL, NULL, NULL, NULL }
+};
+
+static ConfigOCs nullocs[] = {
+       { "( OLcfgDbOc:8.1 "
+               "NAME 'olcNullConfig' "
+               "DESC 'Null backend ocnfiguration' "
+               "SUP olcDatabaseConfig "
+               "MAY ( olcDbBindAllowed ) )",
+               Cft_Database, nullcfg },
+       { NULL, 0, NULL }
+};
+
+
+/* LDAP operations */
+
+static int
+null_back_bind( Operation *op, SlapReply *rs )
 {
-       struct null_info *ni = (struct null_info *) be->be_private;
-
-       if( ni->bind_allowed )
-               /* front end with send result on success (0) */
-               return 0;
-       send_ldap_result( conn, op, LDAP_INVALID_CREDENTIALS,
-                         NULL, NULL, NULL, NULL );
-       return LDAP_INVALID_CREDENTIALS;
+       struct null_info *ni = (struct null_info *) op->o_bd->be_private;
+
+       if ( ni->ni_bind_allowed || be_isroot_pw( op ) ) {
+               /* front end will send result on success (0) */
+               return LDAP_SUCCESS;
+       }
+
+       rs->sr_err = LDAP_INVALID_CREDENTIALS;
+       send_ldap_result( op, rs );
+
+       return rs->sr_err;
 }
 
-int
-null_back_add(
-       BackendDB       *be,
-       Connection      *conn,
-       Operation       *op,
-       Entry           *e )
+
+static int
+null_back_respond( Operation *op, SlapReply *rs, int rc )
 {
-       send_ldap_result( conn, op, LDAP_SUCCESS, NULL, NULL, NULL, NULL );
-       return 0;
+       LDAPControl ctrl[SLAP_MAX_RESPONSE_CONTROLS], *ctrls[SLAP_MAX_RESPONSE_CONTROLS];
+       int c = 0;
+
+       BerElementBuffer        ps_berbuf;
+       BerElement              *ps_ber = NULL;
+       LDAPControl             **preread_ctrl = NULL,
+                               **postread_ctrl = NULL;
+
+       rs->sr_err = LDAP_OTHER;
+
+       /* this comes first, as in case of assertion failure
+        * any further processing must stop */
+       if ( get_assert( op ) ) {
+               rs->sr_err = LDAP_ASSERTION_FAILED;
+               goto respond;
+       }
+
+       if ( op->o_preread ) {
+               Entry           e = { 0 };
+
+               switch ( op->o_tag ) {
+               case LDAP_REQ_MODIFY:
+               case LDAP_REQ_RENAME:
+               case LDAP_REQ_DELETE:
+                       e.e_name = op->o_req_dn;
+                       e.e_nname = op->o_req_ndn;
+
+                       preread_ctrl = &ctrls[c];
+                       *preread_ctrl = NULL;
+
+                       if ( slap_read_controls( op, rs, &e,
+                               &slap_pre_read_bv, preread_ctrl ) )
+                       {
+                               preread_ctrl = NULL;
+
+                               Debug( LDAP_DEBUG_TRACE,
+                                       "<=- null_back_respond: pre-read "
+                                       "failed!\n", 0, 0, 0 );
+
+                               if ( op->o_preread & SLAP_CONTROL_CRITICAL ) {
+                                       /* FIXME: is it correct to abort
+                                        * operation if control fails? */
+                                       goto respond;
+                               }
+
+                       } else {
+                               c++;
+                       }
+                       break;
+               }
+       }
+
+       if ( op->o_postread ) {
+               Entry           e = { 0 };
+
+               switch ( op->o_tag ) {
+               case LDAP_REQ_ADD:
+               case LDAP_REQ_MODIFY:
+               case LDAP_REQ_RENAME:
+                       if ( op->o_tag == LDAP_REQ_ADD ) {
+                               e.e_name = op->ora_e->e_name;
+                               e.e_nname = op->ora_e->e_nname;
+
+                       } else {
+                               e.e_name = op->o_req_dn;
+                               e.e_nname = op->o_req_ndn;
+                       }
+
+                       postread_ctrl = &ctrls[c];
+                       *postread_ctrl = NULL;
+
+                       if ( slap_read_controls( op, rs, &e,
+                               &slap_post_read_bv, postread_ctrl ) )
+                       {
+                               postread_ctrl = NULL;
+
+                               Debug( LDAP_DEBUG_TRACE,
+                                       "<=- null_back_respond: post-read "
+                                       "failed!\n", 0, 0, 0 );
+
+                               if ( op->o_postread & SLAP_CONTROL_CRITICAL ) {
+                                       /* FIXME: is it correct to abort
+                                        * operation if control fails? */
+                                       goto respond;
+                               }
+
+                       } else {
+                               c++;
+                       }
+                       break;
+               }
+       }
+
+       if ( op->o_noop ) {
+               switch ( op->o_tag ) {
+               case LDAP_REQ_ADD:
+               case LDAP_REQ_MODIFY:
+               case LDAP_REQ_RENAME:
+               case LDAP_REQ_DELETE:
+               case LDAP_REQ_EXTENDED:
+                       rc = LDAP_X_NO_OPERATION;
+                       break;
+               }
+       }
+
+       if ( get_pagedresults( op ) > SLAP_CONTROL_IGNORED ) {
+               struct berval           cookie = BER_BVC( "" );
+
+               /* should not be here... */
+               assert( op->o_tag == LDAP_REQ_SEARCH );
+
+               ctrl[c].ldctl_oid = LDAP_CONTROL_PAGEDRESULTS;
+               ctrl[c].ldctl_iscritical = 0;
+
+               ps_ber = (BerElement *)&ps_berbuf;
+               ber_init2( ps_ber, NULL, LBER_USE_DER );
+
+               /* return size of 0 -- no estimate */
+               ber_printf( ps_ber, "{iO}", 0, &cookie ); 
+
+               if ( ber_flatten2( ps_ber, &ctrl[c].ldctl_value, 0 ) == -1 ) {
+                       goto done;
+               }
+               
+               ctrls[c] = &ctrl[c];
+               c++;
+       }
+
+       /* terminate controls array */
+       ctrls[c] = NULL;
+       rs->sr_ctrls = ctrls;
+       rs->sr_err = rc;
+
+respond:;
+       send_ldap_result( op, rs );
+       rs->sr_ctrls = NULL;
+
+done:;
+       if ( ps_ber != NULL ) {
+               (void) ber_free_buf( ps_ber );
+       }
+
+       if( preread_ctrl != NULL && (*preread_ctrl) != NULL ) {
+               slap_sl_free( (*preread_ctrl)->ldctl_value.bv_val, op->o_tmpmemctx );
+               slap_sl_free( *preread_ctrl, op->o_tmpmemctx );
+       }
+
+       if( postread_ctrl != NULL && (*postread_ctrl) != NULL ) {
+               slap_sl_free( (*postread_ctrl)->ldctl_value.bv_val, op->o_tmpmemctx );
+               slap_sl_free( *postread_ctrl, op->o_tmpmemctx );
+       }
+
+       return rs->sr_err;
 }
 
-int
-null_back_compare(
-       BackendDB               *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *dn,
-       struct berval   *ndn,
-       AttributeAssertion *ava
-)
+/* add, delete, modify, modrdn, search */
+static int
+null_back_success( Operation *op, SlapReply *rs )
 {
-       send_ldap_result( conn, op, LDAP_COMPARE_FALSE, NULL, NULL, NULL, NULL );
-       return 0;
+       return null_back_respond( op, rs, LDAP_SUCCESS );
 }
 
-int
-null_back_delete(
-       BackendDB               *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *dn,
-       struct berval   *ndn
-)
+/* compare */
+static int
+null_back_false( Operation *op, SlapReply *rs )
 {
-       send_ldap_result( conn, op, LDAP_SUCCESS, NULL, NULL, NULL, NULL );
-       return 0;
+       return null_back_respond( op, rs, LDAP_COMPARE_FALSE );
 }
 
-int
-null_back_modify(
-       BackendDB               *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *dn,
-       struct berval   *ndn,
-       Modifications   *modlist )
+
+/* for overlays */
+static int
+null_back_entry_get(
+       Operation *op,
+       struct berval *ndn,
+       ObjectClass *oc,
+       AttributeDescription *at,
+       int rw,
+       Entry **ent )
+{
+       /* don't admit the object isn't there */
+       return oc || at ? LDAP_NO_SUCH_ATTRIBUTE : LDAP_BUSY;
+}
+
+
+/* Slap tools */
+
+static int
+null_tool_entry_open( BackendDB *be, int mode )
 {
-       send_ldap_result( conn, op, LDAP_SUCCESS, NULL, NULL, NULL, NULL );
        return 0;
 }
 
-int
-null_back_modrdn(
-       Backend                 *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *dn,
-       struct berval   *ndn,
-       struct berval   *newrdn,
-       struct berval   *nnewrdn,
-       int                             deleteoldrdn,
-       struct berval   *newSuperior,
-       struct berval   *nnewSuperior )
+static int
+null_tool_entry_close( BackendDB *be )
 {
-       send_ldap_result( conn, op, LDAP_SUCCESS, NULL, NULL, NULL, NULL );
+       assert( be != NULL );
        return 0;
 }
 
-int
-null_back_search(
-       BackendDB               *be,
-       Connection              *conn,
-       Operation               *op,
-       struct berval   *base,
-       struct berval   *nbase,
-       int                             scope,
-       int                             deref,
-       int                             slimit,
-       int                             tlimit,
-       Filter                  *filter,
-       struct berval   *filterstr,
-       AttributeName   *attrs,
-       int                             attrsonly )
+static ID
+null_tool_entry_first_x( BackendDB *be, struct berval *base, int scope, Filter *f )
+{
+       return NOID;
+}
+
+static ID
+null_tool_entry_next( BackendDB *be )
 {
-       send_search_result( conn, op, LDAP_SUCCESS, NULL, NULL, NULL, NULL, 0 );
-       return 1;
+       return NOID;
 }
 
+static Entry *
+null_tool_entry_get( BackendDB *be, ID id )
+{
+       assert( slapMode & SLAP_TOOL_MODE );
+       return NULL;
+}
 
-int
-null_back_db_config(
-       BackendDB       *be,
-       const char      *fname,
-       int                     lineno,
-       int                     argc,
-       char            **argv )
+static ID
+null_tool_entry_put( BackendDB *be, Entry *e, struct berval *text )
 {
-       struct null_info *ni = (struct null_info *) be->be_private;
+       assert( slapMode & SLAP_TOOL_MODE );
+       assert( text != NULL );
+       assert( text->bv_val != NULL );
+       assert( text->bv_val[0] == '\0' );      /* overconservative? */
 
-       if ( ni == NULL ) {
-               fprintf( stderr, "%s: line %d: null database info is null!\n",
-                       fname, lineno );
-               return 1;
-       }
+       e->e_id = ((struct null_info *) be->be_private)->ni_nextid++;
+       return e->e_id;
+}
 
-       /* bind requests allowed */
-       if ( strcasecmp( argv[0], "bind" ) == 0 ) {
-               if ( argc < 2 ) {
-                       fprintf( stderr,
-       "%s: line %d: missing <on/off> in \"bind <on/off>\" line\n",
-                                fname, lineno );
-                       return 1;
-               }
-               ni->bind_allowed = strcasecmp( argv[1], "off" );
 
-       /* anything else */
-       } else {
-               fprintf( stderr,
-"%s: line %d: unknown directive \"%s\" in null database definition (ignored)\n",
-                        fname, lineno, argv[0] );
+/* Setup */
+
+static int
+null_cf_gen( ConfigArgs *c )
+{
+       struct null_info *ni = (struct null_info *) c->be->be_private;
+
+       if ( c->op == SLAP_CONFIG_EMIT ) {
+               c->value_int = ni->ni_bind_allowed;
+               return LDAP_SUCCESS;
+       } else if ( c->op == LDAP_MOD_DELETE ) {
+               ni->ni_bind_allowed = 0;
+               return LDAP_SUCCESS;
        }
 
-       return 0;
+       ni->ni_bind_allowed = c->value_int;
+       return LDAP_SUCCESS;
 }
 
-
-int
-null_back_db_init( BackendDB *be )
+static int
+null_back_db_init( BackendDB *be, ConfigReply *cr )
 {
-       be->be_private = ch_calloc( 1, sizeof(struct null_info) );
+       struct null_info *ni = ch_calloc( 1, sizeof(struct null_info) );
+       ni->ni_bind_allowed = 0;
+       ni->ni_nextid = 1;
+       be->be_private = ni;
+       be->be_cf_ocs = be->bd_info->bi_cf_ocs;
        return 0;
 }
 
-int
-null_back_db_destroy(
-    Backend    *be
-)
+static int
+null_back_db_destroy( Backend *be, ConfigReply *cr )
 {
        free( be->be_private );
        return 0;
@@ -182,55 +347,76 @@ null_back_db_destroy(
 
 
 int
-null_back_initialize(
-    BackendInfo        *bi
-)
+null_back_initialize( BackendInfo *bi )
 {
+       static char *controls[] = {
+               LDAP_CONTROL_ASSERT,
+               LDAP_CONTROL_MANAGEDSAIT,
+               LDAP_CONTROL_NOOP,
+               LDAP_CONTROL_PAGEDRESULTS,
+               LDAP_CONTROL_SUBENTRIES,
+               LDAP_CONTROL_PRE_READ,
+               LDAP_CONTROL_POST_READ,
+               LDAP_CONTROL_X_PERMISSIVE_MODIFY,
+               NULL
+       };
+
+       Debug( LDAP_DEBUG_TRACE,
+               "null_back_initialize: initialize null backend\n", 0, 0, 0 );
+
+       bi->bi_flags |=
+               SLAP_BFLAG_INCREMENT |
+               SLAP_BFLAG_SUBENTRIES |
+               SLAP_BFLAG_ALIASES |
+               SLAP_BFLAG_REFERRALS;
+
+       bi->bi_controls = controls;
+
        bi->bi_open = 0;
        bi->bi_close = 0;
        bi->bi_config = 0;
        bi->bi_destroy = 0;
 
        bi->bi_db_init = null_back_db_init;
-       bi->bi_db_config = null_back_db_config;
+       bi->bi_db_config = config_generic_wrapper;
        bi->bi_db_open = 0;
        bi->bi_db_close = 0;
        bi->bi_db_destroy = null_back_db_destroy;
 
        bi->bi_op_bind = null_back_bind;
        bi->bi_op_unbind = 0;
-       bi->bi_op_search = null_back_search;
-       bi->bi_op_compare = null_back_compare;
-       bi->bi_op_modify = null_back_modify;
-       bi->bi_op_modrdn = null_back_modrdn;
-       bi->bi_op_add = null_back_add;
-       bi->bi_op_delete = null_back_delete;
+       bi->bi_op_search = null_back_success;
+       bi->bi_op_compare = null_back_false;
+       bi->bi_op_modify = null_back_success;
+       bi->bi_op_modrdn = null_back_success;
+       bi->bi_op_add = null_back_success;
+       bi->bi_op_delete = null_back_success;
        bi->bi_op_abandon = 0;
 
        bi->bi_extended = 0;
 
-       bi->bi_acl_group = 0;
-       bi->bi_acl_attribute = 0;
        bi->bi_chk_referrals = 0;
 
        bi->bi_connection_init = 0;
        bi->bi_connection_destroy = 0;
 
-       return 0;
+       bi->bi_entry_get_rw = null_back_entry_get;
+
+       bi->bi_tool_entry_open = null_tool_entry_open;
+       bi->bi_tool_entry_close = null_tool_entry_close;
+       bi->bi_tool_entry_first = backend_tool_entry_first;
+       bi->bi_tool_entry_first_x = null_tool_entry_first_x;
+       bi->bi_tool_entry_next = null_tool_entry_next;
+       bi->bi_tool_entry_get = null_tool_entry_get;
+       bi->bi_tool_entry_put = null_tool_entry_put;
+
+       bi->bi_cf_ocs = nullocs;
+       return config_register_schema( nullcfg, nullocs );
 }
 
-#ifdef SLAPD_NULL_DYNAMIC
-int back_null_LTX_init_module(
-       int argc,
-       char *argv[] )
-{
-    BackendInfo bi;
+#if SLAPD_NULL == SLAPD_MOD_DYNAMIC
 
-    memset( &bi, '\0', sizeof(bi) );
-    bi.bi_type = "null";
-    bi.bi_init = null_back_initialize;
+/* conditionally define the init_module() function */
+SLAP_BACKEND_INIT_MODULE( null )
 
-    backend_add(&bi);
-    return 0;
-}
-#endif /* SLAPD_NULL_DYNAMIC */
+#endif /* SLAPD_NULL == SLAPD_MOD_DYNAMIC */