1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
#
# This file is part of pyasn1-modules software.
#
# Created by Russ Housley with assistance from asn1ate v.0.6.0.
# Modified by Russ Housley to add items from the verified errata.
# Modified by Russ Housley to add maps for use with opentypes.
#
# Copyright (c) 2019, Vigil Security, LLC
# License: http://snmplabs.com/pyasn1/license.html
#
# CMS Firmware Wrapper
#
# ASN.1 source from:
# https://www.rfc-editor.org/rfc/rfc4108.txt
# https://www.rfc-editor.org/errata_search.php?rfc=4108
#
from pyasn1.type import univ, char, namedtype, namedval, tag, constraint, useful
from pyasn1_modules import rfc5280
from pyasn1_modules import rfc5652
MAX = float('inf')
class HardwareSerialEntry(univ.Choice):
pass
HardwareSerialEntry.componentType = namedtype.NamedTypes(
namedtype.NamedType('all', univ.Null()),
namedtype.NamedType('single', univ.OctetString()),
namedtype.NamedType('block', univ.Sequence(componentType=namedtype.NamedTypes(
namedtype.NamedType('low', univ.OctetString()),
namedtype.NamedType('high', univ.OctetString())
))
)
)
class HardwareModules(univ.Sequence):
pass
HardwareModules.componentType = namedtype.NamedTypes(
namedtype.NamedType('hwType', univ.ObjectIdentifier()),
namedtype.NamedType('hwSerialEntries', univ.SequenceOf(componentType=HardwareSerialEntry()))
)
class CommunityIdentifier(univ.Choice):
pass
CommunityIdentifier.componentType = namedtype.NamedTypes(
namedtype.NamedType('communityOID', univ.ObjectIdentifier()),
namedtype.NamedType('hwModuleList', HardwareModules())
)
class PreferredPackageIdentifier(univ.Sequence):
pass
PreferredPackageIdentifier.componentType = namedtype.NamedTypes(
namedtype.NamedType('fwPkgID', univ.ObjectIdentifier()),
namedtype.NamedType('verNum', univ.Integer().subtype(subtypeSpec=constraint.ValueRangeConstraint(0, MAX)))
)
class PreferredOrLegacyPackageIdentifier(univ.Choice):
pass
PreferredOrLegacyPackageIdentifier.componentType = namedtype.NamedTypes(
namedtype.NamedType('preferred', PreferredPackageIdentifier()),
namedtype.NamedType('legacy', univ.OctetString())
)
class CurrentFWConfig(univ.Sequence):
pass
CurrentFWConfig.componentType = namedtype.NamedTypes(
namedtype.OptionalNamedType('fwPkgType', univ.Integer()),
namedtype.NamedType('fwPkgName', PreferredOrLegacyPackageIdentifier())
)
class PreferredOrLegacyStalePackageIdentifier(univ.Choice):
pass
PreferredOrLegacyStalePackageIdentifier.componentType = namedtype.NamedTypes(
namedtype.NamedType('preferredStaleVerNum', univ.Integer().subtype(subtypeSpec=constraint.ValueRangeConstraint(0, MAX))),
namedtype.NamedType('legacyStaleVersion', univ.OctetString())
)
class FirmwarePackageLoadErrorCode(univ.Enumerated):
pass
FirmwarePackageLoadErrorCode.namedValues = namedval.NamedValues(
('decodeFailure', 1),
('badContentInfo', 2),
('badSignedData', 3),
('badEncapContent', 4),
('badCertificate', 5),
('badSignerInfo', 6),
('badSignedAttrs', 7),
('badUnsignedAttrs', 8),
('missingContent', 9),
('noTrustAnchor', 10),
('notAuthorized', 11),
('badDigestAlgorithm', 12),
('badSignatureAlgorithm', 13),
('unsupportedKeySize', 14),
('signatureFailure', 15),
('contentTypeMismatch', 16),
('badEncryptedData', 17),
('unprotectedAttrsPresent', 18),
('badEncryptContent', 19),
('badEncryptAlgorithm', 20),
('missingCiphertext', 21),
('noDecryptKey', 22),
('decryptFailure', 23),
('badCompressAlgorithm', 24),
('missingCompressedContent', 25),
('decompressFailure', 26),
('wrongHardware', 27),
('stalePackage', 28),
('notInCommunity', 29),
('unsupportedPackageType', 30),
('missingDependency', 31),
('wrongDependencyVersion', 32),
('insufficientMemory', 33),
('badFirmware', 34),
('unsupportedParameters', 35),
('breaksDependency', 36),
('otherError', 99)
)
class VendorLoadErrorCode(univ.Integer):
pass
# Wrapped Firmware Key Unsigned Attribute and Object Identifier
id_aa_wrappedFirmwareKey = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.39')
class WrappedFirmwareKey(rfc5652.EnvelopedData):
pass
# Firmware Package Information Signed Attribute and Object Identifier
id_aa_firmwarePackageInfo = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.42')
class FirmwarePackageInfo(univ.Sequence):
pass
FirmwarePackageInfo.componentType = namedtype.NamedTypes(
namedtype.OptionalNamedType('fwPkgType', univ.Integer()),
namedtype.OptionalNamedType('dependencies', univ.SequenceOf(componentType=PreferredOrLegacyPackageIdentifier()))
)
FirmwarePackageInfo.sizeSpec = univ.Sequence.sizeSpec + constraint.ValueSizeConstraint(1, 2)
# Community Identifiers Signed Attribute and Object Identifier
id_aa_communityIdentifiers = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.40')
class CommunityIdentifiers(univ.SequenceOf):
pass
CommunityIdentifiers.componentType = CommunityIdentifier()
# Implemented Compression Algorithms Signed Attribute and Object Identifier
id_aa_implCompressAlgs = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.43')
class ImplementedCompressAlgorithms(univ.SequenceOf):
pass
ImplementedCompressAlgorithms.componentType = univ.ObjectIdentifier()
# Implemented Cryptographic Algorithms Signed Attribute and Object Identifier
id_aa_implCryptoAlgs = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.38')
class ImplementedCryptoAlgorithms(univ.SequenceOf):
pass
ImplementedCryptoAlgorithms.componentType = univ.ObjectIdentifier()
# Decrypt Key Identifier Signed Attribute and Object Identifier
id_aa_decryptKeyID = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.37')
class DecryptKeyIdentifier(univ.OctetString):
pass
# Target Hardware Identifier Signed Attribute and Object Identifier
id_aa_targetHardwareIDs = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.36')
class TargetHardwareIdentifiers(univ.SequenceOf):
pass
TargetHardwareIdentifiers.componentType = univ.ObjectIdentifier()
# Firmware Package Identifier Signed Attribute and Object Identifier
id_aa_firmwarePackageID = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.35')
class FirmwarePackageIdentifier(univ.Sequence):
pass
FirmwarePackageIdentifier.componentType = namedtype.NamedTypes(
namedtype.NamedType('name', PreferredOrLegacyPackageIdentifier()),
namedtype.OptionalNamedType('stale', PreferredOrLegacyStalePackageIdentifier())
)
# Firmware Package Message Digest Signed Attribute and Object Identifier
id_aa_fwPkgMessageDigest = univ.ObjectIdentifier('1.2.840.113549.1.9.16.2.41')
class FirmwarePackageMessageDigest(univ.Sequence):
pass
FirmwarePackageMessageDigest.componentType = namedtype.NamedTypes(
namedtype.NamedType('algorithm', rfc5280.AlgorithmIdentifier()),
namedtype.NamedType('msgDigest', univ.OctetString())
)
# Firmware Package Load Error Report Content Type and Object Identifier
class FWErrorVersion(univ.Integer):
pass
FWErrorVersion.namedValues = namedval.NamedValues(
('v1', 1)
)
id_ct_firmwareLoadError = univ.ObjectIdentifier('1.2.840.113549.1.9.16.1.18')
class FirmwarePackageLoadError(univ.Sequence):
pass
FirmwarePackageLoadError.componentType = namedtype.NamedTypes(
namedtype.DefaultedNamedType('version', FWErrorVersion().subtype(value='v1')),
namedtype.NamedType('hwType', univ.ObjectIdentifier()),
namedtype.NamedType('hwSerialNum', univ.OctetString()),
namedtype.NamedType('errorCode', FirmwarePackageLoadErrorCode()),
namedtype.OptionalNamedType('vendorErrorCode', VendorLoadErrorCode()),
namedtype.OptionalNamedType('fwPkgName', PreferredOrLegacyPackageIdentifier()),
namedtype.OptionalNamedType('config', univ.SequenceOf(componentType=CurrentFWConfig()).subtype(implicitTag=tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 1)))
)
# Firmware Package Load Receipt Content Type and Object Identifier
class FWReceiptVersion(univ.Integer):
pass
FWReceiptVersion.namedValues = namedval.NamedValues(
('v1', 1)
)
id_ct_firmwareLoadReceipt = univ.ObjectIdentifier('1.2.840.113549.1.9.16.1.17')
class FirmwarePackageLoadReceipt(univ.Sequence):
pass
FirmwarePackageLoadReceipt.componentType = namedtype.NamedTypes(
namedtype.DefaultedNamedType('version', FWReceiptVersion().subtype(value='v1')),
namedtype.NamedType('hwType', univ.ObjectIdentifier()),
namedtype.NamedType('hwSerialNum', univ.OctetString()),
namedtype.NamedType('fwPkgName', PreferredOrLegacyPackageIdentifier()),
namedtype.OptionalNamedType('trustAnchorKeyID', univ.OctetString()),
namedtype.OptionalNamedType('decryptKeyID', univ.OctetString().subtype(implicitTag=tag.Tag(tag.tagClassContext, tag.tagFormatSimple, 1)))
)
# Firmware Package Content Type and Object Identifier
id_ct_firmwarePackage = univ.ObjectIdentifier('1.2.840.113549.1.9.16.1.16')
class FirmwarePkgData(univ.OctetString):
pass
# Other Name syntax for Hardware Module Name
id_on_hardwareModuleName = univ.ObjectIdentifier('1.3.6.1.5.5.7.8.4')
class HardwareModuleName(univ.Sequence):
pass
HardwareModuleName.componentType = namedtype.NamedTypes(
namedtype.NamedType('hwType', univ.ObjectIdentifier()),
namedtype.NamedType('hwSerialNum', univ.OctetString())
)
# Map of Attribute Type OIDs to Attributes is added to the
# ones that are in rfc5652.py
_cmsAttributesMapUpdate = {
id_aa_wrappedFirmwareKey: WrappedFirmwareKey(),
id_aa_firmwarePackageInfo: FirmwarePackageInfo(),
id_aa_communityIdentifiers: CommunityIdentifiers(),
id_aa_implCompressAlgs: ImplementedCompressAlgorithms(),
id_aa_implCryptoAlgs: ImplementedCryptoAlgorithms(),
id_aa_decryptKeyID: DecryptKeyIdentifier(),
id_aa_targetHardwareIDs: TargetHardwareIdentifiers(),
id_aa_firmwarePackageID: FirmwarePackageIdentifier(),
id_aa_fwPkgMessageDigest: FirmwarePackageMessageDigest(),
}
rfc5652.cmsAttributesMap.update(_cmsAttributesMapUpdate)
# Map of Content Type OIDs to Content Types is added to the
# ones that are in rfc5652.py
_cmsContentTypesMapUpdate = {
id_ct_firmwareLoadError: FirmwarePackageLoadError(),
id_ct_firmwareLoadReceipt: FirmwarePackageLoadReceipt(),
id_ct_firmwarePackage: FirmwarePkgData(),
}
rfc5652.cmsContentTypesMap.update(_cmsContentTypesMapUpdate)
# Map of Other Name OIDs to Other Name is added to the
# ones that are in rfc5280.py
_anotherNameMapUpdate = {
id_on_hardwareModuleName: HardwareModuleName(),
}
rfc5280.anotherNameMap.update(_anotherNameMapUpdate)
|
