2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 /* Experimental ASN1 BIO. When written through the data is converted
60 * to an ASN1 string type: default is OCTET STRING. Additional functions
61 * can be provided to add prefix and suffix data.
65 #include <openssl/bio.h>
66 #include <openssl/asn1.h>
68 /* Must be large enough for biggest tag+length */
69 #define DEFAULT_ASN1_BUF_SIZE 20
76 ASN1_STATE_HEADER_COPY,
82 typedef struct BIO_ASN1_EX_FUNCS_st
84 asn1_ps_func *ex_func;
85 asn1_ps_func *ex_free_func;
88 typedef struct BIO_ASN1_BUF_CTX_t
91 asn1_bio_state_t state;
96 /* Current position in buffer */
98 /* Current buffer length */
100 /* Amount of data to copy */
102 /* Class and tag to use */
103 int asn1_class, asn1_tag;
104 asn1_ps_func *prefix, *prefix_free, *suffix, *suffix_free;
105 /* Extra buffer for prefix and suffix data */
106 unsigned char *ex_buf;
113 static int asn1_bio_write(BIO *h, const char *buf,int num);
114 static int asn1_bio_read(BIO *h, char *buf, int size);
115 static int asn1_bio_puts(BIO *h, const char *str);
116 static int asn1_bio_gets(BIO *h, char *str, int size);
117 static long asn1_bio_ctrl(BIO *h, int cmd, long arg1, void *arg2);
118 static int asn1_bio_new(BIO *h);
119 static int asn1_bio_free(BIO *data);
120 static long asn1_bio_callback_ctrl(BIO *h, int cmd, bio_info_cb *fp);
122 static int asn1_bio_init(BIO_ASN1_BUF_CTX *ctx, int size);
123 static int asn1_bio_flush_ex(BIO *b, BIO_ASN1_BUF_CTX *ctx,
124 asn1_ps_func *cleanup, asn1_bio_state_t next);
125 static int asn1_bio_setup_ex(BIO *b, BIO_ASN1_BUF_CTX *ctx,
127 asn1_bio_state_t ex_state,
128 asn1_bio_state_t other_state);
130 static BIO_METHOD methods_asn1=
141 asn1_bio_callback_ctrl,
144 BIO_METHOD *BIO_f_asn1(void)
146 return(&methods_asn1);
150 static int asn1_bio_new(BIO *b)
152 BIO_ASN1_BUF_CTX *ctx;
153 ctx = OPENSSL_malloc(sizeof(BIO_ASN1_BUF_CTX));
156 if (!asn1_bio_init(ctx, DEFAULT_ASN1_BUF_SIZE))
159 b->ptr = (char *)ctx;
164 static int asn1_bio_init(BIO_ASN1_BUF_CTX *ctx, int size)
166 ctx->buf = OPENSSL_malloc(size);
173 ctx->asn1_class = V_ASN1_UNIVERSAL;
174 ctx->asn1_tag = V_ASN1_OCTET_STRING;
178 ctx->state = ASN1_STATE_START;
182 static int asn1_bio_free(BIO *b)
184 BIO_ASN1_BUF_CTX *ctx;
185 ctx = (BIO_ASN1_BUF_CTX *) b->ptr;
189 OPENSSL_free(ctx->buf);
197 static int asn1_bio_write(BIO *b, const char *in , int inl)
199 BIO_ASN1_BUF_CTX *ctx;
200 int wrmax, wrlen, ret;
202 if (!in || (inl < 0) || (b->next_bio == NULL))
204 ctx = (BIO_ASN1_BUF_CTX *) b->ptr;
216 /* Setup prefix data, call it */
217 case ASN1_STATE_START:
218 if (!asn1_bio_setup_ex(b, ctx, ctx->prefix,
219 ASN1_STATE_PRE_COPY, ASN1_STATE_HEADER))
223 /* Copy any pre data first */
224 case ASN1_STATE_PRE_COPY:
226 ret = asn1_bio_flush_ex(b, ctx, ctx->prefix_free,
234 case ASN1_STATE_HEADER:
236 ASN1_object_size(0, inl, ctx->asn1_tag) - inl;
237 OPENSSL_assert(ctx->buflen <= ctx->bufsize);
239 ASN1_put_object(&p, 0, inl,
240 ctx->asn1_tag, ctx->asn1_class);
242 ctx->state = ASN1_STATE_HEADER_COPY;
246 case ASN1_STATE_HEADER_COPY:
247 ret = BIO_write(b->next_bio,
248 ctx->buf + ctx->bufpos, ctx->buflen);
258 ctx->state = ASN1_STATE_DATA_COPY;
263 case ASN1_STATE_DATA_COPY:
265 if (inl > ctx->copylen)
266 wrmax = ctx->copylen;
269 ret = BIO_write(b->next_bio, in, wrmax);
277 if (ctx->copylen == 0)
278 ctx->state = ASN1_STATE_HEADER;
286 BIO_clear_retry_flags(b);
294 BIO_clear_retry_flags(b);
295 BIO_copy_next_retry(b);
297 return (wrlen > 0) ? wrlen : ret;
301 static int asn1_bio_flush_ex(BIO *b, BIO_ASN1_BUF_CTX *ctx,
302 asn1_ps_func *cleanup, asn1_bio_state_t next)
305 if (ctx->ex_len <= 0)
309 ret = BIO_write(b->next_bio, ctx->ex_buf + ctx->ex_pos,
319 cleanup(b, &ctx->ex_buf, &ctx->ex_len,
329 static int asn1_bio_setup_ex(BIO *b, BIO_ASN1_BUF_CTX *ctx,
331 asn1_bio_state_t ex_state,
332 asn1_bio_state_t other_state)
334 if (setup && !setup(b, &ctx->ex_buf, &ctx->ex_len, &ctx->ex_arg))
336 BIO_clear_retry_flags(b);
340 ctx->state = ex_state;
342 ctx->state = other_state;
346 static int asn1_bio_read(BIO *b, char *in , int inl)
350 return BIO_read(b->next_bio, in , inl);
353 static int asn1_bio_puts(BIO *b, const char *str)
355 return asn1_bio_write(b, str, strlen(str));
358 static int asn1_bio_gets(BIO *b, char *str, int size)
362 return BIO_gets(b->next_bio, str , size);
365 static long asn1_bio_callback_ctrl(BIO *b, int cmd, bio_info_cb *fp)
367 if (b->next_bio == NULL) return(0);
368 return BIO_callback_ctrl(b->next_bio,cmd,fp);
371 static long asn1_bio_ctrl(BIO *b, int cmd, long arg1, void *arg2)
373 BIO_ASN1_BUF_CTX *ctx;
374 BIO_ASN1_EX_FUNCS *ex_func;
376 ctx = (BIO_ASN1_BUF_CTX *) b->ptr;
382 case BIO_C_SET_PREFIX:
384 ctx->prefix = ex_func->ex_func;
385 ctx->prefix_free = ex_func->ex_free_func;
388 case BIO_C_GET_PREFIX:
390 ex_func->ex_func = ctx->prefix;
391 ex_func->ex_free_func = ctx->prefix_free;
394 case BIO_C_SET_SUFFIX:
396 ctx->suffix = ex_func->ex_func;
397 ctx->suffix_free = ex_func->ex_free_func;
400 case BIO_C_GET_SUFFIX:
402 ex_func->ex_func = ctx->suffix;
403 ex_func->ex_free_func = ctx->suffix_free;
406 case BIO_C_SET_EX_ARG:
410 case BIO_C_GET_EX_ARG:
411 *(void **)arg2 = ctx->ex_arg;
418 /* Call post function if possible */
419 if (ctx->state == ASN1_STATE_HEADER)
421 if (!asn1_bio_setup_ex(b, ctx, ctx->suffix,
422 ASN1_STATE_POST_COPY, ASN1_STATE_DONE))
426 if (ctx->state == ASN1_STATE_POST_COPY)
428 ret = asn1_bio_flush_ex(b, ctx, ctx->suffix_free,
434 if (ctx->state == ASN1_STATE_DONE)
435 return BIO_ctrl(b->next_bio, cmd, arg1, arg2);
438 BIO_clear_retry_flags(b);
447 return BIO_ctrl(b->next_bio, cmd, arg1, arg2);
454 static int asn1_bio_set_ex(BIO *b, int cmd,
455 asn1_ps_func *ex_func, asn1_ps_func *ex_free_func)
457 BIO_ASN1_EX_FUNCS extmp;
458 extmp.ex_func = ex_func;
459 extmp.ex_free_func = ex_free_func;
460 return BIO_ctrl(b, cmd, 0, &extmp);
463 static int asn1_bio_get_ex(BIO *b, int cmd,
464 asn1_ps_func **ex_func, asn1_ps_func **ex_free_func)
466 BIO_ASN1_EX_FUNCS extmp;
468 ret = BIO_ctrl(b, cmd, 0, &extmp);
471 *ex_func = extmp.ex_func;
472 *ex_free_func = extmp.ex_free_func;
477 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix, asn1_ps_func *prefix_free)
479 return asn1_bio_set_ex(b, BIO_C_SET_PREFIX, prefix, prefix_free);
482 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix, asn1_ps_func **pprefix_free)
484 return asn1_bio_get_ex(b, BIO_C_GET_PREFIX, pprefix, pprefix_free);
487 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix, asn1_ps_func *suffix_free)
489 return asn1_bio_set_ex(b, BIO_C_SET_SUFFIX, suffix, suffix_free);
492 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix, asn1_ps_func **psuffix_free)
494 return asn1_bio_get_ex(b, BIO_C_GET_SUFFIX, psuffix, psuffix_free);