13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * IPRT - ASN.1, OBJECT IDENTIFIER Type, Decoder.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Copyright (C) 2006-2014 Oracle Corporation
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * available from http://www.virtualbox.org. This file is free software;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * you can redistribute it and/or modify it under the terms of the GNU
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * General Public License (GPL) as published by the Free Software
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * The contents of this file may alternatively be used under the terms
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * of the Common Development and Distribution License Version 1.0
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * VirtualBox OSE distribution, in which case the provisions of the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * CDDL are applicable instead of those of the GPL.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * You may elect to license modified versions of this file under the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * terms and conditions of either the GPL or the CDDL or both.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/*******************************************************************************
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync* Header Files *
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync*******************************************************************************/
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/*******************************************************************************
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync* Global Variables *
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync*******************************************************************************/
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync/*******************************************************************************
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync* Internal Functions *
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync*******************************************************************************/
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncDECLHIDDEN(int) rtAsn1ObjId_InternalFormatComponent(uint32_t uValue, char **ppszObjId, size_t *pcbObjId); /* asn1-ut-objid.cpp */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Internal worker for RTAsn1ObjId_DecodeAsn1 that formats a component, with a
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * leading dot.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @returns VBox status code (caller complains on failure).
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param uValue The component ID value.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param ppszObjId Pointer to the output buffer pointer.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pcbObjId Pointer to the remaining size of the output buffer.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncDECLHIDDEN(int) rtAsn1ObjId_InternalFormatComponent(uint32_t uValue, char **ppszObjId, size_t *pcbObjId)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Format the number backwards.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync } while (uValue > 0);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Do we have enough space?
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * We add a dot and save space for the terminator.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync size_t cchNeeded = &szTmp[sizeof(szTmp) - 1] - psz;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Reads one object ID component, returning it's value and encoded length.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @returns The encoded length (positive) on success, negative IPRT status code
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * on failure.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pbContent The start of the component to parse.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param cbContent The number of content bytes left.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param puValue Where to return the value.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncstatic int rtAsn1ObjId_ReadComponent(uint8_t const *pbContent, uint32_t cbContent, uint32_t *puValue)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync /* The first byte. */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync if (!(b & 0x80))
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync /* Encoded as more than one byte. Make sure that it's efficently
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync encoded as 8.19.2 indicates it must. */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync if (b != 0x80)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync if (!(b & 0x80))
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync return (int)off;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * This function parses the binary content of an OBJECT IDENTIFIER, check the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * encoding as well as calculating the storage requirements.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @returns IPRT status code
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pbContent Pointer to the content.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param cbContent The length of the content.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pCursor The cursor (for error reporting).
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pszErrorTag The error tag.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pcComponents Where to return the component count.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * @param pcchObjId Where to return the length of the dotted string
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * representation.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncstatic int rtAsn1ObjId_PreParse(uint8_t const *pbContent, uint32_t cbContent, PRTASN1CURSOR pCursor, const char *pszErrorTag,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Decode the first two numbers. Monkey business: X*40 + Y
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Where X is the first number, X in {0,1,2}, and Y is the second
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * one. The range of Y is {0,...,39} for X in {0,1}, but has a
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * free range for X = 2.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_ReadComponent(pbContent, cbContent, &uValue);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync uValue = uValue < 2*40 ? uValue % 40 : uValue - 2*40; /* Y */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync /* Figure the encoded string length, binary search fashion. */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync /* advance. */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync if (cchObjId < RT_SIZEOFMEMB(RTASN1OBJID, szObjId))
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync return RTAsn1CursorSetInfo(pCursor, VERR_ASN1_OBJID_TOO_LONG_STRING_FORM,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync "Object ID has a too long string form: %#x (max %#x)",
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync return RTAsn1CursorSetInfo(pCursor, VERR_ASN1_OBJID_TOO_MANY_COMPONENTS,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync "Object ID has too many components: %#x (max 127)", cComponents);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_ReadComponent(pbContent, cbContent, &uValue);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync } while (rc > 0);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = RTAsn1CursorSetInfo(pCursor, rc, "Bad object ID component #%u encoding: %.*Rhxs",
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_INVALID_OBJID_ENCODING, "Object ID content is loo long: %#x", cbContent);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_INVALID_OBJID_ENCODING, "Zero length object ID content");
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsyncRTDECL(int) RTAsn1ObjId_DecodeAsn1(PRTASN1CURSOR pCursor, uint32_t fFlags, PRTASN1OBJID pThis, const char *pszErrorTag)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync int rc = RTAsn1CursorReadHdr(pCursor, &pThis->Asn1Core, pszErrorTag);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = RTAsn1CursorMatchTagClassFlags(pCursor, &pThis->Asn1Core, ASN1_TAG_OID,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_PRIMITIVE, fFlags, pszErrorTag, "OID");
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Validate and count things first.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_PreParse(pCursor->pbCur, pThis->Asn1Core.cb, pCursor, pszErrorTag, &cComponents, &cchObjId);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Allocate memory for the components array, either out of the
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * string buffer or off the heap.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync RTAsn1CursorInitAllocation(pCursor, &pThis->Allocation);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync#if 0 /** @todo breaks with arrays of ObjIds or structs containing them. They get resized and repositioned in memory, thus invalidating the pointer. Add recall-pointers callback, or just waste memory? Or maybe make all arrays pointer-arrays? */
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync if (cComponents * sizeof(uint32_t) <= sizeof(pThis->szObjId) - cchObjId - 1)
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync pThis->pauComponents = (uint32_t *)&pThis->szObjId[sizeof(pThis->szObjId) - cComponents * sizeof(uint32_t)];
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = RTAsn1MemAllocZ(&pThis->Allocation, (void **)&pThis->pauComponents,
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync uint32_t *pauComponents = (uint32_t *)pThis->pauComponents;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Deal with the two first components first since they are
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * encoded in a weird way to save a byte.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_ReadComponent(pbContent, cbContent, &uValue); AssertRC(rc);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_InternalFormatComponent(pauComponents[1], &pszObjId, &cbObjIdLeft); AssertRC(rc);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * The other components are encoded in less complicated manner.
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_ReadComponent(pbContent, cbContent, &uValue);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync rc = rtAsn1ObjId_InternalFormatComponent(uValue, &pszObjId, &cbObjIdLeft);
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync pThis->Asn1Core.fFlags |= RTASN1CORE_F_PRIMITE_TAG_STRUCT;
13493ab7596e827b8d0caab2c89e635dd65f78f9vboxsync * Generate code for the associated collection types.