/* $OpenLDAP$ */ /* This work is part of OpenLDAP Software . * * Copyright 1999-2022 The OpenLDAP Foundation. * Portions Copyright 2001-2003 Pierangelo Masarati. * Portions Copyright 1999-2003 Howard Chu. * 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 * . */ /* ACKNOWLEDGEMENTS: * This work was initially developed by the Howard Chu for inclusion * in OpenLDAP Software and subsequently enhanced by Pierangelo * Masarati. */ #ifndef SLAPD_LDAP_H #error "include servers/slapd/back-ldap/back-ldap.h before this file!" #endif /* SLAPD_LDAP_H */ #ifndef SLAPD_META_H #define SLAPD_META_H #define SLAPD_META_CLIENT_PR 1 #include "proto-meta.h" /* String rewrite library */ #include "rewrite.h" LDAP_BEGIN_DECL /* * Set META_BACK_PRINT_CONNTREE larger than 0 to dump the connection tree (debug only) */ #ifndef META_BACK_PRINT_CONNTREE #define META_BACK_PRINT_CONNTREE 0 #endif /* !META_BACK_PRINT_CONNTREE */ /* from back-ldap.h before rwm removal */ struct ldapmap { int drop_missing; Avlnode *map; Avlnode *remap; }; struct ldapmapping { struct berval src; struct berval dst; }; struct ldaprwmap { /* * DN rewriting */ struct rewrite_info *rwm_rw; BerVarray rwm_bva_rewrite; /* * Attribute/objectClass mapping */ struct ldapmap rwm_oc; struct ldapmap rwm_at; BerVarray rwm_bva_map; }; /* Whatever context ldap_back_dn_massage needs... */ typedef struct dncookie { struct metatarget_t *target; Connection *conn; char *ctx; SlapReply *rs; } dncookie; int ldap_back_dn_massage(dncookie *dc, struct berval *dn, struct berval *res); extern int ldap_back_conn_cmp( const void *c1, const void *c2); extern int ldap_back_conn_dup( void *c1, void *c2 ); extern void ldap_back_conn_free( void *c ); /* attributeType/objectClass mapping */ int mapping_cmp (const void *, const void *); int mapping_dup (void *, void *); void ldap_back_map_init ( struct ldapmap *lm, struct ldapmapping ** ); int ldap_back_mapping ( struct ldapmap *map, struct berval *s, struct ldapmapping **m, int remap ); void ldap_back_map ( struct ldapmap *map, struct berval *s, struct berval *m, int remap ); #define BACKLDAP_MAP 0 #define BACKLDAP_REMAP 1 char * ldap_back_map_filter( struct ldapmap *at_map, struct ldapmap *oc_map, struct berval *f, int remap ); int ldap_back_map_attrs( Operation *op, struct ldapmap *at_map, AttributeName *a, int remap, char ***mapped_attrs ); extern int ldap_back_filter_map_rewrite( dncookie *dc, Filter *f, struct berval *fstr, int remap, void *memctx ); /* suffix massaging by means of librewrite */ extern int suffix_massage_config( struct rewrite_info *info, struct berval *pvnc, struct berval *nvnc, struct berval *prnc, struct berval *nrnc ); extern int ldap_back_referral_result_rewrite( dncookie *dc, BerVarray a_vals, void *memctx ); extern int ldap_dnattr_rewrite( dncookie *dc, BerVarray a_vals ); extern int ldap_dnattr_result_rewrite( dncookie *dc, BerVarray a_vals ); /* (end of) from back-ldap.h before rwm removal */ /* * A metasingleconn_t can be in the following, mutually exclusive states: * * - none (0x0U) * - creating META_BACK_FCONN_CREATING * - initialized META_BACK_FCONN_INITED * - binding LDAP_BACK_FCONN_BINDING * - bound/anonymous LDAP_BACK_FCONN_ISBOUND/LDAP_BACK_FCONN_ISANON * * possible modifiers are: * * - privileged LDAP_BACK_FCONN_ISPRIV * - privileged, TLS LDAP_BACK_FCONN_ISTLS * - subjected to idassert LDAP_BACK_FCONN_ISIDASR * - tainted LDAP_BACK_FCONN_TAINTED */ #define META_BACK_FCONN_INITED (0x00100000U) #define META_BACK_FCONN_CREATING (0x00200000U) #define META_BACK_CONN_INITED(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_INITED) #define META_BACK_CONN_INITED_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_INITED) #define META_BACK_CONN_INITED_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_INITED) #define META_BACK_CONN_INITED_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_INITED, (mlc)) #define META_BACK_CONN_CREATING(lc) LDAP_BACK_CONN_ISSET((lc), META_BACK_FCONN_CREATING) #define META_BACK_CONN_CREATING_SET(lc) LDAP_BACK_CONN_SET((lc), META_BACK_FCONN_CREATING) #define META_BACK_CONN_CREATING_CLEAR(lc) LDAP_BACK_CONN_CLEAR((lc), META_BACK_FCONN_CREATING) #define META_BACK_CONN_CREATING_CPY(lc, mlc) LDAP_BACK_CONN_CPY((lc), META_BACK_FCONN_CREATING, (mlc)) struct metainfo_t; #define META_NOT_CANDIDATE ((ber_tag_t)0x0) #define META_CANDIDATE ((ber_tag_t)0x1) #define META_BINDING ((ber_tag_t)0x2) #define META_RETRYING ((ber_tag_t)0x4) typedef struct metasingleconn_t { #define META_CND_ISSET(rs,f) ( ( (rs)->sr_tag & (f) ) == (f) ) #define META_CND_SET(rs,f) ( (rs)->sr_tag |= (f) ) #define META_CND_CLEAR(rs,f) ( (rs)->sr_tag &= ~(f) ) #define META_CANDIDATE_RESET(rs) ( (rs)->sr_tag = 0 ) #define META_IS_CANDIDATE(rs) META_CND_ISSET( (rs), META_CANDIDATE ) #define META_CANDIDATE_SET(rs) META_CND_SET( (rs), META_CANDIDATE ) #define META_CANDIDATE_CLEAR(rs) META_CND_CLEAR( (rs), META_CANDIDATE ) #define META_IS_BINDING(rs) META_CND_ISSET( (rs), META_BINDING ) #define META_BINDING_SET(rs) META_CND_SET( (rs), META_BINDING ) #define META_BINDING_CLEAR(rs) META_CND_CLEAR( (rs), META_BINDING ) #define META_IS_RETRYING(rs) META_CND_ISSET( (rs), META_RETRYING ) #define META_RETRYING_SET(rs) META_CND_SET( (rs), META_RETRYING ) #define META_RETRYING_CLEAR(rs) META_CND_CLEAR( (rs), META_RETRYING ) LDAP *msc_ld; time_t msc_time; struct berval msc_bound_ndn; struct berval msc_cred; unsigned msc_mscflags; /* NOTE: lc_lcflags is redefined to msc_mscflags to reuse the macros * defined for back-ldap */ #define lc_lcflags msc_mscflags } metasingleconn_t; typedef struct metaconn_t { ldapconn_base_t lc_base; #define mc_base lc_base #define mc_conn mc_base.lcb_conn #define mc_local_ndn mc_base.lcb_local_ndn #define mc_refcnt mc_base.lcb_refcnt #define mc_create_time mc_base.lcb_create_time #define mc_time mc_base.lcb_time LDAP_TAILQ_ENTRY(metaconn_t) mc_q; /* NOTE: msc_mscflags is used to recycle the #define * in metasingleconn_t */ unsigned msc_mscflags; /* * means that the connection is bound; * of course only one target actually is ... */ int mc_authz_target; #define META_BOUND_NONE (-1) #define META_BOUND_ALL (-2) struct metainfo_t *mc_info; /* supersedes the connection stuff */ metasingleconn_t mc_conns[ 1 ]; /* NOTE: mc_conns must be last, because * the required number of conns is malloc'ed * in one block with the metaconn_t structure */ } metaconn_t; typedef enum meta_st_t { #if 0 /* todo */ META_ST_EXACT = LDAP_SCOPE_BASE, #endif META_ST_SUBTREE = LDAP_SCOPE_SUBTREE, META_ST_SUBORDINATE = LDAP_SCOPE_SUBORDINATE, META_ST_REGEX /* last + 1 */ } meta_st_t; typedef struct metasubtree_t { meta_st_t ms_type; union { struct berval msu_dn; struct { struct berval msr_regex_pattern; regex_t msr_regex; } msu_regex; } ms_un; #define ms_dn ms_un.msu_dn #define ms_regex ms_un.msu_regex.msr_regex #define ms_regex_pattern ms_un.msu_regex.msr_regex_pattern struct metasubtree_t *ms_next; } metasubtree_t; typedef struct metafilter_t { struct metafilter_t *mf_next; struct berval mf_regex_pattern; regex_t mf_regex; } metafilter_t; typedef struct metacommon_t { int mc_version; int mc_nretries; #define META_RETRY_UNDEFINED (-2) #define META_RETRY_FOREVER (-1) #define META_RETRY_NEVER (0) #define META_RETRY_DEFAULT (10) unsigned mc_flags; #define META_BACK_CMN_ISSET(mc,f) ( ( (mc)->mc_flags & (f) ) == (f) ) #define META_BACK_CMN_QUARANTINE(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_QUARANTINE ) #define META_BACK_CMN_CHASE_REFERRALS(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_CHASE_REFERRALS ) #define META_BACK_CMN_NOREFS(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOREFS ) #define META_BACK_CMN_NOUNDEFFILTER(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_NOUNDEFFILTER ) #define META_BACK_CMN_SAVECRED(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_SAVECRED ) #define META_BACK_CMN_ST_REQUEST(mc) META_BACK_CMN_ISSET( (mc), LDAP_BACK_F_ST_REQUEST ) #ifdef SLAPD_META_CLIENT_PR /* * client-side paged results: * -1: accept unsolicited paged results responses * 0: off * >0: always request paged results with size == mt_ps */ #define META_CLIENT_PR_DISABLE (0) #define META_CLIENT_PR_ACCEPT_UNSOLICITED (-1) ber_int_t mc_ps; #endif /* SLAPD_META_CLIENT_PR */ slap_retry_info_t mc_quarantine; time_t mc_network_timeout; struct timeval mc_bind_timeout; #define META_BIND_TIMEOUT LDAP_BACK_RESULT_UTIMEOUT time_t mc_timeout[ SLAP_OP_LAST ]; } metacommon_t; typedef struct metatarget_t { char *mt_uri; ldap_pvt_thread_mutex_t mt_uri_mutex; /* TODO: we might want to enable different strategies * for different targets */ LDAP_REBIND_PROC *mt_rebind_f; LDAP_URLLIST_PROC *mt_urllist_f; void *mt_urllist_p; metafilter_t *mt_filter; metasubtree_t *mt_subtree; /* F: subtree-include; T: subtree-exclude */ int mt_subtree_exclude; int mt_scope; struct berval mt_psuffix; /* pretty suffix */ struct berval mt_nsuffix; /* normalized suffix */ struct berval mt_binddn; struct berval mt_bindpw; /* we only care about the TLS options here */ slap_bindconf mt_tls; slap_idassert_t mt_idassert; #define mt_idassert_mode mt_idassert.si_mode #define mt_idassert_authcID mt_idassert.si_bc.sb_authcId #define mt_idassert_authcDN mt_idassert.si_bc.sb_binddn #define mt_idassert_passwd mt_idassert.si_bc.sb_cred #define mt_idassert_authzID mt_idassert.si_bc.sb_authzId #define mt_idassert_authmethod mt_idassert.si_bc.sb_method #define mt_idassert_sasl_mech mt_idassert.si_bc.sb_saslmech #define mt_idassert_sasl_realm mt_idassert.si_bc.sb_realm #define mt_idassert_secprops mt_idassert.si_bc.sb_secprops #define mt_idassert_tls mt_idassert.si_bc.sb_tls #define mt_idassert_flags mt_idassert.si_flags #define mt_idassert_authz mt_idassert.si_authz struct ldaprwmap mt_rwmap; sig_atomic_t mt_isquarantined; ldap_pvt_thread_mutex_t mt_quarantine_mutex; metacommon_t mt_mc; #define mt_nretries mt_mc.mc_nretries #define mt_flags mt_mc.mc_flags #define mt_version mt_mc.mc_version #define mt_ps mt_mc.mc_ps #define mt_network_timeout mt_mc.mc_network_timeout #define mt_bind_timeout mt_mc.mc_bind_timeout #define mt_timeout mt_mc.mc_timeout #define mt_quarantine mt_mc.mc_quarantine #define META_BACK_TGT_ISSET(mt,f) ( ( (mt)->mt_flags & (f) ) == (f) ) #define META_BACK_TGT_ISMASK(mt,m,f) ( ( (mt)->mt_flags & (m) ) == (f) ) #define META_BACK_TGT_SAVECRED(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_SAVECRED ) #define META_BACK_TGT_USE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_USE_TLS ) #define META_BACK_TGT_PROPAGATE_TLS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_PROPAGATE_TLS ) #define META_BACK_TGT_TLS_CRITICAL(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_TLS_CRITICAL ) #define META_BACK_TGT_CHASE_REFERRALS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_CHASE_REFERRALS ) #define META_BACK_TGT_T_F(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK, LDAP_BACK_F_T_F ) #define META_BACK_TGT_T_F_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_T_F_MASK2, LDAP_BACK_F_T_F_DISCOVER ) #define META_BACK_TGT_ABANDON(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_ABANDON ) #define META_BACK_TGT_IGNORE(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_IGNORE ) #define META_BACK_TGT_CANCEL(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK, LDAP_BACK_F_CANCEL_EXOP ) #define META_BACK_TGT_CANCEL_DISCOVER(mt) META_BACK_TGT_ISMASK( (mt), LDAP_BACK_F_CANCEL_MASK2, LDAP_BACK_F_CANCEL_EXOP_DISCOVER ) #define META_BACK_TGT_QUARANTINE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_QUARANTINE ) #ifdef SLAP_CONTROL_X_SESSION_TRACKING #define META_BACK_TGT_ST_REQUEST(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_REQUEST ) #define META_BACK_TGT_ST_RESPONSE(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_ST_RESPONSE ) #endif /* SLAP_CONTROL_X_SESSION_TRACKING */ #define META_BACK_TGT_NOREFS(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOREFS ) #define META_BACK_TGT_NOUNDEFFILTER(mt) META_BACK_TGT_ISSET( (mt), LDAP_BACK_F_NOUNDEFFILTER ) slap_mask_t mt_rep_flags; } metatarget_t; typedef struct metadncache_t { ldap_pvt_thread_mutex_t mutex; Avlnode *tree; #define META_DNCACHE_DISABLED (0) #define META_DNCACHE_FOREVER ((time_t)(-1)) time_t ttl; /* seconds; 0: no cache, -1: no expiry */ } metadncache_t; typedef struct metacandidates_t { int mc_ntargets; SlapReply *mc_candidates; } metacandidates_t; /* * Hook to allow mucking with metainfo_t/metatarget_t when quarantine is over */ typedef int (*meta_back_quarantine_f)( struct metainfo_t *, int target, void * ); typedef struct metainfo_t { int mi_ntargets; int mi_defaulttarget; #define META_DEFAULT_TARGET_NONE (-1) #define mi_nretries mi_mc.mc_nretries #define mi_flags mi_mc.mc_flags #define mi_version mi_mc.mc_version #define mi_ps mi_mc.mc_ps #define mi_network_timeout mi_mc.mc_network_timeout #define mi_bind_timeout mi_mc.mc_bind_timeout #define mi_timeout mi_mc.mc_timeout #define mi_quarantine mi_mc.mc_quarantine metatarget_t **mi_targets; metacandidates_t *mi_candidates; LDAP_REBIND_PROC *mi_rebind_f; LDAP_URLLIST_PROC *mi_urllist_f; metadncache_t mi_cache; /* cached connections; * special conns are in tailq rather than in tree */ ldap_avl_info_t mi_conninfo; struct { int mic_num; LDAP_TAILQ_HEAD(mc_conn_priv_q, metaconn_t) mic_priv; } mi_conn_priv[ LDAP_BACK_PCONN_LAST ]; int mi_conn_priv_max; /* NOTE: quarantine uses the connection mutex */ meta_back_quarantine_f mi_quarantine_f; void *mi_quarantine_p; #define li_flags mi_flags /* uses flags as defined in */ #define META_BACK_F_ONERR_STOP LDAP_BACK_F_ONERR_STOP #define META_BACK_F_ONERR_REPORT (0x02000000U) #define META_BACK_F_ONERR_MASK (META_BACK_F_ONERR_STOP|META_BACK_F_ONERR_REPORT) #define META_BACK_F_DEFER_ROOTDN_BIND (0x04000000U) #define META_BACK_F_PROXYAUTHZ_ALWAYS (0x08000000U) /* users always proxyauthz */ #define META_BACK_F_PROXYAUTHZ_ANON (0x10000000U) /* anonymous always proxyauthz */ #define META_BACK_F_PROXYAUTHZ_NOANON (0x20000000U) /* anonymous remains anonymous */ #define META_BACK_ONERR_STOP(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_STOP ) #define META_BACK_ONERR_REPORT(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_REPORT ) #define META_BACK_ONERR_CONTINUE(mi) ( !LDAP_BACK_ISSET( (mi), META_BACK_F_ONERR_MASK ) ) #define META_BACK_DEFER_ROOTDN_BIND(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_DEFER_ROOTDN_BIND ) #define META_BACK_PROXYAUTHZ_ALWAYS(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ALWAYS ) #define META_BACK_PROXYAUTHZ_ANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_ANON ) #define META_BACK_PROXYAUTHZ_NOANON(mi) LDAP_BACK_ISSET( (mi), META_BACK_F_PROXYAUTHZ_NOANON ) #define META_BACK_QUARANTINE(mi) LDAP_BACK_ISSET( (mi), LDAP_BACK_F_QUARANTINE ) time_t mi_conn_ttl; time_t mi_idle_timeout; metacommon_t mi_mc; ldap_extra_t *mi_ldap_extra; } metainfo_t; typedef enum meta_op_type { META_OP_ALLOW_MULTIPLE = 0, META_OP_REQUIRE_SINGLE, META_OP_REQUIRE_ALL } meta_op_type; SlapReply * meta_back_candidates_get( Operation *op ); extern metaconn_t * meta_back_getconn( Operation *op, SlapReply *rs, int *candidate, ldap_back_send_t sendok ); extern void meta_back_release_conn_lock( metainfo_t *mi, metaconn_t *mc, int dolock ); #define meta_back_release_conn(mi, mc) meta_back_release_conn_lock( (mi), (mc), 1 ) extern int meta_back_retry( Operation *op, SlapReply *rs, metaconn_t **mcp, int candidate, ldap_back_send_t sendok ); extern void meta_back_conn_free( void *v_mc ); #if META_BACK_PRINT_CONNTREE > 0 extern void meta_back_print_conntree( metainfo_t *mi, char *msg ); #endif extern int meta_back_init_one_conn( Operation *op, SlapReply *rs, metaconn_t *mc, int candidate, int ispriv, ldap_back_send_t sendok, int dolock ); extern void meta_back_quarantine( Operation *op, SlapReply *rs, int candidate ); extern int meta_back_dobind( Operation *op, SlapReply *rs, metaconn_t *mc, ldap_back_send_t sendok ); extern int meta_back_single_dobind( Operation *op, SlapReply *rs, metaconn_t **mcp, int candidate, ldap_back_send_t sendok, int retries, int dolock ); extern int meta_back_proxy_authz_cred( metaconn_t *mc, int candidate, Operation *op, SlapReply *rs, ldap_back_send_t sendok, struct berval *binddn, struct berval *bindcred, int *method ); extern int meta_back_cancel( metaconn_t *mc, Operation *op, SlapReply *rs, ber_int_t msgid, int candidate, ldap_back_send_t sendok ); extern int meta_back_op_result( metaconn_t *mc, Operation *op, SlapReply *rs, int candidate, ber_int_t msgid, time_t timeout, ldap_back_send_t sendok ); extern int meta_back_controls_add( Operation *op, SlapReply *rs, metaconn_t *mc, int candidate, LDAPControl ***pctrls ); extern int back_meta_LTX_init_module( int argc, char *argv[] ); extern int meta_back_conn_cmp( const void *c1, const void *c2 ); extern int meta_back_conndn_cmp( const void *c1, const void *c2 ); extern int meta_back_conndn_dup( void *c1, void *c2 ); /* * Candidate stuff */ extern int meta_back_is_candidate( metatarget_t *mt, struct berval *ndn, int scope ); extern int meta_back_select_unique_candidate( metainfo_t *mi, struct berval *ndn ); extern int meta_clear_unused_candidates( Operation *op, int candidate ); extern int meta_clear_one_candidate( Operation *op, metaconn_t *mc, int candidate ); /* * Dn cache stuff (experimental) */ extern int meta_dncache_cmp( const void *c1, const void *c2 ); extern int meta_dncache_dup( void *c1, void *c2 ); #define META_TARGET_NONE (-1) #define META_TARGET_MULTIPLE (-2) extern int meta_dncache_get_target( metadncache_t *cache, struct berval *ndn ); extern int meta_dncache_update_entry( metadncache_t *cache, struct berval *ndn, int target ); extern int meta_dncache_delete_entry( metadncache_t *cache, struct berval *ndn ); extern void meta_dncache_free( void *entry ); extern void meta_back_map_free( struct ldapmap *lm ); extern int meta_subtree_destroy( metasubtree_t *ms ); extern void meta_filter_destroy( metafilter_t *mf ); extern int meta_target_finish( metainfo_t *mi, metatarget_t *mt, const char *log, char *msg, size_t msize ); extern LDAP_REBIND_PROC meta_back_default_rebind; extern LDAP_URLLIST_PROC meta_back_default_urllist; LDAP_END_DECL #endif /* SLAPD_META_H */