git.sur5r.net Git - openldap/blob - libraries/librewrite/rewrite-int.h

   1 /******************************************************************************
   2  *
   3  * Copyright (C) 2000 Pierangelo Masarati, <ando@sys-net.it>
   4  * All rights reserved.
   5  *
   6  * Permission is granted to anyone to use this software for any purpose
   7  * on any computer system, and to alter it and redistribute it, subject
   8  * to the following restrictions:
   9  *
  10  * 1. The author is not responsible for the consequences of use of this
  11  * software, no matter how awful, even if they arise from flaws in it.
  12  *
  13  * 2. The origin of this software must not be misrepresented, either by
  14  * explicit claim or by omission.  Since few users ever read sources,
  15  * credits should appear in the documentation.
  16  *
  17  * 3. Altered versions must be plainly marked as such, and must not be
  18  * misrepresented as being the original software.  Since few users
  19  * ever read sources, credits should appear in the documentation.
  20  *
  21  * 4. This notice may not be removed or altered.
  22  *
  23  ******************************************************************************/
  24
  25 #ifndef REWRITE_INT_H
  26 #define REWRITE_INT_H
  27
  28 /*
  29  * These are required by every file of the library, so they're included here
  30  */
  31 #include <ac/stdlib.h>
  32 #include <ac/string.h>
  33 #include <ac/syslog.h>
  34 #include <ac/regex.h>
  35 #include <ac/socket.h>
  36 #include <ac/unistd.h>
  37 #include <ac/ctype.h>
  38
  39 #include <lber.h>
  40 #include <ldap.h>
  41 #include "../libldap/ldap-int.h"
  42
  43 #include <avl.h>
  44
  45 #include <rewrite.h>
  46
  47 /* Uncomment to use ldap pvt threads */
  48 #define USE_REWRITE_LDAP_PVT_THREADS
  49 #include <ldap_pvt_thread.h>
  50
  51 /*
  52  * For details, see RATIONALE.
  53  */
  54
  55 #define REWRITE_MAX_MATCH       11      /* 0: overall string; 1-9: submatches */
  56 #define REWRITE_MAX_PASSES      100
  57
  58 /*
  59  * Submatch escape char
  60  */
  61 /* the '\' conflicts with slapd.conf parsing */
  62 /* #define REWRITE_SUBMATCH_ESCAPE                      '\\' */
  63 #define REWRITE_SUBMATCH_ESCAPE                 '%'
  64
  65 /*
  66  * REGEX flags
  67  */
  68
  69 #define REWRITE_FLAG_HONORCASE                  'C'
  70 #define REWRITE_FLAG_BASICREGEX                 'R'
  71
  72 /*
  73  * Action flags
  74  */
  75 #define REWRITE_FLAG_EXECONCE                   ':'
  76 #define REWRITE_FLAG_STOP                       '@'
  77 #define REWRITE_FLAG_UNWILLING                  '#'
  78 #define REWRITE_FLAG_GOTO                       'G'     /* requires an arg */
  79 #define REWRITE_FLAG_IGNORE_ERR                 'I'
  80
  81 /*
  82  * Map operators
  83  */
  84 #define REWRITE_OPERATOR_SUBCONTEXT             '>'
  85 #define REWRITE_OPERATOR_COMMAND                '|'
  86 #define REWRITE_OPERATOR_VARIABLE_SET           '&'
  87 #define REWRITE_OPERATOR_VARIABLE_GET           '*'
  88 #define REWRITE_OPERATOR_PARAM_GET              '$'
  89
  90
  91 /***********
  92  * PRIVATE *
  93  ***********/
  94
  95 /*
  96  * Action
  97  */
  98 struct rewrite_action {
  99         struct rewrite_action          *la_next;
 100
 101 #define REWRITE_ACTION_STOP             0x0001
 102 #define REWRITE_ACTION_UNWILLING        0x0002
 103 #define REWRITE_ACTION_GOTO             0x0003
 104 #define REWRITE_ACTION_IGNORE_ERR       0x0004
 105         int                             la_type;
 106         void                           *la_args;
 107 };
 108
 109 /*
 110  * Map
 111  */
 112 struct rewrite_map {
 113
 114         /*
 115          * Legacy stuff
 116          */
 117 #define REWRITE_MAP_XFILEMAP            0x0001  /* Rough implementation! */
 118 #define REWRITE_MAP_XPWDMAP             0x0002  /* uid -> gecos */
 119 #define REWRITE_MAP_XLDAPMAP            0x0003  /* Not implemented yet! */
 120
 121         /*
 122          * Maps with args
 123          */
 124 #define REWRITE_MAP_SUBCONTEXT          0x0101
 125
 126 #define REWRITE_MAP_SET_OP_VAR          0x0102
 127 #define REWRITE_MAP_SETW_OP_VAR         0x0103
 128 #define REWRITE_MAP_GET_OP_VAR          0x0104
 129 #define REWRITE_MAP_SET_SESN_VAR        0x0105
 130 #define REWRITE_MAP_SETW_SESN_VAR       0x0106
 131 #define REWRITE_MAP_GET_SESN_VAR        0x0107
 132 #define REWRITE_MAP_GET_PARAM           0x0108
 133 #define REWRITE_MAP_BUILTIN             0x0109
 134         int                             lm_type;
 135
 136         char                           *lm_name;
 137         void                           *lm_data;
 138
 139         /*
 140          * Old maps store private data in _lm_args;
 141          * new maps store the substitution pattern in _lm_subst
 142          */
 143         union {
 144                 void                   *_lm_args;
 145                 struct rewrite_subst   *_lm_subst;
 146         } lm_union;
 147 #define lm_args lm_union._lm_args
 148 #define lm_subst lm_union._lm_subst
 149
 150 #ifdef USE_REWRITE_LDAP_PVT_THREADS
 151         ldap_pvt_thread_mutex_t         lm_mutex;
 152 #endif /* USE_REWRITE_LDAP_PVT_THREADS */
 153 };
 154
 155 /*
 156  * Builtin maps
 157  */
 158 struct rewrite_builtin_map {
 159 #define REWRITE_BUILTIN_MAP_LDAP        0x0201
 160         int                             lb_type;
 161         char                           *lb_name;
 162         void                           *lb_private;
 163
 164 #ifdef USE_REWRITE_LDAP_PVT_THREADS
 165         ldap_pvt_thread_mutex_t         lb_mutex;
 166 #endif /* USE_REWRITE_LDAP_PVT_THREADS */
 167 };
 168
 169 /*
 170  * Submatch substitution
 171  */
 172 struct rewrite_submatch {
 173 #define REWRITE_SUBMATCH_ASIS           0x0000
 174 #define REWRITE_SUBMATCH_XMAP           0x0001
 175 #define REWRITE_SUBMATCH_MAP_W_ARG      0x0002
 176         int                             ls_type;
 177         struct rewrite_map             *ls_map;
 178         int                             ls_submatch;
 179         /*
 180          * The first one represents the index of the submatch in case
 181          * the map has single submatch as argument;
 182          * the latter represents the map argument scheme in case
 183          * the map has substitution string argument form
 184          */
 185 };
 186
 187 /*
 188  * Pattern substitution
 189  */
 190 struct rewrite_subst {
 191         size_t                          lt_subs_len;
 192         struct berval                 **lt_subs;
 193
 194         int                             lt_num_submatch;
 195         struct rewrite_submatch       **lt_submatch;
 196 };
 197
 198 /*
 199  * Rule
 200  */
 201 struct rewrite_rule {
 202         struct rewrite_rule            *lr_next;
 203         struct rewrite_rule            *lr_prev;
 204
 205         char                           *lr_pattern;
 206         char                           *lr_subststring;
 207         char                           *lr_flagstring;
 208         regex_t                         lr_regex;
 209
 210         /*
 211          * I was thinking about some kind of per-rule mutex, but there's
 212          * probably no need, because rules after compilation are only read;
 213          * however, I need to check whether regexec is reentrant ...
 214          */
 215
 216         struct rewrite_subst           *lr_subst;
 217
 218 #define REWRITE_REGEX_ICASE             REG_ICASE
 219 #define REWRITE_REGEX_EXTENDED          REG_EXTENDED
 220         int                             lr_flags;
 221
 222 #define REWRITE_RECURSE                 0x0001
 223 #define REWRITE_EXEC_ONCE               0x0002
 224         int                             lr_mode;
 225
 226         struct rewrite_action          *lr_action;
 227 };
 228
 229 /*
 230  * Rewrite Context (set of rules)
 231  */
 232 struct rewrite_context {
 233         char                           *lc_name;
 234         struct rewrite_context         *lc_alias;
 235         struct rewrite_rule            *lc_rule;
 236 };
 237
 238 /*
 239  * Session
 240  */
 241 struct rewrite_session {
 242         void                           *ls_cookie;
 243         Avlnode                        *ls_vars;
 244 #ifdef USE_REWRITE_LDAP_PVT_THREADS
 245         ldap_pvt_thread_rdwr_t          ls_vars_mutex;
 246 #endif /* USE_REWRITE_LDAP_PVT_THREADS */
 247 };
 248
 249 /*
 250  * Variable
 251  */
 252 struct rewrite_var {
 253         char                           *lv_name;
 254         struct berval                   lv_value;
 255 };
 256
 257 /*
 258  * Operation
 259  */
 260 struct rewrite_op {
 261         int                             lo_num_passes;
 262         int                             lo_depth;
 263         char                           *lo_string;
 264         char                           *lo_result;
 265         Avlnode                        *lo_vars;
 266         const void                     *lo_cookie;
 267 };
 268
 269
 270 /**********
 271  * PUBLIC *
 272  **********/
 273
 274 /*
 275  * Rewrite info
 276  */
 277 struct rewrite_info {
 278         Avlnode                        *li_context;
 279         Avlnode                        *li_maps;
 280         /*
 281          * No global mutex because maps are read only at
 282          * config time
 283          */
 284         Avlnode                        *li_params;
 285         Avlnode                        *li_cookies;
 286         int                             li_num_cookies;
 287
 288 #ifdef USE_REWRITE_LDAP_PVT_THREADS
 289         ldap_pvt_thread_rdwr_t          li_params_mutex;
 290         ldap_pvt_thread_rdwr_t          li_cookies_mutex;
 291 #endif /* USE_REWRITE_LDAP_PVT_THREADS */
 292
 293         /*
 294          * Default to `off';
 295          * use `rewriteEngine {on|off}' directive to alter
 296          */
 297         int                             li_state;
 298
 299         /*
 300          * Defaults to REWRITE_MAXPASSES;
 301          * use `rewriteMaxPasses numPasses' directive to alter
 302          */
 303 #define REWRITE_MAXPASSES               100
 304         int                             li_max_passes;
 305
 306         /*
 307          * Behavior in case a NULL or non-existent context is required
 308          */
 309         int                             li_rewrite_mode;
 310 };
 311
 312 /***********
 313  * PRIVATE *
 314  ***********/
 315
 316
 317 /*
 318  * Maps
 319  */
 320
 321 /*
 322  * Parses a map (also in legacy 'x' version)
 323  */
 324 extern struct rewrite_map *
 325 rewrite_map_parse(
 326                 struct rewrite_info *info,
 327                 const char *s,
 328                 const char **end
 329 );
 330
 331 extern struct rewrite_map *
 332 rewrite_xmap_parse(
 333                 struct rewrite_info *info,
 334                 const char *s,
 335                 const char **end
 336 );
 337
 338 /*
 339  * Resolves key in val by means of map (also in legacy 'x' version)
 340  */
 341 extern int
 342 rewrite_map_apply(
 343                 struct rewrite_info *info,
 344                 struct rewrite_op *op,
 345                 struct rewrite_map *map,
 346                 struct berval *key,
 347                 struct berval *val
 348 );
 349
 350 extern int
 351 rewrite_xmap_apply(
 352                 struct rewrite_info *info,
 353                 struct rewrite_op *op,
 354                 struct rewrite_map *map,
 355                 struct berval *key,
 356                 struct berval *val
 357 );
 358
 359
 360 /*
 361  * Submatch substitution
 362  */
 363
 364 /*
 365  * Compiles a substitution pattern
 366  */
 367 extern struct rewrite_subst *
 368 rewrite_subst_compile(
 369                 struct rewrite_info *info,
 370                 const char *result
 371 );
 372
 373 /*
 374  * Substitutes a portion of rewritten string according to substitution
 375  * pattern using submatches
 376  */
 377 extern int
 378 rewrite_subst_apply(
 379                 struct rewrite_info *info,
 380                 struct rewrite_op *op,
 381                 struct rewrite_subst *subst,
 382                 const char *string,
 383                 const regmatch_t *match,
 384                 struct berval *val
 385 );
 386
 387
 388 /*
 389  * Rules
 390  */
 391
 392 /*
 393  * Compiles the rule and appends it at the running context
 394  */
 395 extern int
 396 rewrite_rule_compile(
 397                 struct rewrite_info *info,
 398                 struct rewrite_context *context,
 399                 const char *pattern,
 400                 const char *result,
 401                 const char *flagstring
 402 );
 403
 404 /*
 405  * Rewrites string according to rule; may return:
 406  *      REWRITE_REGEXEC_OK:     fine; if *result != NULL rule matched
 407  *                              and rewrite succeeded.
 408  *      REWRITE_REGEXEC_STOP:   fine, rule matched; stop processing
 409  *                              following rules
 410  *      REWRITE_REGEXEC_UNWILL: rule matched; force 'unwilling to perform'
 411  *      REWRITE_REGEXEC_ERR:    an error occurred
 412  */
 413 extern int
 414 rewrite_rule_apply(
 415                 struct rewrite_info *info,
 416                 struct rewrite_op *op,
 417                 struct rewrite_rule *rule,
 418                 const char *string,
 419                 char **result
 420 );
 421
 422 /*
 423  * Sessions
 424  */
 425
 426 /*
 427  * Fetches a struct rewrite_session
 428  */
 429 extern struct rewrite_session *
 430 rewrite_session_find(
 431                 struct rewrite_info *info,
 432                 const void *cookie
 433 );
 434
 435 /*
 436  * Defines and inits a variable with session scope
 437  */
 438 extern int
 439 rewrite_session_var_set(
 440                 struct rewrite_info *info,
 441                 const void *cookie,
 442                 const char *name,
 443                 const char *value
 444 );
 445
 446 /*
 447  * Gets a var with session scope
 448  */
 449 extern int
 450 rewrite_session_var_get(
 451                 struct rewrite_info *info,
 452                 const void *cookie,
 453                 const char *name,
 454                 struct berval *val
 455 );
 456
 457 /*
 458  * Deletes a session
 459  */
 460 extern int
 461 rewrite_session_delete(
 462                 struct rewrite_info *info,
 463                 const void *cookie
 464 );
 465
 466 /*
 467  * Destroys the cookie tree
 468  */
 469 extern int
 470 rewrite_session_destroy(
 471                 struct rewrite_info *info
 472 );
 473
 474
 475 /*
 476  * Vars
 477  */
 478
 479 /*
 480  * Finds a var
 481  */
 482 extern struct rewrite_var *
 483 rewrite_var_find(
 484                 Avlnode *tree,
 485                 const char *name
 486 );
 487
 488 /*
 489  * Inserts a newly created var
 490  */
 491 extern struct rewrite_var *
 492 rewrite_var_insert(
 493                 Avlnode **tree,
 494                 const char *name,
 495                 const char *value
 496 );
 497
 498 /*
 499  * Sets/inserts a var
 500  */
 501 extern struct rewrite_var *
 502 rewrite_var_set(
 503                 Avlnode **tree,
 504                 const char *name,
 505                 const char *value,
 506                 int insert
 507 );
 508
 509 /*
 510  * Deletes a var tree
 511  */
 512 extern int
 513 rewrite_var_delete(
 514                 Avlnode *tree
 515 );
 516
 517
 518 /*
 519  * Contexts
 520  */
 521
 522 /*
 523  * Finds the context named rewriteContext in the context tree
 524  */
 525 extern struct rewrite_context *
 526 rewrite_context_find(
 527                 struct rewrite_info *info,
 528                 const char *rewriteContext
 529 );
 530
 531 /*
 532  * Creates a new context called rewriteContext and stores in into the tree
 533  */
 534 extern struct rewrite_context *
 535 rewrite_context_create(
 536                 struct rewrite_info *info,
 537                 const char *rewriteContext
 538 );
 539
 540 /*
 541  * Rewrites string according to context; may return:
 542  *      OK:     fine; if *result != NULL rule matched and rewrite succeeded.
 543  *      STOP:   fine, rule matched; stop processing following rules
 544  *      UNWILL: rule matched; force 'unwilling to perform'
 545  */
 546 extern int
 547 rewrite_context_apply(
 548                 struct rewrite_info *info,
 549                 struct rewrite_op *op,
 550                 struct rewrite_context *context,
 551                 const char *string,
 552                 char **result
 553 );
 554
 555 #endif /* REWRITE_INT_H */
 556