Loading...
Searching...
No Matches
asn1.h
Go to the documentation of this file.
/*
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
*/
#ifndef MBEDTLS_ASN1_H
#define MBEDTLS_ASN1_H
#if !defined(MBEDTLS_CONFIG_FILE)
#include "mbedtls/config.h"
#else
#include MBEDTLS_CONFIG_FILE
#endif
#include <stddef.h>
#if defined(MBEDTLS_BIGNUM_C)
#include "mbedtls/bignum.h"
#endif
#define MBEDTLS_ERR_ASN1_OUT_OF_DATA -0x0060
#define MBEDTLS_ERR_ASN1_UNEXPECTED_TAG -0x0062
#define MBEDTLS_ERR_ASN1_INVALID_LENGTH -0x0064
#define MBEDTLS_ERR_ASN1_LENGTH_MISMATCH -0x0066
#define MBEDTLS_ERR_ASN1_INVALID_DATA -0x0068
#define MBEDTLS_ERR_ASN1_ALLOC_FAILED -0x006A
#define MBEDTLS_ERR_ASN1_BUF_TOO_SMALL -0x006C
#define MBEDTLS_ASN1_BOOLEAN 0x01
#define MBEDTLS_ASN1_INTEGER 0x02
#define MBEDTLS_ASN1_BIT_STRING 0x03
#define MBEDTLS_ASN1_OCTET_STRING 0x04
#define MBEDTLS_ASN1_NULL 0x05
#define MBEDTLS_ASN1_OID 0x06
#define MBEDTLS_ASN1_ENUMERATED 0x0A
#define MBEDTLS_ASN1_UTF8_STRING 0x0C
#define MBEDTLS_ASN1_SEQUENCE 0x10
#define MBEDTLS_ASN1_SET 0x11
#define MBEDTLS_ASN1_PRINTABLE_STRING 0x13
#define MBEDTLS_ASN1_T61_STRING 0x14
#define MBEDTLS_ASN1_IA5_STRING 0x16
#define MBEDTLS_ASN1_UTC_TIME 0x17
#define MBEDTLS_ASN1_GENERALIZED_TIME 0x18
#define MBEDTLS_ASN1_UNIVERSAL_STRING 0x1C
#define MBEDTLS_ASN1_BMP_STRING 0x1E
#define MBEDTLS_ASN1_PRIMITIVE 0x00
#define MBEDTLS_ASN1_CONSTRUCTED 0x20
#define MBEDTLS_ASN1_CONTEXT_SPECIFIC 0x80
/* Slightly smaller way to check if tag is a string tag
* compared to canonical implementation. */
#define MBEDTLS_ASN1_IS_STRING_TAG(tag) \
((tag) < 32u && ( \
((1u << (tag)) & ((1u << MBEDTLS_ASN1_BMP_STRING) | \
(1u << MBEDTLS_ASN1_UTF8_STRING) | \
(1u << MBEDTLS_ASN1_T61_STRING) | \
(1u << MBEDTLS_ASN1_IA5_STRING) | \
(1u << MBEDTLS_ASN1_UNIVERSAL_STRING) | \
(1u << MBEDTLS_ASN1_PRINTABLE_STRING) | \
(1u << MBEDTLS_ASN1_BIT_STRING))) != 0))
/*
* Bit masks for each of the components of an ASN.1 tag as specified in
* ITU X.690 (08/2015), section 8.1 "General rules for encoding",
* paragraph 8.1.2.2:
*
* Bit 8 7 6 5 1
* +-------+-----+------------+
* | Class | P/C | Tag number |
* +-------+-----+------------+
*/
#define MBEDTLS_ASN1_TAG_CLASS_MASK 0xC0
#define MBEDTLS_ASN1_TAG_PC_MASK 0x20
#define MBEDTLS_ASN1_TAG_VALUE_MASK 0x1F
#define MBEDTLS_OID_SIZE(x) (sizeof(x) - 1)
#define MBEDTLS_OID_CMP(oid_str, oid_buf) \
((MBEDTLS_OID_SIZE(oid_str) != (oid_buf)->len) || \
memcmp((oid_str), (oid_buf)->p, (oid_buf)->len) != 0)
#define MBEDTLS_OID_CMP_RAW(oid_str, oid_buf, oid_buf_len) \
((MBEDTLS_OID_SIZE(oid_str) != (oid_buf_len)) || \
memcmp((oid_str), (oid_buf), (oid_buf_len)) != 0)
#ifdef __cplusplus
extern "C" {
#endif
typedef struct mbedtls_asn1_buf {
int tag;
size_t len;
unsigned char *p;
}
mbedtls_asn1_buf;
typedef struct mbedtls_asn1_bitstring {
size_t len;
unsigned char unused_bits;
unsigned char *p;
}
mbedtls_asn1_bitstring;
typedef struct mbedtls_asn1_sequence {
mbedtls_asn1_buf buf;
struct mbedtls_asn1_sequence *next;
}
mbedtls_asn1_sequence;
typedef struct mbedtls_asn1_named_data {
mbedtls_asn1_buf oid;
mbedtls_asn1_buf val;
struct mbedtls_asn1_named_data *next;
unsigned char next_merged;
}
mbedtls_asn1_named_data;
int mbedtls_asn1_get_len(unsigned char **p,
const unsigned char *end,
size_t *len);
int mbedtls_asn1_get_tag(unsigned char **p,
const unsigned char *end,
size_t *len, int tag);
int mbedtls_asn1_get_bool(unsigned char **p,
const unsigned char *end,
int *val);
int mbedtls_asn1_get_int(unsigned char **p,
const unsigned char *end,
int *val);
int mbedtls_asn1_get_enum(unsigned char **p,
const unsigned char *end,
int *val);
int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end,
mbedtls_asn1_bitstring *bs);
int mbedtls_asn1_get_bitstring_null(unsigned char **p,
const unsigned char *end,
size_t *len);
int mbedtls_asn1_get_sequence_of(unsigned char **p,
const unsigned char *end,
mbedtls_asn1_sequence *cur,
int tag);
void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq);
int mbedtls_asn1_traverse_sequence_of(
unsigned char **p,
const unsigned char *end,
unsigned char tag_must_mask, unsigned char tag_must_val,
unsigned char tag_may_mask, unsigned char tag_may_val,
int (*cb)(void *ctx, int tag,
unsigned char *start, size_t len),
void *ctx);
#if defined(MBEDTLS_BIGNUM_C)
int mbedtls_asn1_get_mpi(unsigned char **p,
const unsigned char *end,
mbedtls_mpi *X);
#endif /* MBEDTLS_BIGNUM_C */
int mbedtls_asn1_get_alg(unsigned char **p,
const unsigned char *end,
mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params);
int mbedtls_asn1_get_alg_null(unsigned char **p,
const unsigned char *end,
mbedtls_asn1_buf *alg);
mbedtls_asn1_named_data *mbedtls_asn1_find_named_data(mbedtls_asn1_named_data *list,
const char *oid, size_t len);
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry);
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head);
#ifdef __cplusplus
}
#endif
#endif /* asn1.h */
bignum.h
Multi-precision integer library.
config.h
Configuration options (set of defines)
mbedtls_asn1_get_bitstring_null
int mbedtls_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 beginnin...
mbedtls_asn1_free_named_data
void mbedtls_asn1_free_named_data(mbedtls_asn1_named_data *entry)
Free a mbedtls_asn1_named_data entry.
mbedtls_asn1_get_mpi
int mbedtls_asn1_get_mpi(unsigned char **p, const unsigned char *end, mbedtls_mpi *X)
Retrieve an integer ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
mbedtls_asn1_get_enum
int mbedtls_asn1_get_enum(unsigned char **p, const unsigned char *end, int *val)
Retrieve an enumerated ASN.1 tag and its value. Updates the pointer to immediately behind the full ta...
mbedtls_asn1_get_int
int mbedtls_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.
mbedtls_asn1_sequence_free
void mbedtls_asn1_sequence_free(mbedtls_asn1_sequence *seq)
Free a heap-allocated linked list presentation of an ASN.1 sequence, including the first element.
mbedtls_asn1_get_sequence_of
int mbedtls_asn1_get_sequence_of(unsigned char **p, const unsigned char *end, mbedtls_asn1_sequence *cur, int tag)
Parses and splits an ASN.1 "SEQUENCE OF <tag>". Updates the pointer to immediately behind the full se...
mbedtls_asn1_traverse_sequence_of
int mbedtls_asn1_traverse_sequence_of(unsigned char **p, const unsigned char *end, unsigned char tag_must_mask, unsigned char tag_must_val, unsigned char tag_may_mask, unsigned char tag_may_val, int(*cb)(void *ctx, int tag, unsigned char *start, size_t len), void *ctx)
Traverse an ASN.1 SEQUENCE container and call a callback for each entry.
mbedtls_asn1_find_named_data
mbedtls_asn1_named_data * mbedtls_asn1_find_named_data(mbedtls_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.
mbedtls_asn1_get_len
int mbedtls_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.
mbedtls_asn1_get_alg_null
int mbedtls_asn1_get_alg_null(unsigned char **p, const unsigned char *end, mbedtls_asn1_buf *alg)
Retrieve an AlgorithmIdentifier ASN.1 sequence with NULL or no params. Updates the pointer to immedia...
mbedtls_asn1_get_alg
int mbedtls_asn1_get_alg(unsigned char **p, const unsigned char *end, mbedtls_asn1_buf *alg, mbedtls_asn1_buf *params)
Retrieve an AlgorithmIdentifier ASN.1 sequence. Updates the pointer to immediately behind the full Al...
mbedtls_asn1_get_bitstring
int mbedtls_asn1_get_bitstring(unsigned char **p, const unsigned char *end, mbedtls_asn1_bitstring *bs)
Retrieve a bitstring ASN.1 tag and its value. Updates the pointer to immediately behind the full tag.
mbedtls_asn1_get_tag
int mbedtls_asn1_get_tag(unsigned char **p, const unsigned char *end, size_t *len, int tag)
Get the tag and length of the element. Check for the requested tag. Updates the pointer to immediatel...
mbedtls_asn1_get_bool
int mbedtls_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.
mbedtls_asn1_free_named_data_list
void mbedtls_asn1_free_named_data_list(mbedtls_asn1_named_data **head)
Free all entries in a mbedtls_asn1_named_data list.
mbedtls_asn1_bitstring
Definition asn1.h:153
mbedtls_asn1_bitstring::len
size_t len
Definition asn1.h:154
mbedtls_asn1_bitstring::unused_bits
unsigned char unused_bits
Definition asn1.h:155
mbedtls_asn1_bitstring::p
unsigned char * p
Definition asn1.h:156
mbedtls_asn1_buf
Definition asn1.h:143
mbedtls_asn1_buf::len
size_t len
Definition asn1.h:145
mbedtls_asn1_buf::p
unsigned char * p
Definition asn1.h:146
mbedtls_asn1_buf::tag
int tag
Definition asn1.h:144
mbedtls_asn1_named_data
Definition asn1.h:172
mbedtls_asn1_named_data::oid
mbedtls_asn1_buf oid
Definition asn1.h:173
mbedtls_asn1_named_data::next
struct mbedtls_asn1_named_data * next
Definition asn1.h:175
mbedtls_asn1_named_data::val
mbedtls_asn1_buf val
Definition asn1.h:174
mbedtls_asn1_named_data::next_merged
unsigned char next_merged
Definition asn1.h:176
mbedtls_asn1_sequence
Definition asn1.h:163
mbedtls_asn1_sequence::buf
mbedtls_asn1_buf buf
Definition asn1.h:164
mbedtls_asn1_sequence::next
struct mbedtls_asn1_sequence * next
Definition asn1.h:165
mbedtls_mpi
MPI structure.
Definition bignum.h:196