git.sur5r.net Git - openldap/blob - servers/slapd/overlays/rwm.h

   1 /* rwm.h - dn rewrite/attribute mapping header file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1999-2005 The OpenLDAP Foundation.
   6  * Portions Copyright 1999-2003 Howard Chu.
   7  * Portions Copyright 2000-2003 Pierangelo Masarati.
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted only as authorized by the OpenLDAP
  12  * Public License.
  13  *
  14  * A copy of this license is available in the file LICENSE in the
  15  * top-level directory of the distribution or, alternatively, at
  16  * <http://www.OpenLDAP.org/license.html>.
  17  */
  18 /* ACKNOWLEDGEMENTS:
  19  * This work was initially developed by the Howard Chu for inclusion
  20  * in OpenLDAP Software and subsequently enhanced by Pierangelo
  21  * Masarati.
  22  */
  23
  24 #ifndef RWM_H
  25 #define RWM_H
  26
  27 /* String rewrite library */
  28 #ifdef ENABLE_REWRITE
  29 #include "rewrite.h"
  30 #endif /* ENABLE_REWRITE */
  31
  32 LDAP_BEGIN_DECL
  33
  34 /* define to enable referral DN massage by default */
  35 #undef RWM_REFERRAL_REWRITE
  36
  37 struct ldapmap {
  38         int drop_missing;
  39
  40         Avlnode *map;
  41         Avlnode *remap;
  42 };
  43
  44 struct ldapmapping {
  45         int                     m_flags;
  46 #define RWMMAP_F_NONE           0x00
  47 #define RWMMAP_F_IS_OC          0x01
  48 #define RWMMAP_F_FREE_SRC       0x10
  49 #define RWMMAP_F_FREE_DST       0x20
  50         struct berval           m_src;
  51         union {
  52                 AttributeDescription    *m_s_ad;
  53                 ObjectClass             *m_s_oc;
  54         } m_src_ref;
  55 #define m_src_ad        m_src_ref.m_s_ad
  56 #define m_src_oc        m_src_ref.m_s_oc
  57         struct berval           m_dst;
  58         union {
  59                 AttributeDescription    *m_d_ad;
  60                 ObjectClass             *m_d_oc;
  61         } m_dst_ref;
  62 #define m_dst_ad        m_dst_ref.m_d_ad
  63 #define m_dst_oc        m_dst_ref.m_d_oc
  64 };
  65
  66 struct ldaprwmap {
  67         /*
  68          * DN rewriting
  69          */
  70 #ifdef ENABLE_REWRITE
  71         struct rewrite_info *rwm_rw;
  72 #else /* !ENABLE_REWRITE */
  73         /* some time the suffix massaging without librewrite
  74          * will be disabled */
  75         BerVarray rwm_suffix_massage;
  76 #endif /* !ENABLE_REWRITE */
  77
  78         /*
  79          * Attribute/objectClass mapping
  80          */
  81         struct ldapmap rwm_oc;
  82         struct ldapmap rwm_at;
  83
  84 #define RWM_F_NONE                      0x0000U
  85 #define RWM_F_SUPPORT_T_F               0x4000U
  86 #define RWM_F_SUPPORT_T_F_DISCOVER      0x8000U
  87         unsigned        rwm_flags;
  88 };
  89
  90 /* Whatever context ldap_back_dn_massage needs... */
  91 typedef struct dncookie {
  92         struct ldaprwmap *rwmap;
  93
  94 #ifdef ENABLE_REWRITE
  95         Connection *conn;
  96         char *ctx;
  97         SlapReply *rs;
  98 #else /* !ENABLE_REWRITE */
  99         int normalized;
 100         int tofrom;
 101 #endif /* !ENABLE_REWRITE */
 102 } dncookie;
 103
 104 int rwm_dn_massage( dncookie *dc, struct berval *in, struct berval *dn );
 105 int rwm_dn_massage_pretty( dncookie *dc, struct berval *in, struct berval *pdn );
 106 int rwm_dn_massage_normalize( dncookie *dc, struct berval *in, struct berval *ndn );
 107 int rwm_dn_massage_pretty_normalize( dncookie *dc, struct berval *in, struct berval *pdn, struct berval *ndn );
 108
 109 /* attributeType/objectClass mapping */
 110 int rwm_mapping_cmp (const void *, const void *);
 111 int rwm_mapping_dup (void *, void *);
 112
 113 int rwm_map_init ( struct ldapmap *lm, struct ldapmapping ** );
 114 void rwm_map ( struct ldapmap *map, struct berval *s, struct berval *m,
 115         int remap );
 116 int rwm_mapping ( struct ldapmap *map, struct berval *s,
 117                 struct ldapmapping **m, int remap );
 118 #define RWM_MAP         0
 119 #define RWM_REMAP       1
 120 char *
 121 rwm_map_filter(
 122                 struct ldapmap *at_map,
 123                 struct ldapmap *oc_map,
 124                 struct berval *f );
 125
 126 int
 127 rwm_map_attrs(
 128                 struct ldapmap *at_map,
 129                 AttributeName *a,
 130                 int remap,
 131                 char ***mapped_attrs );
 132
 133 int
 134 rwm_map_attrnames(
 135                 struct ldapmap *at_map,
 136                 struct ldapmap *oc_map,
 137                 AttributeName *an,
 138                 AttributeName **anp,
 139                 int remap );
 140
 141 extern void rwm_mapping_free ( void *mapping );
 142
 143 extern int rwm_map_config(
 144                 struct ldapmap  *oc_map,
 145                 struct ldapmap  *at_map,
 146                 const char      *fname,
 147                 int             lineno,
 148                 int             argc,
 149                 char            **argv );
 150
 151 extern int
 152 rwm_filter_map_rewrite(
 153                 dncookie                *dc,
 154                 Filter                  *f,
 155                 struct berval           *fstr );
 156
 157 /* suffix massaging by means of librewrite */
 158 #ifdef ENABLE_REWRITE
 159 extern int rwm_suffix_massage_config( struct rewrite_info *info,
 160                 struct berval *pvnc, struct berval *nvnc,
 161                 struct berval *prnc, struct berval *nrnc);
 162 #endif /* ENABLE_REWRITE */
 163 extern int rwm_dnattr_rewrite(
 164         Operation               *op,
 165         SlapReply               *rs,
 166         void                    *cookie,
 167         BerVarray               a_vals,
 168         BerVarray               *pa_nvals );
 169 extern int rwm_referral_rewrite(
 170         Operation               *op,
 171         SlapReply               *rs,
 172         void                    *cookie,
 173         BerVarray               a_vals,
 174         BerVarray               *pa_nvals );
 175 extern int rwm_dnattr_result_rewrite( dncookie *dc, BerVarray a_vals );
 176 extern int rwm_referral_result_rewrite( dncookie *dc, BerVarray a_vals );
 177
 178 LDAP_END_DECL
 179
 180 #endif /* RWM_H */