git.sur5r.net Git - openldap/blob - libraries/libldif/line64.c

   1 /* line64.c - routines for dealing with the slapd line format */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7
   8 #include "portable.h"
   9
  10 #include <stdio.h>
  11
  12 #include <ac/stdlib.h>
  13 #include <ac/ctype.h>
  14
  15 #include <ac/string.h>
  16 #include <ac/socket.h>
  17 #include <ac/time.h>
  18
  19 int ldif_debug = 0;
  20
  21 #include "ldap_log.h"
  22 #include "lber_pvt.h"
  23 #include "ldif.h"
  24
  25 #define RIGHT2                  0x03
  26 #define RIGHT4                  0x0f
  27 #define CONTINUED_LINE_MARKER   '\001'
  28
  29 #ifdef CSRIMALLOC
  30 #define ber_memalloc malloc
  31 #define ber_memcalloc calloc
  32 #define ber_memrealloc realloc
  33 #define ber_strdup strdup
  34 #endif
  35
  36 static const char nib2b64[0x40] =
  37         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  38
  39 static const unsigned char b642nib[0x80] = {
  40         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  41         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  42         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  43         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  44         0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  45         0xff, 0xff, 0xff, 0x3e, 0xff, 0xff, 0xff, 0x3f,
  46         0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b,
  47         0x3c, 0x3d, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
  48         0xff, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06,
  49         0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
  50         0x0f, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16,
  51         0x17, 0x18, 0x19, 0xff, 0xff, 0xff, 0xff, 0xff,
  52         0xff, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f, 0x20,
  53         0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28,
  54         0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30,
  55         0x31, 0x32, 0x33, 0xff, 0xff, 0xff, 0xff, 0xff
  56 };
  57
  58 /*
  59  * ldif_parse_line - takes a line of the form "type:[:] value" and splits it
  60  * into components "type" and "value".  if a double colon separates type from
  61  * value, then value is encoded in base 64, and parse_line un-decodes it
  62  * (in place) before returning.
  63  */
  64
  65 int
  66 ldif_parse_line(
  67     LDAP_CONST char     *line,
  68     char        **typep,
  69     char        **valuep,
  70     ber_len_t *vlenp
  71 )
  72 {
  73         char    *s, *p, *d;
  74         char    nib;
  75         int     b64, url;
  76         char    *freeme, *type, *value;
  77         ber_len_t vlen;
  78
  79         *typep = NULL;
  80         *valuep = NULL;
  81         *vlenp = 0;
  82
  83         /* skip any leading space */
  84         while ( isspace( (unsigned char) *line ) ) {
  85                 line++;
  86         }
  87
  88         freeme = ber_strdup( line );
  89
  90         if( freeme == NULL ) {
  91                 ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
  92                         "ldif_parse_line: line malloc failed\n");
  93                 return( -1 );
  94         }
  95
  96         type = freeme;
  97
  98         s = strchr( type, ':' );
  99
 100         if ( s == NULL ) {
 101                 ber_pvt_log_printf( LDAP_DEBUG_PARSE, ldif_debug,
 102                         "ldif_parse_line: missing ':' after %s\n",
 103                         type );
 104                 ber_memfree( freeme );
 105                 return( -1 );
 106         }
 107
 108         /* trim any space between type and : */
 109         for ( p = &s[-1]; p > type && isspace( * (unsigned char *) p ); p-- ) {
 110                 *p = '\0';
 111         }
 112         *s++ = '\0';
 113
 114         url = 0;
 115         b64 = 0;
 116
 117         if ( *s == '\0' ) {
 118                 /* no value */
 119                 value = NULL;
 120                 vlen = 0;
 121                 goto done;
 122         }
 123
 124         if ( *s == '<' ) {
 125                 s++;
 126                 url = 1;
 127         } else if ( *s == ':' ) {
 128                 /* base 64 encoded value */
 129                 s++;
 130                 b64 = 1;
 131         }
 132
 133         /* skip space between : and value */
 134         while ( isspace( (unsigned char) *s ) ) {
 135                 s++;
 136         }
 137
 138         /* if no value is present, error out */
 139         if ( *s == '\0' ) {
 140                 ber_pvt_log_printf( LDAP_DEBUG_PARSE, ldif_debug,
 141                         "ldif_parse_line: %s missing %svalue\n", type,
 142                                 url ? "URL " : b64 ? "base64 " : "" );
 143                 value = NULL;
 144                 vlen = 0;
 145                 goto done;
 146         }
 147
 148         /* check for continued line markers that should be deleted */
 149         for ( p = s, d = s; *p; p++ ) {
 150                 if ( *p != CONTINUED_LINE_MARKER )
 151                         *d++ = *p;
 152         }
 153         *d = '\0';
 154
 155         if ( b64 ) {
 156                 char *byte = s;
 157
 158                 value = s;
 159
 160                 for ( p = s, vlen = 0; p < d; p += 4, vlen += 3 ) {
 161                         int i;
 162                         for ( i = 0; i < 4; i++ ) {
 163                                 if ( p[i] != '=' && (p[i] & 0x80 ||
 164                                     b642nib[ p[i] & 0x7f ] > 0x3f) ) {
 165                                         ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
 166                                                 "ldif_parse_line: %s: invalid base64 encoding"
 167                                                 " char (%c) 0x%x\n",
 168                                             type, p[i], p[i] );
 169                                         ber_memfree( freeme );
 170                                         return( -1 );
 171                                 }
 172                         }
 173
 174                         /* first digit */
 175                         nib = b642nib[ p[0] & 0x7f ];
 176                         byte[0] = nib << 2;
 177                         /* second digit */
 178                         nib = b642nib[ p[1] & 0x7f ];
 179                         byte[0] |= nib >> 4;
 180                         byte[1] = (nib & RIGHT4) << 4;
 181                         /* third digit */
 182                         if ( p[2] == '=' ) {
 183                                 vlen += 1;
 184                                 break;
 185                         }
 186                         nib = b642nib[ p[2] & 0x7f ];
 187                         byte[1] |= nib >> 2;
 188                         byte[2] = (nib & RIGHT2) << 6;
 189                         /* fourth digit */
 190                         if ( p[3] == '=' ) {
 191                                 vlen += 2;
 192                                 break;
 193                         }
 194                         nib = b642nib[ p[3] & 0x7f ];
 195                         byte[2] |= nib;
 196
 197                         byte += 3;
 198                 }
 199                 s[ vlen ] = '\0';
 200
 201         } else if ( url ) {
 202                 if( ldif_fetch_url( s, &value, &vlen ) ) {
 203                         ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
 204                                 "ldif_parse_line: %s: URL \"%s\" fetch failed\n",
 205                                 type, s );
 206                         ber_memfree( freeme );
 207                         return( -1 );
 208                 }
 209
 210         } else {
 211                 value = s;
 212                 vlen = (int) (d - s);
 213         }
 214
 215 done:
 216         type = ber_strdup( type );
 217
 218         if( type == NULL ) {
 219                 ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
 220                         "ldif_parse_line: type malloc failed\n");
 221                 ber_memfree( freeme );
 222                 return( -1 );
 223         }
 224
 225         if( !url && value != NULL ) {
 226                 value = ber_strdup( value );
 227                 if( value == NULL ) {
 228                         ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
 229                                 "ldif_parse_line: value malloc failed\n");
 230                         ber_memfree( type );
 231                         ber_memfree( freeme );
 232                         return( -1 );
 233                 }
 234         }
 235
 236         ber_memfree( freeme );
 237
 238         *typep = type;
 239         *valuep = value;
 240         *vlenp = vlen;
 241
 242         return( 0 );
 243 }
 244
 245 /*
 246  * ldif_getline - return the next "line" (minus newline) of input from a
 247  * string buffer of lines separated by newlines, terminated by \n\n
 248  * or \0.  this routine handles continued lines, bundling them into
 249  * a single big line before returning.  if a line begins with a white
 250  * space character, it is a continuation of the previous line. the white
 251  * space character (nb: only one char), and preceeding newline are changed
 252  * into CONTINUED_LINE_MARKER chars, to be deleted later by the
 253  * ldif_parse_line() routine above.
 254  *
 255  * ldif_getline will skip over any line which starts '#'.
 256  *
 257  * ldif_getline takes a pointer to a pointer to the buffer on the first call,
 258  * which it updates and must be supplied on subsequent calls.
 259  */
 260
 261 char *
 262 ldif_getline( char **next )
 263 {
 264         char *line;
 265
 266         do {
 267                 if ( *next == NULL || **next == '\n' || **next == '\0' ) {
 268                         return( NULL );
 269                 }
 270
 271                 line = *next;
 272
 273                 while ( (*next = strchr( *next, '\n' )) != NULL ) {
 274                         unsigned char c = *(*next + 1);
 275
 276                         if ( !isspace( c ) || c == '\n' ) {
 277                                 *(*next)++ = '\0';
 278                                 break;
 279                         }
 280
 281                         **next = CONTINUED_LINE_MARKER;
 282                         *(*next+1) = CONTINUED_LINE_MARKER;
 283                         (*next)++;
 284                 }
 285         } while( *line == '#' );
 286
 287         return( line );
 288 }
 289
 290 /* compatibility with U-Mich off by one bug */
 291 #define LDIF_KLUDGE 1
 292
 293 void
 294 ldif_sput(
 295         char **out,
 296         int type,
 297         LDAP_CONST char *name,
 298         LDAP_CONST char *val,
 299         ber_len_t vlen )
 300 {
 301         const unsigned char *byte, *stop;
 302         unsigned char   buf[3];
 303         unsigned long   bits;
 304         char            *save;
 305         int             pad;
 306
 307         ber_len_t savelen;
 308         ber_len_t len=0;
 309         ber_len_t i;
 310
 311         /* prefix */
 312         switch( type ) {
 313         case LDIF_PUT_COMMENT:
 314                 if( name != NULL ) break;
 315
 316                 *(*out)++ = '#';
 317                 len++;
 318
 319                 if( vlen ) {
 320                         *(*out)++ = ' ';
 321                         len++;
 322                         break;
 323                 }
 324
 325                 /* no value, fall-thru */
 326
 327         case LDIF_PUT_SEP:
 328                 *(*out)++ = '\n';
 329                 return;
 330         }
 331
 332         /* name (attribute type) */
 333         if( name != NULL ) {
 334                 /* put the name + ":" */
 335                 for ( i=0 ; name[i]; i++ ) {
 336                         *(*out)++ = name[i];
 337                         len++;
 338                 }
 339
 340                 if( type != LDIF_PUT_COMMENT ) {
 341                         *(*out)++ = ':';
 342                         len++;
 343                 }
 344
 345         }
 346 #ifdef LDAP_DEBUG
 347         else {
 348                 assert( type == LDIF_PUT_COMMENT );
 349         }
 350 #endif
 351
 352         switch( type ) {
 353         case LDIF_PUT_NOVALUE:
 354                 *(*out)++ = '\n';
 355                 return;
 356
 357         case LDIF_PUT_URL: /* url value */
 358                 *(*out)++ = '<';
 359                 len++;
 360                 break;
 361
 362         case LDIF_PUT_B64: /* base64 value */
 363                 *(*out)++ = ':';
 364                 len++;
 365                 break;
 366         }
 367
 368         switch( type ) {
 369         case LDIF_PUT_TEXT:
 370         case LDIF_PUT_URL:
 371         case LDIF_PUT_B64:
 372                 *(*out)++ = ' ';
 373                 len++;
 374                 /* fall-thru */
 375
 376         case LDIF_PUT_COMMENT:
 377                 /* pre-encoded names */
 378                 for ( i=0; i < vlen; i++ ) {
 379                         if ( len > LDIF_LINE_WIDTH ) {
 380                                 *(*out)++ = '\n';
 381                                 *(*out)++ = ' ';
 382                                 len = 1;
 383                         }
 384
 385                         *(*out)++ = val[i];
 386                         len++;
 387                 }
 388                 *(*out)++ = '\n';
 389                 return;
 390         }
 391
 392         save = *out;
 393         savelen = len;
 394
 395         *(*out)++ = ' ';
 396         len++;
 397
 398         if( vlen == 0 ) {
 399                 *(*out)++ = '\n';
 400                 return;
 401         }
 402
 403         stop = (const unsigned char *) (val + vlen);
 404
 405         if ( type == LDIF_PUT_VALUE
 406                 && isgraph( val[0] ) && val[0] != ':' && val[0] != '<'
 407                 && isgraph( val[vlen-1] )
 408                 && strcasecmp( name, "userPassword" ) != 0      /* encode userPassword */
 409                 && strcasecmp( name, "2.5.4.35" ) != 0          /* encode userPassword */
 410         ) {
 411                 int b64 = 0;
 412
 413                 for ( byte = (const unsigned char *) val; byte < stop;
 414                     byte++, len++ )
 415                 {
 416                         if ( !isascii( *byte ) || !isprint( *byte ) ) {
 417                                 b64 = 1;
 418                                 break;
 419                         }
 420                         if ( len > LDIF_LINE_WIDTH+LDIF_KLUDGE ) {
 421                                 *(*out)++ = '\n';
 422                                 *(*out)++ = ' ';
 423                                 len = 1;
 424                         }
 425                         *(*out)++ = *byte;
 426                 }
 427
 428                 if( !b64 ) {
 429                         *(*out)++ = '\n';
 430                         return;
 431                 }
 432         }
 433
 434         *out = save;
 435         *(*out)++ = ':';
 436         *(*out)++ = ' ';
 437         len = savelen + 2;
 438
 439         /* convert to base 64 (3 bytes => 4 base 64 digits) */
 440         for ( byte = (const unsigned char *) val;
 441                 byte < stop - 2;
 442             byte += 3 )
 443         {
 444                 bits = (byte[0] & 0xff) << 16;
 445                 bits |= (byte[1] & 0xff) << 8;
 446                 bits |= (byte[2] & 0xff);
 447
 448                 for ( i = 0; i < 4; i++, len++, bits <<= 6 ) {
 449                         if ( len > LDIF_LINE_WIDTH+LDIF_KLUDGE ) {
 450                                 *(*out)++ = '\n';
 451                                 *(*out)++ = ' ';
 452                                 len = 1;
 453                         }
 454
 455                         /* get b64 digit from high order 6 bits */
 456                         *(*out)++ = nib2b64[ (bits & 0xfc0000L) >> 18 ];
 457                 }
 458         }
 459
 460         /* add padding if necessary */
 461         if ( byte < stop ) {
 462                 for ( i = 0; byte + i < stop; i++ ) {
 463                         buf[i] = byte[i];
 464                 }
 465                 for ( pad = 0; i < 3; i++, pad++ ) {
 466                         buf[i] = '\0';
 467                 }
 468                 byte = buf;
 469                 bits = (byte[0] & 0xff) << 16;
 470                 bits |= (byte[1] & 0xff) << 8;
 471                 bits |= (byte[2] & 0xff);
 472
 473                 for ( i = 0; i < 4; i++, len++, bits <<= 6 ) {
 474                         if ( len > LDIF_LINE_WIDTH+LDIF_KLUDGE ) {
 475                                 *(*out)++ = '\n';
 476                                 *(*out)++ = ' ';
 477                                 len = 1;
 478                         }
 479
 480                         if( i + pad < 4 ) {
 481                                 /* get b64 digit from low order 6 bits */
 482                                 *(*out)++ = nib2b64[ (bits & 0xfc0000L) >> 18 ];
 483                         } else {
 484                                 *(*out)++ = '=';
 485                         }
 486                 }
 487         }
 488         *(*out)++ = '\n';
 489 }
 490
 491
 492 /*
 493  * ldif_type_and_value return BER malloc'd, zero-terminated LDIF line
 494  */
 495 char *
 496 ldif_put(
 497         int type,
 498         LDAP_CONST char *name,
 499         LDAP_CONST char *val,
 500         ber_len_t vlen )
 501 {
 502     char        *buf, *p;
 503     ber_len_t nlen;
 504
 505     nlen = ( name != NULL ) ? strlen( name ) : 0;
 506
 507         buf = (char *) ber_memalloc( LDIF_SIZE_NEEDED( nlen, vlen ) + 1 );
 508
 509     if ( buf == NULL ) {
 510                 ber_pvt_log_printf( LDAP_DEBUG_ANY, ldif_debug,
 511                         "ldif_type_and_value: malloc failed!" );
 512                 return NULL;
 513     }
 514
 515     p = buf;
 516     ldif_sput( &p, type, name, val, vlen );
 517     *p = '\0';
 518
 519     return( buf );
 520 }
 521
 522 int ldif_is_not_printable(
 523         LDAP_CONST char *val,
 524         ber_len_t vlen )
 525 {
 526         if( vlen == 0 || val == NULL  ) {
 527                 return -1;
 528         }
 529
 530         if( isgraph( val[0] ) && val[0] != ':' && val[0] != '<' &&
 531                 isgraph( val[vlen-1] ) )
 532         {
 533                 ber_len_t i;
 534
 535                 for ( i = 0; val[i]; i++ ) {
 536                         if ( !isascii( val[i] ) || !isprint( val[i] ) ) {
 537                                 return 1;
 538                         }
 539                 }
 540
 541                 return 0;
 542         }
 543
 544         return 1;
 545 }
 546
 547 /*
 548  * slap_read_ldif - read an ldif record.  Return 1 for success, 0 for EOF.
 549  */
 550 int
 551 ldif_read_record(
 552         FILE        *fp,
 553         int         *lno,               /* ptr to line number counter              */
 554         char        **bufp,     /* ptr to malloced output buffer           */
 555         int         *buflenp )  /* ptr to length of *bufp                  */
 556 {
 557         char        linebuf[BUFSIZ], *line, *nbufp;
 558         ber_len_t   lcur = 0, len, linesize;
 559         int         last_ch = '\n', found_entry = 0, stop;
 560
 561         line     = linebuf;
 562         linesize = sizeof( linebuf );
 563
 564         for ( stop = feof( fp );  !stop;  last_ch = line[len-1] ) {
 565                 if ( fgets( line, linesize, fp ) == NULL ) {
 566                         stop = 1;
 567                         /* Add \n in case the file does not end with newline */
 568                         line = "\n";
 569                 }
 570                 len = strlen( line );
 571
 572                 if ( last_ch == '\n' ) {
 573                         (*lno)++;
 574
 575                         if ( line[0] == '\n' ) {
 576                                 if ( !found_entry )
 577                                         continue;
 578                                 break;
 579                         }
 580
 581                         if ( !found_entry ) {
 582                                 /* Found a new entry */
 583                                 found_entry = 1;
 584
 585                                 if ( isdigit( (unsigned char) line[0] ) ) {
 586                                         /* skip index */
 587                                         continue;
 588                                 }
 589                         }
 590                 }
 591
 592                 if ( *buflenp - lcur <= len ) {
 593                         *buflenp += len + BUFSIZ;
 594                         nbufp = ber_memrealloc( *bufp, *buflenp );
 595                         if( nbufp == NULL ) {
 596                                 return 0;
 597                         }
 598                         *bufp = nbufp;
 599                 }
 600                 strcpy( *bufp + lcur, line );
 601                 lcur += len;
 602         }
 603
 604         return( found_entry );
 605 }