]> git.sur5r.net Git - openldap/blobdiff - include/slapi-plugin.h
Silence warning in prev commit
[openldap] / include / slapi-plugin.h
index ae08916c54c8231190dd5b6505a03ecba30e34ba..fdea92acd8f540317adbdc59affe8a2e9c46004d 100644 (file)
 #ifndef _SLAPI_PLUGIN_H
 #define _SLAPI_PLUGIN_H
 
-#include "lber.h"
-#include "ldap.h"
+#include <ldap.h>
 
 typedef struct slapi_pblock    Slapi_PBlock;
 typedef struct slapi_entry     Slapi_Entry;
 typedef struct slapi_attr      Slapi_Attr;
+typedef struct slapi_value     Slapi_Value;
+typedef struct slapi_valueset  Slapi_ValueSet;
 typedef struct slapi_filter    Slapi_Filter;
 
-
 /* pblock routines */
 int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );
 int slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value );
@@ -32,6 +32,7 @@ void slapi_pblock_destroy( Slapi_PBlock* );
 Slapi_Entry *slapi_str2entry( char *s, int flags );
 char *slapi_entry2str( Slapi_Entry *e, int *len );
 char *slapi_entry_get_dn( Slapi_Entry *e );
+int slapi_x_entry_get_id( Slapi_Entry *e );
 void slapi_entry_set_dn( Slapi_Entry *e, char *dn );
 Slapi_Entry *slapi_entry_dup( Slapi_Entry *e );
 int slapi_entry_attr_delete( Slapi_Entry *e, char *type );
@@ -39,19 +40,116 @@ Slapi_Entry *slapi_entry_alloc();
 void slapi_entry_free( Slapi_Entry *e );
 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 );
 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_ignore_case( char *dn );
 
-/* char routines */
+/* DS 5.x SLAPI */
+int slapi_access_allowed( Slapi_PBlock *pb, Slapi_Entry *e, char *attr, struct berval *val, int access );
+int slapi_acl_check_mods( Slapi_PBlock *pb, Slapi_Entry *e, LDAPMod **mods, char **errbuf );
+Slapi_Attr *slapi_attr_new( void );
+Slapi_Attr *slapi_attr_init( Slapi_Attr *a, const char *type );
+void slapi_attr_free( Slapi_Attr **a );
+Slapi_Attr *slapi_attr_dup( const Slapi_Attr *attr );
+int slapi_attr_add_value( Slapi_Attr *a, const Slapi_Value *v );
+int slapi_attr_type2plugin( const char *type, void **pi );
+int slapi_attr_get_type( const Slapi_Attr *attr, char **type );
+int slapi_attr_get_oid_copy( const Slapi_Attr *attr, char **oidp );
+int slapi_attr_get_flags( const Slapi_Attr *attr, unsigned long *flags );
+int slapi_attr_flag_is_set( const Slapi_Attr *attr, unsigned long flag );
+int slapi_attr_value_cmp( const Slapi_Attr *attr, const struct berval *v1, const struct berval *v2 );
+int slapi_attr_value_find( const Slapi_Attr *a, struct berval *v );
+#define SLAPI_TYPE_CMP_EXACT   0
+#define SLAPI_TYPE_CMP_BASE    1
+#define SLAPI_TYPE_CMP_SUBTYPE 2
+int slapi_attr_type_cmp( const char *t1, const char *t2, int opt );
+int slapi_attr_types_equivalent( const char *t1, const char *t2 );
+int slapi_attr_first_value( Slapi_Attr *a, Slapi_Value **v );
+int slapi_attr_next_value( Slapi_Attr *a, int hint, Slapi_Value **v );
+int slapi_attr_get_numvalues( const Slapi_Attr *a, int *numValues );
+int slapi_attr_get_valueset( const Slapi_Attr *a, Slapi_ValueSet **vs );
+int slapi_attr_get_bervals_copy( Slapi_Attr *a, struct berval ***vals );
+int slapi_entry_attr_hasvalue( Slapi_Entry *e, const char *type, const char *value );
+int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+void slapi_entry_attr_set_charptr(Slapi_Entry* e, const char *type, const char *value);
+void slapi_entry_attr_set_int( Slapi_Entry* e, const char *type, int l);
+void slapi_entry_attr_set_uint( Slapi_Entry* e, const char *type, unsigned int l);
+void slapi_entry_attr_set_long(Slapi_Entry* e, const char *type, long l);
+void slapi_entry_attr_set_ulong(Slapi_Entry* e, const char *type, unsigned long l);
+int slapi_is_rootdse( const char *dn );
+int slapi_entry_attr_merge_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+int slapi_entry_add_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+int slapi_entry_add_valueset(Slapi_Entry *e, const char *type, Slapi_ValueSet *vs);
+int slapi_entry_delete_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+int slapi_entry_merge_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+int slapi_entry_attr_replace_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
+int slapi_entry_add_value(Slapi_Entry *e, const char *type, const Slapi_Value *value);
+int slapi_entry_add_string(Slapi_Entry *e, const char *type, const char *value);
+int slapi_entry_delete_string(Slapi_Entry *e, const char *type, const char *value);
+int slapi_entry_first_attr( const Slapi_Entry *e, Slapi_Attr **attr );
+int slapi_entry_next_attr( const Slapi_Entry *e, Slapi_Attr *prevattr, Slapi_Attr **attr );
+char *slapi_attr_syntax_normalize( const char *s );
+
+Slapi_Value *slapi_value_new( void );
+Slapi_Value *slapi_value_new_berval(const struct berval *bval);
+Slapi_Value *slapi_value_new_value(const Slapi_Value *v);
+Slapi_Value *slapi_value_new_string(const char *s);
+Slapi_Value *slapi_value_init(Slapi_Value *v);
+Slapi_Value *slapi_value_init_berval(Slapi_Value *v, struct berval *bval);
+Slapi_Value *slapi_value_init_string(Slapi_Value *v,const char *s);
+Slapi_Value *slapi_value_dup(const Slapi_Value *v);
+void slapi_value_free(Slapi_Value **value);
+const struct berval *slapi_value_get_berval( const Slapi_Value *value );
+Slapi_Value *slapi_value_set_berval( Slapi_Value *value, const struct berval *bval );
+Slapi_Value *slapi_value_set_value( Slapi_Value *value, const Slapi_Value *vfrom);
+Slapi_Value *slapi_value_set( Slapi_Value *value, void *val, unsigned long len);
+int slapi_value_set_string(Slapi_Value *value, const char *strVal);
+int slapi_value_set_int(Slapi_Value *value, int intVal);
+const char*slapi_value_get_string(const Slapi_Value *value);
+int slapi_value_get_int(const Slapi_Value *value); 
+unsigned int slapi_value_get_uint(const Slapi_Value *value); 
+long slapi_value_get_long(const Slapi_Value *value); 
+unsigned long slapi_value_get_ulong(const Slapi_Value *value); 
+size_t slapi_value_get_length(const Slapi_Value *value);
+int slapi_value_compare(const Slapi_Attr *a,const Slapi_Value *v1,const Slapi_Value *v2);
+
+Slapi_ValueSet *slapi_valueset_new( void );
+void slapi_valueset_free(Slapi_ValueSet *vs);
+void slapi_valueset_init(Slapi_ValueSet *vs);
+void slapi_valueset_done(Slapi_ValueSet *vs);
+void slapi_valueset_add_value(Slapi_ValueSet *vs, const Slapi_Value *addval);
+int slapi_valueset_first_value( Slapi_ValueSet *vs, Slapi_Value **v );
+int slapi_valueset_next_value( Slapi_ValueSet *vs, int index, Slapi_Value **v);
+int slapi_valueset_count( const Slapi_ValueSet *vs);
+void slapi_valueset_set_valueset(Slapi_ValueSet *vs1, const Slapi_ValueSet *vs2);
+
+typedef struct slapi_mutex     Slapi_Mutex;
+typedef struct slapi_condvar   Slapi_CondVar;
+Slapi_Mutex *slapi_new_mutex( void );
+void slapi_destroy_mutex( Slapi_Mutex *mutex );
+void slapi_lock_mutex( Slapi_Mutex *mutex );
+int slapi_unlock_mutex( Slapi_Mutex *mutex );
+Slapi_CondVar *slapi_new_condvar( Slapi_Mutex *mutex );
+void slapi_destroy_condvar( Slapi_CondVar *cvar );
+int slapi_wait_condvar( Slapi_CondVar *cvar, struct timeval *timeout );
+int slapi_notify_condvar( Slapi_CondVar *cvar, int notify_all );
+
 char *slapi_ch_malloc( unsigned long size );
 void slapi_ch_free( void **ptr );
+void slapi_ch_free_string( char **ptr );
 char *slapi_ch_calloc( unsigned long nelem, unsigned long size );
 char *slapi_ch_realloc( char *block, unsigned long size );
 char *slapi_ch_strdup( char *s );
-
+void slapi_ch_array_free( char **arrayp );
+struct berval *slapi_ch_bvdup(const struct berval *v);
+struct berval **slapi_ch_bvecdup(const struct berval **v);
 
 /* LDAP V3 routines */
 int slapi_control_present( LDAPControl **controls, char *oid,
@@ -72,6 +170,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);
@@ -85,36 +184,88 @@ int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,
 
 /* 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 );
 Slapi_Filter *slapi_filter_list_first( Slapi_Filter *f );
 Slapi_Filter *slapi_filter_list_next( Slapi_Filter *f, Slapi_Filter *fprev );
+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_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 /* 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 */
 Slapi_PBlock *slapi_search_internal( char *base, int scope, char *filter, 
        LDAPControl **controls, char **attrs, int attrsonly );
 Slapi_PBlock *slapi_modify_internal( char *dn, LDAPMod **mods,
-        LDAPControl **controls, int log_change);
-Slapi_PBlock *slapi_add_entry_internal( Slapi_Entry * e,
-       LDAPControl **controls, int log_change );
+        LDAPControl **controls, int log_change );
 Slapi_PBlock *slapi_add_internal( char * dn, LDAPMod **attrs,
        LDAPControl **controls, int log_changes );
 Slapi_PBlock *slapi_add_entry_internal( Slapi_Entry * e,
        LDAPControl **controls, int log_change );
 Slapi_PBlock *slapi_delete_internal( char * dn,  LDAPControl **controls,
        int log_change );
+Slapi_PBlock *slapi_modrdn_internal( char * olddn, char * newrdn,
+       int deloldrdn, LDAPControl **controls,
+       int log_change );
+#if 0
 Slapi_PBlock *slapi_modrdn_internal( char * olddn, char * newrdn,
        char *newParent, int deloldrdn, LDAPControl **controls,
-       int log_change);
+       int log_change );
+#endif
 void slapi_free_search_results_internal(Slapi_PBlock *pb);
 
 /* connection related routines */
 int slapi_is_connection_ssl(Slapi_PBlock *pPB, int *isSSL);
 int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 
+/* computed attributes */
+typedef struct _computed_attr_context computed_attr_context;
+typedef int (*slapi_compute_output_t)(computed_attr_context *c, Slapi_Attr *a, Slapi_Entry *e);
+typedef int (*slapi_compute_callback_t)(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);
+typedef int (*slapi_search_rewrite_callback_t)(Slapi_PBlock *pb);
+int slapi_compute_add_evaluator(slapi_compute_callback_t function);
+int slapi_compute_add_search_rewriter(slapi_search_rewrite_callback_t function);
+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);
+
 /* parameters currently supported */
 
+/*
+ * Attribute flags returned by slapi_attr_get_flags()
+ */
+#define SLAPI_ATTR_FLAG_SINGLE         0x0001
+#define SLAPI_ATTR_FLAG_OPATTR         0x0002
+#define SLAPI_ATTR_FLAG_READONLY       0x0004
+#define SLAPI_ATTR_FLAG_STD_ATTR       SLAPI_ATTR_FLAG_READONLY
+#define SLAPI_ATTR_FLAG_OBSOLETE       0x0040
+#define SLAPI_ATTR_FLAG_COLLECTIVE     0x0080
+#define SLAPI_ATTR_FLAG_NOUSERMOD      0x0100
+
+/*
+ * ACL levels
+ */
+#define SLAPI_ACL_COMPARE       0x01
+#define SLAPI_ACL_SEARCH        0x02
+#define SLAPI_ACL_READ          0x04
+#define SLAPI_ACL_WRITE         0x08
+#define SLAPI_ACL_DELETE        0x10    
+#define SLAPI_ACL_ADD           0x20
+#define SLAPI_ACL_SELF          0x40
+#define SLAPI_ACL_PROXY         0x80
+#define SLAPI_ACL_ALL           0x7f
 
 /* plugin types supported */
 
@@ -122,6 +273,8 @@ int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 #define SLAPI_PLUGIN_EXTENDEDOP         2
 #define SLAPI_PLUGIN_PREOPERATION       3
 #define SLAPI_PLUGIN_POSTOPERATION      4
+#define SLAPI_PLUGIN_MATCHINGRULE       5
+#define SLAPI_PLUGIN_SYNTAX             6
 #define SLAPI_PLUGIN_AUDIT              7   
 
 /* misc params */
@@ -144,6 +297,12 @@ int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 /* connection  structure params*/
 #define SLAPI_CONN_DN                          143
 #define SLAPI_CONN_AUTHTYPE                            144
+#define SLAPI_CONN_CLIENTIP                    145
+#define SLAPI_CONN_SERVERIP                    146
+/* OpenLDAP extensions */
+#define SLAPI_X_CONN_CLIENTPATH                        1300
+#define SLAPI_X_CONN_SERVERPATH                        1301
+#define SLAPI_X_CONN_IS_UDP                    1302
 
 /*  Authentication types */
 #define SLAPD_AUTH_NONE   "none"
@@ -231,6 +390,61 @@ int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 #define SLAPI_PLUGIN_POST_REFERRAL_FN          511
 #define SLAPI_PLUGIN_POST_RESULT_FN            512
 
+#define SLAPI_OPERATION_TYPE                   590
+
+#define SLAPI_PLUGIN_MR_FILTER_CREATE_FN       600
+#define SLAPI_PLUGIN_MR_INDEXER_CREATE_FN      601
+#define SLAPI_PLUGIN_MR_FILTER_MATCH_FN                602
+#define SLAPI_PLUGIN_MR_FILTER_INDEX_FN                603
+#define SLAPI_PLUGIN_MR_FILTER_RESET_FN                604
+#define SLAPI_PLUGIN_MR_INDEX_FN               605
+#define SLAPI_PLUGIN_MR_OID                    610
+#define SLAPI_PLUGIN_MR_TYPE                   611
+#define SLAPI_PLUGIN_MR_VALUE                  612
+#define SLAPI_PLUGIN_MR_VALUES                 613
+#define SLAPI_PLUGIN_MR_KEYS                   614
+#define SLAPI_PLUGIN_MR_FILTER_REUSABLE                615
+#define SLAPI_PLUGIN_MR_QUERY_OPERATOR         616
+#define SLAPI_PLUGIN_MR_USAGE                  617
+
+#define SLAPI_MATCHINGRULE_NAME                        1
+#define SLAPI_MATCHINGRULE_OID                 2
+#define SLAPI_MATCHINGRULE_DESC                        3
+#define SLAPI_MATCHINGRULE_SYNTAX              4
+#define SLAPI_MATCHINGRULE_OBSOLETE            5
+
+#define SLAPI_OP_LESS                                  1
+#define SLAPI_OP_LESS_OR_EQUAL                         2
+#define SLAPI_OP_EQUAL                                 3
+#define SLAPI_OP_GREATER_OR_EQUAL                      4
+#define SLAPI_OP_GREATER                               5
+#define SLAPI_OP_SUBSTRING                             6
+
+#define SLAPI_PLUGIN_MR_USAGE_INDEX            0
+#define SLAPI_PLUGIN_MR_USAGE_SORT             1
+
+#define SLAPI_PLUGIN_SYNTAX_FILTER_AVA         700
+#define SLAPI_PLUGIN_SYNTAX_FILTER_SUB         701
+#define SLAPI_PLUGIN_SYNTAX_VALUES2KEYS                702
+#define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_AVA 703
+#define SLAPI_PLUGIN_SYNTAX_ASSERTION2KEYS_SUB 704
+#define SLAPI_PLUGIN_SYNTAX_NAMES              705
+#define SLAPI_PLUGIN_SYNTAX_OID                        706
+#define SLAPI_PLUGIN_SYNTAX_FLAGS              707
+#define SLAPI_PLUGIN_SYNTAX_COMPARE            708
+
+#define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                        1
+#define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING              2
+
+#define SLAPI_OPERATION_AUTHTYPE                741
+#define SLAPI_OPERATION_ID                      742
+#define SLAPI_CONN_CERT                         743
+#define SLAPI_CONN_AUTHMETHOD                   746
+
+#define SLAPI_RESULT_CODE                       881
+#define SLAPI_RESULT_TEXT                       882
+#define SLAPI_RESULT_MATCHED                    883
+
 /* audit plugin defines */
 #define SLAPI_PLUGIN_AUDIT_DATA                1100
 #define SLAPI_PLUGIN_AUDIT_FN                  1101
@@ -305,13 +519,16 @@ int slapi_get_client_port(Slapi_PBlock *pPB, int *fromPort);
 
 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT      -1
 
+#define SLAPI_BIND_SUCCESS             0
+#define SLAPI_BIND_FAIL                        2
+#define SLAPI_BIND_ANONYMOUS           3
+
 /* Search result params */
 #define SLAPI_SEARCH_RESULT_SET                        193
 #define        SLAPI_SEARCH_RESULT_ENTRY               194
 #define        SLAPI_NENTRIES                          195
 #define SLAPI_SEARCH_REFERRALS                 196
 
-
 /* filter types */
 #ifndef LDAP_FILTER_AND
 #define LDAP_FILTER_AND         0xa0L