VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/asn1/asn1-ut-time.cpp

Last change on this file was 98103, checked in by vboxsync, 16 months ago

Copyright year updates by scm.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.9 KB
Line 
1/* $Id: asn1-ut-time.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * IPRT - ASN.1, UTC TIME and GENERALIZED TIME Types.
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#include "internal/iprt.h"
42#include <iprt/asn1.h>
43
44#include <iprt/ctype.h>
45#include <iprt/err.h>
46#include <iprt/string.h>
47#include <iprt/uni.h>
48
49#include <iprt/formats/asn1.h>
50
51
52/*********************************************************************************************************************************
53* Global Variables *
54*********************************************************************************************************************************/
55/** The UTC TIME encoding of the IPRT epoch time. */
56static const char g_szEpochUtc[] = "700101000000Z";
57/** The GENERALIZED TIME encoding of the IPRT epoch time. */
58static const char g_szEpochGeneralized[] = "19700101000000Z";
59
60
61/*
62 * ASN.1 TIME - Special Methods.
63 */
64
65RTDECL(int) RTAsn1Time_InitEx(PRTASN1TIME pThis, uint32_t uTag, PCRTASN1ALLOCATORVTABLE pAllocator)
66{
67 RT_NOREF_PV(pAllocator);
68 AssertReturn(uTag == ASN1_TAG_UTC_TIME || uTag == ASN1_TAG_GENERALIZED_TIME, VERR_INVALID_PARAMETER);
69 RTAsn1Core_InitEx(&pThis->Asn1Core,
70 uTag,
71 ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_PRIMITIVE,
72 &g_RTAsn1Time_Vtable,
73 RTASN1CORE_F_PRESENT | RTASN1CORE_F_PRIMITE_TAG_STRUCT);
74 if (uTag == ASN1_TAG_UTC_TIME)
75 {
76 pThis->Asn1Core.cb = sizeof(g_szEpochUtc) - 1;
77 pThis->Asn1Core.uData.pv = &g_szEpochUtc[0];
78 }
79 else
80 {
81 pThis->Asn1Core.cb = sizeof(g_szEpochGeneralized) - 1;
82 pThis->Asn1Core.uData.pv = &g_szEpochGeneralized[0];
83 }
84
85 RTTIMESPEC EpochTimeSpec;
86 RTTimeExplode(&pThis->Time, RTTimeSpecSetSeconds(&EpochTimeSpec, 0));
87
88 return VINF_SUCCESS;
89}
90
91
92RTDECL(int) RTAsn1Time_InitWithTime(PRTASN1TIME pThis, uint32_t uTag, PCRTASN1ALLOCATORVTABLE pAllocator, PCRTTIME pTime)
93{
94 int rc = RTAsn1Time_InitEx(pThis, uTag, pAllocator); /* this doens't leave any state needing deletion */
95 if (RT_SUCCESS(rc) && pTime)
96 rc = RTAsn1Time_SetTime(pThis, pAllocator, pTime);
97 return rc;
98}
99
100
101RTDECL(int) RTAsn1Time_SetTime(PRTASN1TIME pThis, PCRTASN1ALLOCATORVTABLE pAllocator, PCRTTIME pTime)
102{
103 /*
104 * Validate input.
105 */
106 AssertReturn(RTAsn1Time_IsPresent(pThis), VERR_INVALID_STATE); /* Use RTAsn1Time_InitWithTime. */
107
108 RTTIMESPEC TmpTimeSpec;
109 AssertReturn(RTTimeImplode(&TmpTimeSpec, pTime), VERR_INVALID_PARAMETER);
110 RTTIME NormalizedTime;
111 RTTimeExplode(&NormalizedTime, &TmpTimeSpec);
112
113 uint32_t const uTag = RTASN1CORE_GET_TAG(&pThis->Asn1Core);
114 if (uTag == ASN1_TAG_UTC_TIME)
115 {
116 AssertReturn(NormalizedTime.i32Year >= 1950, VERR_INVALID_PARAMETER);
117 AssertReturn(NormalizedTime.i32Year < 2050, VERR_INVALID_PARAMETER);
118 }
119 else
120 {
121 AssertReturn(uTag == ASN1_TAG_GENERAL_STRING, VERR_INVALID_STATE);
122 AssertReturn(NormalizedTime.i32Year >= 0, VERR_INVALID_PARAMETER);
123 AssertReturn(NormalizedTime.i32Year < 9999, VERR_INVALID_PARAMETER);
124 }
125
126 /*
127 * Format the string to a temporary buffer, since the ASN.1 content isn't
128 * zero terminated and we cannot use RTStrPrintf directly on it.
129 */
130 char szTmp[64];
131 uint32_t cchTime;
132 if (uTag == ASN1_TAG_UTC_TIME)
133 cchTime = (uint32_t)RTStrPrintf(szTmp, sizeof(szTmp), "%02u%02u%02u%02u%02u%02uZ",
134 NormalizedTime.i32Year % 100,
135 NormalizedTime.u8Month,
136 NormalizedTime.u8MonthDay,
137 NormalizedTime.u8Hour,
138 NormalizedTime.u8Minute,
139 NormalizedTime.u8Second);
140 else
141 cchTime = (uint32_t)RTStrPrintf(szTmp, sizeof(szTmp), "%04u%02u%02u%02u%02u%02uZ",
142 NormalizedTime.i32Year,
143 NormalizedTime.u8Month,
144 NormalizedTime.u8MonthDay,
145 NormalizedTime.u8Hour,
146 NormalizedTime.u8Minute,
147 NormalizedTime.u8Second);
148 AssertReturn(cchTime == (uTag == ASN1_TAG_UTC_TIME ? sizeof(g_szEpochUtc) - 1 : sizeof(g_szEpochGeneralized) - 1),
149 VERR_INTERNAL_ERROR_3);
150
151 /*
152 * (Re-)Allocate content buffer, copy over the formatted timestamp and
153 * set the exploded time member to the new time.
154 */
155 int rc = RTAsn1ContentReallocZ(&pThis->Asn1Core, cchTime, pAllocator);
156 if (RT_SUCCESS(rc))
157 {
158 memcpy((void *)pThis->Asn1Core.uData.pv, szTmp, cchTime);
159 pThis->Time = NormalizedTime;
160 }
161 return rc;
162}
163
164
165RTDECL(int) RTAsn1Time_SetTimeSpec(PRTASN1TIME pThis, PCRTASN1ALLOCATORVTABLE pAllocator, PCRTTIMESPEC pTimeSpec)
166{
167 RTTIME Time;
168 return RTAsn1Time_SetTime(pThis, pAllocator, RTTimeExplode(&Time, pTimeSpec));
169}
170
171
172RTDECL(int) RTAsn1Time_CompareWithTimeSpec(PCRTASN1TIME pLeft, PCRTTIMESPEC pTsRight)
173{
174 int iDiff = RTAsn1Time_IsPresent(pLeft) ? 0 : -1;
175 if (!iDiff)
176 {
177 RTTIME RightTime;
178 iDiff = RTTimeCompare(&pLeft->Time, RTTimeExplode(&RightTime, pTsRight));
179 }
180
181 return iDiff;
182}
183
184
185/*
186 * ASN.1 TIME - Standard Methods.
187 */
188
189RT_DECL_DATA_CONST(RTASN1COREVTABLE const) g_RTAsn1Time_Vtable =
190{
191 "RTAsn1Time",
192 sizeof(RTASN1TIME),
193 UINT8_MAX,
194 ASN1_TAGCLASS_UNIVERSAL | ASN1_TAGFLAG_PRIMITIVE,
195 0,
196 (PFNRTASN1COREVTDTOR)RTAsn1Time_Delete,
197 NULL,
198 (PFNRTASN1COREVTCLONE)RTAsn1Time_Clone,
199 (PFNRTASN1COREVTCOMPARE)RTAsn1Time_Compare,
200 (PFNRTASN1COREVTCHECKSANITY)RTAsn1Time_CheckSanity,
201 NULL,
202 NULL
203};
204
205
206RTDECL(int) RTAsn1Time_Init(PRTASN1TIME pThis, PCRTASN1ALLOCATORVTABLE pAllocator)
207{
208 /* Using UTC TIME since epoch would be encoded using UTC TIME following
209 X.509 Validity / Whatever time tag guidelines. */
210 return RTAsn1Time_InitEx(pThis, ASN1_TAG_UTC_TIME, pAllocator);
211}
212
213
214RTDECL(int) RTAsn1Time_Clone(PRTASN1TIME pThis, PCRTASN1TIME pSrc, PCRTASN1ALLOCATORVTABLE pAllocator)
215{
216 AssertPtr(pSrc); AssertPtr(pThis); AssertPtr(pAllocator);
217 RT_ZERO(*pThis);
218 if (RTAsn1Time_IsPresent(pSrc))
219 {
220 AssertReturn(pSrc->Asn1Core.pOps == &g_RTAsn1Time_Vtable, VERR_INTERNAL_ERROR_3);
221
222 int rc = RTAsn1Core_CloneContent(&pThis->Asn1Core, &pSrc->Asn1Core, pAllocator);
223 if (RT_SUCCESS(rc))
224 {
225 pThis->Time = pSrc->Time;
226 return VINF_SUCCESS;
227 }
228 return rc;
229 }
230 return VINF_SUCCESS;
231}
232
233
234RTDECL(void) RTAsn1Time_Delete(PRTASN1TIME pThis)
235{
236 if ( pThis
237 && RTAsn1Time_IsPresent(pThis))
238 {
239 Assert(pThis->Asn1Core.pOps == &g_RTAsn1Time_Vtable);
240
241 RTAsn1ContentFree(&pThis->Asn1Core);
242 RT_ZERO(*pThis);
243 }
244}
245
246
247RTDECL(int) RTAsn1Time_Enum(PRTASN1TIME pThis, PFNRTASN1ENUMCALLBACK pfnCallback, uint32_t uDepth, void *pvUser)
248{
249 RT_NOREF_PV(pThis); RT_NOREF_PV(pfnCallback); RT_NOREF_PV(uDepth); RT_NOREF_PV(pvUser);
250 Assert(pThis && (!RTAsn1Time_IsPresent(pThis) || pThis->Asn1Core.pOps == &g_RTAsn1Time_Vtable));
251
252 /* No children to enumerate. */
253 return VINF_SUCCESS;
254}
255
256
257RTDECL(int) RTAsn1Time_Compare(PCRTASN1TIME pLeft, PCRTASN1TIME pRight)
258{
259 Assert(pLeft && (!RTAsn1Time_IsPresent(pLeft) || pLeft->Asn1Core.pOps == &g_RTAsn1Time_Vtable));
260 Assert(pRight && (!RTAsn1Time_IsPresent(pRight) || pRight->Asn1Core.pOps == &g_RTAsn1Time_Vtable));
261
262 int iDiff;
263 if (RTAsn1Time_IsPresent(pLeft))
264 {
265 if (RTAsn1Time_IsPresent(pRight))
266 iDiff = RTTimeCompare(&pLeft->Time, &pRight->Time);
267 else
268 iDiff = -1;
269 }
270 else
271 iDiff = 0 - (int)RTAsn1Time_IsPresent(pRight);
272 return iDiff;
273}
274
275
276RTDECL(int) RTAsn1Time_CheckSanity(PCRTASN1TIME pThis, uint32_t fFlags, PRTERRINFO pErrInfo, const char *pszErrorTag)
277{
278 RT_NOREF_PV(fFlags);
279 if (RT_UNLIKELY(!RTAsn1Time_IsPresent(pThis)))
280 return RTErrInfoSetF(pErrInfo, VERR_ASN1_NOT_PRESENT, "%s: Missing (TIME).", pszErrorTag);
281 return VINF_SUCCESS;
282}
283
284
285/*
286 * Generate code for the tag specific methods.
287 * Note! This is very similar to what we're doing in asn1-ut-string.cpp.
288 */
289#define RTASN1TIME_IMPL(a_uTag, a_szTag, a_Api) \
290 \
291 RTDECL(int) RT_CONCAT(a_Api,_Init)(PRTASN1TIME pThis, PCRTASN1ALLOCATORVTABLE pAllocator) \
292 { \
293 return RTAsn1Time_InitEx(pThis, a_uTag, pAllocator); \
294 } \
295 \
296 RTDECL(int) RT_CONCAT(a_Api,_Clone)(PRTASN1TIME pThis, PCRTASN1TIME pSrc, PCRTASN1ALLOCATORVTABLE pAllocator) \
297 { \
298 AssertReturn(RTASN1CORE_GET_TAG(&pSrc->Asn1Core) == a_uTag || !RTAsn1Time_IsPresent(pSrc), \
299 VERR_ASN1_TIME_TAG_MISMATCH); \
300 return RTAsn1Time_Clone(pThis, pSrc, pAllocator); \
301 } \
302 \
303 RTDECL(void) RT_CONCAT(a_Api,_Delete)(PRTASN1TIME pThis) \
304 { \
305 Assert( !pThis \
306 || !RTAsn1Time_IsPresent(pThis) \
307 || ( pThis->Asn1Core.pOps == &g_RTAsn1Time_Vtable \
308 && RTASN1CORE_GET_TAG(&pThis->Asn1Core) == a_uTag) ); \
309 RTAsn1Time_Delete(pThis); \
310 } \
311 \
312 RTDECL(int) RT_CONCAT(a_Api,_Enum)(PRTASN1TIME pThis, PFNRTASN1ENUMCALLBACK pfnCallback, uint32_t uDepth, void *pvUser) \
313 { \
314 RT_NOREF_PV(pThis); RT_NOREF_PV(pfnCallback); RT_NOREF_PV(uDepth); RT_NOREF_PV(pvUser); \
315 Assert( pThis \
316 && ( !RTAsn1Time_IsPresent(pThis) \
317 || ( pThis->Asn1Core.pOps == &g_RTAsn1Time_Vtable \
318 && RTASN1CORE_GET_TAG(&pThis->Asn1Core) == a_uTag) ) ); \
319 /* No children to enumerate. */ \
320 return VINF_SUCCESS; \
321 } \
322 \
323 RTDECL(int) RT_CONCAT(a_Api,_Compare)(PCRTASN1TIME pLeft, PCRTASN1TIME pRight) \
324 { \
325 int iDiff = RTAsn1Time_Compare(pLeft, pRight); \
326 if (!iDiff && RTAsn1Time_IsPresent(pLeft)) \
327 { \
328 if (RTASN1CORE_GET_TAG(&pLeft->Asn1Core) == RTASN1CORE_GET_TAG(&pRight->Asn1Core)) \
329 { \
330 if (RTASN1CORE_GET_TAG(&pLeft->Asn1Core) != a_uTag) \
331 iDiff = RTASN1CORE_GET_TAG(&pLeft->Asn1Core) < a_uTag ? -1 : 1; \
332 } \
333 else \
334 iDiff = RTASN1CORE_GET_TAG(&pLeft->Asn1Core) < RTASN1CORE_GET_TAG(&pRight->Asn1Core) ? -1 : 1; \
335 } \
336 return iDiff; \
337 } \
338 \
339 RTDECL(int) RT_CONCAT(a_Api,_CheckSanity)(PCRTASN1TIME pThis, uint32_t fFlags, \
340 PRTERRINFO pErrInfo, const char *pszErrorTag) \
341 { \
342 if (RTASN1CORE_GET_TAG(&pThis->Asn1Core) != a_uTag && RTAsn1Time_IsPresent(pThis)) \
343 return RTErrInfoSetF(pErrInfo, VERR_ASN1_TIME_TAG_MISMATCH, "%s: uTag=%#x, expected %#x (%s)", \
344 pszErrorTag, RTASN1CORE_GET_TAG(&pThis->Asn1Core), a_uTag, a_szTag); \
345 return RTAsn1Time_CheckSanity(pThis, fFlags, pErrInfo, pszErrorTag); \
346 }
347
348#include "asn1-ut-time-template2.h"
349
350
351/*
352 * Generate code for the associated collection types.
353 */
354#define RTASN1TMPL_TEMPLATE_FILE "../common/asn1/asn1-ut-time-template.h"
355#include <iprt/asn1-generator-internal-header.h>
356#include <iprt/asn1-generator-core.h>
357#include <iprt/asn1-generator-init.h>
358#include <iprt/asn1-generator-sanity.h>
359
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use