1 | /* $Id: asn1-ut-string-decode.cpp 93115 2022-01-01 11:31:46Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * IPRT - ASN.1, XXX STRING Types, Decoding.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2022 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * The contents of this file may alternatively be used under the terms
|
---|
18 | * of the Common Development and Distribution License Version 1.0
|
---|
19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
21 | * CDDL are applicable instead of those of the GPL.
|
---|
22 | *
|
---|
23 | * You may elect to license modified versions of this file under the
|
---|
24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
25 | */
|
---|
26 |
|
---|
27 |
|
---|
28 | /*********************************************************************************************************************************
|
---|
29 | * Header Files *
|
---|
30 | *********************************************************************************************************************************/
|
---|
31 | #include "internal/iprt.h"
|
---|
32 | #include <iprt/asn1.h>
|
---|
33 |
|
---|
34 | #include <iprt/alloca.h>
|
---|
35 | #include <iprt/err.h>
|
---|
36 | #include <iprt/string.h>
|
---|
37 | #include <iprt/ctype.h>
|
---|
38 |
|
---|
39 | #include <iprt/formats/asn1.h>
|
---|
40 |
|
---|
41 |
|
---|
42 | RTDECL(int) RTAsn1String_DecodeAsn1(PRTASN1CURSOR pCursor, uint32_t fFlags, PRTASN1STRING pThis, const char *pszErrorTag)
|
---|
43 | {
|
---|
44 | RT_ZERO(*pThis);
|
---|
45 | AssertReturn(!(fFlags & RTASN1CURSOR_GET_F_IMPLICIT), VERR_INVALID_PARAMETER);
|
---|
46 |
|
---|
47 | int rc = RTAsn1CursorReadHdr(pCursor, &pThis->Asn1Core, pszErrorTag);
|
---|
48 | if (RT_SUCCESS(rc))
|
---|
49 | {
|
---|
50 | /*
|
---|
51 | * Do tag matching.
|
---|
52 | */
|
---|
53 | switch (pThis->Asn1Core.uTag)
|
---|
54 | {
|
---|
55 | case ASN1_TAG_UTF8_STRING:
|
---|
56 | case ASN1_TAG_NUMERIC_STRING:
|
---|
57 | case ASN1_TAG_PRINTABLE_STRING:
|
---|
58 | case ASN1_TAG_T61_STRING:
|
---|
59 | case ASN1_TAG_VIDEOTEX_STRING:
|
---|
60 | case ASN1_TAG_IA5_STRING:
|
---|
61 | case ASN1_TAG_GENERALIZED_TIME:
|
---|
62 | case ASN1_TAG_GRAPHIC_STRING:
|
---|
63 | case ASN1_TAG_VISIBLE_STRING:
|
---|
64 | case ASN1_TAG_GENERAL_STRING:
|
---|
65 | case ASN1_TAG_UNIVERSAL_STRING:
|
---|
66 | case ASN1_TAG_BMP_STRING:
|
---|
67 | rc = VINF_SUCCESS;
|
---|
68 | break;
|
---|
69 | default:
|
---|
70 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CURSOR_TAG_MISMATCH,
|
---|
71 | "%s: Not a string object: fClass=%#x / uTag=%#x",
|
---|
72 | pszErrorTag, pThis->Asn1Core.fClass, pThis->Asn1Core.uTag);
|
---|
73 | }
|
---|
74 | if (RT_SUCCESS(rc))
|
---|
75 | {
|
---|
76 | /*
|
---|
77 | * Match flags. CER/DER makes it complicated.
|
---|
78 | */
|
---|
79 | if (pThis->Asn1Core.fClass == (ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_PRIMITIVE))
|
---|
80 | {
|
---|
81 | /*
|
---|
82 | * Primitive strings are simple.
|
---|
83 | */
|
---|
84 | RTAsn1CursorSkip(pCursor, pThis->Asn1Core.cb);
|
---|
85 | pThis->Asn1Core.pOps = &g_RTAsn1String_Vtable;
|
---|
86 | pThis->Asn1Core.fFlags |= RTASN1CORE_F_PRIMITE_TAG_STRUCT;
|
---|
87 | RTAsn1CursorInitAllocation(pCursor, &pThis->Allocation);
|
---|
88 |
|
---|
89 | /* UTF-8 conversion is done lazily, upon request. */
|
---|
90 | return VINF_SUCCESS;
|
---|
91 | }
|
---|
92 |
|
---|
93 | if (pThis->Asn1Core.fClass == (ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_CONSTRUCTED))
|
---|
94 | {
|
---|
95 | /*
|
---|
96 | * Constructed strings are not yet fully implemented.
|
---|
97 | */
|
---|
98 | if (pCursor->fFlags & RTASN1CURSOR_FLAGS_DER)
|
---|
99 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CURSOR_ILLEGAL_CONSTRUCTED_STRING,
|
---|
100 | "%s: DER encoding does not allow constructed strings (cb=%#x uTag=%#x fClass=%#x)",
|
---|
101 | pszErrorTag, pThis->Asn1Core.cb, pThis->Asn1Core.uTag, pThis->Asn1Core.fClass);
|
---|
102 | else if (pCursor->fFlags & RTASN1CURSOR_FLAGS_CER)
|
---|
103 | {
|
---|
104 | if (pThis->Asn1Core.cb > 1000)
|
---|
105 | rc = VINF_SUCCESS;
|
---|
106 | else
|
---|
107 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CURSOR_ILLEGAL_CONSTRUCTED_STRING,
|
---|
108 | "%s: Constructed strings only allowed for >1000 byte in CER encoding: cb=%#x uTag=%#x fClass=%#x",
|
---|
109 | pszErrorTag, pThis->Asn1Core.cb,
|
---|
110 | pThis->Asn1Core.uTag, pThis->Asn1Core.fClass);
|
---|
111 | }
|
---|
112 | /** @todo implement constructed strings. */
|
---|
113 | if (RT_SUCCESS(rc))
|
---|
114 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CONSTRUCTED_STRING_NOT_IMPL,
|
---|
115 | "%s: Support for constructed strings is not implemented", pszErrorTag);
|
---|
116 | }
|
---|
117 | else
|
---|
118 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CURSOR_TAG_FLAG_CLASS_MISMATCH,
|
---|
119 | "%s: Not a valid string object: fClass=%#x / uTag=%#x",
|
---|
120 | pszErrorTag, pThis->Asn1Core.fClass, pThis->Asn1Core.uTag);
|
---|
121 | }
|
---|
122 | }
|
---|
123 | RT_ZERO(*pThis);
|
---|
124 | return rc;
|
---|
125 | }
|
---|
126 |
|
---|
127 |
|
---|
128 | /**
|
---|
129 | * Common worker for the specific string type getters.
|
---|
130 | *
|
---|
131 | * @returns IPRT status code
|
---|
132 | * @param pCursor The cursor.
|
---|
133 | * @param fFlags The RTASN1CURSOR_GET_F_XXX flags.
|
---|
134 | * @param uTag The string tag.
|
---|
135 | * @param pThis The output object.
|
---|
136 | * @param pszErrorTag The error tag.
|
---|
137 | * @param pszWhat The string type name.
|
---|
138 | */
|
---|
139 | static int rtAsn1XxxString_DecodeAsn1(PRTASN1CURSOR pCursor, uint32_t fFlags, uint8_t uTag, PRTASN1STRING pThis,
|
---|
140 | const char *pszErrorTag, const char *pszWhat)
|
---|
141 | {
|
---|
142 | pThis->cchUtf8 = 0;
|
---|
143 | pThis->pszUtf8 = NULL;
|
---|
144 |
|
---|
145 | int rc = RTAsn1CursorReadHdr(pCursor, &pThis->Asn1Core, pszErrorTag);
|
---|
146 | if (RT_SUCCESS(rc))
|
---|
147 | {
|
---|
148 | rc = RTAsn1CursorMatchTagClassFlagsString(pCursor, &pThis->Asn1Core, uTag,
|
---|
149 | ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_PRIMITIVE,
|
---|
150 | fFlags, pszErrorTag, pszWhat);
|
---|
151 | if (RT_SUCCESS(rc))
|
---|
152 | {
|
---|
153 | if (!(pThis->Asn1Core.fClass & ASN1_TAGFLAG_CONSTRUCTED))
|
---|
154 | {
|
---|
155 | RTAsn1CursorSkip(pCursor, pThis->Asn1Core.cb);
|
---|
156 | pThis->Asn1Core.pOps = &g_RTAsn1String_Vtable;
|
---|
157 | pThis->Asn1Core.fFlags |= RTASN1CORE_F_PRIMITE_TAG_STRUCT;
|
---|
158 | RTAsn1CursorInitAllocation(pCursor, &pThis->Allocation);
|
---|
159 | /* UTF-8 conversion is done lazily, upon request. */
|
---|
160 | return VINF_SUCCESS;
|
---|
161 | }
|
---|
162 | rc = RTAsn1CursorSetInfo(pCursor, VERR_ASN1_CONSTRUCTED_STRING_NOT_IMPL,
|
---|
163 | "%s: Constructed %s not implemented.", pszErrorTag, pszWhat);
|
---|
164 | }
|
---|
165 | }
|
---|
166 | RT_ZERO(*pThis);
|
---|
167 | return rc;
|
---|
168 | }
|
---|
169 |
|
---|
170 |
|
---|
171 | /*
|
---|
172 | * Generate code for the tag specific decoders.
|
---|
173 | */
|
---|
174 | #define RTASN1STRING_IMPL(a_uTag, a_szTag, a_Api) \
|
---|
175 | RTDECL(int) RT_CONCAT(a_Api,_DecodeAsn1)(PRTASN1CURSOR pCursor, uint32_t fFlags, \
|
---|
176 | PRTASN1STRING pThis, const char *pszErrorTag) \
|
---|
177 | { \
|
---|
178 | return rtAsn1XxxString_DecodeAsn1(pCursor, fFlags, a_uTag, pThis, pszErrorTag, a_szTag); \
|
---|
179 | }
|
---|
180 | #include "asn1-ut-string-template2.h"
|
---|
181 |
|
---|
182 |
|
---|
183 | /*
|
---|
184 | * Generate code for the associated collection types.
|
---|
185 | */
|
---|
186 | #define RTASN1TMPL_TEMPLATE_FILE "../common/asn1/asn1-ut-string-template.h"
|
---|
187 | #include <iprt/asn1-generator-internal-header.h>
|
---|
188 | #include <iprt/asn1-generator-asn1-decoder.h>
|
---|
189 |
|
---|