libs/smux/NativeInteger.c

   1 /*-
   2  * Copyright (c) 2004, 2005, 2006 Lev Walkin <vlm@lionet.info>.
   3  * All rights reserved.
   4  * Redistribution and modifications are permitted subject to BSD license.
   5  */
   6 /*
   7  * Read the NativeInteger.h for the explanation wrt. differences between
   8  * INTEGER and NativeInteger.
   9  * Basically, both are decoders and encoders of ASN.1 INTEGER type, but this
  10  * implementation deals with the standard (machine-specific) representation
  11  * of them instead of using the platform-independent buffer.
  12  */
  13 #include <asn_internal.h>
  14 #include <NativeInteger.h>
  15
  16 /*
  17  * NativeInteger basic type description.
  18  */
  19 static const ber_tlv_tag_t asn_DEF_NativeInteger_tags[] = {
  20         (ASN_TAG_CLASS_UNIVERSAL | (2 << 2))
  21 };
  22 asn_TYPE_operation_t asn_OP_NativeInteger = {
  23         NativeInteger_free,
  24         NativeInteger_print,
  25         NativeInteger_compare,
  26         NativeInteger_decode_ber,
  27         NativeInteger_encode_der,
  28         NativeInteger_decode_xer,
  29         NativeInteger_encode_xer,
  30 #ifdef  ASN_DISABLE_OER_SUPPORT
  31         0,
  32         0,
  33 #else
  34         NativeInteger_decode_oer,       /* OER decoder */
  35         NativeInteger_encode_oer,       /* Canonical OER encoder */
  36 #endif  /* ASN_DISABLE_OER_SUPPORT */
  37 #ifdef  ASN_DISABLE_PER_SUPPORT
  38         0,
  39         0,
  40 #else
  41         NativeInteger_decode_uper,      /* Unaligned PER decoder */
  42         NativeInteger_encode_uper,      /* Unaligned PER encoder */
  43 #endif  /* ASN_DISABLE_PER_SUPPORT */
  44         NativeInteger_random_fill,
  45         0       /* Use generic outmost tag fetcher */
  46 };
  47 asn_TYPE_descriptor_t asn_DEF_NativeInteger = {
  48         "INTEGER",                      /* The ASN.1 type is still INTEGER */
  49         "INTEGER",
  50         &asn_OP_NativeInteger,
  51         asn_DEF_NativeInteger_tags,
  52         sizeof(asn_DEF_NativeInteger_tags) / sizeof(asn_DEF_NativeInteger_tags[0]),
  53         asn_DEF_NativeInteger_tags,     /* Same as above */
  54         sizeof(asn_DEF_NativeInteger_tags) / sizeof(asn_DEF_NativeInteger_tags[0]),
  55         { 0, 0, asn_generic_no_constraint },
  56         0, 0,   /* No members */
  57         0       /* No specifics */
  58 };
  59
  60 /*
  61  * Decode INTEGER type.
  62  */
  63 asn_dec_rval_t
  64 NativeInteger_decode_ber(const asn_codec_ctx_t *opt_codec_ctx,
  65                          const asn_TYPE_descriptor_t *td, void **nint_ptr,
  66                          const void *buf_ptr, size_t size, int tag_mode) {
  67     const asn_INTEGER_specifics_t *specs =
  68         (const asn_INTEGER_specifics_t *)td->specifics;
  69     long *native = (long *)*nint_ptr;
  70         asn_dec_rval_t rval;
  71         ber_tlv_len_t length;
  72
  73         /*
  74          * If the structure is not there, allocate it.
  75          */
  76         if(native == NULL) {
  77                 native = (long *)(*nint_ptr = CALLOC(1, sizeof(*native)));
  78                 if(native == NULL) {
  79                         rval.code = RC_FAIL;
  80                         rval.consumed = 0;
  81                         return rval;
  82                 }
  83         }
  84
  85         ASN_DEBUG("Decoding %s as INTEGER (tm=%d)",
  86                 td->name, tag_mode);
  87
  88         /*
  89          * Check tags.
  90          */
  91         rval = ber_check_tags(opt_codec_ctx, td, 0, buf_ptr, size,
  92                         tag_mode, 0, &length, 0);
  93         if(rval.code != RC_OK)
  94                 return rval;
  95
  96         ASN_DEBUG("%s length is %d bytes", td->name, (int)length);
  97
  98         /*
  99          * Make sure we have this length.
 100          */
 101         buf_ptr = ((const char *)buf_ptr) + rval.consumed;
 102         size -= rval.consumed;
 103         if(length > (ber_tlv_len_t)size) {
 104                 rval.code = RC_WMORE;
 105                 rval.consumed = 0;
 106                 return rval;
 107         }
 108
 109         /*
 110          * ASN.1 encoded INTEGER: buf_ptr, length
 111          * Fill the native, at the same time checking for overflow.
 112          * If overflow occurred, return with RC_FAIL.
 113          */
 114         {
 115                 INTEGER_t tmp;
 116                 union {
 117                         const void *constbuf;
 118                         void *nonconstbuf;
 119                 } unconst_buf;
 120                 long l;
 121
 122                 unconst_buf.constbuf = buf_ptr;
 123                 tmp.buf = (uint8_t *)unconst_buf.nonconstbuf;
 124                 tmp.size = length;
 125
 126                 if((specs&&specs->field_unsigned)
 127                         ? asn_INTEGER2ulong(&tmp, (unsigned long *)&l) /* sic */
 128                         : asn_INTEGER2long(&tmp, &l)) {
 129                         rval.code = RC_FAIL;
 130                         rval.consumed = 0;
 131                         return rval;
 132                 }
 133
 134                 *native = l;
 135         }
 136
 137         rval.code = RC_OK;
 138         rval.consumed += length;
 139
 140         ASN_DEBUG("Took %ld/%ld bytes to encode %s (%ld)",
 141                 (long)rval.consumed, (long)length, td->name, (long)*native);
 142
 143         return rval;
 144 }
 145
 146 /*
 147  * Encode the NativeInteger using the standard INTEGER type DER encoder.
 148  */
 149 asn_enc_rval_t
 150 NativeInteger_encode_der(const asn_TYPE_descriptor_t *sd, const void *ptr,
 151                          int tag_mode, ber_tlv_tag_t tag,
 152                          asn_app_consume_bytes_f *cb, void *app_key) {
 153     unsigned long native = *(const unsigned long *)ptr; /* Disable sign ext. */
 154     asn_enc_rval_t erval;
 155         INTEGER_t tmp;
 156
 157 #ifdef  WORDS_BIGENDIAN         /* Opportunistic optimization */
 158
 159         tmp.buf = (uint8_t *)&native;
 160         tmp.size = sizeof(native);
 161
 162 #else   /* Works even if WORDS_BIGENDIAN is not set where should've been */
 163         uint8_t buf[sizeof(native)];
 164         uint8_t *p;
 165
 166         /* Prepare a fake INTEGER */
 167         for(p = buf + sizeof(buf) - 1; p >= buf; p--, native >>= 8)
 168                 *p = (uint8_t)native;
 169
 170         tmp.buf = buf;
 171         tmp.size = sizeof(buf);
 172 #endif  /* WORDS_BIGENDIAN */
 173
 174         /* Encode fake INTEGER */
 175         erval = INTEGER_encode_der(sd, &tmp, tag_mode, tag, cb, app_key);
 176     if(erval.structure_ptr == &tmp) {
 177         erval.structure_ptr = ptr;
 178     }
 179         return erval;
 180 }
 181
 182 /*
 183  * Decode the chunk of XML text encoding INTEGER.
 184  */
 185 asn_dec_rval_t
 186 NativeInteger_decode_xer(const asn_codec_ctx_t *opt_codec_ctx,
 187                          const asn_TYPE_descriptor_t *td, void **sptr,
 188                          const char *opt_mname, const void *buf_ptr,
 189                          size_t size) {
 190     const asn_INTEGER_specifics_t *specs =
 191         (const asn_INTEGER_specifics_t *)td->specifics;
 192     asn_dec_rval_t rval;
 193         INTEGER_t st;
 194         void *st_ptr = (void *)&st;
 195         long *native = (long *)*sptr;
 196
 197         if(!native) {
 198                 native = (long *)(*sptr = CALLOC(1, sizeof(*native)));
 199                 if(!native) ASN__DECODE_FAILED;
 200         }
 201
 202         memset(&st, 0, sizeof(st));
 203         rval = INTEGER_decode_xer(opt_codec_ctx, td, &st_ptr,
 204                 opt_mname, buf_ptr, size);
 205         if(rval.code == RC_OK) {
 206                 long l;
 207                 if((specs&&specs->field_unsigned)
 208                         ? asn_INTEGER2ulong(&st, (unsigned long *)&l) /* sic */
 209                         : asn_INTEGER2long(&st, &l)) {
 210                         rval.code = RC_FAIL;
 211                         rval.consumed = 0;
 212                 } else {
 213                         *native = l;
 214                 }
 215         } else {
 216                 /*
 217                  * Cannot restart from the middle;
 218                  * there is no place to save state in the native type.
 219                  * Request a continuation from the very beginning.
 220                  */
 221                 rval.consumed = 0;
 222         }
 223         ASN_STRUCT_FREE_CONTENTS_ONLY(asn_DEF_INTEGER, &st);
 224         return rval;
 225 }
 226
 227
 228 asn_enc_rval_t
 229 NativeInteger_encode_xer(const asn_TYPE_descriptor_t *td, const void *sptr,
 230                          int ilevel, enum xer_encoder_flags_e flags,
 231                          asn_app_consume_bytes_f *cb, void *app_key) {
 232     const asn_INTEGER_specifics_t *specs =
 233         (const asn_INTEGER_specifics_t *)td->specifics;
 234     char scratch[32];   /* Enough for 64-bit int */
 235         asn_enc_rval_t er;
 236         const long *native = (const long *)sptr;
 237
 238         (void)ilevel;
 239         (void)flags;
 240
 241         if(!native) ASN__ENCODE_FAILED;
 242
 243         er.encoded = snprintf(scratch, sizeof(scratch),
 244                         (specs && specs->field_unsigned)
 245                         ? "%lu" : "%ld", *native);
 246         if(er.encoded <= 0 || (size_t)er.encoded >= sizeof(scratch)
 247                 || cb(scratch, er.encoded, app_key) < 0)
 248                 ASN__ENCODE_FAILED;
 249
 250         ASN__ENCODED_OK(er);
 251 }
 252
 253 #ifndef  ASN_DISABLE_PER_SUPPORT
 254
 255 asn_dec_rval_t
 256 NativeInteger_decode_uper(const asn_codec_ctx_t *opt_codec_ctx,
 257                           const asn_TYPE_descriptor_t *td,
 258                           const asn_per_constraints_t *constraints, void **sptr,
 259                           asn_per_data_t *pd) {
 260     const asn_INTEGER_specifics_t *specs =
 261         (const asn_INTEGER_specifics_t *)td->specifics;
 262     asn_dec_rval_t rval;
 263         long *native = (long *)*sptr;
 264         INTEGER_t tmpint;
 265         void *tmpintptr = &tmpint;
 266
 267         (void)opt_codec_ctx;
 268         ASN_DEBUG("Decoding NativeInteger %s (UPER)", td->name);
 269
 270         if(!native) {
 271                 native = (long *)(*sptr = CALLOC(1, sizeof(*native)));
 272                 if(!native) ASN__DECODE_FAILED;
 273         }
 274
 275         memset(&tmpint, 0, sizeof tmpint);
 276         rval = INTEGER_decode_uper(opt_codec_ctx, td, constraints,
 277                                    &tmpintptr, pd);
 278         if(rval.code == RC_OK) {
 279                 if((specs&&specs->field_unsigned)
 280                         ? asn_INTEGER2ulong(&tmpint, (unsigned long *)native)
 281                         : asn_INTEGER2long(&tmpint, native))
 282                         rval.code = RC_FAIL;
 283                 else
 284                         ASN_DEBUG("NativeInteger %s got value %ld",
 285                                 td->name, *native);
 286         }
 287         ASN_STRUCT_FREE_CONTENTS_ONLY(asn_DEF_INTEGER, &tmpint);
 288
 289         return rval;
 290 }
 291
 292 asn_enc_rval_t
 293 NativeInteger_encode_uper(const asn_TYPE_descriptor_t *td,
 294                           const asn_per_constraints_t *constraints,
 295                           const void *sptr, asn_per_outp_t *po) {
 296     const asn_INTEGER_specifics_t *specs =
 297         (const asn_INTEGER_specifics_t *)td->specifics;
 298     asn_enc_rval_t er;
 299         long native;
 300         INTEGER_t tmpint;
 301
 302         if(!sptr) ASN__ENCODE_FAILED;
 303
 304     native = *(const long *)sptr;
 305
 306     ASN_DEBUG("Encoding NativeInteger %s %ld (UPER)", td->name, native);
 307
 308         memset(&tmpint, 0, sizeof(tmpint));
 309         if((specs&&specs->field_unsigned)
 310                 ? asn_ulong2INTEGER(&tmpint, native)
 311                 : asn_long2INTEGER(&tmpint, native))
 312                 ASN__ENCODE_FAILED;
 313         er = INTEGER_encode_uper(td, constraints, &tmpint, po);
 314         ASN_STRUCT_FREE_CONTENTS_ONLY(asn_DEF_INTEGER, &tmpint);
 315         return er;
 316 }
 317
 318 #endif  /* ASN_DISABLE_PER_SUPPORT */
 319
 320 /*
 321  * INTEGER specific human-readable output.
 322  */
 323 int
 324 NativeInteger_print(const asn_TYPE_descriptor_t *td, const void *sptr,
 325                     int ilevel, asn_app_consume_bytes_f *cb, void *app_key) {
 326     const asn_INTEGER_specifics_t *specs =
 327         (const asn_INTEGER_specifics_t *)td->specifics;
 328     const long *native = (const long *)sptr;
 329     char scratch[32]; /* Enough for 64-bit int */
 330     int ret;
 331
 332     (void)td;       /* Unused argument */
 333     (void)ilevel;   /* Unused argument */
 334
 335     if(native) {
 336         long value = *native;
 337         ret = snprintf(scratch, sizeof(scratch),
 338                        (specs && specs->field_unsigned) ? "%lu" : "%ld", value);
 339         assert(ret > 0 && (size_t)ret < sizeof(scratch));
 340         if(cb(scratch, ret, app_key) < 0) return -1;
 341         if(specs && (value >= 0 || !specs->field_unsigned)) {
 342             const asn_INTEGER_enum_map_t *el =
 343                 INTEGER_map_value2enum(specs, value);
 344             if(el) {
 345                 if(cb(" (", 2, app_key) < 0) return -1;
 346                 if(cb(el->enum_name, el->enum_len, app_key) < 0) return -1;
 347                 if(cb(")", 1, app_key) < 0) return -1;
 348             }
 349         }
 350         return 0;
 351         } else {
 352                 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
 353         }
 354 }
 355
 356 void
 357 NativeInteger_free(const asn_TYPE_descriptor_t *td, void *ptr,
 358                    enum asn_struct_free_method method) {
 359     if(!td || !ptr)
 360                 return;
 361
 362         ASN_DEBUG("Freeing %s as INTEGER (%d, %p, Native)",
 363                 td->name, method, ptr);
 364
 365     switch(method) {
 366     case ASFM_FREE_EVERYTHING:
 367         FREEMEM(ptr);
 368         break;
 369     case ASFM_FREE_UNDERLYING:
 370         break;
 371     case ASFM_FREE_UNDERLYING_AND_RESET:
 372         memset(ptr, 0, sizeof(long));
 373         break;
 374     }
 375 }
 376
 377 int
 378 NativeInteger_compare(const asn_TYPE_descriptor_t *td, const void *aptr, const void *bptr) {
 379     (void)td;
 380
 381     if(aptr && bptr) {
 382         const asn_INTEGER_specifics_t *specs =
 383             (const asn_INTEGER_specifics_t *)td->specifics;
 384         if(specs && specs->field_unsigned) {
 385             const unsigned long *a = aptr;
 386             const unsigned long *b = bptr;
 387             if(*a < *b) {
 388                 return -1;
 389             } else if(*a > *b) {
 390                 return 1;
 391             } else {
 392                 return 0;
 393             }
 394         } else {
 395             const long *a = aptr;
 396             const long *b = bptr;
 397             if(*a < *b) {
 398                 return -1;
 399             } else if(*a > *b) {
 400                 return 1;
 401             } else {
 402                 return 0;
 403             }
 404         }
 405     } else if(!aptr) {
 406         return -1;
 407     } else {
 408         return 1;
 409     }
 410 }
 411
 412 asn_random_fill_result_t
 413 NativeInteger_random_fill(const asn_TYPE_descriptor_t *td, void **sptr,
 414                           const asn_encoding_constraints_t *constraints,
 415                           size_t max_length) {
 416     const asn_INTEGER_specifics_t *specs =
 417         (const asn_INTEGER_specifics_t *)td->specifics;
 418     asn_random_fill_result_t result_ok = {ARFILL_OK, 1};
 419     asn_random_fill_result_t result_failed = {ARFILL_FAILED, 0};
 420     asn_random_fill_result_t result_skipped = {ARFILL_SKIPPED, 0};
 421     long *st = *sptr;
 422     const asn_INTEGER_enum_map_t *emap;
 423     size_t emap_len;
 424     intmax_t value;
 425     int find_inside_map;
 426
 427     if(max_length == 0) return result_skipped;
 428
 429     if(st == NULL) {
 430         st = (long *)CALLOC(1, sizeof(*st));
 431         if(st == NULL) {
 432             return result_failed;
 433         }
 434     }
 435
 436     if(specs) {
 437         emap = specs->value2enum;
 438         emap_len = specs->map_count;
 439         if(specs->strict_enumeration) {
 440             find_inside_map = emap_len > 0;
 441         } else {
 442             find_inside_map = emap_len ? asn_random_between(0, 1) : 0;
 443         }
 444     } else {
 445         emap = 0;
 446         emap_len = 0;
 447         find_inside_map = 0;
 448     }
 449
 450     if(find_inside_map) {
 451         assert(emap_len > 0);
 452         value = emap[asn_random_between(0, emap_len - 1)].nat_value;
 453     } else {
 454         const asn_per_constraints_t *ct;
 455
 456         static const long variants[] = {
 457             -65536, -65535, -65534, -32769, -32768, -32767, -16385, -16384,
 458             -16383, -257,   -256,   -255,   -254,   -129,   -128,   -127,
 459             -126,   -1,     0,      1,      126,    127,    128,    129,
 460             254,    255,    256,    257,    16383,  16384,  16385,  32767,
 461             32768,  32769,  65534,  65535,  65536,  65537};
 462         if(specs && specs->field_unsigned) {
 463             assert(variants[18] == 0);
 464             value = variants[asn_random_between(
 465                 18, sizeof(variants) / sizeof(variants[0]) - 1)];
 466         } else {
 467             value = variants[asn_random_between(
 468                 0, sizeof(variants) / sizeof(variants[0]) - 1)];
 469         }
 470
 471         if(!constraints) constraints = &td->encoding_constraints;
 472         ct = constraints ? constraints->per_constraints : 0;
 473         if(ct && (ct->value.flags & APC_CONSTRAINED)) {
 474             if(value < ct->value.lower_bound || value > ct->value.upper_bound) {
 475                 value = asn_random_between(ct->value.lower_bound,
 476                                            ct->value.upper_bound);
 477             }
 478         }
 479     }
 480
 481     *sptr = st;
 482     *st = value;
 483     return result_ok;
 484 }