der_encoder.h 2.08 KB
Newer Older
yangjian's avatar
yangjian committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*-
 * Copyright (c) 2003-2017 Lev Walkin <vlm@lionet.info>. All rights reserved.
 * Redistribution and modifications are permitted subject to BSD license.
 */
#ifndef _DER_ENCODER_H_
#define _DER_ENCODER_H_

#include <asn_application.h>

#ifdef __cplusplus
extern "C" {
#endif

struct asn_TYPE_descriptor_s; /* Forward declaration */

/*
 * The DER encoder of any type. May be invoked by the application.
 * Produces DER- and BER-compliant encoding. (DER is a subset of BER).
 *
 * NOTE: Use the ber_decode() function (ber_decoder.h) to decode data
 * produced by der_encode().
 */
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
23 24 25 26 27
asn_enc_rval_t der_encode(
    const struct asn_TYPE_descriptor_s* type_descriptor,
    const void* struct_ptr, /* Structure to be encoded */
    asn_app_consume_bytes_f* consume_bytes_cb,
    void* app_key /* Arbitrary callback argument */
yangjian's avatar
yangjian committed
28 29 30
);

/* A variant of der_encode() which encodes data into the pre-allocated buffer */
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
31 32 33 34 35
asn_enc_rval_t der_encode_to_buffer(
    const struct asn_TYPE_descriptor_s* type_descriptor,
    const void* struct_ptr, /* Structure to be encoded */
    void* buffer,           /* Pre-allocated buffer */
    size_t buffer_size      /* Initial buffer size (maximum) */
yangjian's avatar
yangjian committed
36 37 38 39 40 41
);

/*
 * Type of the generic DER encoder.
 */
typedef asn_enc_rval_t(der_type_encoder_f)(
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
42 43
    const struct asn_TYPE_descriptor_s* type_descriptor,
    const void* struct_ptr, /* Structure to be encoded */
yangjian's avatar
yangjian committed
44
    int tag_mode,           /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
45 46
    ber_tlv_tag_t tag, asn_app_consume_bytes_f* consume_bytes_cb, /* Callback */
    void* app_key /* Arbitrary callback argument */
yangjian's avatar
yangjian committed
47 48 49 50 51 52 53 54 55
);

/*******************************
 * INTERNALLY USEFUL FUNCTIONS *
 *******************************/

/*
 * Write out leading TL[v] sequence according to the type definition.
 */
Tien-Thinh Nguyen's avatar
Tien-Thinh Nguyen committed
56 57 58 59 60 61
ssize_t der_write_tags(
    const struct asn_TYPE_descriptor_s* type_descriptor, size_t struct_length,
    int tag_mode,      /* {-1,0,1}: IMPLICIT, no, EXPLICIT */
    int last_tag_form, /* {0,!0}: prim, constructed */
    ber_tlv_tag_t tag, asn_app_consume_bytes_f* consume_bytes_cb,
    void* app_key);
yangjian's avatar
yangjian committed
62 63 64 65 66 67

#ifdef __cplusplus
}
#endif

#endif /* _DER_ENCODER_H_ */