oid.c File Reference

Object Identifier (OID) database. More...

#include "mbedtls/config.h"
#include "mbedtls/oid.h"
#include "mbedtls/rsa.h"
#include <stdio.h>
#include <string.h>
#include "mbedtls/platform.h"
#include "mbedtls/x509.h"

Include dependency graph for oid.c:

Classes
struct	oid_x520_attr_t
struct	oid_x509_ext_t
struct	oid_sig_alg_t
struct	oid_pk_alg_t
struct	oid_ecp_grp_t
struct	oid_cipher_alg_t
struct	oid_md_alg_t
struct	oid_pkcs12_pbe_alg_t

Macros
#define	ADD_LEN(s)   s, MBEDTLS_OID_SIZE(s)
#define	FN_OID_TYPED_FROM_ASN1(TYPE_T, NAME, LIST)
#define	FN_OID_GET_DESCRIPTOR_ATTR1(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1)
#define	FN_OID_GET_ATTR1(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1)
#define	FN_OID_GET_ATTR2(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1, ATTR2_TYPE, ATTR2)
#define	FN_OID_GET_OID_BY_ATTR1(FN_NAME, TYPE_T, LIST, ATTR1_TYPE, ATTR1)
#define	FN_OID_GET_OID_BY_ATTR2(FN_NAME, TYPE_T, LIST, ATTR1_TYPE, ATTR1, ATTR2_TYPE, ATTR2)
#define	OID_SAFE_SNPRINTF

Functions
int	mbedtls_oid_get_numeric_string (char *buf, size_t size, const mbedtls_asn1_buf *oid)
	Translate an ASN.1 OID into its numeric representation (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549") More...

Variables
static const oid_x520_attr_t	oid_x520_attr_type []
static const oid_x509_ext_t	oid_x509_ext []
static const mbedtls_oid_descriptor_t	oid_ext_key_usage []
static const oid_sig_alg_t	oid_sig_alg []
static const oid_pk_alg_t	oid_pk_alg []
static const oid_ecp_grp_t	oid_ecp_grp []
static const oid_cipher_alg_t	oid_cipher_alg []
static const oid_md_alg_t	oid_md_alg []
static const oid_pkcs12_pbe_alg_t	oid_pkcs12_pbe_alg []

Detailed Description

Object Identifier (OID) database.

Copyright (C) 2006-2015, ARM Limited, All Rights Reserved SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This file is part of mbed TLS (https://tls.mbed.org)

Macro Definition Documentation

ADD_LEN

#define ADD_LEN

(

s

)

s, MBEDTLS_OID_SIZE(s)

FN_OID_GET_ATTR1

#define FN_OID_GET_ATTR1	(		FN_NAME,
			TYPE_T,
			TYPE_NAME,
			ATTR1_TYPE,
			ATTR1
	)

Value:

int FN_NAME( const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1 )                  \
{                                                                       \
    const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1( oid );        \
    if( data == NULL ) return( MBEDTLS_ERR_OID_NOT_FOUND );            \
    *ATTR1 = data->ATTR1;                                               \
    return( 0 );                                                        \
}

FN_OID_GET_ATTR2

#define FN_OID_GET_ATTR2	(		FN_NAME,
			TYPE_T,
			TYPE_NAME,
			ATTR1_TYPE,
			ATTR1,
			ATTR2_TYPE,
			ATTR2
	)

Value:

int FN_NAME( const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1, ATTR2_TYPE * ATTR2 )  \
{                                                                           \
    const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1( oid );            \
    if( data == NULL ) return( MBEDTLS_ERR_OID_NOT_FOUND );                \
    *ATTR1 = data->ATTR1;                                                   \
    *ATTR2 = data->ATTR2;                                                   \
    return( 0 );                                                            \
}

FN_OID_GET_DESCRIPTOR_ATTR1

#define FN_OID_GET_DESCRIPTOR_ATTR1	(		FN_NAME,
			TYPE_T,
			TYPE_NAME,
			ATTR1_TYPE,
			ATTR1
	)

Value:

int FN_NAME( const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1 )                  \
{                                                                       \
    const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1( oid );        \
    if( data == NULL ) return( MBEDTLS_ERR_OID_NOT_FOUND );            \
    *ATTR1 = data->descriptor.ATTR1;                                    \
    return( 0 );                                                        \
}

FN_OID_GET_OID_BY_ATTR1

#define FN_OID_GET_OID_BY_ATTR1	(		FN_NAME,
			TYPE_T,
			LIST,
			ATTR1_TYPE,
			ATTR1
	)

Value:

int FN_NAME( ATTR1_TYPE ATTR1, const char **oid, size_t *olen )             \
{                                                                           \
    const TYPE_T *cur = LIST;                                               \
    while( cur->descriptor.asn1 != NULL ) {                                 \
        if( cur->ATTR1 == ATTR1 ) {                                         \
            *oid = cur->descriptor.asn1;                                    \
            *olen = cur->descriptor.asn1_len;                               \
            return( 0 );                                                    \
        }                                                                   \
        cur++;                                                              \
    }                                                                       \
    return( MBEDTLS_ERR_OID_NOT_FOUND );                                   \
}

FN_OID_GET_OID_BY_ATTR2

#define FN_OID_GET_OID_BY_ATTR2	(		FN_NAME,
			TYPE_T,
			LIST,
			ATTR1_TYPE,
			ATTR1,
			ATTR2_TYPE,
			ATTR2
	)

Value:

int FN_NAME( ATTR1_TYPE ATTR1, ATTR2_TYPE ATTR2, const char **oid ,         \
             size_t *olen )                                                 \
{                                                                           \
    const TYPE_T *cur = LIST;                                               \
    while( cur->descriptor.asn1 != NULL ) {                                 \
        if( cur->ATTR1 == ATTR1 && cur->ATTR2 == ATTR2 ) {                  \
            *oid = cur->descriptor.asn1;                                    \
            *olen = cur->descriptor.asn1_len;                               \
            return( 0 );                                                    \
        }                                                                   \
        cur++;                                                              \
    }                                                                       \
    return( MBEDTLS_ERR_OID_NOT_FOUND );                                   \
}

FN_OID_TYPED_FROM_ASN1

#define FN_OID_TYPED_FROM_ASN1	(		TYPE_T,
			NAME,
			LIST
	)

Value:

static const TYPE_T * oid_ ## NAME ## _from_asn1( const mbedtls_asn1_buf *oid )     \
{                                                                           \
    const TYPE_T *p = LIST;                                                 \
    const mbedtls_oid_descriptor_t *cur = (const mbedtls_oid_descriptor_t *) p;             \
    if( p == NULL || oid == NULL ) return( NULL );                          \
    while( cur->asn1 != NULL ) {                                            \
        if( cur->asn1_len == oid->len &&                                    \
            memcmp( cur->asn1, oid->p, oid->len ) == 0 ) {                  \
            return( p );                                                    \
        }                                                                   \
        p++;                                                                \
        cur = (const mbedtls_oid_descriptor_t *) p;                                 \
    }                                                                       \
    return( NULL );                                                         \
}

OID_SAFE_SNPRINTF

#define OID_SAFE_SNPRINTF

Value:

do {                                                \
        if( ret < 0 || (size_t) ret >= n )              \
            return( MBEDTLS_ERR_OID_BUF_TOO_SMALL );    \
                                                        \
        n -= (size_t) ret;                              \
        p += (size_t) ret;                              \
    } while( 0 )

Function Documentation

mbedtls_oid_get_numeric_string()

int mbedtls_oid_get_numeric_string	(	char *	buf,
		size_t	size,
		const mbedtls_asn1_buf *	oid
	)

Translate an ASN.1 OID into its numeric representation (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")

Parameters

buf	buffer to put representation in
size	size of the buffer
oid	OID to translate

Returns

Length of the string written (excluding final NULL) or MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error

Variable Documentation

oid_cipher_alg

const oid_cipher_alg_t oid_cipher_alg[]

static

Initial value:

=
{
    {
        { ADD_LEN( MBEDTLS_OID_DES_CBC ),              "desCBC",       "DES-CBC" },
        MBEDTLS_CIPHER_DES_CBC,
    },
    {
        { ADD_LEN( MBEDTLS_OID_DES_EDE3_CBC ),         "des-ede3-cbc", "DES-EDE3-CBC" },
        MBEDTLS_CIPHER_DES_EDE3_CBC,
    },
    {
        { NULL, 0, NULL, NULL },
        MBEDTLS_CIPHER_NONE,
    },
}

oid_ecp_grp

const oid_ecp_grp_t oid_ecp_grp[]

static

oid_ext_key_usage

const mbedtls_oid_descriptor_t oid_ext_key_usage[]

static

Initial value:

=
{
    { ADD_LEN( MBEDTLS_OID_SERVER_AUTH ),      "id-kp-serverAuth",      "TLS Web Server Authentication" },
    { ADD_LEN( MBEDTLS_OID_CLIENT_AUTH ),      "id-kp-clientAuth",      "TLS Web Client Authentication" },
    { ADD_LEN( MBEDTLS_OID_CODE_SIGNING ),     "id-kp-codeSigning",     "Code Signing" },
    { ADD_LEN( MBEDTLS_OID_EMAIL_PROTECTION ), "id-kp-emailProtection", "E-mail Protection" },
    { ADD_LEN( MBEDTLS_OID_TIME_STAMPING ),    "id-kp-timeStamping",    "Time Stamping" },
    { ADD_LEN( MBEDTLS_OID_OCSP_SIGNING ),     "id-kp-OCSPSigning",     "OCSP Signing" },
    { NULL, 0, NULL, NULL },
}

oid_md_alg

const oid_md_alg_t oid_md_alg[]

static

oid_pk_alg

const oid_pk_alg_t oid_pk_alg[]

static

Initial value:

=
{
    {
        { ADD_LEN( MBEDTLS_OID_PKCS1_RSA ),      "rsaEncryption",   "RSA" },
        MBEDTLS_PK_RSA,
    },
    {
        { ADD_LEN( MBEDTLS_OID_EC_ALG_UNRESTRICTED ),  "id-ecPublicKey",   "Generic EC key" },
        MBEDTLS_PK_ECKEY,
    },
    {
        { ADD_LEN( MBEDTLS_OID_EC_ALG_ECDH ),          "id-ecDH",          "EC key for ECDH" },
        MBEDTLS_PK_ECKEY_DH,
    },
    {
        { NULL, 0, NULL, NULL },
        MBEDTLS_PK_NONE,
    },
}

oid_pkcs12_pbe_alg

const oid_pkcs12_pbe_alg_t oid_pkcs12_pbe_alg[]

static

Initial value:

=
{
    {
        { ADD_LEN( MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC ), "pbeWithSHAAnd3-KeyTripleDES-CBC", "PBE with SHA1 and 3-Key 3DES" },
        MBEDTLS_MD_SHA1,      MBEDTLS_CIPHER_DES_EDE3_CBC,
    },
    {
        { ADD_LEN( MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC ), "pbeWithSHAAnd2-KeyTripleDES-CBC", "PBE with SHA1 and 2-Key 3DES" },
        MBEDTLS_MD_SHA1,      MBEDTLS_CIPHER_DES_EDE_CBC,
    },
    {
        { NULL, 0, NULL, NULL },
        MBEDTLS_MD_NONE, MBEDTLS_CIPHER_NONE,
    },
}

oid_sig_alg

const oid_sig_alg_t oid_sig_alg[]

static

oid_x509_ext

const oid_x509_ext_t oid_x509_ext[]

static

Initial value:

=
{
    {
        { ADD_LEN( MBEDTLS_OID_BASIC_CONSTRAINTS ),    "id-ce-basicConstraints",   "Basic Constraints" },
        MBEDTLS_X509_EXT_BASIC_CONSTRAINTS,
    },
    {
        { ADD_LEN( MBEDTLS_OID_KEY_USAGE ),            "id-ce-keyUsage",           "Key Usage" },
        MBEDTLS_X509_EXT_KEY_USAGE,
    },
    {
        { ADD_LEN( MBEDTLS_OID_EXTENDED_KEY_USAGE ),   "id-ce-extKeyUsage",        "Extended Key Usage" },
        MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE,
    },
    {
        { ADD_LEN( MBEDTLS_OID_SUBJECT_ALT_NAME ),     "id-ce-subjectAltName",     "Subject Alt Name" },
        MBEDTLS_X509_EXT_SUBJECT_ALT_NAME,
    },
    {
        { ADD_LEN( MBEDTLS_OID_NS_CERT_TYPE ),         "id-netscape-certtype",     "Netscape Certificate Type" },
        MBEDTLS_X509_EXT_NS_CERT_TYPE,
    },
    {
        { NULL, 0, NULL, NULL },
        0,
    },
}

oid_x520_attr_type

const oid_x520_attr_t oid_x520_attr_type[]

static