| Current File : //usr/include/libtasn1.h |
/*
* Copyright (C) 2002, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free
* Software Foundation, Inc.
*
* This file is part of LIBTASN1.
*
* LIBTASN1 is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* LIBTASN1 is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with LIBTASN1; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA
*
*/
#ifndef LIBTASN1_H
# define LIBTASN1_H
# ifndef ASN1_API
# if defined ASN1_BUILDING && defined HAVE_VISIBILITY && HAVE_VISIBILITY
# define ASN1_API __attribute__((__visibility__("default")))
# elif defined ASN1_BUILDING && defined _MSC_VER && ! defined ASN1_STATIC
# define ASN1_API __declspec(dllexport)
# elif defined _MSC_VER && ! defined ASN1_STATIC
# define ASN1_API __declspec(dllimport)
# else
# define ASN1_API
# endif
# endif
#include <stdio.h> /* for FILE* */
#include <sys/types.h>
#include <time.h>
#ifdef __cplusplus
extern "C"
{
#endif
#define ASN1_VERSION "2.8"
#if defined(__GNUC__) && !defined(ASN1_INTERNAL_BUILD)
# define _ASN1_GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
# if _ASN1_GCC_VERSION >= 30100
# define _ASN1_GCC_ATTR_DEPRECATED __attribute__ ((__deprecated__))
# endif
#endif
#ifndef _ASN1_GCC_ATTR_DEPRECATED
#define _ASN1_GCC_ATTR_DEPRECATED
#endif
typedef int asn1_retCode; /* type returned by libtasn1 functions */
/*****************************************/
/* Errors returned by libtasn1 functions */
/*****************************************/
#define ASN1_SUCCESS 0
#define ASN1_FILE_NOT_FOUND 1
#define ASN1_ELEMENT_NOT_FOUND 2
#define ASN1_IDENTIFIER_NOT_FOUND 3
#define ASN1_DER_ERROR 4
#define ASN1_VALUE_NOT_FOUND 5
#define ASN1_GENERIC_ERROR 6
#define ASN1_VALUE_NOT_VALID 7
#define ASN1_TAG_ERROR 8
#define ASN1_TAG_IMPLICIT 9
#define ASN1_ERROR_TYPE_ANY 10
#define ASN1_SYNTAX_ERROR 11
#define ASN1_MEM_ERROR 12
#define ASN1_MEM_ALLOC_ERROR 13
#define ASN1_DER_OVERFLOW 14
#define ASN1_NAME_TOO_LONG 15
#define ASN1_ARRAY_ERROR 16
#define ASN1_ELEMENT_NOT_EMPTY 17
/*************************************/
/* Constants used in asn1_visit_tree */
/*************************************/
#define ASN1_PRINT_NAME 1
#define ASN1_PRINT_NAME_TYPE 2
#define ASN1_PRINT_NAME_TYPE_VALUE 3
#define ASN1_PRINT_ALL 4
/*****************************************/
/* Constants returned by asn1_read_tag */
/*****************************************/
#define ASN1_CLASS_UNIVERSAL 0x00 /* old: 1 */
#define ASN1_CLASS_APPLICATION 0x40 /* old: 2 */
#define ASN1_CLASS_CONTEXT_SPECIFIC 0x80 /* old: 3 */
#define ASN1_CLASS_PRIVATE 0xC0 /* old: 4 */
#define ASN1_CLASS_STRUCTURED 0x20
/*****************************************/
/* Constants returned by asn1_read_tag */
/*****************************************/
#define ASN1_TAG_BOOLEAN 0x01
#define ASN1_TAG_INTEGER 0x02
#define ASN1_TAG_SEQUENCE 0x10
#define ASN1_TAG_SET 0x11
#define ASN1_TAG_OCTET_STRING 0x04
#define ASN1_TAG_BIT_STRING 0x03
#define ASN1_TAG_UTCTime 0x17
#define ASN1_TAG_GENERALIZEDTime 0x18
#define ASN1_TAG_OBJECT_ID 0x06
#define ASN1_TAG_ENUMERATED 0x0A
#define ASN1_TAG_NULL 0x05
#define ASN1_TAG_GENERALSTRING 0x1B
#define ASN1_TAG_NUMERIC_STRING 0x12
#define ASN1_TAG_IA5_STRING 0x16
#define ASN1_TAG_TELETEX_STRING 0x14
#define ASN1_TAG_PRINTABLE_STRING 0x13
#define ASN1_TAG_UNIVERSAL_STRING 0x1C
#define ASN1_TAG_BMP_STRING 0x1E
#define ASN1_TAG_UTF8_STRING 0x0C
#define ASN1_TAG_VISIBLE_STRING 0x1A
/******************************************************/
/* Structure definition used for the node of the tree */
/* that represent an ASN.1 DEFINITION. */
/******************************************************/
/* maximum number of characters of a name */
/* inside a file with ASN1 definitons */
#define ASN1_MAX_NAME_SIZE 64
typedef struct node_asn_struct node_asn;
typedef node_asn *ASN1_TYPE;
#if !defined ASN1_BUILDING
/* This structure is also in internal.h, but then contains more
fields. You cannot make any modifications to these fields
without breaking ABI. */
struct node_asn_struct
{
char name[ASN1_MAX_NAME_SIZE + 1]; /* Node name */
unsigned int name_hash;
unsigned int type; /* Node type */
unsigned char *value; /* Node value */
int value_len;
ASN1_TYPE down; /* Pointer to the son node */
ASN1_TYPE right; /* Pointer to the brother node */
ASN1_TYPE left; /* Pointer to the next list element */
};
#endif
#define ASN1_TYPE_EMPTY NULL
#define ASN1_DELETE_FLAG_ZEROIZE 1
/*****************************************/
/* For the on-disk format of ASN.1 trees */
/*****************************************/
struct static_struct_asn
{
const char *name; /* Node name */
unsigned int type; /* Node type */
const void *value; /* Node value */
};
typedef struct static_struct_asn ASN1_ARRAY_TYPE;
struct asn1_data_node_st
{
const char *name; /* Node name */
const void *value; /* Node value */
unsigned int value_len; /* Node value size */
unsigned int type; /* Node value type (TYPE_*) */
};
typedef struct asn1_data_node_st asn1_data_node_st;
/***********************************/
/* Fixed constants */
/***********************************/
/* maximum number of characters */
/* of a description message */
/* (null character included) */
#define ASN1_MAX_ERROR_DESCRIPTION_SIZE 128
/***********************************/
/* Functions definitions */
/***********************************/
extern ASN1_API asn1_retCode
asn1_parser2tree (const char *file_name,
ASN1_TYPE * definitions, char *errorDescription);
extern ASN1_API asn1_retCode
asn1_parser2array (const char *inputFileName,
const char *outputFileName,
const char *vectorName, char *errorDescription);
extern ASN1_API asn1_retCode
asn1_array2tree (const ASN1_ARRAY_TYPE * array,
ASN1_TYPE * definitions, char *errorDescription);
extern ASN1_API void
asn1_print_structure (FILE * out, ASN1_TYPE structure,
const char *name, int mode);
extern ASN1_API asn1_retCode
asn1_create_element (ASN1_TYPE definitions,
const char *source_name, ASN1_TYPE * element);
extern ASN1_API asn1_retCode asn1_delete_structure (ASN1_TYPE * structure);
extern ASN1_API asn1_retCode asn1_delete_structure2 (ASN1_TYPE * structure, unsigned int flags);
extern ASN1_API asn1_retCode
asn1_delete_element (ASN1_TYPE structure, const char *element_name);
extern ASN1_API asn1_retCode
asn1_write_value (ASN1_TYPE node_root, const char *name,
const void *ivalue, int len);
extern ASN1_API asn1_retCode
asn1_read_value (ASN1_TYPE root, const char *name,
void *ivalue, int *len);
extern ASN1_API asn1_retCode
asn1_read_value_type (ASN1_TYPE root, const char *name,
void *ivalue, int *len, unsigned int *etype);
extern ASN1_API asn1_retCode
asn1_read_node_value (ASN1_TYPE node, asn1_data_node_st * data);
extern ASN1_API asn1_retCode
asn1_number_of_elements (ASN1_TYPE element, const char *name, int *num);
extern ASN1_API asn1_retCode
asn1_der_coding (ASN1_TYPE element, const char *name,
void *ider, int *len, char *ErrorDescription);
extern ASN1_API asn1_retCode
asn1_der_decoding (ASN1_TYPE * element, const void *ider,
int len, char *errorDescription);
extern ASN1_API asn1_retCode
asn1_der_decoding_element (ASN1_TYPE * structure,
const char *elementName,
const void *ider, int len,
char *errorDescription); _ASN1_GCC_ATTR_DEPRECATED;
extern ASN1_API asn1_retCode
asn1_der_decoding_startEnd (ASN1_TYPE element,
const void *ider, int len,
const char *name_element,
int *start, int *end);
extern ASN1_API asn1_retCode
asn1_expand_any_defined_by (ASN1_TYPE definitions, ASN1_TYPE * element);
extern ASN1_API asn1_retCode
asn1_expand_octet_string (ASN1_TYPE definitions,
ASN1_TYPE * element,
const char *octetName, const char *objectName);
extern ASN1_API asn1_retCode
asn1_read_tag (ASN1_TYPE root, const char *name,
int *tagValue, int *classValue);
extern ASN1_API const char *asn1_find_structure_from_oid (ASN1_TYPE
definitions,
const char
*oidValue);
extern ASN1_API const char *asn1_check_version (const char *req_version);
extern ASN1_API const char *asn1_strerror (asn1_retCode error);
extern ASN1_API void asn1_perror (asn1_retCode error);
#define ASN1_MAX_TAG_SIZE 4
#define ASN1_MAX_LENGTH_SIZE 9
#define ASN1_MAX_TL_SIZE (ASN1_MAX_TAG_SIZE+ASN1_MAX_LENGTH_SIZE)
/* DER utility functions. */
extern ASN1_API int
asn1_get_tag_der (const unsigned char *der, int der_len,
unsigned char *cls, int *len, unsigned long *tag);
extern ASN1_API void
asn1_octet_der (const unsigned char *str, int str_len,
unsigned char *der, int *der_len);
extern ASN1_API asn1_retCode
asn1_get_octet_der (const unsigned char *der, int der_len,
int *ret_len, unsigned char *str,
int str_size, int *str_len);
extern ASN1_API void asn1_bit_der (const unsigned char *str, int bit_len,
unsigned char *der, int *der_len);
extern ASN1_API asn1_retCode
asn1_get_bit_der (const unsigned char *der, int der_len,
int *ret_len, unsigned char *str,
int str_size, int *bit_len);
extern ASN1_API signed long
asn1_get_length_der (const unsigned char *der, int der_len, int *len);
extern ASN1_API signed long
asn1_get_length_ber (const unsigned char *ber, int ber_len, int *len);
extern ASN1_API void
asn1_length_der (unsigned long int len, unsigned char *ans, int *ans_len);
/* Other utility functions. */
extern ASN1_API
int asn1_decode_simple_der (unsigned int etype, const unsigned char *der,
unsigned int der_len,
const unsigned char **str,
unsigned int *str_len);
extern ASN1_API int
asn1_encode_simple_der (unsigned int etype, const unsigned char *str,
unsigned int str_len, unsigned char *tl,
unsigned int *tl_len);
extern ASN1_API ASN1_TYPE
asn1_find_node (ASN1_TYPE pointer, const char *name);
extern ASN1_API asn1_retCode
asn1_copy_node (ASN1_TYPE dst, const char *dst_name,
ASN1_TYPE src, const char *src_name);
/* Deprecated stuff. */
#ifndef ASN1_DISABLE_DEPRECATED
#define LIBTASN1_VERSION ASN1_VERSION
#ifndef MAX_NAME_SIZE
# define MAX_NAME_SIZE ASN1_MAX_NAME_SIZE
#endif
#ifndef MAX_ERROR_DESCRIPTION_SIZE
# define MAX_ERROR_DESCRIPTION_SIZE ASN1_MAX_ERROR_DESCRIPTION_SIZE
#endif
#ifndef __attribute__
/* This feature is available in gcc versions 2.5 and later. */
# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5)
# define __attribute__(Spec) /* empty */
# endif
#endif
/* Use asn1_strerror instead. */
extern ASN1_API const char *libtasn1_strerror (asn1_retCode error)
__attribute__ ((deprecated));
/* Use asn1_perror instead. */
extern ASN1_API void
libtasn1_perror (asn1_retCode error) __attribute__ ((deprecated));
#endif
#ifdef __cplusplus
}
#endif
#endif /* LIBTASN1_H */