API Documentation (Doxygen generated)

These pages are generated with doxygen directly from the source code!

Asn1_module

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.
#define POLARSSL_ERR_ASN1_UNEXPECTED_TAG   -0x0062
 ASN1 tag was of an unexpected value.
#define POLARSSL_ERR_ASN1_INVALID_LENGTH   -0x0064
 Error when trying to determine the length or invalid length.
#define POLARSSL_ERR_ASN1_LENGTH_MISMATCH   -0x0066
 Actual length differs from expected length.
#define POLARSSL_ERR_ASN1_INVALID_DATA   -0x0068
 Data is invalid.
#define POLARSSL_ERR_ASN1_MALLOC_FAILED   -0x006A
 Memory allocation failed.
#define POLARSSL_ERR_ASN1_BUF_TOO_SMALL   -0x006C
 Buffer too small when writing ASN.1 data structure.

DER constants

These constants comply with DER encoded the ANS1 type tags.

DER encoding uses hexadecimal representation. An example DER sequence is:

  • 0x02 – tag indicating INTEGER
  • 0x01 – length in octets
  • 0x05 – value Such sequences are typically read into x509_buf.
#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

Detailed Description

Macro Definition Documentation

#define ASN1_BIT_STRING   0x03

Definition at line 73 of file asn1.h.

#define ASN1_BMP_STRING   0x1E

Definition at line 86 of file asn1.h.

#define ASN1_BOOLEAN   0x01

Definition at line 71 of file asn1.h.

#define ASN1_CONSTRUCTED   0x20

Definition at line 88 of file asn1.h.

#define ASN1_CONTEXT_SPECIFIC   0x80

Definition at line 89 of file asn1.h.

#define ASN1_GENERALIZED_TIME   0x18

Definition at line 84 of file asn1.h.

#define ASN1_IA5_STRING   0x16

Definition at line 82 of file asn1.h.

#define ASN1_INTEGER   0x02

Definition at line 72 of file asn1.h.

#define ASN1_NULL   0x05

Definition at line 75 of file asn1.h.

#define ASN1_OCTET_STRING   0x04

Definition at line 74 of file asn1.h.

#define ASN1_OID   0x06

Definition at line 76 of file asn1.h.

#define ASN1_PRIMITIVE   0x00

Definition at line 87 of file asn1.h.

#define ASN1_PRINTABLE_STRING   0x13

Definition at line 80 of file asn1.h.

#define ASN1_SEQUENCE   0x10

Definition at line 78 of file asn1.h.

#define ASN1_SET   0x11

Definition at line 79 of file asn1.h.

#define ASN1_T61_STRING   0x14

Definition at line 81 of file asn1.h.

#define ASN1_UNIVERSAL_STRING   0x1C

Definition at line 85 of file asn1.h.

#define ASN1_UTC_TIME   0x17

Definition at line 83 of file asn1.h.

#define ASN1_UTF8_STRING   0x0C

Definition at line 77 of file asn1.h.

#define POLARSSL_ERR_ASN1_BUF_TOO_SMALL   -0x006C

Buffer too small when writing ASN.1 data structure.

Definition at line 56 of file asn1.h.

#define POLARSSL_ERR_ASN1_INVALID_DATA   -0x0068

Data is invalid.

(not used)

Definition at line 54 of file asn1.h.

#define POLARSSL_ERR_ASN1_INVALID_LENGTH   -0x0064

Error when trying to determine the length or invalid length.

Definition at line 52 of file asn1.h.

#define POLARSSL_ERR_ASN1_LENGTH_MISMATCH   -0x0066

Actual length differs from expected length.

Definition at line 53 of file asn1.h.

#define POLARSSL_ERR_ASN1_MALLOC_FAILED   -0x006A

Memory allocation failed.

Definition at line 55 of file asn1.h.

#define POLARSSL_ERR_ASN1_OUT_OF_DATA   -0x0060

Out of data when parsing an ASN1 data structure.

Definition at line 50 of file asn1.h.

#define POLARSSL_ERR_ASN1_UNEXPECTED_TAG   -0x0062

ASN1 tag was of an unexpected value.

Definition at line 51 of file asn1.h.