bsl_asn1.h

/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
 
#ifndef BSL_ASN1_H
#define BSL_ASN1_H
 
#include <stdint.h>
#include "bsl_types.h"
#include "bsl_list.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BSL_ASN1_CLASS_UNIVERSAL       0x0   /* bit8 0, bit7 0 */
#define BSL_ASN1_CLASS_APPLICATION     0x40  /* bit8 0, bit7 1 */
#define BSL_ASN1_CLASS_CTX_SPECIFIC    0x80  /* bit8 1, bit7 0 */
#define BSL_ASN1_CLASS_PRIVATE         0xC0  /* bit8 1, bit7 1 */
 
#define BSL_ASN1_TAG_CONSTRUCTED       0x20
 
/* ASN1 tag from x.680  */
#define BSL_ASN1_TAG_BOOLEAN           0x01
#define BSL_ASN1_TAG_INTEGER           0x02
#define BSL_ASN1_TAG_BITSTRING         0x03
#define BSL_ASN1_TAG_OCTETSTRING       0x04
#define BSL_ASN1_TAG_NULL              0x05
#define BSL_ASN1_TAG_OBJECT_ID         0x06
#define BSL_ASN1_TAG_OBJECT_DESCP      0x07
#define BSL_ASN1_TAG_INSTANCE_OF       0x08
#define BSL_ASN1_TAG_REAL              0x09
#define BSL_ASN1_TAG_ENUMERATED        0x0A
#define BSL_ASN1_TAG_EMBEDDED_PDV      0x0B
#define BSL_ASN1_TAG_UTF8STRING        0x0C
#define BSL_ASN1_TAG_RALATIVE_ID       0x0D
#define BSL_ASN1_TAG_TIME              0x0E
#define BSL_ASN1_TAG_SEQUENCE          0x10
#define BSL_ASN1_TAG_SET               0x11
#define BSL_ASN1_TAG_PRINTABLESTRING   0x13
#define BSL_ASN1_TAG_TELETEXSTRING     0x14
#define BSL_ASN1_TAG_T61STRING         BSL_ASN1_TAG_TELETEXSTRING
#define BSL_ASN1_TAG_IA5STRING         0x16
 
#define BSL_ASN1_TAG_UTCTIME           0x17
#define BSL_ASN1_TAG_GENERALIZEDTIME   0x18
#define BSL_ASN1_TAG_UNIVERSALSTRING   0x1C
#define BSL_ASN1_TAG_BMPSTRING         0x1E
 
/* Custom types, use private class to prevent conflicts */
#define BSL_ASN1_TAG_CHOICE (BSL_ASN1_CLASS_PRIVATE | 1)
#define BSL_ASN1_TAG_ANY (BSL_ASN1_CLASS_PRIVATE | 2)
#define BSL_ASN1_TAG_EMPTY 0x00 /* Empty tag, used to indicate that the tag is not encoded */
 
/* The current value is flags, is used to guide asn1 encoding or decoding */
#define BSL_ASN1_FLAG_OPTIONAL 1
/* The current value is default, is used to guide asn1 encoding or decoding */
#define BSL_ASN1_FLAG_DEFAULT  2
/* Only parsing or encoding headers, and child nodes are not traversed */
#define BSL_ASN1_FLAG_HEADERONLY 4
/* The implied values are of the same type */
#define BSL_ASN1_FLAG_SAME 8
 
#define BSL_ASN1_List BslList
 
typedef struct _BSL_ASN1_TemplateItem {
    /* exptect tag */
    uint8_t tag;
    /* corresponding to the tag flag */
    uint8_t flags : 5;
    uint8_t depth : 3;
} BSL_ASN1_TemplateItem;
 
typedef struct _BSL_ASN1_Template {
    BSL_ASN1_TemplateItem *templItems;
    uint32_t templNum;
} BSL_ASN1_Template;
 
typedef struct _BSL_ASN1_Buffer {
    uint8_t tag;
    uint32_t len;
    uint8_t *buff;
} BSL_ASN1_Buffer;
 
typedef struct _BSL_ASN1_BitString {
    uint8_t *buff;
    uint32_t len;
    uint8_t unusedBits;
} BSL_ASN1_BitString;
 

typedef int32_t(*BSL_ASN1_DecTemplCallBack)(int32_t type, uint32_t idx, void *data, void *expVal);

typedef int32_t(*BSL_ASN1_ParseListAsnItem)(uint32_t layer, BSL_ASN1_Buffer *asn, void *cbParam, BSL_ASN1_List *list);
 
typedef struct _BSL_ASN1_DecodeListParam {
    uint32_t layer;
    uint8_t *expTag;
} BSL_ASN1_DecodeListParam;

int32_t BSL_ASN1_DecodeTagLen(uint8_t tag, uint8_t **encode, uint32_t *encLen, uint32_t *valLen);

int32_t BSL_ASN1_DecodeListItem(BSL_ASN1_DecodeListParam *param, BSL_ASN1_Buffer *asn,
    BSL_ASN1_ParseListAsnItem parseListItemCb, void *cbParam, BSL_ASN1_List *list);

int32_t BSL_ASN1_DecodeTemplate(BSL_ASN1_Template *templ, BSL_ASN1_DecTemplCallBack decTemlCb,
    uint8_t **encode, uint32_t *encLen, BSL_ASN1_Buffer *asnArr, uint32_t arrNum);

int32_t BSL_ASN1_EncodeTemplate(BSL_ASN1_Template *templ, BSL_ASN1_Buffer *asnArr, uint32_t arrNum,
    uint8_t **encode, uint32_t *encLen);

int32_t BSL_ASN1_EncodeListItem(uint8_t tag, uint32_t listSize, BSL_ASN1_Template *templ, BSL_ASN1_Buffer *asnArr,
    uint32_t arrNum, BSL_ASN1_Buffer *out);
 
#ifdef __cplusplus
}
#endif
 
#endif // BSL_ASN1_H