]> git.sur5r.net Git - openldap/blobdiff - include/slapi-plugin.h
find_connections fix (ITS#3280) from HEAD
[openldap] / include / slapi-plugin.h
index 556dcc8614a13a1eae17d5de61f6c7f6aa01888f..d21c5471c66f6cf4b6858913833fbc93444dd6be 100644 (file)
@@ -1,19 +1,28 @@
-/*
- * Copyright 1998-2003 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 1998-2004 The OpenLDAP Foundation.
+ * Portions Copyright 1997,2002,2003 IBM 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 file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
  */
+
 /*
- * (C) Copyright IBM Corp. 1997,2002
- * Redistribution and use in source and binary forms are permitted
- * provided that this notice is preserved and that due credit is
- * given to IBM Corporation. This software is provided ``as is''
- * without express or implied warranty.
+ * This header is used in development of SLAPI plugins for
+ * OpenLDAP slapd(8) and other directory servers supporting
+ * this interface.  Your portability mileage may vary.
  */
 
 #ifndef _SLAPI_PLUGIN_H
 #define _SLAPI_PLUGIN_H
 
-#include <lber.h>
 #include <ldap.h>
 
 typedef struct slapi_pblock    Slapi_PBlock;
@@ -43,13 +52,16 @@ int slapi_entry_attr_merge( Slapi_Entry *e, char *type, struct berval **vals );
 int slapi_entry_attr_find( Slapi_Entry *e, char *type, Slapi_Attr **attr );
 char *slapi_entry_attr_get_charptr( const Slapi_Entry *e, const char *type );
 int slapi_entry_attr_get_int( const Slapi_Entry *e, const char *type );
-int slapi_entry_attr_get_long( const Slapi_Entry *e, const char *type );
-int slapi_entry_attr_get_uint( const Slapi_Entry *e, const char *type );
-int slapi_entry_attr_get_ulong( const Slapi_Entry *e, const char *type );
+long slapi_entry_attr_get_long( const Slapi_Entry *e, const char *type );
+unsigned int slapi_entry_attr_get_uint( const Slapi_Entry *e, const char *type );
+unsigned long slapi_entry_attr_get_ulong( const Slapi_Entry *e, const char *type );
 int slapi_attr_get_values( Slapi_Attr *attr, struct berval ***vals );
 char *slapi_dn_normalize( char *dn );
 char *slapi_dn_normalize_case( char *dn );
 int slapi_dn_issuffix( char *dn, char *suffix );
+char *slapi_dn_beparent( Slapi_PBlock *pb, const char *dn );
+char *slapi_dn_parent( const char *dn );
+int slapi_dn_isparent( const char *parentdn, const char *childdn );
 char *slapi_dn_ignore_case( char *dn );
 
 /* DS 5.x SLAPI */
@@ -171,6 +183,7 @@ void slapi_register_supported_control(char *controloid,
 #define SLAPI_OPERATION_ANY             0xFFFFFFFFL
 #define SLAPI_OPERATION_NONE            0x00000000L
 int slapi_get_supported_controls(char ***ctrloidsp, unsigned long **ctrlopsp);
+LDAPControl *slapi_dup_control(LDAPControl *ctrl);
 void slapi_register_supported_saslmechanism(char *mechanism);
 char **slapi_get_supported_saslmechanisms();
 char **slapi_get_supported_extended_ops(void);
@@ -181,9 +194,12 @@ void slapi_send_ldap_result( Slapi_PBlock *pb, int err, char *matched,
        char *text, int nentries, struct berval **urls );
 int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,
        LDAPControl **ectrls, char **attrs, int attrsonly );
+int slapi_send_ldap_search_reference( Slapi_PBlock *pb, Slapi_Entry *e,
+       struct berval **urls, LDAPControl **ectrls, struct berval **v2refs );
 
 /* filter routines */
 Slapi_Filter *slapi_str2filter( char *str );
+Slapi_Filter *slapi_filter_dup( Slapi_Filter *f );
 void slapi_filter_free( Slapi_Filter *f, int recurse );
 int slapi_filter_get_choice( Slapi_Filter *f);
 int slapi_filter_get_ava( Slapi_Filter *f, char **type, struct berval **bval );
@@ -193,15 +209,17 @@ int slapi_filter_get_attribute_type( Slapi_Filter *f, char **type );
 int slapi_filter_get_subfilt( Slapi_Filter *f, char **type, char **initial,
        char ***any, char **final );
 Slapi_Filter *slapi_filter_join( int ftype, Slapi_Filter *f1, Slapi_Filter *f2);
+int slapi_x_filter_append( int choice, Slapi_Filter **pContainingFilter,
+       Slapi_Filter **pNextFilter, Slapi_Filter *filterToAppend );
 int slapi_filter_test( Slapi_PBlock *pb, Slapi_Entry *e, Slapi_Filter *f,
        int verify_access );
 int slapi_filter_test_simple( Slapi_Entry *e, Slapi_Filter *f );
 typedef int (*FILTER_APPLY_FN)( Slapi_Filter *f, void *arg );
 int slapi_filter_apply( Slapi_Filter *f, FILTER_APPLY_FN fn, void *arg, int *error_code );
-#define SLAPI_FILTER_SCAN_STOP                 -1
-#define SLAPI_FILTER_SCAN_ERROR                        -2
-#define SLAPI_FILTER_SCAN_NOMORE               0
-#define SLAPI_FILTER_SCAN_CONTINUE             1
+#define SLAPI_FILTER_SCAN_STOP                 -1 /* set by callback */
+#define SLAPI_FILTER_SCAN_ERROR                        -2 /* set by callback */
+#define SLAPI_FILTER_SCAN_NOMORE               0 /* set by callback */
+#define SLAPI_FILTER_SCAN_CONTINUE             1 /* set by callback */
 #define SLAPI_FILTER_UNKNOWN_FILTER_TYPE       2 /* set by slapi_filter_apply() */
 
 /* internal add/delete/search/modify routines */
@@ -240,6 +258,35 @@ int compute_rewrite_search_filter(Slapi_PBlock *pb);
 int compute_evaluator(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
 int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
 
+/* ACL plugins; only SLAPI_PLUGIN_ACL_ALLOW_ACCESS supported now */
+typedef int (*slapi_acl_callback_t)(Slapi_PBlock *pb,
+       Slapi_Entry *e,
+       const char *attr,
+       struct berval *berval,
+       int access,
+       void *state);
+
+/* object extensions */
+typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);
+
+typedef void (*slapi_extension_destructor_fnptr)(void *extension,
+       void *object, void *parent);
+
+int slapi_register_object_extension( const char *pluginname,
+       const char *objectname, slapi_extension_constructor_fnptr constructor,
+       slapi_extension_destructor_fnptr destructor, int *objecttype,
+       int *extensionhandle);
+
+#define SLAPI_EXT_CONNECTION    "Connection"
+#define SLAPI_EXT_OPERATION     "Operation"
+#define SLAPI_EXT_ENTRY         "Entry"
+#define SLAPI_EXT_MTNODE        "Mapping Tree Node"
+
+void *slapi_get_object_extension(int objecttype, void *object,
+       int extensionhandle);
+void slapi_set_object_extension(int objecttype, void *object,
+       int extensionhandle, void *extension);
+
 /* parameters currently supported */
 
 /*
@@ -302,6 +349,8 @@ int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
 #define SLAPI_X_CONN_CLIENTPATH                        1300
 #define SLAPI_X_CONN_SERVERPATH                        1301
 #define SLAPI_X_CONN_IS_UDP                    1302
+#define SLAPI_X_CONN_SSF                       1303
+#define SLAPI_X_CONN_SASL_CONTEXT              1304
 
 /*  Authentication types */
 #define SLAPD_AUTH_NONE   "none"
@@ -435,6 +484,12 @@ int slapi_x_compute_get_pblock(computed_attr_context *c, Slapi_PBlock **pb);
 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                        1
 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING              2
 
+#define SLAPI_PLUGIN_ACL_INIT                  730
+#define SLAPI_PLUGIN_ACL_SYNTAX_CHECK          731
+#define SLAPI_PLUGIN_ACL_ALLOW_ACCESS          732
+#define SLAPI_PLUGIN_ACL_MODS_ALLOWED          733
+#define SLAPI_PLUGIN_ACL_MODS_UPDATE           734
+
 #define SLAPI_OPERATION_AUTHTYPE                741
 #define SLAPI_OPERATION_ID                      742
 #define SLAPI_CONN_CERT                         743