Diff for /include/slapi-plugin.h between versions 1.21 and 1.37

version 1.21, 2003/07/03 15:38:57 version 1.37, 2004/08/26 03:30:49
Line 1 Line 1
 /*  /* $OpenLDAP: pkg/ldap/include/slapi-plugin.h,v 1.36 2004/08/25 13:18:56 lukeh Exp $ */
  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.  /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file   *
    * 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   * This header is used in development of SLAPI plugins for
  * Redistribution and use in source and binary forms are permitted   * OpenLDAP slapd(8) and other directory servers supporting
  * provided that this notice is preserved and that due credit is   * this interface.  Your portability mileage may vary.
  * given to IBM Corporation. This software is provided ``as is''  
  * without express or implied warranty.  
  */   */
   
 #ifndef _SLAPI_PLUGIN_H  #ifndef _SLAPI_PLUGIN_H
Line 15 Line 25
   
 #include <ldap.h>  #include <ldap.h>
   
 typedef struct slapi_pblock     Slapi_PBlock;  typedef struct slapi_pblock             Slapi_PBlock;
 typedef struct slapi_entry      Slapi_Entry;  typedef struct slapi_entry              Slapi_Entry;
 typedef struct slapi_attr       Slapi_Attr;  typedef struct slapi_attr               Slapi_Attr;
 typedef struct slapi_value      Slapi_Value;  typedef struct slapi_value              Slapi_Value;
 typedef struct slapi_valueset   Slapi_ValueSet;  typedef struct slapi_valueset           Slapi_ValueSet;
 typedef struct slapi_filter     Slapi_Filter;  typedef struct slapi_filter             Slapi_Filter;
   typedef struct slap_backend_db          Slapi_Backend;
   typedef struct slap_op                  Slapi_Operation;
   typedef struct slap_conn                Slapi_Connection;
   typedef struct slapi_dn                 Slapi_DN;
   typedef struct slapi_rdn                Slapi_RDN;
   typedef struct slapi_mod                Slapi_Mod;
   typedef struct slapi_mods               Slapi_Mods;
   typedef struct slapi_componentid        Slapi_ComponentId;
   
 /* pblock routines */  /* pblock routines */
 int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );  int slapi_pblock_get( Slapi_PBlock *pb, int arg, void *value );
 int slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value );  int slapi_pblock_set( Slapi_PBlock *pb, int arg, void *value );
 Slapi_PBlock *slapi_pblock_new();  Slapi_PBlock *slapi_pblock_new( void );
 void slapi_pblock_destroy( Slapi_PBlock* );  void slapi_pblock_destroy( Slapi_PBlock *pb );
   
 /* entry/attr/dn routines */  /* entry/attr/dn routines */
 Slapi_Entry *slapi_str2entry( char *s, int flags );  Slapi_Entry *slapi_str2entry( char *s, int flags );
   #define SLAPI_STR2ENTRY_REMOVEDUPVALS   1
   #define SLAPI_STR2ENTRY_ADDRDNVALS      2
   #define SLAPI_STR2ENTRY_BIGENTRY        4
   #define SLAPI_STR2ENTRY_TOMBSTONE_CHECK 8
   #define SLAPI_STR2ENTRY_IGNORE_STATE    16
   #define SLAPI_STR2ENTRY_INCLUDE_VERSION_STR     32
   #define SLAPI_STR2ENTRY_EXPAND_OBJECTCLASSES    64
   #define SLAPI_STR2ENTRY_NOT_WELL_FORMED_LDIF    128
 char *slapi_entry2str( Slapi_Entry *e, int *len );  char *slapi_entry2str( Slapi_Entry *e, int *len );
 char *slapi_entry_get_dn( Slapi_Entry *e );  char *slapi_entry_get_dn( Slapi_Entry *e );
 int slapi_x_entry_get_id( Slapi_Entry *e );  int slapi_x_entry_get_id( Slapi_Entry *e );
Line 42  int slapi_entry_attr_merge( Slapi_Entry Line 68  int slapi_entry_attr_merge( Slapi_Entry
 int slapi_entry_attr_find( Slapi_Entry *e, char *type, Slapi_Attr **attr );  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 );  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_int( const Slapi_Entry *e, const char *type );
 int slapi_entry_attr_get_long( const Slapi_Entry *e, const char *type );  long 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 );  unsigned 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 );  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 );  int slapi_attr_get_values( Slapi_Attr *attr, struct berval ***vals );
 char *slapi_dn_normalize( char *dn );  char *slapi_dn_normalize( char *dn );
 char *slapi_dn_normalize_case( char *dn );  char *slapi_dn_normalize_case( char *dn );
 int slapi_dn_issuffix( char *dn, char *suffix );  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 );  char *slapi_dn_ignore_case( char *dn );
   int slapi_rdn2typeval( char *rdn, char **type, struct berval *bv );
   char *slapi_dn_plus_rdn(const char *dn, const char *rdn);
   
 /* DS 5.x SLAPI */  /* DS 5.x SLAPI */
 int slapi_access_allowed( Slapi_PBlock *pb, Slapi_Entry *e, char *attr, struct berval *val, int access );  int slapi_access_allowed( Slapi_PBlock *pb, Slapi_Entry *e, char *attr, struct berval *val, int access );
Line 83  void slapi_entry_attr_set_int( Slapi_Ent Line 114  void slapi_entry_attr_set_int( Slapi_Ent
 void slapi_entry_attr_set_uint( Slapi_Entry* e, const char *type, unsigned 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_long(Slapi_Entry* e, const char *type, long l);
 void slapi_entry_attr_set_ulong(Slapi_Entry* e, const char *type, unsigned long l);  void slapi_entry_attr_set_ulong(Slapi_Entry* e, const char *type, unsigned long l);
   int slapi_entry_has_children(const Slapi_Entry *e);
   size_t slapi_entry_size(Slapi_Entry *e);
 int slapi_is_rootdse( const char *dn );  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_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_values_sv( Slapi_Entry *e, const char *type, Slapi_Value **vals );
Line 95  int slapi_entry_add_string(Slapi_Entry * Line 128  int slapi_entry_add_string(Slapi_Entry *
 int slapi_entry_delete_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_first_attr( const Slapi_Entry *e, Slapi_Attr **attr );
 int slapi_entry_next_attr( const Slapi_Entry *e, Slapi_Attr *prevattr, Slapi_Attr **attr );  int slapi_entry_next_attr( const Slapi_Entry *e, Slapi_Attr *prevattr, Slapi_Attr **attr );
   const char *slapi_entry_get_uniqueid( const Slapi_Entry *e );
   void slapi_entry_set_uniqueid( Slapi_Entry *e, char *uniqueid );
   int slapi_entry_schema_check( Slapi_PBlock *pb, Slapi_Entry *e );
   int slapi_entry_rdn_values_present( const Slapi_Entry *e );
   int slapi_entry_add_rdn_values( Slapi_Entry *e );
 char *slapi_attr_syntax_normalize( const char *s );  char *slapi_attr_syntax_normalize( const char *s );
   
 Slapi_Value *slapi_value_new( void );  Slapi_Value *slapi_value_new( void );
Line 130  int slapi_valueset_next_value( Slapi_Val Line 168  int slapi_valueset_next_value( Slapi_Val
 int slapi_valueset_count( const Slapi_ValueSet *vs);  int slapi_valueset_count( const Slapi_ValueSet *vs);
 void slapi_valueset_set_valueset(Slapi_ValueSet *vs1, const Slapi_ValueSet *vs2);  void slapi_valueset_set_valueset(Slapi_ValueSet *vs1, const Slapi_ValueSet *vs2);
   
   /* locks and synchronization */
 typedef struct slapi_mutex      Slapi_Mutex;  typedef struct slapi_mutex      Slapi_Mutex;
 typedef struct slapi_condvar    Slapi_CondVar;  typedef struct slapi_condvar    Slapi_CondVar;
 Slapi_Mutex *slapi_new_mutex( void );  Slapi_Mutex *slapi_new_mutex( void );
Line 141  void slapi_destroy_condvar( Slapi_CondVa Line 180  void slapi_destroy_condvar( Slapi_CondVa
 int slapi_wait_condvar( Slapi_CondVar *cvar, struct timeval *timeout );  int slapi_wait_condvar( Slapi_CondVar *cvar, struct timeval *timeout );
 int slapi_notify_condvar( Slapi_CondVar *cvar, int notify_all );  int slapi_notify_condvar( Slapi_CondVar *cvar, int notify_all );
   
   /* thread-safe LDAP connections */
   LDAP *slapi_ldap_init( char *ldaphost, int ldapport, int secure, int shared );
   void slapi_ldap_unbind( LDAP *ld );
   
 char *slapi_ch_malloc( unsigned long size );  char *slapi_ch_malloc( unsigned long size );
 void slapi_ch_free( void **ptr );  void slapi_ch_free( void **ptr );
 void slapi_ch_free_string( char **ptr );  void slapi_ch_free_string( char **ptr );
Line 181  void slapi_send_ldap_result( Slapi_PBloc Line 224  void slapi_send_ldap_result( Slapi_PBloc
         char *text, int nentries, struct berval **urls );          char *text, int nentries, struct berval **urls );
 int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,  int slapi_send_ldap_search_entry( Slapi_PBlock *pb, Slapi_Entry *e,
         LDAPControl **ectrls, char **attrs, int attrsonly );          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 */  /* filter routines */
 Slapi_Filter *slapi_str2filter( char *str );  Slapi_Filter *slapi_str2filter( char *str );
Line 243  int compute_rewrite_search_filter(Slapi_ Line 288  int compute_rewrite_search_filter(Slapi_
 int compute_evaluator(computed_attr_context *c, char *type, Slapi_Entry *e, slapi_compute_output_t outputfn);  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);  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 */  /* object extensions */
 typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);  typedef void *(*slapi_extension_constructor_fnptr)(void *object, void *parent);
   
Line 327  void slapi_set_object_extension(int obje Line 380  void slapi_set_object_extension(int obje
 #define SLAPI_X_CONN_SERVERPATH                 1301  #define SLAPI_X_CONN_SERVERPATH                 1301
 #define SLAPI_X_CONN_IS_UDP                     1302  #define SLAPI_X_CONN_IS_UDP                     1302
 #define SLAPI_X_CONN_SSF                        1303  #define SLAPI_X_CONN_SSF                        1303
   #define SLAPI_X_CONN_SASL_CONTEXT               1304
   
 /*  Authentication types */  /*  Authentication types */
 #define SLAPD_AUTH_NONE   "none"  #define SLAPD_AUTH_NONE   "none"
Line 460  void slapi_set_object_extension(int obje Line 514  void slapi_set_object_extension(int obje
 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                 1  #define SLAPI_PLUGIN_SYNTAX_FLAG_ORKEYS                 1
 #define SLAPI_PLUGIN_SYNTAX_FLAG_ORDERING               2  #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_AUTHTYPE                741
 #define SLAPI_OPERATION_ID                      742  #define SLAPI_OPERATION_ID                      742
 #define SLAPI_CONN_CERT                         743  #define SLAPI_CONN_CERT                         743
Line 469  void slapi_set_object_extension(int obje Line 529  void slapi_set_object_extension(int obje
 #define SLAPI_RESULT_TEXT                       882  #define SLAPI_RESULT_TEXT                       882
 #define SLAPI_RESULT_MATCHED                    883  #define SLAPI_RESULT_MATCHED                    883
   
   /* managedsait control */
   #define SLAPI_MANAGEDSAIT                       1000
   
 /* audit plugin defines */  /* audit plugin defines */
 #define SLAPI_PLUGIN_AUDIT_DATA                1100  #define SLAPI_PLUGIN_AUDIT_DATA                1100
 #define SLAPI_PLUGIN_AUDIT_FN                  1101  #define SLAPI_PLUGIN_AUDIT_FN                  1101
   
 /* managedsait control */  /* backend_group extension */
 #define SLAPI_MANAGEDSAIT                       1000  #define SLAPI_X_PLUGIN_PRE_GROUP_FN             1202 
   #define SLAPI_X_PLUGIN_POST_GROUP_FN            1203
   
   #define SLAPI_X_GROUP_ENTRY                     1250 /* group entry */
   #define SLAPI_X_GROUP_ATTRIBUTE                 1251 /* member attribute */
   #define SLAPI_X_GROUP_OPERATION_DN              1252 /* asserted value */
   #define SLAPI_X_GROUP_TARGET_ENTRY              1253 /* target entry */
   
 /* config stuff */  /* config stuff */
 #define SLAPI_CONFIG_FILENAME                   40  #define SLAPI_CONFIG_FILENAME                   40
Line 543  void slapi_set_object_extension(int obje Line 612  void slapi_set_object_extension(int obje
   
 #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT       -1  #define SLAPI_PLUGIN_EXTENDED_SENT_RESULT       -1
   
   #define SLAPI_FAIL_DISKFULL             -2
   #define SLAPI_FAIL_GENERAL              -1
 #define SLAPI_BIND_SUCCESS              0  #define SLAPI_BIND_SUCCESS              0
 #define SLAPI_BIND_FAIL                 2  #define SLAPI_BIND_FAIL                 2
 #define SLAPI_BIND_ANONYMOUS            3  #define SLAPI_BIND_ANONYMOUS            3

Removed from v.1.21  
changed lines
  Added in v.1.37


______________
© Copyright 1998-2020, OpenLDAP Foundation, info@OpenLDAP.org