blob: e93944edc2a7fecef22c0281151fec9ea16b2b49 [file] [log] [blame]
Lev Walkinf15320b2004-06-03 03:38:44 +00001/*-
Lev Walkin20696a42017-10-17 21:27:33 -07002 * Copyright (c) 2003-2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
Lev Walkinf15320b2004-06-03 03:38:44 +00003 * Redistribution and modifications are permitted subject to BSD license.
4 */
5#ifndef _DER_ENCODER_H_
6#define _DER_ENCODER_H_
7
Lev Walkin11c3e172004-09-24 21:00:50 +00008#include <asn_application.h>
Lev Walkinf15320b2004-06-03 03:38:44 +00009
Lev Walkin21b41ac2005-07-24 09:03:44 +000010#ifdef __cplusplus
11extern "C" {
12#endif
13
Lev Walkin5e033762004-09-29 13:26:15 +000014struct asn_TYPE_descriptor_s; /* Forward declaration */
Lev Walkinf15320b2004-06-03 03:38:44 +000015
16/*
Lev Walkinf15320b2004-06-03 03:38:44 +000017 * The DER encoder of any type. May be invoked by the application.
Lev Walkin28647742017-09-12 11:07:06 -070018 * Produces DER- and BER-compliant encoding. (DER is a subset of BER).
19 *
20 * NOTE: Use the ber_decode() function (ber_decoder.h) to decode data
21 * produced by der_encode().
Lev Walkinf15320b2004-06-03 03:38:44 +000022 */
Lev Walkin20696a42017-10-17 21:27:33 -070023asn_enc_rval_t der_encode(const struct asn_TYPE_descriptor_s *type_descriptor,
24 const void *struct_ptr, /* Structure to be encoded */
25 asn_app_consume_bytes_f *consume_bytes_cb,
26 void *app_key /* Arbitrary callback argument */
27);
Lev Walkinf15320b2004-06-03 03:38:44 +000028
Lev Walkinc4676a82004-11-16 09:46:00 +000029/* A variant of der_encode() which encodes data into the pre-allocated buffer */
30asn_enc_rval_t der_encode_to_buffer(
Lev Walkin20696a42017-10-17 21:27:33 -070031 const struct asn_TYPE_descriptor_s *type_descriptor,
32 const void *struct_ptr, /* Structure to be encoded */
33 void *buffer, /* Pre-allocated buffer */
34 size_t buffer_size /* Initial buffer size (maximum) */
35);
Lev Walkinc4676a82004-11-16 09:46:00 +000036
Lev Walkinf15320b2004-06-03 03:38:44 +000037/*
38 * Type of the generic DER encoder.
39 */
Lev Walkin20696a42017-10-17 21:27:33 -070040typedef asn_enc_rval_t(der_type_encoder_f)(
41 const struct asn_TYPE_descriptor_s *type_descriptor,
42 const void *struct_ptr, /* Structure to be encoded */
43 int tag_mode, /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
44 ber_tlv_tag_t tag, asn_app_consume_bytes_f *consume_bytes_cb, /* Callback */
45 void *app_key /* Arbitrary callback argument */
46);
Lev Walkinf15320b2004-06-03 03:38:44 +000047
48
49/*******************************
50 * INTERNALLY USEFUL FUNCTIONS *
51 *******************************/
52
53/*
54 * Write out leading TL[v] sequence according to the type definition.
55 */
Lev Walkin20696a42017-10-17 21:27:33 -070056ssize_t der_write_tags(const struct asn_TYPE_descriptor_s *type_descriptor,
57 size_t struct_length,
58 int tag_mode, /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
59 int last_tag_form, /* {0,!0}: prim, constructed */
60 ber_tlv_tag_t tag,
61 asn_app_consume_bytes_f *consume_bytes_cb,
62 void *app_key);
Lev Walkinf15320b2004-06-03 03:38:44 +000063
Lev Walkin21b41ac2005-07-24 09:03:44 +000064#ifdef __cplusplus
65}
66#endif
67
Lev Walkinf15320b2004-06-03 03:38:44 +000068#endif /* _DER_ENCODER_H_ */