Top |
The Libtasn1 library provides Abstract Syntax Notation One (ASN.1, as specified by the X.680 ITU-T recommendation) parsing and structures management, and Distinguished Encoding Rules (DER, as per X.690) encoding and decoding functions.
int asn1_parser2tree (const char *file
,asn1_node *definitions
,char *error_desc
);
Function used to start the parse algorithm. Creates the structures
needed to manage the definitions included in file
file.
file |
specify the path and the name of file that contains ASN.1 declarations. |
|
definitions |
return the pointer to the structure created from "file" ASN.1 declarations. |
|
error_desc |
return the error description or an empty string if success. |
ASN1_SUCCESS
if the file has a correct syntax and every
identifier is known, ASN1_ELEMENT_NOT_EMPTY
if definitions
not
NULL
, ASN1_FILE_NOT_FOUND
if an error occurred while
opening file
, ASN1_SYNTAX_ERROR
if the syntax is not
correct, ASN1_IDENTIFIER_NOT_FOUND
if in the file there is an
identifier that is not defined, ASN1_NAME_TOO_LONG
if in the
file there is an identifier with more than ASN1_MAX_NAME_SIZE
characters.
int asn1_parser2array (const char *inputFileName
,const char *outputFileName
,const char *vectorName
,char *error_desc
);
Function that generates a C structure from an ASN1 file. Creates a
file containing a C vector to use to manage the definitions
included in inputFileName
file. If inputFileName
is
"/aa/bb/xx.yy" and outputFileName
is NULL
, the file created is
"/aa/bb/xx_asn1_tab.c". If vectorName
is NULL
the vector name
will be "xx_asn1_tab".
inputFileName |
specify the path and the name of file that contains ASN.1 declarations. |
|
outputFileName |
specify the path and the name of file that will contain the C vector definition. |
|
vectorName |
specify the name of the C vector. |
|
error_desc |
return the error description or an empty string if success. |
ASN1_SUCCESS
if the file has a correct syntax and every
identifier is known, ASN1_FILE_NOT_FOUND
if an error occurred
while opening inputFileName
, ASN1_SYNTAX_ERROR
if the syntax is
not correct, ASN1_IDENTIFIER_NOT_FOUND
if in the file there is
an identifier that is not defined, ASN1_NAME_TOO_LONG
if in the
file there is an identifier with more than ASN1_MAX_NAME_SIZE
characters.
int asn1_array2tree (const asn1_static_node *array
,asn1_node *definitions
,char *errorDescription
);
Creates the structures needed to manage the ASN.1 definitions.
array
is a vector created by asn1_parser2array()
.
array |
specify the array that contains ASN.1 declarations |
|
definitions |
return the pointer to the structure created by *ARRAY ASN.1 declarations |
|
errorDescription |
return the error description. |
ASN1_SUCCESS
if structure was created correctly,
ASN1_ELEMENT_NOT_EMPTY
if *definitions
not NULL,
ASN1_IDENTIFIER_NOT_FOUND
if in the file there is an identifier
that is not defined (see errorDescription
for more information),
ASN1_ARRAY_ERROR
if the array pointed by array
is wrong.
void asn1_print_structure (FILE *out
,asn1_node_const structure
,const char *name
,int mode
);
Prints on the out
file descriptor the structure's tree starting
from the name
element inside the structure structure
.
out |
pointer to the output file (e.g. stdout). |
|
structure |
pointer to the structure that you want to visit. |
|
name |
an element of the structure |
|
mode |
specify how much of the structure to print, can be
|
int asn1_create_element (asn1_node_const definitions
,const char *source_name
,asn1_node *element
);
Creates a structure of type source_name
. Example using
"pkix.asn":
rc = asn1_create_element(cert_def, "PKIX1.Certificate", certptr);
int
asn1_delete_structure (asn1_node *structure
);
Deletes the structure *structure
. At the end, *structure
is set
to NULL.
int asn1_delete_structure2 (asn1_node *structure
,unsigned int flags
);
Deletes the structure *structure
. At the end, *structure
is set
to NULL.
structure |
pointer to the structure that you want to delete. |
|
flags |
additional flags (see |
int asn1_delete_element (asn1_node structure
,const char *element_name
);
Deletes the element named *element_name
inside *structure
.
int asn1_write_value (asn1_node node_root
,const char *name
,const void *ivalue
,int len
);
Set the value of one element inside a structure.
If an element is OPTIONAL and you want to delete it, you must use the value=NULL and len=0. Using "pkix.asn":
result=asn1_write_value(cert, "tbsCertificate.issuerUniqueID", NULL, 0);
Description for each type:
INTEGER: VALUE must contain a two's complement form integer.
value[0]=0xFF , len=1 -> integer=-1. value[0]=0xFF value[1]=0xFF , len=2 -> integer=-1. value[0]=0x01 , len=1 -> integer= 1. value[0]=0x00 value[1]=0x01 , len=2 -> integer= 1. value="123" , len=0 -> integer= 123.
ENUMERATED: As INTEGER (but only with not negative numbers).
BOOLEAN: VALUE must be the null terminated string "TRUE" or "FALSE" and LEN != 0.
value="TRUE" , len=1 -> boolean=TRUE. value="FALSE" , len=1 -> boolean=FALSE.
OBJECT IDENTIFIER: VALUE must be a null terminated string with each number separated by a dot (e.g. "1.2.3.543.1"). LEN != 0.
value="1 2 840 10040 4 3" , len=1 -> OID=dsa-with-sha.
UTCTime: VALUE must be a null terminated string in one of these formats: "YYMMDDhhmmssZ", "YYMMDDhhmmssZ", "YYMMDDhhmmss+hh'mm'", "YYMMDDhhmmss-hh'mm'", "YYMMDDhhmm+hh'mm'", or "YYMMDDhhmm-hh'mm'". LEN != 0.
value="9801011200Z" , len=1 -> time=Jannuary 1st, 1998 at 12h 00m Greenwich Mean Time
GeneralizedTime: VALUE must be in one of this format: "YYYYMMDDhhmmss.sZ", "YYYYMMDDhhmmss.sZ", "YYYYMMDDhhmmss.s+hh'mm'", "YYYYMMDDhhmmss.s-hh'mm'", "YYYYMMDDhhmm+hh'mm'", or "YYYYMMDDhhmm-hh'mm'" where ss.s indicates the seconds with any precision like "10.1" or "01.02". LEN != 0
value="2001010112001.12-0700" , len=1 -> time=Jannuary 1st, 2001 at 12h 00m 01.12s Pacific Daylight Time
OCTET STRING: VALUE contains the octet string and LEN is the number of octets.
value="$\backslash$x01$\backslash$x02$\backslash$x03" , len=3 -> three bytes octet string
GeneralString: VALUE contains the generalstring and LEN is the number of octets.
value="$\backslash$x01$\backslash$x02$\backslash$x03" , len=3 -> three bytes generalstring
BIT STRING: VALUE contains the bit string organized by bytes and LEN is the number of bits.
value="$\backslash$xCF" , len=6 -> bit string="110011" (six bits)
CHOICE: if NAME indicates a choice type, VALUE must specify one of the alternatives with a null terminated string. LEN != 0. Using "pkix.asn"\:
result=asn1_write_value(cert, "certificate1.tbsCertificate.subject", "rdnSequence", 1);
ANY: VALUE indicates the der encoding of a structure. LEN != 0.
SEQUENCE OF: VALUE must be the null terminated string "NEW" and LEN != 0. With this instruction another element is appended in the sequence. The name of this element will be "?1" if it's the first one, "?2" for the second and so on.
Using "pkix.asn"\:
result=asn1_write_value(cert, "certificate1.tbsCertificate.subject.rdnSequence", "NEW", 1);
SET OF: the same as SEQUENCE OF. Using "pkix.asn":
result=asn1_write_value(cert, "tbsCertificate.subject.rdnSequence.?LAST", "NEW", 1);
node_root |
pointer to a structure |
|
name |
the name of the element inside the structure that you want to set. |
|
ivalue |
vector used to specify the value to set. If len is >0, VALUE must be a two's complement form integer. if len=0 *VALUE must be a null terminated string with an integer value. |
|
len |
number of bytes of *value to use to set the value: value[0]..value[len-1] or 0 if value is a null terminated string |
ASN1_SUCCESS
if the value was set,
ASN1_ELEMENT_NOT_FOUND
if name
is not a valid element, and
ASN1_VALUE_NOT_VALID
if ivalue
has a wrong format.
int asn1_read_value (asn1_node_const root
,const char *name
,void *ivalue
,int *len
);
Returns the value of one element inside a structure.
If an element is OPTIONAL and this returns
ASN1_ELEMENT_NOT_FOUND
, it means that this element wasn't present
in the der encoding that created the structure. The first element
of a SEQUENCE_OF or SET_OF is named "?1". The second one "?2" and
so on. If the root
provided is a node to specific sequence element,
then the keyword "?CURRENT" is also acceptable and indicates the
current sequence element of this node.
Note that there can be valid values with length zero. In these case
this function will succeed and len
will be zero.
INTEGER: VALUE will contain a two's complement form integer.
integer=-1 -> value[0]=0xFF , len=1. integer=1 -> value[0]=0x01 , len=1.
ENUMERATED: As INTEGER (but only with not negative numbers).
BOOLEAN: VALUE will be the null terminated string "TRUE" or "FALSE" and LEN=5 or LEN=6.
OBJECT IDENTIFIER: VALUE will be a null terminated string with each number separated by a dot (i.e. "1.2.3.543.1").
LEN = strlen(VALUE)+1
UTCTime: VALUE will be a null terminated string in one of these formats: "YYMMDDhhmmss+hh'mm'" or "YYMMDDhhmmss-hh'mm'". LEN=strlen(VALUE)+1.
GeneralizedTime: VALUE will be a null terminated string in the same format used to set the value.
OCTET STRING: VALUE will contain the octet string and LEN will be the number of octets.
GeneralString: VALUE will contain the generalstring and LEN will be the number of octets.
BIT STRING: VALUE will contain the bit string organized by bytes and LEN will be the number of bits.
CHOICE: If NAME indicates a choice type, VALUE will specify the alternative selected.
ANY: If NAME indicates an any type, VALUE will indicate the DER encoding of the structure actually used.
root |
pointer to a structure. |
|
name |
the name of the element inside a structure that you want to read. |
|
ivalue |
vector that will contain the element's content, must be a
pointer to memory cells already allocated (may be |
|
len |
number of bytes of *value: value[0]..value[len-1]. Initialy holds the sizeof value. |
ASN1_SUCCESS
if value is returned,
ASN1_ELEMENT_NOT_FOUND
if name
is not a valid element,
ASN1_VALUE_NOT_FOUND
if there isn't any value for the element
selected, and ASN1_MEM_ERROR
if The value vector isn't big enough
to store the result, and in this case len
will contain the number of
bytes needed. On the occasion that the stored data are of zero-length
this function may return ASN1_SUCCESS
even if the provided len
is zero.
int asn1_read_value_type (asn1_node_const root
,const char *name
,void *ivalue
,int *len
,unsigned int *etype
);
Returns the type and value of one element inside a structure.
If an element is OPTIONAL and this returns
ASN1_ELEMENT_NOT_FOUND
, it means that this element wasn't present
in the der encoding that created the structure. The first element
of a SEQUENCE_OF or SET_OF is named "?1". The second one "?2" and
so on. If the root
provided is a node to specific sequence element,
then the keyword "?CURRENT" is also acceptable and indicates the
current sequence element of this node.
Note that there can be valid values with length zero. In these case
this function will succeed and len
will be zero.
INTEGER: VALUE will contain a two's complement form integer.
integer=-1 -> value[0]=0xFF , len=1. integer=1 -> value[0]=0x01 , len=1.
ENUMERATED: As INTEGER (but only with not negative numbers).
BOOLEAN: VALUE will be the null terminated string "TRUE" or "FALSE" and LEN=5 or LEN=6.
OBJECT IDENTIFIER: VALUE will be a null terminated string with each number separated by a dot (i.e. "1.2.3.543.1").
LEN = strlen(VALUE)+1
UTCTime: VALUE will be a null terminated string in one of these formats: "YYMMDDhhmmss+hh'mm'" or "YYMMDDhhmmss-hh'mm'". LEN=strlen(VALUE)+1.
GeneralizedTime: VALUE will be a null terminated string in the same format used to set the value.
OCTET STRING: VALUE will contain the octet string and LEN will be the number of octets.
GeneralString: VALUE will contain the generalstring and LEN will be the number of octets.
BIT STRING: VALUE will contain the bit string organized by bytes and LEN will be the number of bits.
CHOICE: If NAME indicates a choice type, VALUE will specify the alternative selected.
ANY: If NAME indicates an any type, VALUE will indicate the DER encoding of the structure actually used.
root |
pointer to a structure. |
|
name |
the name of the element inside a structure that you want to read. |
|
ivalue |
vector that will contain the element's content, must be a
pointer to memory cells already allocated (may be |
|
len |
number of bytes of *value: value[0]..value[len-1]. Initialy holds the sizeof value. |
|
etype |
The type of the value read (ASN1_ETYPE) |
ASN1_SUCCESS
if value is returned,
ASN1_ELEMENT_NOT_FOUND
if name
is not a valid element,
ASN1_VALUE_NOT_FOUND
if there isn't any value for the element
selected, and ASN1_MEM_ERROR
if The value vector isn't big enough
to store the result, and in this case len
will contain the number of
bytes needed. On the occasion that the stored data are of zero-length
this function may return ASN1_SUCCESS
even if the provided len
is zero.
int asn1_read_node_value (asn1_node_const node
,asn1_data_node_st *data
);
Returns the value a data node inside a asn1_node structure. The data returned should be handled as constant values.
int asn1_number_of_elements (asn1_node_const element
,const char *name
,int *num
);
Counts the number of elements of a sub-structure called NAME with names equal to "?1","?2", ...
element |
pointer to the root of an ASN1 structure. |
|
name |
the name of a sub-structure of ROOT. |
|
num |
pointer to an integer where the result will be stored |
ASN1_SUCCESS
if successful, ASN1_ELEMENT_NOT_FOUND
if
name
is not known, ASN1_GENERIC_ERROR
if pointer num
is NULL
.
int asn1_der_coding (asn1_node_const element
,const char *name
,void *ider
,int *len
,char *ErrorDescription
);
Creates the DER encoding for the NAME structure (inside *POINTER structure).
element |
pointer to an ASN1 element |
|
name |
the name of the structure you want to encode (it must be inside *POINTER). |
|
ider |
vector that will contain the DER encoding. DER must be a pointer to memory cells already allocated. |
|
len |
number of bytes of * |
|
ErrorDescription |
return the error description or an empty string if success. |
ASN1_SUCCESS
if DER encoding OK, ASN1_ELEMENT_NOT_FOUND
if name
is not a valid element, ASN1_VALUE_NOT_FOUND
if there
is an element without a value, ASN1_MEM_ERROR
if the ider
vector isn't big enough and in this case len
will contain the
length needed.
int asn1_der_decoding2 (asn1_node *element
,const void *ider
,int *max_ider_len
,unsigned int flags
,char *errorDescription
);
Fill the structure *element
with values of a DER encoding string. The
structure must just be created with function asn1_create_element()
.
If ASN1_DECODE_FLAG_ALLOW_PADDING
flag is set then the function will ignore
padding after the decoded DER data. Upon a successful return the value of
*max_ider_len
will be set to the number of bytes decoded.
If ASN1_DECODE_FLAG_STRICT_DER
flag is set then the function will
not decode any BER-encoded elements.
element |
pointer to an ASN1 structure. |
|
ider |
vector that contains the DER encoding. |
|
max_ider_len |
pointer to an integer giving the information about the
maximal number of bytes occupied by * |
|
flags |
flags controlling the behaviour of the function. |
|
errorDescription |
null-terminated string contains details when an error occurred. |
ASN1_SUCCESS
if DER encoding OK, ASN1_ELEMENT_NOT_FOUND
if ELEMENT
is NULL
, and ASN1_TAG_ERROR
or
ASN1_DER_ERROR
if the der encoding doesn't match the structure
name (*ELEMENT
deleted).
int asn1_der_decoding (asn1_node *element
,const void *ider
,int ider_len
,char *errorDescription
);
Fill the structure *element
with values of a DER encoding
string. The structure must just be created with function
asn1_create_element()
.
Note that the *element
variable is provided as a pointer for
historical reasons.
element |
pointer to an ASN1 structure. |
|
ider |
vector that contains the DER encoding. |
|
ider_len |
number of bytes of * |
|
errorDescription |
null-terminated string contains details when an error occurred. |
ASN1_SUCCESS
if DER encoding OK, ASN1_ELEMENT_NOT_FOUND
if ELEMENT
is NULL
, and ASN1_TAG_ERROR
or
ASN1_DER_ERROR
if the der encoding doesn't match the structure
name (*ELEMENT
deleted).
int asn1_der_decoding_element (asn1_node *structure
,const char *elementName
,const void *ider
,int len
,char *errorDescription
);
asn1_der_decoding_element
is deprecated and should not be used in newly-written code.
Fill the element named ELEMENTNAME
with values of a DER encoding
string. The structure must just be created with function
asn1_create_element()
. The DER vector must contain the encoding
string of the whole STRUCTURE
. If an error occurs during the
decoding procedure, the *STRUCTURE
is deleted and set equal to
NULL
.
This function is deprecated and may just be an alias to asn1_der_decoding
in future versions. Use asn1_der_decoding()
instead.
structure |
pointer to an ASN1 structure |
|
elementName |
name of the element to fill |
|
ider |
vector that contains the DER encoding of the whole structure. |
|
len |
number of bytes of *der: der[0]..der[len-1] |
|
errorDescription |
null-terminated string contains details when an error occurred. |
ASN1_SUCCESS
if DER encoding OK, ASN1_ELEMENT_NOT_FOUND
if ELEMENT is NULL
or elementName
== NULL, and
ASN1_TAG_ERROR
or ASN1_DER_ERROR
if the der encoding doesn't
match the structure structure
(*ELEMENT deleted).
int asn1_der_decoding_startEnd (asn1_node element
,const void *ider
,int ider_len
,const char *name_element
,int *start
,int *end
);
Find the start and end point of an element in a DER encoding
string. I mean that if you have a der encoding and you have already
used the function asn1_der_decoding()
to fill a structure, it may
happen that you want to find the piece of string concerning an
element of the structure.
One example is the sequence "tbsCertificate" inside an X509 certificate.
Note that since libtasn1 3.7 the ider
and ider_len
parameters
can be omitted, if the element is already decoded using asn1_der_decoding()
.
element |
pointer to an ASN1 element |
|
ider |
vector that contains the DER encoding. |
|
ider_len |
number of bytes of * |
|
name_element |
an element of NAME structure. |
|
start |
the position of the first byte of NAME_ELEMENT decoding
( |
|
end |
the position of the last byte of NAME_ELEMENT decoding
( |
ASN1_SUCCESS
if DER encoding OK, ASN1_ELEMENT_NOT_FOUND
if ELEMENT is asn1_node
EMPTY or name_element
is not a valid
element, ASN1_TAG_ERROR
or ASN1_DER_ERROR
if the der encoding
doesn't match the structure ELEMENT.
int asn1_expand_any_defined_by (asn1_node_const definitions
,asn1_node *element
);
Expands every "ANY DEFINED BY" element of a structure created from a DER decoding process (asn1_der_decoding function). The element ANY must be defined by an OBJECT IDENTIFIER. The type used to expand the element ANY is the first one following the definition of the actual value of the OBJECT IDENTIFIER.
ASN1_SUCCESS
if Substitution OK, ASN1_ERROR_TYPE_ANY
if
some "ANY DEFINED BY" element couldn't be expanded due to a
problem in OBJECT_ID -> TYPE association, or other error codes
depending on DER decoding.
int asn1_expand_octet_string (asn1_node_const definitions
,asn1_node *element
,const char *octetName
,const char *objectName
);
Expands an "OCTET STRING" element of a structure created from a DER
decoding process (the asn1_der_decoding()
function). The type used
for expansion is the first one following the definition of the
actual value of the OBJECT IDENTIFIER indicated by OBJECTNAME.
definitions |
ASN1 definitions |
|
element |
pointer to an ASN1 structure |
|
octetName |
name of the OCTECT STRING field to expand. |
|
objectName |
name of the OBJECT IDENTIFIER field to use to define the type for expansion. |
ASN1_SUCCESS
if substitution OK, ASN1_ELEMENT_NOT_FOUND
if objectName
or octetName
are not correct,
ASN1_VALUE_NOT_VALID
if it wasn't possible to find the type to
use for expansion, or other errors depending on DER decoding.
int asn1_read_tag (asn1_node_const root
,const char *name
,int *tagValue
,int *classValue
);
Returns the TAG and the CLASS of one element inside a structure.
CLASS can have one of these constants: ASN1_CLASS_APPLICATION
,
ASN1_CLASS_UNIVERSAL
, ASN1_CLASS_PRIVATE
or
ASN1_CLASS_CONTEXT_SPECIFIC
.
const char * asn1_find_structure_from_oid (asn1_node_const definitions
,const char *oidValue
);
Search the structure that is defined just after an OID definition.
const char *
asn1_check_version (const char *req_version
);
Check that the version of the library is at minimum the
requested one and return the version string; return NULL
if the
condition is not satisfied. If a NULL
is passed to this function,
no check is done, but the version string is simply returned.
See ASN1_VERSION
for a suitable req_version
string.
void
asn1_perror (int error
);
Prints a string to stderr with a description of an error. This
function is like perror()
. The only difference is that it accepts
an error returned by a libtasn1 function.
Since: 1.6
long asn1_get_length_der (const unsigned char *der
,int der_len
,int *len
);
Extract a length field from DER data.
long asn1_get_length_ber (const unsigned char *ber
,int ber_len
,int *len
);
Extract a length field from BER data. The difference to
asn1_get_length_der()
is that this function will return a length
even if the value has indefinite encoding.
ber |
BER data to decode. |
|
ber_len |
Length of BER data to decode. |
|
len |
Output variable containing the length of the BER length field. |
Since: 2.0
void asn1_length_der (unsigned long int len
,unsigned char *der
,int *der_len
);
Creates the DER encoding of the provided length value.
The der
buffer must have enough room for the output. The maximum
length this function will encode is ASN1_MAX_LENGTH_SIZE
.
To know the size of the DER encoding use a NULL
value for der
.
int asn1_decode_simple_der (unsigned int etype
,const unsigned char *der
,unsigned int _der_len
,const unsigned char **str
,unsigned int *str_len
);
Decodes a simple DER encoded type (e.g. a string, which is not constructed).
The output is a pointer inside the der
.
int asn1_decode_simple_ber (unsigned int etype
,const unsigned char *der
,unsigned int _der_len
,unsigned char **str
,unsigned int *str_len
,unsigned int *ber_len
);
Decodes a BER encoded type. The output is an allocated value of the data. This decodes BER STRINGS only. Other types are decoded as DER.
int asn1_encode_simple_der (unsigned int etype
,const unsigned char *str
,unsigned int str_len
,unsigned char *tl
,unsigned int *tl_len
);
Creates the DER encoding for various simple ASN.1 types like strings etc.
It stores the tag and length in tl
, which should have space for at least
ASN1_MAX_TL_SIZE
bytes. Initially tl_len
should contain the size of tl
.
The complete DER encoding should consist of the value in tl
appended
with the provided str
.
asn1_node asn1_find_node (asn1_node_const pointer
,const char *name
);
Searches for an element called name
starting from pointer
. The
name is composed by different identifiers separated by dots. When
*pointer
has a name, the first identifier must be the name of
*pointer
, otherwise it must be the name of one child of *pointer
.
int asn1_copy_node (asn1_node dst
,const char *dst_name
,asn1_node_const src
,const char *src_name
);
Create a deep copy of a asn1_node variable. That
function requires dst
to be expanded using asn1_create_element()
.
asn1_node asn1_dup_node (asn1_node_const src
,const char *src_name
);
Create a deep copy of a asn1_node variable. This function will return an exact copy of the provided structure.
int asn1_get_tag_der (const unsigned char *der
,int der_len
,unsigned char *cls
,int *len
,unsigned long *tag
);
Decode the class and TAG from DER code.
void asn1_octet_der (const unsigned char *str
,int str_len
,unsigned char *der
,int *der_len
);
Creates a length-value DER encoding for the input data.
The DER encoding of the input data will be placed in the der
variable.
Note that the OCTET STRING tag is not included in the output.
This function does not return any value because it is expected
that der_len
will contain enough bytes to store the string
plus the DER encoding. The DER encoding size can be obtained using
asn1_length_der()
.
int asn1_get_octet_der (const unsigned char *der
,int der_len
,int *ret_len
,unsigned char *str
,int str_size
,int *str_len
);
Extract an OCTET SEQUENCE from DER data. Note that this function expects the DER data past the tag field, i.e., the length and content octets.
der |
DER data to decode containing the OCTET SEQUENCE. |
|
der_len |
The length of the |
|
ret_len |
Output variable containing the encoded length of the DER data. |
|
str |
Pre-allocated output buffer to put decoded OCTET SEQUENCE in. |
|
str_size |
Length of pre-allocated output buffer. |
|
str_len |
Output variable containing the length of the contents of the OCTET SEQUENCE. |
void asn1_bit_der (const unsigned char *str
,int bit_len
,unsigned char *der
,int *der_len
);
Creates a length-value DER encoding for the input data
as it would have been for a BIT STRING.
The DER encoded data will be copied in der
.
Note that the BIT STRING tag is not included in the output.
This function does not return any value because it is expected
that der_len
will contain enough bytes to store the string
plus the DER encoding. The DER encoding size can be obtained using
asn1_length_der()
.
int asn1_get_bit_der (const unsigned char *der
,int der_len
,int *ret_len
,unsigned char *str
,int str_size
,int *bit_len
);
Extract a BIT SEQUENCE from DER data.
der |
DER data to decode containing the BIT SEQUENCE. |
|
der_len |
Length of DER data to decode. |
|
ret_len |
Output variable containing the length of the DER data. |
|
str |
Pre-allocated output buffer to put decoded BIT SEQUENCE in. |
|
str_size |
Length of pre-allocated output buffer. |
|
bit_len |
Output variable containing the size of the BIT SEQUENCE. |
int asn1_get_object_id_der (const unsigned char *der
,int der_len
,int *ret_len
,char *str
,int str_size
);
Converts a DER encoded object identifier to its textual form. This function expects the DER object identifier without the tag.
int asn1_object_id_der (const char *str
,unsigned char *der
,int *der_len
,unsigned flags
);
Creates the DER encoding of the provided object identifier.
str |
An object identifier in numeric, dot format. |
|
der |
buffer to hold the returned encoding (may be |
|
der_len |
initially the size of |
|
flags |
must be zero |
ASN1_SUCCESS
if DER encoding was OK, ASN1_VALUE_NOT_VALID
if str
is not a valid OID, ASN1_MEM_ERROR
if the der
vector isn't big enough and in this case der_len
will contain the
length needed.
# define ASN1_VERSION_NUMBER 0x041300
Version number of the library as a number.
typedef asn1_node_st *asn1_node;
Structure definition used for the node of the tree that represents an ASN.1 DEFINITION.
# define ASN1_MAX_NAME_SIZE 64
Maximum number of characters of a name inside a file with ASN1 definitions.
# define ASN1_DELETE_FLAG_ZEROIZE 1
Used by: asn1_delete_structure2()
Zeroize values prior to deinitialization.
# define ASN1_DECODE_FLAG_ALLOW_PADDING 1
Used by: asn1_der_decoding2()
This flag would allow arbitrary data past the DER data.
# define ASN1_DECODE_FLAG_STRICT_DER (1<<1)
Used by: asn1_der_decoding2()
This flag would ensure that no BER decoding takes place.
# define ASN1_DECODE_FLAG_ALLOW_INCORRECT_TIME (1<<2)
Used by: asn1_der_decoding2()
This flag will tolerate Time encoding errors when in strict DER.
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 (ASN1_ETYPE_*) */ };
Data node inside a asn1_node structure.
# define ASN1_MAX_ERROR_DESCRIPTION_SIZE 128
Maximum number of characters of a description message (null character included).
typedef int asn1_retCode _ASN1_GCC_ATTR_DEPRECATED;
_ASN1_GCC_ATTR_DEPRECATED
is deprecated and should not be used in newly-written code.
# define node_asn_struct _Pragma ("GCC warning \"'node_asn_struct' macro is deprecated, use 'asn1_node' instead.\"") asn1_node_st
node_asn_struct
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_node instead.
Compat #define.
# define node_asn _Pragma ("GCC warning \"'node_asn' macro is deprecated, use 'asn1_node' instead.\"") asn1_node_st
node_asn
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_node instead.
Compat #define.
# define ASN1_TYPE _Pragma ("GCC warning \"'ASN1_TYPE' macro is deprecated, use 'asn1_node' instead.\"") asn1_node
ASN1_TYPE
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_node instead.
Compat #define.
# define ASN1_TYPE_EMPTY _Pragma ("GCC warning \"'ASN1_TYPE_EMPTY' macro is deprecated, use 'NULL' instead.\"") NULL
ASN1_TYPE_EMPTY
has been deprecated since version 3.0 and should not be used in newly-written code.
Use NULL instead.
Compat #define.
# define static_struct_asn _Pragma ("GCC warning \"'static_struct_asn' macro is deprecated, use 'asn1_static_node_st' instead.\"") asn1_static_node_st
static_struct_asn
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_static_node instead.
Compat #define.
# define ASN1_ARRAY_TYPE _Pragma ("GCC warning \"'ASN1_ARRAY_TYPE' macro is deprecated, use 'asn1_static_node' instead.\"") asn1_static_node
ASN1_ARRAY_TYPE
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_static_node instead.
Compat #define.
# define asn1_static_node_t _Pragma ("GCC warning \"'asn1_static_node_t' macro is deprecated, use 'asn1_static_node' instead.\"") asn1_static_node
asn1_static_node_t
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_static_node instead.
Compat #define.
# define node_data_struct _Pragma ("GCC warning \"'node_data_struct' macro is deprecated, use 'asn1_data_node_st' instead.\"") asn1_data_node_st
node_data_struct
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_data_node_st instead.
Compat #define.
# define ASN1_DATA_NODE _Pragma ("GCC warning \"'asn1_static_node_t' macro is deprecated, use 'asn1_static_node' instead.\"") asn1_data_node_st
ASN1_DATA_NODE
has been deprecated since version 3.0 and should not be used in newly-written code.
Use asn1_data_node_st instead.
Compat #define.