e2sim/ASN1c/per_support.c

   1 /*****************************************************************************
   2 #                                                                            *
   3 # Copyright 2019 AT&T Intellectual Property                                  *
   4 #                                                                            *
   5 # Licensed under the Apache License, Version 2.0 (the "License");            *
   6 # you may not use this file except in compliance with the License.           *
   7 # You may obtain a copy of the License at                                    *
   8 #                                                                            *
   9 #      http://www.apache.org/licenses/LICENSE-2.0                            *
  10 #                                                                            *
  11 # Unless required by applicable law or agreed to in writing, software        *
  12 # distributed under the License is distributed on an "AS IS" BASIS,          *
  13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   *
  14 # See the License for the specific language governing permissions and        *
  15 # limitations under the License.                                             *
  16 #                                                                            *
  17 ******************************************************************************/
  18
  19 /*
  20  * Copyright (c) 2005-2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
  21  * Redistribution and modifications are permitted subject to BSD license.
  22  */
  23 #include <asn_system.h>
  24 #include <asn_internal.h>
  25 #include <per_support.h>
  26
  27 /*
  28  * X.691-201508 #10.9 General rules for encoding a length determinant.
  29  * Get the optionally constrained length "n" from the stream.
  30  */
  31 ssize_t
  32 uper_get_length(asn_per_data_t *pd, int ebits, size_t lower_bound,
  33                 int *repeat) {
  34     ssize_t value;
  35
  36     *repeat = 0;
  37
  38     /* #11.9.4.1 Encoding if constrained (according to effective bits) */
  39     if(ebits >= 0 && ebits <= 16) {
  40         value = per_get_few_bits(pd, ebits);
  41         if(value >= 0) value += lower_bound;
  42         return value;
  43     }
  44
  45         value = per_get_few_bits(pd, 8);
  46     if((value & 0x80) == 0) { /* #11.9.3.6 */
  47         return (value & 0x7F);
  48     } else if((value & 0x40) == 0) { /* #11.9.3.7 */
  49         /* bit 8 ... set to 1 and bit 7 ... set to zero */
  50         value = ((value & 0x3f) << 8) | per_get_few_bits(pd, 8);
  51         return value; /* potential -1 from per_get_few_bits passes through. */
  52     } else if(value < 0) {
  53         ASN_DEBUG("END of stream reached for PER");
  54         return -1;
  55     }
  56     value &= 0x3f; /* this is "m" from X.691, #11.9.3.8 */
  57     if(value < 1 || value > 4) {
  58         return -1; /* Prohibited by #11.9.3.8 */
  59     }
  60     *repeat = 1;
  61     return (16384 * value);
  62 }
  63
  64 /*
  65  * Get the normally small length "n".
  66  * This procedure used to decode length of extensions bit-maps
  67  * for SET and SEQUENCE types.
  68  */
  69 ssize_t
  70 uper_get_nslength(asn_per_data_t *pd) {
  71         ssize_t length;
  72
  73         ASN_DEBUG("Getting normally small length");
  74
  75         if(per_get_few_bits(pd, 1) == 0) {
  76                 length = per_get_few_bits(pd, 6) + 1;
  77                 if(length <= 0) return -1;
  78                 ASN_DEBUG("l=%d", (int)length);
  79                 return length;
  80         } else {
  81                 int repeat;
  82                 length = uper_get_length(pd, -1, 0, &repeat);
  83                 if(length >= 0 && !repeat) return length;
  84                 return -1; /* Error, or do not support >16K extensions */
  85         }
  86 }
  87
  88 /*
  89  * Get the normally small non-negative whole number.
  90  * X.691, #10.6
  91  */
  92 ssize_t
  93 uper_get_nsnnwn(asn_per_data_t *pd) {
  94         ssize_t value;
  95
  96         value = per_get_few_bits(pd, 7);
  97         if(value & 64) {        /* implicit (value < 0) */
  98                 value &= 63;
  99                 value <<= 2;
 100                 value |= per_get_few_bits(pd, 2);
 101                 if(value & 128) /* implicit (value < 0) */
 102                         return -1;
 103                 if(value == 0)
 104                         return 0;
 105                 if(value >= 3)
 106                         return -1;
 107                 value = per_get_few_bits(pd, 8 * value);
 108                 return value;
 109         }
 110
 111         return value;
 112 }
 113
 114 /*
 115  * X.691-11/2008, #11.6
 116  * Encoding of a normally small non-negative whole number
 117  */
 118 int
 119 uper_put_nsnnwn(asn_per_outp_t *po, int n) {
 120         int bytes;
 121
 122         if(n <= 63) {
 123                 if(n < 0) return -1;
 124                 return per_put_few_bits(po, n, 7);
 125         }
 126         if(n < 256)
 127                 bytes = 1;
 128         else if(n < 65536)
 129                 bytes = 2;
 130         else if(n < 256 * 65536)
 131                 bytes = 3;
 132         else
 133                 return -1;      /* This is not a "normally small" value */
 134         if(per_put_few_bits(po, bytes, 8))
 135                 return -1;
 136
 137         return per_put_few_bits(po, n, 8 * bytes);
 138 }
 139
 140
 141 /* X.691-2008/11, #11.5.6 -> #11.3 */
 142 int uper_get_constrained_whole_number(asn_per_data_t *pd, unsigned long *out_value, int nbits) {
 143         unsigned long lhalf;    /* Lower half of the number*/
 144         long half;
 145
 146         if(nbits <= 31) {
 147                 half = per_get_few_bits(pd, nbits);
 148                 if(half < 0) return -1;
 149                 *out_value = half;
 150                 return 0;
 151         }
 152
 153         if((size_t)nbits > 8 * sizeof(*out_value))
 154                 return -1;  /* RANGE */
 155
 156         half = per_get_few_bits(pd, 31);
 157         if(half < 0) return -1;
 158
 159         if(uper_get_constrained_whole_number(pd, &lhalf, nbits - 31))
 160                 return -1;
 161
 162         *out_value = ((unsigned long)half << (nbits - 31)) | lhalf;
 163         return 0;
 164 }
 165
 166
 167 /* X.691-2008/11, #11.5.6 -> #11.3 */
 168 int
 169 uper_put_constrained_whole_number_u(asn_per_outp_t *po, unsigned long v,
 170                                     int nbits) {
 171     if(nbits <= 31) {
 172         return per_put_few_bits(po, v, nbits);
 173     } else {
 174         /* Put higher portion first, followed by lower 31-bit */
 175         if(uper_put_constrained_whole_number_u(po, v >> 31, nbits - 31))
 176             return -1;
 177         return per_put_few_bits(po, v, 31);
 178     }
 179 }
 180
 181 /*
 182  * X.691 (08/2015) #11.9 "General rules for encoding a length determinant"
 183  * Put the length "n" (or part of it) into the stream.
 184  */
 185 ssize_t
 186 uper_put_length(asn_per_outp_t *po, size_t length, int *need_eom) {
 187     int dummy = 0;
 188     if(!need_eom) need_eom = &dummy;
 189
 190     if(length <= 127) { /* #11.9.3.6 */
 191         *need_eom = 0;
 192         return per_put_few_bits(po, length, 8)
 193             ? -1 : (ssize_t)length;
 194     } else if(length < 16384) { /* #10.9.3.7 */
 195         *need_eom = 0;
 196         return per_put_few_bits(po, length|0x8000, 16)
 197             ? -1 : (ssize_t)length;
 198     }
 199
 200     *need_eom = 0 == (length & 16383);
 201     length >>= 14;
 202     if(length > 4) {
 203         *need_eom = 0;
 204         length = 4;
 205     }
 206
 207     return per_put_few_bits(po, 0xC0 | length, 8)
 208             ? -1 : (ssize_t)(length << 14);
 209
 210 }
 211
 212
 213 /*
 214  * Put the normally small length "n" into the stream.
 215  * This procedure used to encode length of extensions bit-maps
 216  * for SET and SEQUENCE types.
 217  */
 218 int
 219 uper_put_nslength(asn_per_outp_t *po, size_t length) {
 220     if(length <= 64) {
 221         /* #11.9.3.4 */
 222         if(length == 0) return -1;
 223         return per_put_few_bits(po, length - 1, 7) ? -1 : 0;
 224     } else {
 225         int need_eom = 0;
 226         if(uper_put_length(po, length, &need_eom) != (ssize_t)length
 227            || need_eom) {
 228             /* This might happen in case of >16K extensions */
 229             return -1;
 230         }
 231     }
 232
 233     return 0;
 234 }
 235
 236 static int
 237 per__long_range(long lb, long ub, unsigned long *range_r) {
 238     unsigned long bounds_range;
 239     if((ub < 0) == (lb < 0)) {
 240         bounds_range = ub - lb;
 241     } else if(lb < 0) {
 242         assert(ub >= 0);
 243         bounds_range = 1 + ((unsigned long)ub + (unsigned long)-(lb + 1));
 244     } else {
 245         assert(!"Unreachable");
 246         return -1;
 247     }
 248     *range_r = bounds_range;
 249     return 0;
 250 }
 251
 252 int
 253 per_long_range_rebase(long v, long lb, long ub, unsigned long *output) {
 254     unsigned long range;
 255
 256     assert(lb <= ub);
 257
 258     if(v < lb || v > ub || per__long_range(lb, ub, &range) < 0) {
 259         /* Range error. */
 260         return -1;
 261     }
 262
 263     /*
 264      * Fundamentally what we're doing is returning (v-lb).
 265      * However, this triggers undefined behavior when the word width
 266      * of signed (v) is the same as the size of unsigned (*output).
 267      * In practice, it triggers the UndefinedSanitizer. Therefore we shall
 268      * compute the ranges accurately to avoid C's undefined behavior.
 269      */
 270     if((v < 0) == (lb < 0)) {
 271         *output = v-lb;
 272         return 0;
 273     } else if(v < 0) {
 274         unsigned long rebased = 1 + (unsigned long)-(v+1) + (unsigned long)lb;
 275         assert(rebased <= range);   /* By construction */
 276         *output = rebased;
 277         return 0;
 278     } else if(lb < 0) {
 279         unsigned long rebased = 1 + (unsigned long)-(lb+1) + (unsigned long)v;
 280         assert(rebased <= range);   /* By construction */
 281         *output = rebased;
 282         return 0;
 283     } else {
 284         assert(!"Unreachable");
 285         return -1;
 286     }
 287 }
 288
 289 int
 290 per_long_range_unrebase(unsigned long inp, long lb, long ub, long *outp) {
 291     unsigned long range;
 292
 293     if(per__long_range(lb, ub, &range) != 0) {
 294         return -1;
 295     }
 296
 297     if(inp > range) {
 298         /*
 299          * We can encode something in the given number of bits that technically
 300          * exceeds the range. This is an avenue for security errors,
 301          * so we don't allow that.
 302          */
 303         return -1;
 304     }
 305
 306     if(inp <= LONG_MAX) {
 307         *outp = (long)inp + lb;
 308     } else {
 309         *outp = (lb + LONG_MAX + 1) + (long)((inp - LONG_MAX) - 1);
 310     }
 311
 312     return 0;
 313 }
 314
 315 int32_t
 316 aper_get_align(asn_per_data_t *pd) {
 317
 318         if(pd->nboff & 0x7) {
 319                 ASN_DEBUG("Aligning %ld bits", 8 - ((unsigned long)pd->nboff & 0x7));
 320                 return per_get_few_bits(pd, 8 - (pd->nboff & 0x7));
 321         }
 322         return 0;
 323 }
 324
 325 ssize_t
 326 aper_get_length(asn_per_data_t *pd, int range, int ebits, int *repeat) {
 327         ssize_t value;
 328
 329         *repeat = 0;
 330
 331         if (range <= 65536 && range >= 0)
 332                 return aper_get_nsnnwn(pd, range);
 333
 334         if (aper_get_align(pd) < 0)
 335                 return -1;
 336
 337         if(ebits >= 0) return per_get_few_bits(pd, ebits);
 338
 339         value = per_get_few_bits(pd, 8);
 340         if(value < 0) return -1;
 341         if((value & 128) == 0)  /* #10.9.3.6 */
 342                 return (value & 0x7F);
 343         if((value & 64) == 0) { /* #10.9.3.7 */
 344                 value = ((value & 63) << 8) | per_get_few_bits(pd, 8);
 345                 if(value < 0) return -1;
 346                 return value;
 347         }
 348         value &= 63;    /* this is "m" from X.691, #10.9.3.8 */
 349         if(value < 1 || value > 4)
 350                 return -1;
 351         *repeat = 1;
 352         return (16384 * value);
 353 }
 354
 355 ssize_t
 356 aper_get_nslength(asn_per_data_t *pd) {
 357         ssize_t length;
 358
 359         ASN_DEBUG("Getting normally small length");
 360
 361         if(per_get_few_bits(pd, 1) == 0) {
 362                 length = per_get_few_bits(pd, 6) + 1;
 363                 if(length <= 0) return -1;
 364                 ASN_DEBUG("l=%ld", length);
 365                 return length;
 366         } else {
 367                 int repeat;
 368                 length = aper_get_length(pd, -1, -1, &repeat);
 369                 if(length >= 0 && !repeat) return length;
 370                 return -1; /* Error, or do not support >16K extensions */
 371         }
 372 }
 373
 374 ssize_t
 375 aper_get_nsnnwn(asn_per_data_t *pd, int range) {
 376         ssize_t value;
 377         int bytes = 0;
 378
 379         ASN_DEBUG("getting nsnnwn with range %d", range);
 380
 381         if(range <= 255) {
 382                 int i;
 383
 384                 if (range < 0) return -1;
 385                 /* 1 -> 8 bits */
 386                 for (i = 1; i <= 8; i++) {
 387                         int upper = 1 << i;
 388                         if (upper >= range)
 389                                 break;
 390                 }
 391                 value = per_get_few_bits(pd, i);
 392                 return value;
 393         } else if (range == 256){
 394                 /* 1 byte */
 395                 bytes = 1;
 396         } else if (range <= 65536) {
 397                 /* 2 bytes */
 398                 bytes = 2;
 399         } else {
 400                 return -1;
 401         }
 402         if (aper_get_align(pd) < 0)
 403                 return -1;
 404         value = per_get_few_bits(pd, 8 * bytes);
 405         return value;
 406 }
 407
 408 int aper_put_align(asn_per_outp_t *po) {
 409
 410         if(po->nboff & 0x7) {
 411                 ASN_DEBUG("Aligning %ld bits", 8 - ((unsigned long)po->nboff & 0x7));
 412                 if(per_put_few_bits(po, 0x00, (8 - (po->nboff & 0x7))))
 413                         return -1;
 414         }
 415         return 0;
 416 }
 417
 418 ssize_t
 419 aper_put_length(asn_per_outp_t *po, int range, size_t length) {
 420
 421         ASN_DEBUG("APER put length %zu with range %d", length, range);
 422
 423         /* 10.9 X.691 Note 2 */
 424         if (range <= 65536 && range >= 0)
 425                 return aper_put_nsnnwn(po, range, length);
 426
 427         if (aper_put_align(po) < 0)
 428                 return -1;
 429
 430         if(length <= 127)          /* #10.9.3.6 */{
 431                 return per_put_few_bits(po, length, 8)
 432                 ? -1 : (ssize_t)length;
 433         }
 434         else if(length < 16384) /* #10.9.3.7 */
 435                 return per_put_few_bits(po, length|0x8000, 16)
 436                 ? -1 : (ssize_t)length;
 437
 438         length >>= 14;
 439         if(length > 4) length = 4;
 440
 441         return per_put_few_bits(po, 0xC0 | length, 8)
 442         ? -1 : (ssize_t)(length << 14);
 443 }
 444
 445
 446 int
 447 aper_put_nslength(asn_per_outp_t *po, size_t length) {
 448
 449         if(length <= 64) {
 450                 /* #10.9.3.4 */
 451                 if(length == 0) return -1;
 452                 return per_put_few_bits(po, length-1, 7) ? -1 : 0;
 453         } else {
 454                 if(aper_put_length(po, -1, length) != (ssize_t)length) {
 455                         /* This might happen in case of >16K extensions */
 456                         return -1;
 457                 }
 458         }
 459
 460         return 0;
 461 }
 462
 463 int
 464 aper_put_nsnnwn(asn_per_outp_t *po, int range, int number) {
 465         int bytes;
 466
 467     ASN_DEBUG("aper put nsnnwn %d with range %d", number, range);
 468         /* 10.5.7.1 X.691 */
 469         if(range < 0) {
 470                 int i;
 471                 for (i = 1; ; i++) {
 472                         int bits = 1 << (8 * i);
 473                         if (number <= bits)
 474                                 break;
 475                 }
 476                 bytes = i;
 477                 assert(i <= 4);
 478         }
 479         if(range <= 255) {
 480                 int i;
 481                 for (i = 1; i <= 8; i++) {
 482                         int bits = 1 << i;
 483                         if (range <= bits)
 484                                 break;
 485                 }
 486                 return per_put_few_bits(po, number, i);
 487         } else if(range == 256) {
 488                 bytes = 1;
 489         } else if(range <= 65536) {
 490                 bytes = 2;
 491         } else { /* Ranges > 64K */
 492                 int i;
 493                 for (i = 1; ; i++) {
 494                         int bits = 1 << (8 * i);
 495                         if (range <= bits)
 496                                 break;
 497                 }
 498                 assert(i <= 4);
 499                 bytes = i;
 500         }
 501         if(aper_put_align(po) < 0) /* Aligning on octet */
 502                 return -1;
 503 /*      if(per_put_few_bits(po, bytes, 8))
 504                 return -1;
 505 */
 506     return per_put_few_bits(po, number, 8 * bytes);
 507 }