mbed TLS v1.3.21
|
Generic ASN.1 parsing. More...
Go to the source code of this file.
Data Structures | |
struct | _asn1_buf |
Type-length-value structure that allows for ASN1 using DER. More... | |
struct | _asn1_bitstring |
Container for ASN1 bit strings. More... | |
struct | _asn1_sequence |
Container for a sequence of ASN.1 items. More... | |
struct | _asn1_named_data |
Container for a sequence or list of 'named' ASN.1 data items. More... | |
Macros | |
#define | OID_SIZE(x) (sizeof(x) - 1) |
Returns the size of the binary string, without the trailing \0. More... | |
#define | OID_CMP(oid_str, oid_buf) |
Compares an asn1_buf structure to a reference OID. More... | |
ASN1 Error codes | |
These error codes are OR'ed to X509 error codes for higher error granularity. ASN1 is a standard to specify data structures. | |
#define | POLARSSL_ERR_ASN1_OUT_OF_DATA -0x0060 |
Out of data when parsing an ASN1 data structure. More... | |
#define | POLARSSL_ERR_ASN1_UNEXPECTED_TAG -0x0062 |
ASN1 tag was of an unexpected value. More... | |
#define | POLARSSL_ERR_ASN1_INVALID_LENGTH -0x0064 |
Error when trying to determine the length or invalid length. More... | |
#define | POLARSSL_ERR_ASN1_LENGTH_MISMATCH -0x0066 |
Actual length differs from expected length. More... | |
#define | POLARSSL_ERR_ASN1_INVALID_DATA -0x0068 |
Data is invalid. More... | |
#define | POLARSSL_ERR_ASN1_MALLOC_FAILED -0x006A |
Memory allocation failed. More... | |
#define | POLARSSL_ERR_ASN1_BUF_TOO_SMALL -0x006C |
Buffer too small when writing ASN.1 data structure. More... | |
DER constants | |
These constants comply with DER encoded the ANS1 type tags. DER encoding uses hexadecimal representation. An example DER sequence is:
| |
#define | ASN1_BOOLEAN 0x01 |
#define | ASN1_INTEGER 0x02 |
#define | ASN1_BIT_STRING 0x03 |
#define | ASN1_OCTET_STRING 0x04 |
#define | ASN1_NULL 0x05 |
#define | ASN1_OID 0x06 |
#define | ASN1_UTF8_STRING 0x0C |
#define | ASN1_SEQUENCE 0x10 |
#define | ASN1_SET 0x11 |
#define | ASN1_PRINTABLE_STRING 0x13 |
#define | ASN1_T61_STRING 0x14 |
#define | ASN1_IA5_STRING 0x16 |
#define | ASN1_UTC_TIME 0x17 |
#define | ASN1_GENERALIZED_TIME 0x18 |
#define | ASN1_UNIVERSAL_STRING 0x1C |
#define | ASN1_BMP_STRING 0x1E |
#define | ASN1_PRIMITIVE 0x00 |
#define | ASN1_CONSTRUCTED 0x20 |
#define | ASN1_CONTEXT_SPECIFIC 0x80 |
Functions to parse ASN.1 data structures | |
typedef struct _asn1_buf | asn1_buf |
Type-length-value structure that allows for ASN1 using DER. More... | |
typedef struct _asn1_bitstring | asn1_bitstring |
Container for ASN1 bit strings. More... | |
typedef struct _asn1_sequence | asn1_sequence |
Container for a sequence of ASN.1 items. More... | |
typedef struct _asn1_named_data | asn1_named_data |
Container for a sequence or list of 'named' ASN.1 data items. More... | |
int | asn1_get_len (unsigned char **p, const unsigned char *end, size_t *len) |
Get the length of an ASN.1 element. More... | |
int | asn1_get_tag (unsigned char **p, const unsigned char *end, size_t *len, int tag) |
Get the tag and length of the tag. More... | |
int | asn1_get_bool (unsigned char **p, const unsigned char *end, int *val) |
Retrieve a boolean ASN.1 tag and its value. More... | |
int | asn1_get_int (unsigned char **p, const unsigned char *end, int *val) |
Retrieve an integer ASN.1 tag and its value. More... | |
int | asn1_get_bitstring (unsigned char **p, const unsigned char *end, asn1_bitstring *bs) |
Retrieve a bitstring ASN.1 tag and its value. More... | |
int | asn1_get_bitstring_null (unsigned char **p, const unsigned char *end, size_t *len) |
Retrieve a bitstring ASN.1 tag without unused bits and its value. More... | |
int | asn1_get_sequence_of (unsigned char **p, const unsigned char *end, asn1_sequence *cur, int tag) |
Parses and splits an ASN.1 "SEQUENCE OF <tag>" Updated the pointer to immediately behind the full sequence tag. More... | |
int | asn1_get_mpi (unsigned char **p, const unsigned char *end, mpi *X) |
Retrieve a MPI value from an integer ASN.1 tag. More... | |
int | asn1_get_alg (unsigned char **p, const unsigned char *end, asn1_buf *alg, asn1_buf *params) |
Retrieve an AlgorithmIdentifier ASN.1 sequence. More... | |
int | asn1_get_alg_null (unsigned char **p, const unsigned char *end, asn1_buf *alg) |
Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no params. More... | |
asn1_named_data * | asn1_find_named_data (asn1_named_data *list, const char *oid, size_t len) |
Find a specific named_data entry in a sequence or list based on the OID. More... | |
void | asn1_free_named_data (asn1_named_data *entry) |
Free a asn1_named_data entry. More... | |
void | asn1_free_named_data_list (asn1_named_data **head) |
Free all entries in a asn1_named_data list Head will be set to NULL. More... | |
Generic ASN.1 parsing.
Copyright (C) 2006-2013, ARM Limited, All Rights Reserved
This file is part of mbed TLS (https://tls.mbed.org)
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Definition in file asn1.h.
#define OID_CMP | ( | oid_str, | |
oid_buf | |||
) |
Compares an asn1_buf structure to a reference OID.
Only works for 'defined' oid_str values (OID_HMAC_SHA1), you cannot use a 'unsigned char *oid' here!
Warning: returns true when the OIDs are equal (unlike memcmp)!
#define OID_SIZE | ( | x | ) | (sizeof(x) - 1) |
typedef struct _asn1_bitstring asn1_bitstring |
Container for ASN1 bit strings.
typedef struct _asn1_named_data asn1_named_data |
Container for a sequence or list of 'named' ASN.1 data items.
typedef struct _asn1_sequence asn1_sequence |
Container for a sequence of ASN.1 items.
asn1_named_data* asn1_find_named_data | ( | asn1_named_data * | list, |
const char * | oid, | ||
size_t | len | ||
) |
Find a specific named_data entry in a sequence or list based on the OID.
list | The list to seek through |
oid | The OID to look for |
len | Size of the OID |
void asn1_free_named_data | ( | asn1_named_data * | entry | ) |
Free a asn1_named_data entry.
entry | The named data entry to free |
void asn1_free_named_data_list | ( | asn1_named_data ** | head | ) |
Free all entries in a asn1_named_data list Head will be set to NULL.
head | Pointer to the head of the list of named data entries to free |
int asn1_get_alg | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
asn1_buf * | alg, | ||
asn1_buf * | params | ||
) |
Retrieve an AlgorithmIdentifier ASN.1 sequence.
Updates the pointer to immediately behind the full AlgorithmIdentifier.
p | The position in the ASN.1 data |
end | End of data |
alg | The buffer to receive the OID |
params | The buffer to receive the params (if any) |
int asn1_get_alg_null | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
asn1_buf * | alg | ||
) |
Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no params.
Updates the pointer to immediately behind the full AlgorithmIdentifier.
p | The position in the ASN.1 data |
end | End of data |
alg | The buffer to receive the OID |
int asn1_get_bitstring | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
asn1_bitstring * | bs | ||
) |
Retrieve a bitstring ASN.1 tag and its value.
Updates the pointer to immediately behind the full tag.
p | The position in the ASN.1 data |
end | End of data |
bs | The variable that will receive the value |
int asn1_get_bitstring_null | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
size_t * | len | ||
) |
Retrieve a bitstring ASN.1 tag without unused bits and its value.
Updates the pointer to the beginning of the bit/octet string.
p | The position in the ASN.1 data |
end | End of data |
len | Length of the actual bit/octect string in bytes |
int asn1_get_bool | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
int * | val | ||
) |
Retrieve a boolean ASN.1 tag and its value.
Updates the pointer to immediately behind the full tag.
p | The position in the ASN.1 data |
end | End of data |
val | The variable that will receive the value |
int asn1_get_int | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
int * | val | ||
) |
Retrieve an integer ASN.1 tag and its value.
Updates the pointer to immediately behind the full tag.
p | The position in the ASN.1 data |
end | End of data |
val | The variable that will receive the value |
int asn1_get_len | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
size_t * | len | ||
) |
Get the length of an ASN.1 element.
Updates the pointer to immediately behind the length.
p | The position in the ASN.1 data |
end | End of data |
len | The variable that will receive the value |
int asn1_get_mpi | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
mpi * | X | ||
) |
Retrieve a MPI value from an integer ASN.1 tag.
Updates the pointer to immediately behind the full tag.
p | The position in the ASN.1 data |
end | End of data |
X | The MPI that will receive the value |
int asn1_get_sequence_of | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
asn1_sequence * | cur, | ||
int | tag | ||
) |
Parses and splits an ASN.1 "SEQUENCE OF <tag>" Updated the pointer to immediately behind the full sequence tag.
p | The position in the ASN.1 data |
end | End of data |
cur | First variable in the chain to fill |
tag | Type of sequence |
int asn1_get_tag | ( | unsigned char ** | p, |
const unsigned char * | end, | ||
size_t * | len, | ||
int | tag | ||
) |
Get the tag and length of the tag.
Check for the requested tag. Updates the pointer to immediately behind the tag and length.
p | The position in the ASN.1 data |
end | End of data |
len | The variable that will receive the length |
tag | The expected tag |