]> git.stg.codes - stg.git/blob - libs/smux/BIT_STRING.c
More std::jthread stuff.
[stg.git] / libs / smux / BIT_STRING.c
1 /*-
2  * Copyright (c) 2003, 2004 Lev Walkin <vlm@lionet.info>. All rights reserved.
3  * Redistribution and modifications are permitted subject to BSD license.
4  */
5 #include <asn_internal.h>
6 #include <BIT_STRING.h>
7 #include <asn_internal.h>
8
9 /*
10  * BIT STRING basic type description.
11  */
12 static const ber_tlv_tag_t asn_DEF_BIT_STRING_tags[] = {
13         (ASN_TAG_CLASS_UNIVERSAL | (3 << 2))
14 };
15 asn_OCTET_STRING_specifics_t asn_SPC_BIT_STRING_specs = {
16         sizeof(BIT_STRING_t),
17         offsetof(BIT_STRING_t, _asn_ctx),
18         ASN_OSUBV_BIT
19 };
20 asn_TYPE_operation_t asn_OP_BIT_STRING = {
21         OCTET_STRING_free,         /* Implemented in terms of OCTET STRING */
22         BIT_STRING_print,
23         BIT_STRING_compare,
24         OCTET_STRING_decode_ber,   /* Implemented in terms of OCTET STRING */
25         OCTET_STRING_encode_der,   /* Implemented in terms of OCTET STRING */
26         OCTET_STRING_decode_xer_binary,
27         BIT_STRING_encode_xer,
28 #ifdef  ASN_DISABLE_OER_SUPPORT
29         0,
30         0,
31 #else
32         BIT_STRING_decode_oer,
33         BIT_STRING_encode_oer,
34 #endif  /* ASN_DISABLE_OER_SUPPORT */
35 #ifdef  ASN_DISABLE_PER_SUPPORT
36         0,
37         0,
38 #else
39         BIT_STRING_decode_uper, /* Unaligned PER decoder */
40         BIT_STRING_encode_uper, /* Unaligned PER encoder */
41 #endif  /* ASN_DISABLE_PER_SUPPORT */
42         BIT_STRING_random_fill,
43         0       /* Use generic outmost tag fetcher */
44 };
45 asn_TYPE_descriptor_t asn_DEF_BIT_STRING = {
46         "BIT STRING",
47         "BIT_STRING",
48         &asn_OP_BIT_STRING,
49         asn_DEF_BIT_STRING_tags,
50         sizeof(asn_DEF_BIT_STRING_tags)
51           / sizeof(asn_DEF_BIT_STRING_tags[0]),
52         asn_DEF_BIT_STRING_tags,        /* Same as above */
53         sizeof(asn_DEF_BIT_STRING_tags)
54           / sizeof(asn_DEF_BIT_STRING_tags[0]),
55         { 0, 0, BIT_STRING_constraint },
56         0, 0,   /* No members */
57         &asn_SPC_BIT_STRING_specs
58 };
59
60 /*
61  * BIT STRING generic constraint.
62  */
63 int
64 BIT_STRING_constraint(const asn_TYPE_descriptor_t *td, const void *sptr,
65                       asn_app_constraint_failed_f *ctfailcb, void *app_key) {
66     const BIT_STRING_t *st = (const BIT_STRING_t *)sptr;
67
68         if(st && st->buf) {
69                 if((st->size == 0 && st->bits_unused)
70                 || st->bits_unused < 0 || st->bits_unused > 7) {
71                         ASN__CTFAIL(app_key, td, sptr,
72                                 "%s: invalid padding byte (%s:%d)",
73                                 td->name, __FILE__, __LINE__);
74                         return -1;
75                 }
76         } else {
77                 ASN__CTFAIL(app_key, td, sptr,
78                         "%s: value not given (%s:%d)",
79                         td->name, __FILE__, __LINE__);
80                 return -1;
81         }
82
83         return 0;
84 }
85
86 static const char *_bit_pattern[16] = {
87         "0000", "0001", "0010", "0011", "0100", "0101", "0110", "0111",
88         "1000", "1001", "1010", "1011", "1100", "1101", "1110", "1111"
89 };
90
91 asn_enc_rval_t
92 BIT_STRING_encode_xer(const asn_TYPE_descriptor_t *td, const void *sptr,
93                       int ilevel, enum xer_encoder_flags_e flags,
94                       asn_app_consume_bytes_f *cb, void *app_key) {
95     asn_enc_rval_t er;
96         char scratch[128];
97         char *p = scratch;
98         char *scend = scratch + (sizeof(scratch) - 10);
99         const BIT_STRING_t *st = (const BIT_STRING_t *)sptr;
100         int xcan = (flags & XER_F_CANONICAL);
101         uint8_t *buf;
102         uint8_t *end;
103
104         if(!st || !st->buf)
105                 ASN__ENCODE_FAILED;
106
107         er.encoded = 0;
108
109         buf = st->buf;
110         end = buf + st->size - 1;       /* Last byte is special */
111
112         /*
113          * Binary dump
114          */
115         for(; buf < end; buf++) {
116                 int v = *buf;
117                 int nline = xcan?0:(((buf - st->buf) % 8) == 0);
118                 if(p >= scend || nline) {
119                         ASN__CALLBACK(scratch, p - scratch);
120                         p = scratch;
121                         if(nline) ASN__TEXT_INDENT(1, ilevel);
122                 }
123                 memcpy(p + 0, _bit_pattern[v >> 4], 4);
124                 memcpy(p + 4, _bit_pattern[v & 0x0f], 4);
125                 p += 8;
126         }
127
128         if(!xcan && ((buf - st->buf) % 8) == 0)
129                 ASN__TEXT_INDENT(1, ilevel);
130         ASN__CALLBACK(scratch, p - scratch);
131         p = scratch;
132
133         if(buf == end) {
134                 int v = *buf;
135                 int ubits = st->bits_unused;
136                 int i;
137                 for(i = 7; i >= ubits; i--)
138                         *p++ = (v & (1 << i)) ? 0x31 : 0x30;
139                 ASN__CALLBACK(scratch, p - scratch);
140         }
141
142         if(!xcan) ASN__TEXT_INDENT(1, ilevel - 1);
143
144         ASN__ENCODED_OK(er);
145 cb_failed:
146         ASN__ENCODE_FAILED;
147 }
148
149
150 /*
151  * BIT STRING specific contents printer.
152  */
153 int
154 BIT_STRING_print(const asn_TYPE_descriptor_t *td, const void *sptr, int ilevel,
155                  asn_app_consume_bytes_f *cb, void *app_key) {
156     const char * const h2c = "0123456789ABCDEF";
157         char scratch[64];
158         const BIT_STRING_t *st = (const BIT_STRING_t *)sptr;
159         uint8_t *buf;
160         uint8_t *end;
161         char *p = scratch;
162
163         (void)td;       /* Unused argument */
164
165         if(!st || !st->buf)
166                 return (cb("<absent>", 8, app_key) < 0) ? -1 : 0;
167
168         ilevel++;
169         buf = st->buf;
170         end = buf + st->size;
171
172         /*
173          * Hexadecimal dump.
174          */
175         for(; buf < end; buf++) {
176                 if((buf - st->buf) % 16 == 0 && (st->size > 16)
177                                 && buf != st->buf) {
178                         _i_INDENT(1);
179                         /* Dump the string */
180                         if(cb(scratch, p - scratch, app_key) < 0) return -1;
181                         p = scratch;
182                 }
183                 *p++ = h2c[*buf >> 4];
184                 *p++ = h2c[*buf & 0x0F];
185                 *p++ = 0x20;
186         }
187
188         if(p > scratch) {
189                 p--;    /* Eat the tailing space */
190
191                 if((st->size > 16)) {
192                         _i_INDENT(1);
193                 }
194
195                 /* Dump the incomplete 16-bytes row */
196                 if(cb(scratch, p - scratch, app_key) < 0)
197                         return -1;
198         }
199
200     if(st->bits_unused) {
201         int ret = snprintf(scratch, sizeof(scratch), " (%d bit%s unused)",
202                            st->bits_unused, st->bits_unused == 1 ? "" : "s");
203         assert(ret > 0 && ret < (ssize_t)sizeof(scratch));
204         if(ret > 0 && ret < (ssize_t)sizeof(scratch)
205            && cb(scratch, ret, app_key) < 0)
206             return -1;
207     }
208
209         return 0;
210 }
211
212 /*
213  * Non-destructively remove the trailing 0-bits from the given bit string.
214  */
215 static const BIT_STRING_t *
216 BIT_STRING__compactify(const BIT_STRING_t *st, BIT_STRING_t *tmp) {
217     const uint8_t *b;
218     union {
219         const uint8_t *c_buf;
220         uint8_t *nc_buf;
221     } unconst;
222
223     if(st->size == 0) {
224         assert(st->bits_unused == 0);
225         return st;
226     } else {
227         for(b = &st->buf[st->size - 1]; b > st->buf && *b == 0; b--) {
228             ;
229         }
230         /* b points to the last byte which may contain data */
231         if(*b) {
232             int unused = 7;
233             uint8_t v = *b;
234             v &= -(int8_t)v;
235             if(v & 0x0F) unused -= 4;
236             if(v & 0x33) unused -= 2;
237             if(v & 0x55) unused -= 1;
238             tmp->size = b-st->buf + 1;
239             tmp->bits_unused = unused;
240         } else {
241             tmp->size = b-st->buf;
242             tmp->bits_unused = 0;
243         }
244
245         assert(b >= st->buf);
246     }
247
248     unconst.c_buf = st->buf;
249     tmp->buf = unconst.nc_buf;
250     return tmp;
251 }
252
253 /*
254  * Lexicographically compare the common prefix of both strings,
255  * and if it is the same return -1 for the smallest string.
256  */
257 int
258 BIT_STRING_compare(const asn_TYPE_descriptor_t *td, const void *aptr,
259                    const void *bptr) {
260     /*
261      * Remove information about trailing bits, since
262      * X.680 (08/2015) #22.7 "ensure that different semantics are not"
263      * "associated with [values that differ only in] the trailing 0 bits."
264      */
265     BIT_STRING_t compact_a, compact_b;
266     const BIT_STRING_t *a = BIT_STRING__compactify(aptr, &compact_a);
267     const BIT_STRING_t *b = BIT_STRING__compactify(bptr, &compact_b);
268     const asn_OCTET_STRING_specifics_t *specs = td->specifics;
269
270     assert(specs && specs->subvariant == ASN_OSUBV_BIT);
271
272     if(a && b) {
273         size_t common_prefix_size = a->size <= b->size ? a->size : b->size;
274         int ret = memcmp(a->buf, b->buf, common_prefix_size);
275         if(ret == 0) {
276             /* Figure out which string with equal prefixes is longer. */
277             if(a->size < b->size) {
278                 return -1;
279             } else if(a->size > b->size) {
280                 return 1;
281             } else {
282                 /* Figure out how many unused bits */
283                 if(a->bits_unused > b->bits_unused) {
284                     return -1;
285                 } else if(a->bits_unused < b->bits_unused) {
286                     return 1;
287                 } else {
288                     return 0;
289                 }
290             }
291         } else {
292             return ret;
293         }
294     } else if(!a && !b) {
295         return 0;
296     } else if(!a) {
297         return -1;
298     } else {
299         return 1;
300     }
301 }
302
303 #ifndef  ASN_DISABLE_PER_SUPPORT
304
305 #undef  RETURN
306 #define RETURN(_code)                       \
307     do {                                    \
308         asn_dec_rval_t tmprval;             \
309         tmprval.code = _code;               \
310         tmprval.consumed = consumed_myself; \
311         return tmprval;                     \
312     } while(0)
313
314 static asn_per_constraint_t asn_DEF_BIT_STRING_constraint_size = {
315     APC_SEMI_CONSTRAINED, -1, -1, 0, 0};
316
317 asn_dec_rval_t
318 BIT_STRING_decode_uper(const asn_codec_ctx_t *opt_codec_ctx,
319                        const asn_TYPE_descriptor_t *td,
320                        const asn_per_constraints_t *constraints, void **sptr,
321                        asn_per_data_t *pd) {
322     const asn_OCTET_STRING_specifics_t *specs = td->specifics
323                 ? (const asn_OCTET_STRING_specifics_t *)td->specifics
324                 : &asn_SPC_BIT_STRING_specs;
325     const asn_per_constraints_t *pc =
326         constraints ? constraints : td->encoding_constraints.per_constraints;
327         const asn_per_constraint_t *csiz;
328         asn_dec_rval_t rval = { RC_OK, 0 };
329         BIT_STRING_t *st = (BIT_STRING_t *)*sptr;
330         ssize_t consumed_myself = 0;
331         int repeat;
332
333         (void)opt_codec_ctx;
334
335         if(pc) {
336                 csiz = &pc->size;
337         } else {
338                 csiz = &asn_DEF_BIT_STRING_constraint_size;
339         }
340
341         if(specs->subvariant != ASN_OSUBV_BIT) {
342                 ASN_DEBUG("Subvariant %d is not BIT OSUBV_BIT", specs->subvariant);
343                 RETURN(RC_FAIL);
344     }
345
346         /*
347          * Allocate the string.
348          */
349         if(!st) {
350                 st = (BIT_STRING_t *)(*sptr = CALLOC(1, specs->struct_size));
351                 if(!st) RETURN(RC_FAIL);
352         }
353
354         ASN_DEBUG("PER Decoding %s size %ld .. %ld bits %d",
355                 csiz->flags & APC_EXTENSIBLE ? "extensible" : "non-extensible",
356                 csiz->lower_bound, csiz->upper_bound, csiz->effective_bits);
357
358         if(csiz->flags & APC_EXTENSIBLE) {
359                 int inext = per_get_few_bits(pd, 1);
360                 if(inext < 0) RETURN(RC_WMORE);
361                 if(inext) {
362                         csiz = &asn_DEF_BIT_STRING_constraint_size;
363                 }
364         }
365
366         if(csiz->effective_bits >= 0) {
367                 FREEMEM(st->buf);
368         st->size = (csiz->upper_bound + 7) >> 3;
369         st->buf = (uint8_t *)MALLOC(st->size + 1);
370                 if(!st->buf) { st->size = 0; RETURN(RC_FAIL); }
371         }
372
373         /* X.691, #16.5: zero-length encoding */
374         /* X.691, #16.6: short fixed length encoding (up to 2 octets) */
375         /* X.691, #16.7: long fixed length encoding (up to 64K octets) */
376         if(csiz->effective_bits == 0) {
377                 int ret;
378         ASN_DEBUG("Encoding BIT STRING size %ld", csiz->upper_bound);
379         ret = per_get_many_bits(pd, st->buf, 0, csiz->upper_bound);
380                 if(ret < 0) RETURN(RC_WMORE);
381                 consumed_myself += csiz->upper_bound;
382                 st->buf[st->size] = 0;
383         st->bits_unused = (8 - (csiz->upper_bound & 0x7)) & 0x7;
384         RETURN(RC_OK);
385         }
386
387         st->size = 0;
388         do {
389                 ssize_t raw_len;
390                 ssize_t len_bytes;
391                 ssize_t len_bits;
392                 void *p;
393                 int ret;
394
395                 /* Get the PER length */
396                 raw_len = uper_get_length(pd, csiz->effective_bits, csiz->lower_bound,
397                                           &repeat);
398                 if(raw_len < 0) RETURN(RC_WMORE);
399         if(raw_len == 0 && st->buf) break;
400
401                 ASN_DEBUG("Got PER length eb %ld, len %ld, %s (%s)",
402                         (long)csiz->effective_bits, (long)raw_len,
403                         repeat ? "repeat" : "once", td->name);
404         len_bits = raw_len;
405         len_bytes = (len_bits + 7) >> 3;
406         if(len_bits & 0x7) st->bits_unused = 8 - (len_bits & 0x7);
407         /* len_bits be multiple of 16K if repeat is set */
408         p = REALLOC(st->buf, st->size + len_bytes + 1);
409                 if(!p) RETURN(RC_FAIL);
410                 st->buf = (uint8_t *)p;
411
412         ret = per_get_many_bits(pd, &st->buf[st->size], 0, len_bits);
413         if(ret < 0) RETURN(RC_WMORE);
414                 st->size += len_bytes;
415         } while(repeat);
416         st->buf[st->size] = 0;  /* nul-terminate */
417
418         return rval;
419 }
420
421 asn_enc_rval_t
422 BIT_STRING_encode_uper(const asn_TYPE_descriptor_t *td,
423                        const asn_per_constraints_t *constraints,
424                        const void *sptr, asn_per_outp_t *po) {
425     const asn_OCTET_STRING_specifics_t *specs =
426         td->specifics ? (const asn_OCTET_STRING_specifics_t *)td->specifics
427                       : &asn_SPC_BIT_STRING_specs;
428     const asn_per_constraints_t *pc =
429         constraints ? constraints : td->encoding_constraints.per_constraints;
430         const asn_per_constraint_t *csiz;
431         const BIT_STRING_t *st = (const BIT_STRING_t *)sptr;
432         BIT_STRING_t compact_bstr;  /* Do not modify this directly! */
433         asn_enc_rval_t er = { 0, 0, 0 };
434         int inext = 0;          /* Lies not within extension root */
435         size_t size_in_bits;
436         const uint8_t *buf;
437         int ret;
438         int ct_extensible;
439
440         if(!st || (!st->buf && st->size))
441                 ASN__ENCODE_FAILED;
442
443         if(specs->subvariant == ASN_OSUBV_BIT) {
444         if((st->size == 0 && st->bits_unused) || (st->bits_unused & ~7))
445             ASN__ENCODE_FAILED;
446     } else {
447                 ASN__ENCODE_FAILED;
448     }
449
450         if(pc) {
451         csiz = &pc->size;
452     } else {
453                 csiz = &asn_DEF_BIT_STRING_constraint_size;
454         }
455         ct_extensible = csiz->flags & APC_EXTENSIBLE;
456
457     /* Figure out the size without the trailing bits */
458     st = BIT_STRING__compactify(st, &compact_bstr);
459     size_in_bits = 8 * st->size - st->bits_unused;
460
461     ASN_DEBUG(
462         "Encoding %s into %" ASN_PRI_SIZE " bits"
463         " (%ld..%ld, effective %d)%s",
464         td->name, size_in_bits, csiz->lower_bound, csiz->upper_bound,
465         csiz->effective_bits, ct_extensible ? " EXT" : "");
466
467     /* Figure out whether size lies within PER visible constraint */
468
469     if(csiz->effective_bits >= 0) {
470         if((ssize_t)size_in_bits > csiz->upper_bound) {
471             if(ct_extensible) {
472                 csiz = &asn_DEF_BIT_STRING_constraint_size;
473                 inext = 1;
474             } else {
475                 ASN__ENCODE_FAILED;
476             }
477         }
478     } else {
479         inext = 0;
480     }
481
482     if(ct_extensible) {
483                 /* Declare whether length is [not] within extension root */
484                 if(per_put_few_bits(po, inext, 1))
485                         ASN__ENCODE_FAILED;
486         }
487
488     if(csiz->effective_bits >= 0 && !inext) {
489         int add_trailer = (ssize_t)size_in_bits < csiz->lower_bound;
490         ASN_DEBUG(
491             "Encoding %" ASN_PRI_SIZE " bytes (%ld), length (in %d bits) trailer %d; actual "
492             "value %" ASN_PRI_SSIZE "",
493             st->size, size_in_bits - csiz->lower_bound, csiz->effective_bits,
494             add_trailer,
495             add_trailer ? 0 : (ssize_t)size_in_bits - csiz->lower_bound);
496         ret = per_put_few_bits(
497             po, add_trailer ? 0 : (ssize_t)size_in_bits - csiz->lower_bound,
498             csiz->effective_bits);
499         if(ret) ASN__ENCODE_FAILED;
500         ret = per_put_many_bits(po, st->buf, size_in_bits);
501         if(ret) ASN__ENCODE_FAILED;
502         if(add_trailer) {
503             static const uint8_t zeros[16];
504             size_t trailing_zero_bits = csiz->lower_bound - size_in_bits;
505             while(trailing_zero_bits > 0) {
506                 if(trailing_zero_bits > 8 * sizeof(zeros)) {
507                     ret = per_put_many_bits(po, zeros, 8 * sizeof(zeros));
508                     trailing_zero_bits -= 8 * sizeof(zeros);
509                 } else {
510                     ret = per_put_many_bits(po, zeros, trailing_zero_bits);
511                     trailing_zero_bits = 0;
512                 }
513                 if(ret) ASN__ENCODE_FAILED;
514             }
515         }
516         ASN__ENCODED_OK(er);
517     }
518
519     ASN_DEBUG("Encoding %" ASN_PRI_SIZE " bytes", st->size);
520
521     buf = st->buf;
522     do {
523         int need_eom = 0;
524         ssize_t maySave = uper_put_length(po, size_in_bits, &need_eom);
525         if(maySave < 0) ASN__ENCODE_FAILED;
526
527         ASN_DEBUG("Encoding %" ASN_PRI_SSIZE " of %" ASN_PRI_SIZE "", maySave, size_in_bits);
528
529         ret = per_put_many_bits(po, buf, maySave);
530         if(ret) ASN__ENCODE_FAILED;
531
532         buf += maySave >> 3;
533         size_in_bits -= maySave;
534         assert(!(maySave & 0x07) || !size_in_bits);
535         if(need_eom && uper_put_length(po, 0, 0))
536             ASN__ENCODE_FAILED; /* End of Message length */
537     } while(size_in_bits);
538
539     ASN__ENCODED_OK(er);
540 }
541
542 #endif  /* ASN_DISABLE_PER_SUPPORT */
543
544 asn_random_fill_result_t
545 BIT_STRING_random_fill(const asn_TYPE_descriptor_t *td, void **sptr,
546                        const asn_encoding_constraints_t *constraints,
547                        size_t max_length) {
548     const asn_OCTET_STRING_specifics_t *specs =
549         td->specifics ? (const asn_OCTET_STRING_specifics_t *)td->specifics
550                       : &asn_SPC_BIT_STRING_specs;
551     asn_random_fill_result_t result_ok = {ARFILL_OK, 1};
552     asn_random_fill_result_t result_failed = {ARFILL_FAILED, 0};
553     asn_random_fill_result_t result_skipped = {ARFILL_SKIPPED, 0};
554     static unsigned lengths[] = {0,     1,     2,     3,     4,     8,
555                                  126,   127,   128,   16383, 16384, 16385,
556                                  65534, 65535, 65536, 65537};
557     uint8_t *buf;
558     uint8_t *bend;
559     uint8_t *b;
560     size_t rnd_bits, rnd_len;
561     BIT_STRING_t *st;
562
563     if(max_length == 0) return result_skipped;
564
565     switch(specs->subvariant) {
566     case ASN_OSUBV_ANY:
567         return result_failed;
568     case ASN_OSUBV_BIT:
569         break;
570     default:
571         break;
572     }
573
574     /* Figure out how far we should go */
575     rnd_bits = lengths[asn_random_between(
576         0, sizeof(lengths) / sizeof(lengths[0]) - 1)];
577     if(!constraints || !constraints->per_constraints)
578         constraints = &td->encoding_constraints;
579     if(constraints->per_constraints) {
580         const asn_per_constraint_t *pc = &constraints->per_constraints->size;
581         if(pc->flags & APC_CONSTRAINED) {
582             long suggested_upper_bound = pc->upper_bound < (ssize_t)max_length
583                                              ? pc->upper_bound
584                                              : (ssize_t)max_length;
585             if(max_length < (size_t)pc->lower_bound) {
586                 return result_skipped;
587             }
588             if(pc->flags & APC_EXTENSIBLE) {
589                 switch(asn_random_between(0, 5)) {
590                 case 0:
591                     if(pc->lower_bound > 0) {
592                         rnd_bits = pc->lower_bound - 1;
593                         break;
594                     }
595                     /* Fall through */
596                 case 1:
597                     rnd_bits = pc->upper_bound + 1;
598                     break;
599                 case 2:
600                     /* Keep rnd_bits from the table */
601                     if(rnd_bits < max_length) {
602                         break;
603                     }
604                     /* Fall through */
605                 default:
606                     rnd_bits = asn_random_between(pc->lower_bound,
607                                                   suggested_upper_bound);
608                 }
609             } else {
610                 rnd_bits =
611                     asn_random_between(pc->lower_bound, suggested_upper_bound);
612             }
613         } else {
614             rnd_bits = asn_random_between(0, max_length - 1);
615         }
616     } else if(rnd_bits >= max_length) {
617         rnd_bits = asn_random_between(0, max_length - 1);
618     }
619
620     rnd_len = (rnd_bits + 7) / 8;
621     buf = CALLOC(1, rnd_len + 1);
622     if(!buf) return result_failed;
623
624     bend = &buf[rnd_len];
625
626     for(b = buf; b < bend; b++) {
627         *(uint8_t *)b = asn_random_between(0, 255);
628     }
629     *b = 0; /* Zero-terminate just in case. */
630
631     if(*sptr) {
632         st = *sptr;
633         FREEMEM(st->buf);
634     } else {
635         st = (BIT_STRING_t *)(*sptr = CALLOC(1, specs->struct_size));
636         if(!st) {
637             FREEMEM(buf);
638             return result_failed;
639         }
640     }
641
642     st->buf = buf;
643     st->size = rnd_len;
644     st->bits_unused = (8 - (rnd_bits & 0x7)) & 0x7;
645     if(st->bits_unused) {
646         assert(st->size > 0);
647         st->buf[st->size-1] &= 0xff << st->bits_unused;
648     }
649
650     result_ok.length = st->size;
651     return result_ok;
652 }