File oid.h

Object Identifier (OID) database.

Defines

MBEDTLS_ERR_OID_NOT_FOUND

OID is not found.

MBEDTLS_ERR_OID_BUF_TOO_SMALL

output buffer is too small

MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER
MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER
MBEDTLS_OID_X509_EXT_KEY_USAGE
MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES
MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS
MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME
MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME
MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS
MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS
MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS
MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS
MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE
MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS
MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY
MBEDTLS_OID_X509_EXT_FRESHEST_CRL
MBEDTLS_OID_X509_EXT_NS_CERT_TYPE
MBEDTLS_OID_MAX_COMPONENTS
MBEDTLS_OID_ISO_MEMBER_BODIES
MBEDTLS_OID_ISO_IDENTIFIED_ORG
MBEDTLS_OID_ISO_CCITT_DS
MBEDTLS_OID_ISO_ITU_COUNTRY
MBEDTLS_OID_COUNTRY_US
MBEDTLS_OID_ORG_RSA_DATA_SECURITY
MBEDTLS_OID_RSA_COMPANY
MBEDTLS_OID_ORG_ANSI_X9_62
MBEDTLS_OID_ANSI_X9_62
MBEDTLS_OID_ORG_DOD
MBEDTLS_OID_ORG_OIW
MBEDTLS_OID_OIW_SECSIG
MBEDTLS_OID_OIW_SECSIG_ALG
MBEDTLS_OID_OIW_SECSIG_SHA1
MBEDTLS_OID_ORG_THAWTE
MBEDTLS_OID_THAWTE
MBEDTLS_OID_ORG_CERTICOM
MBEDTLS_OID_CERTICOM
MBEDTLS_OID_ORG_TELETRUST
MBEDTLS_OID_TELETRUST
MBEDTLS_OID_ORGANIZATION
MBEDTLS_OID_ISO_ITU_US_ORG
MBEDTLS_OID_ORG_GOV
MBEDTLS_OID_GOV
MBEDTLS_OID_ORG_NETSCAPE
MBEDTLS_OID_NETSCAPE
MBEDTLS_OID_ID_CE

id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29}

MBEDTLS_OID_NIST_ALG
MBEDTLS_OID_INTERNET

Private Internet Extensions { iso(1) identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) pkix(7) }

MBEDTLS_OID_PKIX
MBEDTLS_OID_AT

id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4}

MBEDTLS_OID_AT_CN

id-at-commonName AttributeType:= {id-at 3}

MBEDTLS_OID_AT_SUR_NAME

id-at-surName AttributeType:= {id-at 4}

MBEDTLS_OID_AT_SERIAL_NUMBER

id-at-serialNumber AttributeType:= {id-at 5}

MBEDTLS_OID_AT_COUNTRY

id-at-countryName AttributeType:= {id-at 6}

MBEDTLS_OID_AT_LOCALITY

id-at-locality AttributeType:= {id-at 7}

MBEDTLS_OID_AT_STATE

id-at-state AttributeType:= {id-at 8}

MBEDTLS_OID_AT_ORGANIZATION

id-at-organizationName AttributeType:= {id-at 10}

MBEDTLS_OID_AT_ORG_UNIT

id-at-organizationalUnitName AttributeType:= {id-at 11}

MBEDTLS_OID_AT_TITLE

id-at-title AttributeType:= {id-at 12}

MBEDTLS_OID_AT_POSTAL_ADDRESS

id-at-postalAddress AttributeType:= {id-at 16}

MBEDTLS_OID_AT_POSTAL_CODE

id-at-postalCode AttributeType:= {id-at 17}

MBEDTLS_OID_AT_GIVEN_NAME

id-at-givenName AttributeType:= {id-at 42}

MBEDTLS_OID_AT_INITIALS

id-at-initials AttributeType:= {id-at 43}

MBEDTLS_OID_AT_GENERATION_QUALIFIER

id-at-generationQualifier AttributeType:= {id-at 44}

MBEDTLS_OID_AT_UNIQUE_IDENTIFIER

id-at-uniqueIdentifier AttributeType:= {id-at 45}

MBEDTLS_OID_AT_DN_QUALIFIER

id-at-dnQualifier AttributeType:= {id-at 46}

MBEDTLS_OID_AT_PSEUDONYM

id-at-pseudonym AttributeType:= {id-at 65}

MBEDTLS_OID_UID
MBEDTLS_OID_DOMAIN_COMPONENT
MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER

id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 }

MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER

id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 }

MBEDTLS_OID_KEY_USAGE

id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 }

MBEDTLS_OID_CERTIFICATE_POLICIES

id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 }

MBEDTLS_OID_POLICY_MAPPINGS

id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 }

MBEDTLS_OID_SUBJECT_ALT_NAME

id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 }

MBEDTLS_OID_ISSUER_ALT_NAME

id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 }

MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS

id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 }

MBEDTLS_OID_BASIC_CONSTRAINTS

id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 }

MBEDTLS_OID_NAME_CONSTRAINTS

id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 }

MBEDTLS_OID_POLICY_CONSTRAINTS

id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 }

MBEDTLS_OID_EXTENDED_KEY_USAGE

id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 }

MBEDTLS_OID_CRL_DISTRIBUTION_POINTS

id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 }

MBEDTLS_OID_INIHIBIT_ANYPOLICY

id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 }

MBEDTLS_OID_FRESHEST_CRL

id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 }

MBEDTLS_OID_ANY_POLICY

anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 }

MBEDTLS_OID_NS_CERT
MBEDTLS_OID_NS_CERT_TYPE
MBEDTLS_OID_NS_BASE_URL
MBEDTLS_OID_NS_REVOCATION_URL
MBEDTLS_OID_NS_CA_REVOCATION_URL
MBEDTLS_OID_NS_RENEWAL_URL
MBEDTLS_OID_NS_CA_POLICY_URL
MBEDTLS_OID_NS_SSL_SERVER_NAME
MBEDTLS_OID_NS_COMMENT
MBEDTLS_OID_NS_DATA_TYPE
MBEDTLS_OID_NS_CERT_SEQUENCE
MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD
MBEDTLS_OID_CRL_NUMBER

id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 }

MBEDTLS_OID_ANY_EXTENDED_KEY_USAGE

anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 }

MBEDTLS_OID_KP

id-kp OBJECT IDENTIFIER ::= { id-pkix 3 }

MBEDTLS_OID_SERVER_AUTH

id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 }

MBEDTLS_OID_CLIENT_AUTH

id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 }

MBEDTLS_OID_CODE_SIGNING

id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 }

MBEDTLS_OID_EMAIL_PROTECTION

id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 }

MBEDTLS_OID_TIME_STAMPING

id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 }

MBEDTLS_OID_OCSP_SIGNING

id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 }

MBEDTLS_OID_WISUN_FAN

Wi-SUN Alliance Field Area Network { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }

MBEDTLS_OID_ON

id-on OBJECT IDENTIFIER ::= { id-pkix 8 }

MBEDTLS_OID_ON_HW_MODULE_NAME

id-on-hardwareModuleName OBJECT IDENTIFIER ::= { id-on 4 }

MBEDTLS_OID_PKCS

pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 }

MBEDTLS_OID_PKCS1

pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 }

MBEDTLS_OID_PKCS5

pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 }

MBEDTLS_OID_PKCS7

pkcs-7 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 7 }

MBEDTLS_OID_PKCS9

pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 }

MBEDTLS_OID_PKCS12

pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 }

MBEDTLS_OID_PKCS1_RSA

rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 }

MBEDTLS_OID_PKCS1_MD5

md5WithRSAEncryption ::= { pkcs-1 4 }

MBEDTLS_OID_PKCS1_SHA1

sha1WithRSAEncryption ::= { pkcs-1 5 }

MBEDTLS_OID_PKCS1_SHA224

sha224WithRSAEncryption ::= { pkcs-1 14 }

MBEDTLS_OID_PKCS1_SHA256

sha256WithRSAEncryption ::= { pkcs-1 11 }

MBEDTLS_OID_PKCS1_SHA384

sha384WithRSAEncryption ::= { pkcs-1 12 }

MBEDTLS_OID_PKCS1_SHA512

sha512WithRSAEncryption ::= { pkcs-1 13 }

MBEDTLS_OID_RSA_SHA_OBS
MBEDTLS_OID_PKCS9_EMAIL

emailAddress AttributeType ::= { pkcs-9 1 }

MBEDTLS_OID_RSASSA_PSS

id-RSASSA-PSS ::= { pkcs-1 10 }

MBEDTLS_OID_MGF1

id-mgf1 ::= { pkcs-1 8 }

MBEDTLS_OID_DIGEST_ALG_MD5

id-mbedtls_md5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 5 }

MBEDTLS_OID_DIGEST_ALG_SHA1

id-mbedtls_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 }

MBEDTLS_OID_DIGEST_ALG_SHA224

id-sha224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 4 }

MBEDTLS_OID_DIGEST_ALG_SHA256

id-mbedtls_sha256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 1 }

MBEDTLS_OID_DIGEST_ALG_SHA384

id-sha384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 2 }

MBEDTLS_OID_DIGEST_ALG_SHA512

id-mbedtls_sha512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 3 }

MBEDTLS_OID_DIGEST_ALG_RIPEMD160

id-ripemd160 OBJECT IDENTIFIER :: { iso(1) identified-organization(3) teletrust(36) algorithm(3) hashAlgorithm(2) ripemd160(1) }

MBEDTLS_OID_DIGEST_ALG_SHA3_224

id-sha3-224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-224(7) }

MBEDTLS_OID_DIGEST_ALG_SHA3_256

id-sha3-256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-256(8) }

MBEDTLS_OID_DIGEST_ALG_SHA3_384

id-sha3-384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-384(9) }

MBEDTLS_OID_DIGEST_ALG_SHA3_512

id-sha3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-512(10) }

MBEDTLS_OID_HMAC_SHA1

id-hmacWithSHA1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 7 }

MBEDTLS_OID_HMAC_SHA224

id-hmacWithSHA224 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 8 }

MBEDTLS_OID_HMAC_SHA256

id-hmacWithSHA256 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 9 }

MBEDTLS_OID_HMAC_SHA384

id-hmacWithSHA384 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 10 }

MBEDTLS_OID_HMAC_SHA512

id-hmacWithSHA512 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 11 }

MBEDTLS_OID_HMAC_SHA3_224

id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-224(13) }

MBEDTLS_OID_HMAC_SHA3_256

id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-256(14) }

MBEDTLS_OID_HMAC_SHA3_384

id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-384(15) }

MBEDTLS_OID_HMAC_SHA3_512

id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-512(16) }

MBEDTLS_OID_HMAC_RIPEMD160

id-hmacWithSHA1 OBJECT IDENTIFIER ::= {iso(1) iso-identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) ipsec(8) isakmpOakley(1) hmacRIPEMD160(4)}

MBEDTLS_OID_DES_CBC

desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 }

MBEDTLS_OID_DES_EDE3_CBC

des-ede3-cbc OBJECT IDENTIFIER ::= { iso(1) member-body(2) — us(840) rsadsi(113549) encryptionAlgorithm(3) 7 }

MBEDTLS_OID_AES
MBEDTLS_OID_AES_128_CBC
MBEDTLS_OID_AES_192_CBC
MBEDTLS_OID_AES_256_CBC
MBEDTLS_OID_AES128_KW
MBEDTLS_OID_AES128_KWP
MBEDTLS_OID_AES192_KW
MBEDTLS_OID_AES192_KWP
MBEDTLS_OID_AES256_KW
MBEDTLS_OID_AES256_KWP
MBEDTLS_OID_PKCS5_PBKDF2

id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12}

MBEDTLS_OID_PKCS5_PBES2

id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13}

MBEDTLS_OID_PKCS5_PBMAC1

id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14}

MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC

pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3}

MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC

pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6}

MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC

pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10}

MBEDTLS_OID_PKCS5_PBE_SHA1_RC2_CBC

pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11}

MBEDTLS_OID_PKCS7_DATA

Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1}

MBEDTLS_OID_PKCS7_SIGNED_DATA

Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2}

MBEDTLS_OID_PKCS7_ENVELOPED_DATA

Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3}

MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA

Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4}

MBEDTLS_OID_PKCS7_DIGESTED_DATA

Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5}

MBEDTLS_OID_PKCS7_ENCRYPTED_DATA

Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6}

MBEDTLS_OID_PKCS9_CSR_EXT_REQ

extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14}

MBEDTLS_OID_PKCS12_PBE

pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1}

MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC

pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3}

MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC

pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4}

MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC

pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5}

MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_40_CBC

pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6}

MBEDTLS_OID_EC_ALG_UNRESTRICTED
MBEDTLS_OID_EC_ALG_ECDH
MBEDTLS_OID_EC_GRP_SECP192R1
MBEDTLS_OID_EC_GRP_SECP224R1
MBEDTLS_OID_EC_GRP_SECP256R1
MBEDTLS_OID_EC_GRP_SECP384R1
MBEDTLS_OID_EC_GRP_SECP521R1
MBEDTLS_OID_EC_GRP_SECP192K1
MBEDTLS_OID_EC_GRP_SECP224K1
MBEDTLS_OID_EC_GRP_SECP256K1
MBEDTLS_OID_EC_BRAINPOOL_V1
MBEDTLS_OID_EC_GRP_BP256R1
MBEDTLS_OID_EC_GRP_BP384R1
MBEDTLS_OID_EC_GRP_BP512R1
MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE
MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD
MBEDTLS_OID_ANSI_X9_62_SIG
MBEDTLS_OID_ANSI_X9_62_SIG_SHA2
MBEDTLS_OID_ECDSA_SHA1
MBEDTLS_OID_ECDSA_SHA224
MBEDTLS_OID_ECDSA_SHA256
MBEDTLS_OID_ECDSA_SHA384
MBEDTLS_OID_ECDSA_SHA512
MBEDTLS_OID_X25519

id-X25519 OBJECT IDENTIFIER ::= { 1 3 101 110 }

MBEDTLS_OID_X448

id-X448 OBJECT IDENTIFIER ::= { 1 3 101 111 }

MBEDTLS_OID_ED25519

id-Ed25519 OBJECT IDENTIFIER ::= { 1 3 101 112 }

MBEDTLS_OID_ED448

id-Ed448 OBJECT IDENTIFIER ::= { 1 3 101 113 }

Typedefs

typedef struct mbedtls_oid_descriptor_t mbedtls_oid_descriptor_t

Base OID descriptor structure.

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”)

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

int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size)

Translate a string containing a dotted-decimal representation of an ASN.1 OID into its encoded form (e.g. “1.2.840.113549” into “\x2A\x86\x48\x86\xF7\x0D”). On success, this function allocates oid->buf from the heap. It must be freed by the caller using mbedtls_free().

Parameters
  • oidmbedtls_asn1_buf to populate with the DER-encoded OID

  • oid_str – string representation of the OID to parse

  • size – length of the OID string, not including any null terminator

Returns

0 if successful

Returns

MBEDTLS_ERR_ASN1_INVALID_DATA if oid_str does not represent a valid OID

Returns

MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to allocate oid->buf

int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type)

Translate an X.509 extension OID into local values.

Parameters
  • oid – OID to use

  • ext_type – place to store the extension type

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name)

Translate an X.509 attribute type OID into the short name (e.g. the OID for an X520 Common Name into “CN”)

Parameters
  • oid – OID to use

  • short_name – place to store the string pointer

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg)

Translate PublicKeyAlgorithm OID into pk_type.

Parameters
  • oid – OID to use

  • pk_alg – place to store public key algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg, const char **oid, size_t *olen)

Translate pk_type into PublicKeyAlgorithm OID.

Parameters
  • pk_alg – Public key type to look for

  • oid – place to store ASN.1 OID string pointer

  • olen – length of the OID

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_ec_grp(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id)

Translate NamedCurve OID into an EC group identifier.

Parameters
  • oid – OID to use

  • grp_id – place to store group id

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id, const char **oid, size_t *olen)

Translate EC group identifier into NamedCurve OID.

Parameters
  • grp_id – EC group identifier

  • oid – place to store ASN.1 OID string pointer

  • olen – length of the OID

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_ec_grp_algid(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id)

Translate AlgorithmIdentifier OID into an EC group identifier, for curves that are directly encoded at this level.

Parameters
  • oid – OID to use

  • grp_id – place to store group id

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_oid_by_ec_grp_algid(mbedtls_ecp_group_id grp_id, const char **oid, size_t *olen)

Translate EC group identifier into AlgorithmIdentifier OID, for curves that are directly encoded at this level.

Parameters
  • grp_id – EC group identifier

  • oid – place to store ASN.1 OID string pointer

  • olen – length of the OID

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg)

Translate SignatureAlgorithm OID into md_type and pk_type.

Parameters
  • oid – OID to use

  • md_alg – place to store message digest algorithm

  • pk_alg – place to store public key algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc)

Translate SignatureAlgorithm OID into description.

Parameters
  • oid – OID to use

  • desc – place to store string pointer

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg, const char **oid, size_t *olen)

Translate md_type and pk_type into SignatureAlgorithm OID.

Parameters
  • md_alg – message digest algorithm

  • pk_alg – public key algorithm

  • oid – place to store ASN.1 OID string pointer

  • olen – length of the OID

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac)

Translate hmac algorithm OID into md_type.

Parameters
  • oid – OID to use

  • md_hmac – place to store message hmac algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_md_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg)

Translate hash algorithm OID into md_type.

Parameters
  • oid – OID to use

  • md_alg – place to store message digest algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc)

Translate certificate policies OID into description.

Parameters
  • oid – OID to use

  • desc – place to store string pointer

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen)

Translate md_type into hash algorithm OID.

Parameters
  • md_alg – message digest algorithm

  • oid – place to store ASN.1 OID string pointer

  • olen – length of the OID

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg)

Translate encryption algorithm OID into cipher_type.

Parameters
  • oid – OID to use

  • cipher_alg – place to store cipher algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg, mbedtls_cipher_type_t *cipher_alg)

Translate PKCS#12 PBE algorithm OID into md_type and cipher_type.

Parameters
  • oid – OID to use

  • md_alg – place to store message digest algorithm

  • cipher_alg – place to store cipher algorithm

Returns

0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND

struct mbedtls_oid_descriptor_t
#include <oid.h>

Base OID descriptor structure.

Public Members

const char *private_asn1

OID ASN.1 representation

size_t private_asn1_len

length of asn1