mirror of
https://github.com/PiBrewing/craftbeerpi4.git
synced 2024-11-14 02:58:16 +01:00
5673 lines
167 KiB
Python
5673 lines
167 KiB
Python
|
# coding: utf-8
|
||
|
|
||
|
"""
|
||
|
ASN.1 type classes for universal types. Exports the following items:
|
||
|
|
||
|
- load()
|
||
|
- Any()
|
||
|
- Asn1Value()
|
||
|
- BitString()
|
||
|
- BMPString()
|
||
|
- Boolean()
|
||
|
- CharacterString()
|
||
|
- Choice()
|
||
|
- EmbeddedPdv()
|
||
|
- Enumerated()
|
||
|
- GeneralizedTime()
|
||
|
- GeneralString()
|
||
|
- GraphicString()
|
||
|
- IA5String()
|
||
|
- InstanceOf()
|
||
|
- Integer()
|
||
|
- IntegerBitString()
|
||
|
- IntegerOctetString()
|
||
|
- Null()
|
||
|
- NumericString()
|
||
|
- ObjectDescriptor()
|
||
|
- ObjectIdentifier()
|
||
|
- OctetBitString()
|
||
|
- OctetString()
|
||
|
- PrintableString()
|
||
|
- Real()
|
||
|
- RelativeOid()
|
||
|
- Sequence()
|
||
|
- SequenceOf()
|
||
|
- Set()
|
||
|
- SetOf()
|
||
|
- TeletexString()
|
||
|
- UniversalString()
|
||
|
- UTCTime()
|
||
|
- UTF8String()
|
||
|
- VideotexString()
|
||
|
- VisibleString()
|
||
|
- VOID
|
||
|
- Void()
|
||
|
|
||
|
Other type classes are defined that help compose the types listed above.
|
||
|
"""
|
||
|
|
||
|
from __future__ import unicode_literals, division, absolute_import, print_function
|
||
|
|
||
|
from datetime import datetime, timedelta
|
||
|
from fractions import Fraction
|
||
|
import binascii
|
||
|
import copy
|
||
|
import math
|
||
|
import re
|
||
|
import sys
|
||
|
|
||
|
from . import _teletex_codec
|
||
|
from ._errors import unwrap
|
||
|
from ._ordereddict import OrderedDict
|
||
|
from ._types import type_name, str_cls, byte_cls, int_types, chr_cls
|
||
|
from .parser import _parse, _dump_header
|
||
|
from .util import int_to_bytes, int_from_bytes, timezone, extended_datetime, create_timezone, utc_with_dst
|
||
|
|
||
|
if sys.version_info <= (3,):
|
||
|
from cStringIO import StringIO as BytesIO
|
||
|
|
||
|
range = xrange # noqa
|
||
|
_PY2 = True
|
||
|
|
||
|
else:
|
||
|
from io import BytesIO
|
||
|
|
||
|
_PY2 = False
|
||
|
|
||
|
|
||
|
_teletex_codec.register()
|
||
|
|
||
|
|
||
|
CLASS_NUM_TO_NAME_MAP = {
|
||
|
0: 'universal',
|
||
|
1: 'application',
|
||
|
2: 'context',
|
||
|
3: 'private',
|
||
|
}
|
||
|
|
||
|
CLASS_NAME_TO_NUM_MAP = {
|
||
|
'universal': 0,
|
||
|
'application': 1,
|
||
|
'context': 2,
|
||
|
'private': 3,
|
||
|
0: 0,
|
||
|
1: 1,
|
||
|
2: 2,
|
||
|
3: 3,
|
||
|
}
|
||
|
|
||
|
METHOD_NUM_TO_NAME_MAP = {
|
||
|
0: 'primitive',
|
||
|
1: 'constructed',
|
||
|
}
|
||
|
|
||
|
|
||
|
_OID_RE = re.compile(r'^\d+(\.\d+)*$')
|
||
|
|
||
|
|
||
|
# A global tracker to ensure that _setup() is called for every class, even
|
||
|
# if is has been called for a parent class. This allows different _fields
|
||
|
# definitions for child classes. Without such a construct, the child classes
|
||
|
# would just see the parent class attributes and would use them.
|
||
|
_SETUP_CLASSES = {}
|
||
|
|
||
|
|
||
|
def load(encoded_data, strict=False):
|
||
|
"""
|
||
|
Loads a BER/DER-encoded byte string and construct a universal object based
|
||
|
on the tag value:
|
||
|
|
||
|
- 1: Boolean
|
||
|
- 2: Integer
|
||
|
- 3: BitString
|
||
|
- 4: OctetString
|
||
|
- 5: Null
|
||
|
- 6: ObjectIdentifier
|
||
|
- 7: ObjectDescriptor
|
||
|
- 8: InstanceOf
|
||
|
- 9: Real
|
||
|
- 10: Enumerated
|
||
|
- 11: EmbeddedPdv
|
||
|
- 12: UTF8String
|
||
|
- 13: RelativeOid
|
||
|
- 16: Sequence,
|
||
|
- 17: Set
|
||
|
- 18: NumericString
|
||
|
- 19: PrintableString
|
||
|
- 20: TeletexString
|
||
|
- 21: VideotexString
|
||
|
- 22: IA5String
|
||
|
- 23: UTCTime
|
||
|
- 24: GeneralizedTime
|
||
|
- 25: GraphicString
|
||
|
- 26: VisibleString
|
||
|
- 27: GeneralString
|
||
|
- 28: UniversalString
|
||
|
- 29: CharacterString
|
||
|
- 30: BMPString
|
||
|
|
||
|
:param encoded_data:
|
||
|
A byte string of BER or DER-encoded data
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when strict is True and trailing data is present
|
||
|
ValueError - when the encoded value tag a tag other than listed above
|
||
|
ValueError - when the ASN.1 header length is longer than the data
|
||
|
TypeError - when encoded_data is not a byte string
|
||
|
|
||
|
:return:
|
||
|
An instance of the one of the universal classes
|
||
|
"""
|
||
|
|
||
|
return Asn1Value.load(encoded_data, strict=strict)
|
||
|
|
||
|
|
||
|
class Asn1Value(object):
|
||
|
"""
|
||
|
The basis of all ASN.1 values
|
||
|
"""
|
||
|
|
||
|
# The integer 0 for primitive, 1 for constructed
|
||
|
method = None
|
||
|
|
||
|
# An integer 0 through 3 - see CLASS_NUM_TO_NAME_MAP for value
|
||
|
class_ = None
|
||
|
|
||
|
# An integer 1 or greater indicating the tag number
|
||
|
tag = None
|
||
|
|
||
|
# An alternate tag allowed for this type - used for handling broken
|
||
|
# structures where a string value is encoded using an incorrect tag
|
||
|
_bad_tag = None
|
||
|
|
||
|
# If the value has been implicitly tagged
|
||
|
implicit = False
|
||
|
|
||
|
# If explicitly tagged, a tuple of 2-element tuples containing the
|
||
|
# class int and tag int, from innermost to outermost
|
||
|
explicit = None
|
||
|
|
||
|
# The BER/DER header bytes
|
||
|
_header = None
|
||
|
|
||
|
# Raw encoded value bytes not including class, method, tag, length header
|
||
|
contents = None
|
||
|
|
||
|
# The BER/DER trailer bytes
|
||
|
_trailer = b''
|
||
|
|
||
|
# The native python representation of the value - this is not used by
|
||
|
# some classes since they utilize _bytes or _unicode
|
||
|
_native = None
|
||
|
|
||
|
@classmethod
|
||
|
def load(cls, encoded_data, strict=False, **kwargs):
|
||
|
"""
|
||
|
Loads a BER/DER-encoded byte string using the current class as the spec
|
||
|
|
||
|
:param encoded_data:
|
||
|
A byte string of BER or DER-encoded data
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists
|
||
|
|
||
|
:return:
|
||
|
An instance of the current class
|
||
|
"""
|
||
|
|
||
|
if not isinstance(encoded_data, byte_cls):
|
||
|
raise TypeError('encoded_data must be a byte string, not %s' % type_name(encoded_data))
|
||
|
|
||
|
spec = None
|
||
|
if cls.tag is not None:
|
||
|
spec = cls
|
||
|
|
||
|
value, _ = _parse_build(encoded_data, spec=spec, spec_params=kwargs, strict=strict)
|
||
|
return value
|
||
|
|
||
|
def __init__(self, explicit=None, implicit=None, no_explicit=False, tag_type=None, class_=None, tag=None,
|
||
|
optional=None, default=None, contents=None, method=None):
|
||
|
"""
|
||
|
The optional parameter is not used, but rather included so we don't
|
||
|
have to delete it from the parameter dictionary when passing as keyword
|
||
|
args
|
||
|
|
||
|
:param explicit:
|
||
|
An int tag number for explicit tagging, or a 2-element tuple of
|
||
|
class and tag.
|
||
|
|
||
|
:param implicit:
|
||
|
An int tag number for implicit tagging, or a 2-element tuple of
|
||
|
class and tag.
|
||
|
|
||
|
:param no_explicit:
|
||
|
If explicit tagging info should be removed from this instance.
|
||
|
Used internally to allow contructing the underlying value that
|
||
|
has been wrapped in an explicit tag.
|
||
|
|
||
|
:param tag_type:
|
||
|
None for normal values, or one of "implicit", "explicit" for tagged
|
||
|
values. Deprecated in favor of explicit and implicit params.
|
||
|
|
||
|
:param class_:
|
||
|
The class for the value - defaults to "universal" if tag_type is
|
||
|
None, otherwise defaults to "context". Valid values include:
|
||
|
- "universal"
|
||
|
- "application"
|
||
|
- "context"
|
||
|
- "private"
|
||
|
Deprecated in favor of explicit and implicit params.
|
||
|
|
||
|
:param tag:
|
||
|
The integer tag to override - usually this is used with tag_type or
|
||
|
class_. Deprecated in favor of explicit and implicit params.
|
||
|
|
||
|
:param optional:
|
||
|
Dummy parameter that allows "optional" key in spec param dicts
|
||
|
|
||
|
:param default:
|
||
|
The default value to use if the value is currently None
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the encoded contents of the value
|
||
|
|
||
|
:param method:
|
||
|
The method for the value - no default value since this is
|
||
|
normally set on a class. Valid values include:
|
||
|
- "primitive" or 0
|
||
|
- "constructed" or 1
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when implicit, explicit, tag_type, class_ or tag are invalid values
|
||
|
"""
|
||
|
|
||
|
try:
|
||
|
if self.__class__ not in _SETUP_CLASSES:
|
||
|
cls = self.__class__
|
||
|
# Allow explicit to be specified as a simple 2-element tuple
|
||
|
# instead of requiring the user make a nested tuple
|
||
|
if cls.explicit is not None and isinstance(cls.explicit[0], int_types):
|
||
|
cls.explicit = (cls.explicit, )
|
||
|
if hasattr(cls, '_setup'):
|
||
|
self._setup()
|
||
|
_SETUP_CLASSES[cls] = True
|
||
|
|
||
|
# Normalize tagging values
|
||
|
if explicit is not None:
|
||
|
if isinstance(explicit, int_types):
|
||
|
if class_ is None:
|
||
|
class_ = 'context'
|
||
|
explicit = (class_, explicit)
|
||
|
# Prevent both explicit and tag_type == 'explicit'
|
||
|
if tag_type == 'explicit':
|
||
|
tag_type = None
|
||
|
tag = None
|
||
|
|
||
|
if implicit is not None:
|
||
|
if isinstance(implicit, int_types):
|
||
|
if class_ is None:
|
||
|
class_ = 'context'
|
||
|
implicit = (class_, implicit)
|
||
|
# Prevent both implicit and tag_type == 'implicit'
|
||
|
if tag_type == 'implicit':
|
||
|
tag_type = None
|
||
|
tag = None
|
||
|
|
||
|
# Convert old tag_type API to explicit/implicit params
|
||
|
if tag_type is not None:
|
||
|
if class_ is None:
|
||
|
class_ = 'context'
|
||
|
if tag_type == 'explicit':
|
||
|
explicit = (class_, tag)
|
||
|
elif tag_type == 'implicit':
|
||
|
implicit = (class_, tag)
|
||
|
else:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
tag_type must be one of "implicit", "explicit", not %s
|
||
|
''',
|
||
|
repr(tag_type)
|
||
|
))
|
||
|
|
||
|
if explicit is not None:
|
||
|
# Ensure we have a tuple of 2-element tuples
|
||
|
if len(explicit) == 2 and isinstance(explicit[1], int_types):
|
||
|
explicit = (explicit, )
|
||
|
for class_, tag in explicit:
|
||
|
invalid_class = None
|
||
|
if isinstance(class_, int_types):
|
||
|
if class_ not in CLASS_NUM_TO_NAME_MAP:
|
||
|
invalid_class = class_
|
||
|
else:
|
||
|
if class_ not in CLASS_NAME_TO_NUM_MAP:
|
||
|
invalid_class = class_
|
||
|
class_ = CLASS_NAME_TO_NUM_MAP[class_]
|
||
|
if invalid_class is not None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
explicit class must be one of "universal", "application",
|
||
|
"context", "private", not %s
|
||
|
''',
|
||
|
repr(invalid_class)
|
||
|
))
|
||
|
if tag is not None:
|
||
|
if not isinstance(tag, int_types):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
explicit tag must be an integer, not %s
|
||
|
''',
|
||
|
type_name(tag)
|
||
|
))
|
||
|
if self.explicit is None:
|
||
|
self.explicit = ((class_, tag), )
|
||
|
else:
|
||
|
self.explicit = self.explicit + ((class_, tag), )
|
||
|
|
||
|
elif implicit is not None:
|
||
|
class_, tag = implicit
|
||
|
if class_ not in CLASS_NAME_TO_NUM_MAP:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
implicit class must be one of "universal", "application",
|
||
|
"context", "private", not %s
|
||
|
''',
|
||
|
repr(class_)
|
||
|
))
|
||
|
if tag is not None:
|
||
|
if not isinstance(tag, int_types):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
implicit tag must be an integer, not %s
|
||
|
''',
|
||
|
type_name(tag)
|
||
|
))
|
||
|
self.class_ = CLASS_NAME_TO_NUM_MAP[class_]
|
||
|
self.tag = tag
|
||
|
self.implicit = True
|
||
|
else:
|
||
|
if class_ is not None:
|
||
|
if class_ not in CLASS_NAME_TO_NUM_MAP:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
class_ must be one of "universal", "application",
|
||
|
"context", "private", not %s
|
||
|
''',
|
||
|
repr(class_)
|
||
|
))
|
||
|
self.class_ = CLASS_NAME_TO_NUM_MAP[class_]
|
||
|
|
||
|
if self.class_ is None:
|
||
|
self.class_ = 0
|
||
|
|
||
|
if tag is not None:
|
||
|
self.tag = tag
|
||
|
|
||
|
if method is not None:
|
||
|
if method not in set(["primitive", 0, "constructed", 1]):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
method must be one of "primitive" or "constructed",
|
||
|
not %s
|
||
|
''',
|
||
|
repr(method)
|
||
|
))
|
||
|
if method == "primitive":
|
||
|
method = 0
|
||
|
elif method == "constructed":
|
||
|
method = 1
|
||
|
self.method = method
|
||
|
|
||
|
if no_explicit:
|
||
|
self.explicit = None
|
||
|
|
||
|
if contents is not None:
|
||
|
self.contents = contents
|
||
|
|
||
|
elif default is not None:
|
||
|
self.set(default)
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def __str__(self):
|
||
|
"""
|
||
|
Since str is different in Python 2 and 3, this calls the appropriate
|
||
|
method, __unicode__() or __bytes__()
|
||
|
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
if _PY2:
|
||
|
return self.__bytes__()
|
||
|
else:
|
||
|
return self.__unicode__()
|
||
|
|
||
|
def __repr__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
if _PY2:
|
||
|
return '<%s %s b%s>' % (type_name(self), id(self), repr(self.dump()))
|
||
|
else:
|
||
|
return '<%s %s %s>' % (type_name(self), id(self), repr(self.dump()))
|
||
|
|
||
|
def __bytes__(self):
|
||
|
"""
|
||
|
A fall-back method for print() in Python 2
|
||
|
|
||
|
:return:
|
||
|
A byte string of the output of repr()
|
||
|
"""
|
||
|
|
||
|
return self.__repr__().encode('utf-8')
|
||
|
|
||
|
def __unicode__(self):
|
||
|
"""
|
||
|
A fall-back method for print() in Python 3
|
||
|
|
||
|
:return:
|
||
|
A unicode string of the output of repr()
|
||
|
"""
|
||
|
|
||
|
return self.__repr__()
|
||
|
|
||
|
def _new_instance(self):
|
||
|
"""
|
||
|
Constructs a new copy of the current object, preserving any tagging
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value object
|
||
|
"""
|
||
|
|
||
|
new_obj = self.__class__()
|
||
|
new_obj.class_ = self.class_
|
||
|
new_obj.tag = self.tag
|
||
|
new_obj.implicit = self.implicit
|
||
|
new_obj.explicit = self.explicit
|
||
|
return new_obj
|
||
|
|
||
|
def __copy__(self):
|
||
|
"""
|
||
|
Implements the copy.copy() interface
|
||
|
|
||
|
:return:
|
||
|
A new shallow copy of the current Asn1Value object
|
||
|
"""
|
||
|
|
||
|
new_obj = self._new_instance()
|
||
|
new_obj._copy(self, copy.copy)
|
||
|
return new_obj
|
||
|
|
||
|
def __deepcopy__(self, memo):
|
||
|
"""
|
||
|
Implements the copy.deepcopy() interface
|
||
|
|
||
|
:param memo:
|
||
|
A dict for memoization
|
||
|
|
||
|
:return:
|
||
|
A new deep copy of the current Asn1Value object
|
||
|
"""
|
||
|
|
||
|
new_obj = self._new_instance()
|
||
|
memo[id(self)] = new_obj
|
||
|
new_obj._copy(self, copy.deepcopy)
|
||
|
return new_obj
|
||
|
|
||
|
def copy(self):
|
||
|
"""
|
||
|
Copies the object, preserving any special tagging from it
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value object
|
||
|
"""
|
||
|
|
||
|
return copy.deepcopy(self)
|
||
|
|
||
|
def retag(self, tagging, tag=None):
|
||
|
"""
|
||
|
Copies the object, applying a new tagging to it
|
||
|
|
||
|
:param tagging:
|
||
|
A dict containing the keys "explicit" and "implicit". Legacy
|
||
|
API allows a unicode string of "implicit" or "explicit".
|
||
|
|
||
|
:param tag:
|
||
|
A integer tag number. Only used when tagging is a unicode string.
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value object
|
||
|
"""
|
||
|
|
||
|
# This is required to preserve the old API
|
||
|
if not isinstance(tagging, dict):
|
||
|
tagging = {tagging: tag}
|
||
|
new_obj = self.__class__(explicit=tagging.get('explicit'), implicit=tagging.get('implicit'))
|
||
|
new_obj._copy(self, copy.deepcopy)
|
||
|
return new_obj
|
||
|
|
||
|
def untag(self):
|
||
|
"""
|
||
|
Copies the object, removing any special tagging from it
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value object
|
||
|
"""
|
||
|
|
||
|
new_obj = self.__class__()
|
||
|
new_obj._copy(self, copy.deepcopy)
|
||
|
return new_obj
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Asn1Value object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
if self.__class__ != other.__class__:
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
Can not copy values from %s object to %s object
|
||
|
''',
|
||
|
type_name(other),
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self.contents = other.contents
|
||
|
self._native = copy_func(other._native)
|
||
|
|
||
|
def debug(self, nest_level=1):
|
||
|
"""
|
||
|
Show the binary data and parsed data in a tree structure
|
||
|
"""
|
||
|
|
||
|
prefix = ' ' * nest_level
|
||
|
|
||
|
# This interacts with Any and moves the tag, implicit, explicit, _header,
|
||
|
# contents, _footer to the parsed value so duplicate data isn't present
|
||
|
has_parsed = hasattr(self, 'parsed')
|
||
|
|
||
|
_basic_debug(prefix, self)
|
||
|
if has_parsed:
|
||
|
self.parsed.debug(nest_level + 2)
|
||
|
elif hasattr(self, 'chosen'):
|
||
|
self.chosen.debug(nest_level + 2)
|
||
|
else:
|
||
|
if _PY2 and isinstance(self.native, byte_cls):
|
||
|
print('%s Native: b%s' % (prefix, repr(self.native)))
|
||
|
else:
|
||
|
print('%s Native: %s' % (prefix, self.native))
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
contents = self.contents
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._header is not None and self._header[-1:] == b'\x80':
|
||
|
force = True
|
||
|
|
||
|
if self._header is None or force:
|
||
|
if isinstance(self, Constructable) and self._indefinite:
|
||
|
self.method = 0
|
||
|
|
||
|
header = _dump_header(self.class_, self.method, self.tag, self.contents)
|
||
|
|
||
|
if self.explicit is not None:
|
||
|
for class_, tag in self.explicit:
|
||
|
header = _dump_header(class_, 1, tag, header + self.contents) + header
|
||
|
|
||
|
self._header = header
|
||
|
self._trailer = b''
|
||
|
|
||
|
return self._header + contents + self._trailer
|
||
|
|
||
|
|
||
|
class ValueMap():
|
||
|
"""
|
||
|
Basic functionality that allows for mapping values from ints or OIDs to
|
||
|
python unicode strings
|
||
|
"""
|
||
|
|
||
|
# A dict from primitive value (int or OID) to unicode string. This needs
|
||
|
# to be defined in the source code
|
||
|
_map = None
|
||
|
|
||
|
# A dict from unicode string to int/OID. This is automatically generated
|
||
|
# from _map the first time it is needed
|
||
|
_reverse_map = None
|
||
|
|
||
|
def _setup(self):
|
||
|
"""
|
||
|
Generates _reverse_map from _map
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
if cls._map is None or cls._reverse_map is not None:
|
||
|
return
|
||
|
cls._reverse_map = {}
|
||
|
for key, value in cls._map.items():
|
||
|
cls._reverse_map[value] = key
|
||
|
|
||
|
|
||
|
class Castable(object):
|
||
|
"""
|
||
|
A mixin to handle converting an object between different classes that
|
||
|
represent the same encoded value, but with different rules for converting
|
||
|
to and from native Python values
|
||
|
"""
|
||
|
|
||
|
def cast(self, other_class):
|
||
|
"""
|
||
|
Converts the current object into an object of a different class. The
|
||
|
new class must use the ASN.1 encoding for the value.
|
||
|
|
||
|
:param other_class:
|
||
|
The class to instantiate the new object from
|
||
|
|
||
|
:return:
|
||
|
An instance of the type other_class
|
||
|
"""
|
||
|
|
||
|
if other_class.tag != self.__class__.tag:
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
Can not covert a value from %s object to %s object since they
|
||
|
use different tags: %d versus %d
|
||
|
''',
|
||
|
type_name(other_class),
|
||
|
type_name(self),
|
||
|
other_class.tag,
|
||
|
self.__class__.tag
|
||
|
))
|
||
|
|
||
|
new_obj = other_class()
|
||
|
new_obj.class_ = self.class_
|
||
|
new_obj.implicit = self.implicit
|
||
|
new_obj.explicit = self.explicit
|
||
|
new_obj._header = self._header
|
||
|
new_obj.contents = self.contents
|
||
|
new_obj._trailer = self._trailer
|
||
|
if isinstance(self, Constructable):
|
||
|
new_obj.method = self.method
|
||
|
new_obj._indefinite = self._indefinite
|
||
|
return new_obj
|
||
|
|
||
|
|
||
|
class Constructable(object):
|
||
|
"""
|
||
|
A mixin to handle string types that may be constructed from chunks
|
||
|
contained within an indefinite length BER-encoded container
|
||
|
"""
|
||
|
|
||
|
# Instance attribute indicating if an object was indefinite
|
||
|
# length when parsed - affects parsing and dumping
|
||
|
_indefinite = False
|
||
|
|
||
|
def _merge_chunks(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A concatenation of the native values of the contained chunks
|
||
|
"""
|
||
|
|
||
|
if not self._indefinite:
|
||
|
return self._as_chunk()
|
||
|
|
||
|
pointer = 0
|
||
|
contents_len = len(self.contents)
|
||
|
output = None
|
||
|
|
||
|
while pointer < contents_len:
|
||
|
# We pass the current class as the spec so content semantics are preserved
|
||
|
sub_value, pointer = _parse_build(self.contents, pointer, spec=self.__class__)
|
||
|
if output is None:
|
||
|
output = sub_value._merge_chunks()
|
||
|
else:
|
||
|
output += sub_value._merge_chunks()
|
||
|
|
||
|
if output is None:
|
||
|
return self._as_chunk()
|
||
|
|
||
|
return output
|
||
|
|
||
|
def _as_chunk(self):
|
||
|
"""
|
||
|
A method to return a chunk of data that can be combined for
|
||
|
constructed method values
|
||
|
|
||
|
:return:
|
||
|
A native Python value that can be added together. Examples include
|
||
|
byte strings, unicode strings or tuples.
|
||
|
"""
|
||
|
|
||
|
return self.contents
|
||
|
|
||
|
def _setable_native(self):
|
||
|
"""
|
||
|
Returns a native value that can be round-tripped into .set(), to
|
||
|
result in a DER encoding. This differs from .native in that .native
|
||
|
is designed for the end use, and may account for the fact that the
|
||
|
merged value is further parsed as ASN.1, such as in the case of
|
||
|
ParsableOctetString() and ParsableOctetBitString().
|
||
|
|
||
|
:return:
|
||
|
A python value that is valid to pass to .set()
|
||
|
"""
|
||
|
|
||
|
return self.native
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Constructable object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(Constructable, self)._copy(other, copy_func)
|
||
|
# We really don't want to dump BER encodings, so if we see an
|
||
|
# indefinite encoding, let's re-encode it
|
||
|
if other._indefinite:
|
||
|
self.set(other._setable_native())
|
||
|
|
||
|
|
||
|
class Void(Asn1Value):
|
||
|
"""
|
||
|
A representation of an optional value that is not present. Has .native
|
||
|
property and .dump() method to be compatible with other value classes.
|
||
|
"""
|
||
|
|
||
|
contents = b''
|
||
|
|
||
|
def __eq__(self, other):
|
||
|
"""
|
||
|
:param other:
|
||
|
The other Primitive to compare to
|
||
|
|
||
|
:return:
|
||
|
A boolean
|
||
|
"""
|
||
|
|
||
|
return other.__class__ == self.__class__
|
||
|
|
||
|
def __nonzero__(self):
|
||
|
return False
|
||
|
|
||
|
def __len__(self):
|
||
|
return 0
|
||
|
|
||
|
def __iter__(self):
|
||
|
return iter(())
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
None
|
||
|
"""
|
||
|
|
||
|
return None
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
return b''
|
||
|
|
||
|
|
||
|
VOID = Void()
|
||
|
|
||
|
|
||
|
class Any(Asn1Value):
|
||
|
"""
|
||
|
A value class that can contain any value, and allows for easy parsing of
|
||
|
the underlying encoded value using a spec. This is normally contained in
|
||
|
a Structure that has an ObjectIdentifier field and _oid_pair and _oid_specs
|
||
|
defined.
|
||
|
"""
|
||
|
|
||
|
# The parsed value object
|
||
|
_parsed = None
|
||
|
|
||
|
def __init__(self, value=None, **kwargs):
|
||
|
"""
|
||
|
Sets the value of the object before passing to Asn1Value.__init__()
|
||
|
|
||
|
:param value:
|
||
|
An Asn1Value object that will be set as the parsed value
|
||
|
"""
|
||
|
|
||
|
Asn1Value.__init__(self, **kwargs)
|
||
|
|
||
|
try:
|
||
|
if value is not None:
|
||
|
if not isinstance(value, Asn1Value):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
value must be an instance of Asn1Value, not %s
|
||
|
''',
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._parsed = (value, value.__class__, None)
|
||
|
self.contents = value.dump()
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
The .native value from the parsed value object
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None:
|
||
|
self.parse()
|
||
|
|
||
|
return self._parsed[0].native
|
||
|
|
||
|
@property
|
||
|
def parsed(self):
|
||
|
"""
|
||
|
Returns the parsed object from .parse()
|
||
|
|
||
|
:return:
|
||
|
The object returned by .parse()
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None:
|
||
|
self.parse()
|
||
|
|
||
|
return self._parsed[0]
|
||
|
|
||
|
def parse(self, spec=None, spec_params=None):
|
||
|
"""
|
||
|
Parses the contents generically, or using a spec with optional params
|
||
|
|
||
|
:param spec:
|
||
|
A class derived from Asn1Value that defines what class_ and tag the
|
||
|
value should have, and the semantics of the encoded value. The
|
||
|
return value will be of this type. If omitted, the encoded value
|
||
|
will be decoded using the standard universal tag based on the
|
||
|
encoded tag number.
|
||
|
|
||
|
:param spec_params:
|
||
|
A dict of params to pass to the spec object
|
||
|
|
||
|
:return:
|
||
|
An object of the type spec, or if not present, a child of Asn1Value
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None or self._parsed[1:3] != (spec, spec_params):
|
||
|
try:
|
||
|
passed_params = spec_params or {}
|
||
|
_tag_type_to_explicit_implicit(passed_params)
|
||
|
if self.explicit is not None:
|
||
|
if 'explicit' in passed_params:
|
||
|
passed_params['explicit'] = self.explicit + passed_params['explicit']
|
||
|
else:
|
||
|
passed_params['explicit'] = self.explicit
|
||
|
contents = self._header + self.contents + self._trailer
|
||
|
parsed_value, _ = _parse_build(
|
||
|
contents,
|
||
|
spec=spec,
|
||
|
spec_params=passed_params
|
||
|
)
|
||
|
self._parsed = (parsed_value, spec, spec_params)
|
||
|
|
||
|
# Once we've parsed the Any value, clear any attributes from this object
|
||
|
# since they are now duplicate
|
||
|
self.tag = None
|
||
|
self.explicit = None
|
||
|
self.implicit = False
|
||
|
self._header = b''
|
||
|
self.contents = contents
|
||
|
self._trailer = b''
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
return self._parsed[0]
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Any object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(Any, self)._copy(other, copy_func)
|
||
|
self._parsed = copy_func(other._parsed)
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None:
|
||
|
self.parse()
|
||
|
|
||
|
return self._parsed[0].dump(force=force)
|
||
|
|
||
|
|
||
|
class Choice(Asn1Value):
|
||
|
"""
|
||
|
A class to handle when a value may be one of several options
|
||
|
"""
|
||
|
|
||
|
# The index in _alternatives of the validated alternative
|
||
|
_choice = None
|
||
|
|
||
|
# The name of the chosen alternative
|
||
|
_name = None
|
||
|
|
||
|
# The Asn1Value object for the chosen alternative
|
||
|
_parsed = None
|
||
|
|
||
|
# Choice overrides .contents to be a property so that the code expecting
|
||
|
# the .contents attribute will get the .contents of the chosen alternative
|
||
|
_contents = None
|
||
|
|
||
|
# A list of tuples in one of the following forms.
|
||
|
#
|
||
|
# Option 1, a unicode string field name and a value class
|
||
|
#
|
||
|
# ("name", Asn1ValueClass)
|
||
|
#
|
||
|
# Option 2, same as Option 1, but with a dict of class params
|
||
|
#
|
||
|
# ("name", Asn1ValueClass, {'explicit': 5})
|
||
|
_alternatives = None
|
||
|
|
||
|
# A dict that maps tuples of (class_, tag) to an index in _alternatives
|
||
|
_id_map = None
|
||
|
|
||
|
# A dict that maps alternative names to an index in _alternatives
|
||
|
_name_map = None
|
||
|
|
||
|
@classmethod
|
||
|
def load(cls, encoded_data, strict=False, **kwargs):
|
||
|
"""
|
||
|
Loads a BER/DER-encoded byte string using the current class as the spec
|
||
|
|
||
|
:param encoded_data:
|
||
|
A byte string of BER or DER encoded data
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists
|
||
|
|
||
|
:return:
|
||
|
A instance of the current class
|
||
|
"""
|
||
|
|
||
|
if not isinstance(encoded_data, byte_cls):
|
||
|
raise TypeError('encoded_data must be a byte string, not %s' % type_name(encoded_data))
|
||
|
|
||
|
value, _ = _parse_build(encoded_data, spec=cls, spec_params=kwargs, strict=strict)
|
||
|
return value
|
||
|
|
||
|
def _setup(self):
|
||
|
"""
|
||
|
Generates _id_map from _alternatives to allow validating contents
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
cls._id_map = {}
|
||
|
cls._name_map = {}
|
||
|
for index, info in enumerate(cls._alternatives):
|
||
|
if len(info) < 3:
|
||
|
info = info + ({},)
|
||
|
cls._alternatives[index] = info
|
||
|
id_ = _build_id_tuple(info[2], info[1])
|
||
|
cls._id_map[id_] = index
|
||
|
cls._name_map[info[0]] = index
|
||
|
|
||
|
def __init__(self, name=None, value=None, **kwargs):
|
||
|
"""
|
||
|
Checks to ensure implicit tagging is not being used since it is
|
||
|
incompatible with Choice, then forwards on to Asn1Value.__init__()
|
||
|
|
||
|
:param name:
|
||
|
The name of the alternative to be set - used with value.
|
||
|
Alternatively this may be a dict with a single key being the name
|
||
|
and the value being the value, or a two-element tuple of the name
|
||
|
and the value.
|
||
|
|
||
|
:param value:
|
||
|
The alternative value to set - used with name
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when implicit param is passed (or legacy tag_type param is "implicit")
|
||
|
"""
|
||
|
|
||
|
_tag_type_to_explicit_implicit(kwargs)
|
||
|
|
||
|
Asn1Value.__init__(self, **kwargs)
|
||
|
|
||
|
try:
|
||
|
if kwargs.get('implicit') is not None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
The Choice type can not be implicitly tagged even if in an
|
||
|
implicit module - due to its nature any tagging must be
|
||
|
explicit
|
||
|
'''
|
||
|
))
|
||
|
|
||
|
if name is not None:
|
||
|
if isinstance(name, dict):
|
||
|
if len(name) != 1:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
When passing a dict as the "name" argument to %s,
|
||
|
it must have a single key/value - however %d were
|
||
|
present
|
||
|
''',
|
||
|
type_name(self),
|
||
|
len(name)
|
||
|
))
|
||
|
name, value = list(name.items())[0]
|
||
|
|
||
|
if isinstance(name, tuple):
|
||
|
if len(name) != 2:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
When passing a tuple as the "name" argument to %s,
|
||
|
it must have two elements, the name and value -
|
||
|
however %d were present
|
||
|
''',
|
||
|
type_name(self),
|
||
|
len(name)
|
||
|
))
|
||
|
value = name[1]
|
||
|
name = name[0]
|
||
|
|
||
|
if name not in self._name_map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
The name specified, "%s", is not a valid alternative
|
||
|
for %s
|
||
|
''',
|
||
|
name,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self._choice = self._name_map[name]
|
||
|
_, spec, params = self._alternatives[self._choice]
|
||
|
|
||
|
if not isinstance(value, spec):
|
||
|
value = spec(value, **params)
|
||
|
else:
|
||
|
value = _fix_tagging(value, params)
|
||
|
self._parsed = value
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
@property
|
||
|
def contents(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string of the DER-encoded contents of the chosen alternative
|
||
|
"""
|
||
|
|
||
|
if self._parsed is not None:
|
||
|
return self._parsed.contents
|
||
|
|
||
|
return self._contents
|
||
|
|
||
|
@contents.setter
|
||
|
def contents(self, value):
|
||
|
"""
|
||
|
:param value:
|
||
|
A byte string of the DER-encoded contents of the chosen alternative
|
||
|
"""
|
||
|
|
||
|
self._contents = value
|
||
|
|
||
|
@property
|
||
|
def name(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string of the field name of the chosen alternative
|
||
|
"""
|
||
|
if not self._name:
|
||
|
self._name = self._alternatives[self._choice][0]
|
||
|
return self._name
|
||
|
|
||
|
def parse(self):
|
||
|
"""
|
||
|
Parses the detected alternative
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value object of the chosen alternative
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None:
|
||
|
try:
|
||
|
_, spec, params = self._alternatives[self._choice]
|
||
|
self._parsed, _ = _parse_build(self._contents, spec=spec, spec_params=params)
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
return self._parsed
|
||
|
|
||
|
@property
|
||
|
def chosen(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An Asn1Value object of the chosen alternative
|
||
|
"""
|
||
|
|
||
|
return self.parse()
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
The .native value from the contained value object
|
||
|
"""
|
||
|
|
||
|
return self.chosen.native
|
||
|
|
||
|
def validate(self, class_, tag, contents):
|
||
|
"""
|
||
|
Ensures that the class and tag specified exist as an alternative
|
||
|
|
||
|
:param class_:
|
||
|
The integer class_ from the encoded value header
|
||
|
|
||
|
:param tag:
|
||
|
The integer tag from the encoded value header
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the contents of the value - used when the object
|
||
|
is explicitly tagged
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when value is not a valid alternative
|
||
|
"""
|
||
|
|
||
|
id_ = (class_, tag)
|
||
|
|
||
|
if self.explicit is not None:
|
||
|
if self.explicit[-1] != id_:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s was explicitly tagged, but the value provided does not
|
||
|
match the class and tag
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
((class_, _, tag, _, _, _), _) = _parse(contents, len(contents))
|
||
|
id_ = (class_, tag)
|
||
|
|
||
|
if id_ in self._id_map:
|
||
|
self._choice = self._id_map[id_]
|
||
|
return
|
||
|
|
||
|
# This means the Choice was implicitly tagged
|
||
|
if self.class_ is not None and self.tag is not None:
|
||
|
if len(self._alternatives) > 1:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s was implicitly tagged, but more than one alternative
|
||
|
exists
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
if id_ == (self.class_, self.tag):
|
||
|
self._choice = 0
|
||
|
return
|
||
|
|
||
|
asn1 = self._format_class_tag(class_, tag)
|
||
|
asn1s = [self._format_class_tag(pair[0], pair[1]) for pair in self._id_map]
|
||
|
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Value %s did not match the class and tag of any of the alternatives
|
||
|
in %s: %s
|
||
|
''',
|
||
|
asn1,
|
||
|
type_name(self),
|
||
|
', '.join(asn1s)
|
||
|
))
|
||
|
|
||
|
def _format_class_tag(self, class_, tag):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string of a human-friendly representation of the class and tag
|
||
|
"""
|
||
|
|
||
|
return '[%s %s]' % (CLASS_NUM_TO_NAME_MAP[class_].upper(), tag)
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Choice object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(Choice, self)._copy(other, copy_func)
|
||
|
self._choice = other._choice
|
||
|
self._name = other._name
|
||
|
self._parsed = copy_func(other._parsed)
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._header is not None and self._header[-1:] == b'\x80':
|
||
|
force = True
|
||
|
|
||
|
self._contents = self.chosen.dump(force=force)
|
||
|
if self._header is None or force:
|
||
|
self._header = b''
|
||
|
if self.explicit is not None:
|
||
|
for class_, tag in self.explicit:
|
||
|
self._header = _dump_header(class_, 1, tag, self._header + self._contents) + self._header
|
||
|
return self._header + self._contents
|
||
|
|
||
|
|
||
|
class Concat(object):
|
||
|
"""
|
||
|
A class that contains two or more encoded child values concatentated
|
||
|
together. THIS IS NOT PART OF THE ASN.1 SPECIFICATION! This exists to handle
|
||
|
the x509.TrustedCertificate() class for OpenSSL certificates containing
|
||
|
extra information.
|
||
|
"""
|
||
|
|
||
|
# A list of the specs of the concatenated values
|
||
|
_child_specs = None
|
||
|
|
||
|
_children = None
|
||
|
|
||
|
@classmethod
|
||
|
def load(cls, encoded_data, strict=False):
|
||
|
"""
|
||
|
Loads a BER/DER-encoded byte string using the current class as the spec
|
||
|
|
||
|
:param encoded_data:
|
||
|
A byte string of BER or DER encoded data
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists
|
||
|
|
||
|
:return:
|
||
|
A Concat object
|
||
|
"""
|
||
|
|
||
|
return cls(contents=encoded_data, strict=strict)
|
||
|
|
||
|
def __init__(self, value=None, contents=None, strict=False):
|
||
|
"""
|
||
|
:param value:
|
||
|
A native Python datatype to initialize the object value with
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the encoded contents of the value
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists in contents
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an error occurs with one of the children
|
||
|
TypeError - when an error occurs with one of the children
|
||
|
"""
|
||
|
|
||
|
if contents is not None:
|
||
|
try:
|
||
|
contents_len = len(contents)
|
||
|
self._children = []
|
||
|
|
||
|
offset = 0
|
||
|
for spec in self._child_specs:
|
||
|
if offset < contents_len:
|
||
|
child_value, offset = _parse_build(contents, pointer=offset, spec=spec)
|
||
|
else:
|
||
|
child_value = spec()
|
||
|
self._children.append(child_value)
|
||
|
|
||
|
if strict and offset != contents_len:
|
||
|
extra_bytes = contents_len - offset
|
||
|
raise ValueError('Extra data - %d bytes of trailing data were provided' % extra_bytes)
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
if value is not None:
|
||
|
if self._children is None:
|
||
|
self._children = [None] * len(self._child_specs)
|
||
|
for index, data in enumerate(value):
|
||
|
self.__setitem__(index, data)
|
||
|
|
||
|
def __str__(self):
|
||
|
"""
|
||
|
Since str is different in Python 2 and 3, this calls the appropriate
|
||
|
method, __unicode__() or __bytes__()
|
||
|
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
if _PY2:
|
||
|
return self.__bytes__()
|
||
|
else:
|
||
|
return self.__unicode__()
|
||
|
|
||
|
def __bytes__(self):
|
||
|
"""
|
||
|
A byte string of the DER-encoded contents
|
||
|
"""
|
||
|
|
||
|
return self.dump()
|
||
|
|
||
|
def __unicode__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
return repr(self)
|
||
|
|
||
|
def __repr__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
return '<%s %s %s>' % (type_name(self), id(self), repr(self.dump()))
|
||
|
|
||
|
def __copy__(self):
|
||
|
"""
|
||
|
Implements the copy.copy() interface
|
||
|
|
||
|
:return:
|
||
|
A new shallow copy of the Concat object
|
||
|
"""
|
||
|
|
||
|
new_obj = self.__class__()
|
||
|
new_obj._copy(self, copy.copy)
|
||
|
return new_obj
|
||
|
|
||
|
def __deepcopy__(self, memo):
|
||
|
"""
|
||
|
Implements the copy.deepcopy() interface
|
||
|
|
||
|
:param memo:
|
||
|
A dict for memoization
|
||
|
|
||
|
:return:
|
||
|
A new deep copy of the Concat object and all child objects
|
||
|
"""
|
||
|
|
||
|
new_obj = self.__class__()
|
||
|
memo[id(self)] = new_obj
|
||
|
new_obj._copy(self, copy.deepcopy)
|
||
|
return new_obj
|
||
|
|
||
|
def copy(self):
|
||
|
"""
|
||
|
Copies the object
|
||
|
|
||
|
:return:
|
||
|
A Concat object
|
||
|
"""
|
||
|
|
||
|
return copy.deepcopy(self)
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Concat object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
if self.__class__ != other.__class__:
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
Can not copy values from %s object to %s object
|
||
|
''',
|
||
|
type_name(other),
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self._children = copy_func(other._children)
|
||
|
|
||
|
def debug(self, nest_level=1):
|
||
|
"""
|
||
|
Show the binary data and parsed data in a tree structure
|
||
|
"""
|
||
|
|
||
|
prefix = ' ' * nest_level
|
||
|
print('%s%s Object #%s' % (prefix, type_name(self), id(self)))
|
||
|
print('%s Children:' % (prefix,))
|
||
|
for child in self._children:
|
||
|
child.debug(nest_level + 2)
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
contents = b''
|
||
|
for child in self._children:
|
||
|
contents += child.dump(force=force)
|
||
|
return contents
|
||
|
|
||
|
@property
|
||
|
def contents(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string of the DER-encoded contents of the children
|
||
|
"""
|
||
|
|
||
|
return self.dump()
|
||
|
|
||
|
def __len__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
Integer
|
||
|
"""
|
||
|
|
||
|
return len(self._children)
|
||
|
|
||
|
def __getitem__(self, key):
|
||
|
"""
|
||
|
Allows accessing children by index
|
||
|
|
||
|
:param key:
|
||
|
An integer of the child index
|
||
|
|
||
|
:raises:
|
||
|
KeyError - when an index is invalid
|
||
|
|
||
|
:return:
|
||
|
The Asn1Value object of the child specified
|
||
|
"""
|
||
|
|
||
|
if key > len(self._child_specs) - 1 or key < 0:
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No child is definition for position %d of %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
return self._children[key]
|
||
|
|
||
|
def __setitem__(self, key, value):
|
||
|
"""
|
||
|
Allows settings children by index
|
||
|
|
||
|
:param key:
|
||
|
An integer of the child index
|
||
|
|
||
|
:param value:
|
||
|
An Asn1Value object to set the child to
|
||
|
|
||
|
:raises:
|
||
|
KeyError - when an index is invalid
|
||
|
ValueError - when the value is not an instance of Asn1Value
|
||
|
"""
|
||
|
|
||
|
if key > len(self._child_specs) - 1 or key < 0:
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No child is defined for position %d of %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
if not isinstance(value, Asn1Value):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Value for child %s of %s is not an instance of
|
||
|
asn1crypto.core.Asn1Value
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self._children[key] = value
|
||
|
|
||
|
def __iter__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An iterator of child values
|
||
|
"""
|
||
|
|
||
|
return iter(self._children)
|
||
|
|
||
|
|
||
|
class Primitive(Asn1Value):
|
||
|
"""
|
||
|
Sets the class_ and method attributes for primitive, universal values
|
||
|
"""
|
||
|
|
||
|
class_ = 0
|
||
|
|
||
|
method = 0
|
||
|
|
||
|
def __init__(self, value=None, default=None, contents=None, **kwargs):
|
||
|
"""
|
||
|
Sets the value of the object before passing to Asn1Value.__init__()
|
||
|
|
||
|
:param value:
|
||
|
A native Python datatype to initialize the object value with
|
||
|
|
||
|
:param default:
|
||
|
The default value if no value is specified
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the encoded contents of the value
|
||
|
"""
|
||
|
|
||
|
Asn1Value.__init__(self, **kwargs)
|
||
|
|
||
|
try:
|
||
|
if contents is not None:
|
||
|
self.contents = contents
|
||
|
|
||
|
elif value is not None:
|
||
|
self.set(value)
|
||
|
|
||
|
elif default is not None:
|
||
|
self.set(default)
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, byte_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a byte string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._native = value
|
||
|
self.contents = value
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._header is not None and self._header[-1:] == b'\x80':
|
||
|
force = True
|
||
|
|
||
|
if force:
|
||
|
native = self.native
|
||
|
self.contents = None
|
||
|
self.set(native)
|
||
|
|
||
|
return Asn1Value.dump(self)
|
||
|
|
||
|
def __ne__(self, other):
|
||
|
return not self == other
|
||
|
|
||
|
def __eq__(self, other):
|
||
|
"""
|
||
|
:param other:
|
||
|
The other Primitive to compare to
|
||
|
|
||
|
:return:
|
||
|
A boolean
|
||
|
"""
|
||
|
|
||
|
if not isinstance(other, Primitive):
|
||
|
return False
|
||
|
|
||
|
if self.contents != other.contents:
|
||
|
return False
|
||
|
|
||
|
# We compare class tag numbers since object tag numbers could be
|
||
|
# different due to implicit or explicit tagging
|
||
|
if self.__class__.tag != other.__class__.tag:
|
||
|
return False
|
||
|
|
||
|
if self.__class__ == other.__class__ and self.contents == other.contents:
|
||
|
return True
|
||
|
|
||
|
# If the objects share a common base class that is not too low-level
|
||
|
# then we can compare the contents
|
||
|
self_bases = (set(self.__class__.__bases__) | set([self.__class__])) - set([Asn1Value, Primitive, ValueMap])
|
||
|
other_bases = (set(other.__class__.__bases__) | set([other.__class__])) - set([Asn1Value, Primitive, ValueMap])
|
||
|
if self_bases | other_bases:
|
||
|
return self.contents == other.contents
|
||
|
|
||
|
# When tagging is going on, do the extra work of constructing new
|
||
|
# objects to see if the dumped representation are the same
|
||
|
if self.implicit or self.explicit or other.implicit or other.explicit:
|
||
|
return self.untag().dump() == other.untag().dump()
|
||
|
|
||
|
return self.dump() == other.dump()
|
||
|
|
||
|
|
||
|
class AbstractString(Constructable, Primitive):
|
||
|
"""
|
||
|
A base class for all strings that have a known encoding. In general, we do
|
||
|
not worry ourselves with confirming that the decoded values match a specific
|
||
|
set of characters, only that they are decoded into a Python unicode string
|
||
|
"""
|
||
|
|
||
|
# The Python encoding name to use when decoding or encoded the contents
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
# Instance attribute of (possibly-merged) unicode string
|
||
|
_unicode = None
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the string
|
||
|
|
||
|
:param value:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a unicode string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._unicode = value
|
||
|
self.contents = value.encode(self._encoding)
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __unicode__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return ''
|
||
|
if self._unicode is None:
|
||
|
self._unicode = self._merge_chunks().decode(self._encoding)
|
||
|
return self._unicode
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another AbstractString object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(AbstractString, self)._copy(other, copy_func)
|
||
|
self._unicode = other._unicode
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A unicode string or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
return self.__unicode__()
|
||
|
|
||
|
|
||
|
class Boolean(Primitive):
|
||
|
"""
|
||
|
Represents a boolean in both ASN.1 and Python
|
||
|
"""
|
||
|
|
||
|
tag = 1
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
True, False or another value that works with bool()
|
||
|
"""
|
||
|
|
||
|
self._native = bool(value)
|
||
|
self.contents = b'\x00' if not value else b'\xff'
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
# Python 2
|
||
|
def __nonzero__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
True or False
|
||
|
"""
|
||
|
return self.__bool__()
|
||
|
|
||
|
def __bool__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
True or False
|
||
|
"""
|
||
|
return self.contents != b'\x00'
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
True, False or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native = self.__bool__()
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class Integer(Primitive, ValueMap):
|
||
|
"""
|
||
|
Represents an integer in both ASN.1 and Python
|
||
|
"""
|
||
|
|
||
|
tag = 2
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
An integer, or a unicode string if _map is set
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if isinstance(value, str_cls):
|
||
|
if self._map is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value is a unicode string, but no _map provided
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
if value not in self._reverse_map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value, %s, is not present in the _map
|
||
|
''',
|
||
|
type_name(self),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
value = self._reverse_map[value]
|
||
|
|
||
|
elif not isinstance(value, int_types):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be an integer or unicode string when a name_map
|
||
|
is provided, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._native = self._map[value] if self._map and value in self._map else value
|
||
|
|
||
|
self.contents = int_to_bytes(value, signed=True)
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __int__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An integer
|
||
|
"""
|
||
|
return int_from_bytes(self.contents, signed=True)
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
An integer or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native = self.__int__()
|
||
|
if self._map is not None and self._native in self._map:
|
||
|
self._native = self._map[self._native]
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class _IntegerBitString(object):
|
||
|
"""
|
||
|
A mixin for IntegerBitString and BitString to parse the contents as an integer.
|
||
|
"""
|
||
|
|
||
|
# Tuple of 1s and 0s; set through native
|
||
|
_unused_bits = ()
|
||
|
|
||
|
def _as_chunk(self):
|
||
|
"""
|
||
|
Parse the contents of a primitive BitString encoding as an integer value.
|
||
|
Allows reconstructing indefinite length values.
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
|
||
|
:return:
|
||
|
A list with one tuple (value, bits, unused_bits) where value is an integer
|
||
|
with the value of the BitString, bits is the bit count of value and
|
||
|
unused_bits is a tuple of 1s and 0s.
|
||
|
"""
|
||
|
|
||
|
if self._indefinite:
|
||
|
# return an empty chunk, for cases like \x23\x80\x00\x00
|
||
|
return []
|
||
|
|
||
|
unused_bits_len = ord(self.contents[0]) if _PY2 else self.contents[0]
|
||
|
value = int_from_bytes(self.contents[1:])
|
||
|
bits = (len(self.contents) - 1) * 8
|
||
|
|
||
|
if not unused_bits_len:
|
||
|
return [(value, bits, ())]
|
||
|
|
||
|
if len(self.contents) == 1:
|
||
|
# Disallowed by X.690 §8.6.2.3
|
||
|
raise ValueError('Empty bit string has {0} unused bits'.format(unused_bits_len))
|
||
|
|
||
|
if unused_bits_len > 7:
|
||
|
# Disallowed by X.690 §8.6.2.2
|
||
|
raise ValueError('Bit string has {0} unused bits'.format(unused_bits_len))
|
||
|
|
||
|
unused_bits = _int_to_bit_tuple(value & ((1 << unused_bits_len) - 1), unused_bits_len)
|
||
|
value >>= unused_bits_len
|
||
|
bits -= unused_bits_len
|
||
|
|
||
|
return [(value, bits, unused_bits)]
|
||
|
|
||
|
def _chunks_to_int(self):
|
||
|
"""
|
||
|
Combines the chunks into a single value.
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
|
||
|
:return:
|
||
|
A tuple (value, bits, unused_bits) where value is an integer with the
|
||
|
value of the BitString, bits is the bit count of value and unused_bits
|
||
|
is a tuple of 1s and 0s.
|
||
|
"""
|
||
|
|
||
|
if not self._indefinite:
|
||
|
# Fast path
|
||
|
return self._as_chunk()[0]
|
||
|
|
||
|
value = 0
|
||
|
total_bits = 0
|
||
|
unused_bits = ()
|
||
|
|
||
|
# X.690 §8.6.3 allows empty indefinite encodings
|
||
|
for chunk, bits, unused_bits in self._merge_chunks():
|
||
|
if total_bits & 7:
|
||
|
# Disallowed by X.690 §8.6.4
|
||
|
raise ValueError('Only last chunk in a bit string may have unused bits')
|
||
|
total_bits += bits
|
||
|
value = (value << bits) | chunk
|
||
|
|
||
|
return value, total_bits, unused_bits
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another _IntegerBitString object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(_IntegerBitString, self)._copy(other, copy_func)
|
||
|
self._unused_bits = other._unused_bits
|
||
|
|
||
|
@property
|
||
|
def unused_bits(self):
|
||
|
"""
|
||
|
The unused bits of the bit string encoding.
|
||
|
|
||
|
:return:
|
||
|
A tuple of 1s and 0s
|
||
|
"""
|
||
|
|
||
|
# call native to set _unused_bits
|
||
|
self.native
|
||
|
|
||
|
return self._unused_bits
|
||
|
|
||
|
|
||
|
class BitString(_IntegerBitString, Constructable, Castable, Primitive, ValueMap):
|
||
|
"""
|
||
|
Represents a bit string from ASN.1 as a Python tuple of 1s and 0s
|
||
|
"""
|
||
|
|
||
|
tag = 3
|
||
|
|
||
|
_size = None
|
||
|
|
||
|
def _setup(self):
|
||
|
"""
|
||
|
Generates _reverse_map from _map
|
||
|
"""
|
||
|
|
||
|
ValueMap._setup(self)
|
||
|
|
||
|
cls = self.__class__
|
||
|
if cls._map is not None:
|
||
|
cls._size = max(self._map.keys()) + 1
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
An integer or a tuple of integers 0 and 1
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if isinstance(value, set):
|
||
|
if self._map is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map has not been defined
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
bits = [0] * self._size
|
||
|
self._native = value
|
||
|
for index in range(0, self._size):
|
||
|
key = self._map.get(index)
|
||
|
if key is None:
|
||
|
continue
|
||
|
if key in value:
|
||
|
bits[index] = 1
|
||
|
|
||
|
value = ''.join(map(str_cls, bits))
|
||
|
|
||
|
elif value.__class__ == tuple:
|
||
|
if self._map is None:
|
||
|
self._native = value
|
||
|
else:
|
||
|
self._native = set()
|
||
|
for index, bit in enumerate(value):
|
||
|
if bit:
|
||
|
name = self._map.get(index, index)
|
||
|
self._native.add(name)
|
||
|
value = ''.join(map(str_cls, value))
|
||
|
|
||
|
else:
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a tuple of ones and zeros or a set of unicode
|
||
|
strings, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
if self._map is not None:
|
||
|
if len(value) > self._size:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value must be at most %s bits long, specified was %s long
|
||
|
''',
|
||
|
type_name(self),
|
||
|
self._size,
|
||
|
len(value)
|
||
|
))
|
||
|
# A NamedBitList must have trailing zero bit truncated. See
|
||
|
# https://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf
|
||
|
# section 11.2,
|
||
|
# https://tools.ietf.org/html/rfc5280#page-134 and
|
||
|
# https://www.ietf.org/mail-archive/web/pkix/current/msg10443.html
|
||
|
value = value.rstrip('0')
|
||
|
size = len(value)
|
||
|
|
||
|
size_mod = size % 8
|
||
|
extra_bits = 0
|
||
|
if size_mod != 0:
|
||
|
extra_bits = 8 - size_mod
|
||
|
value += '0' * extra_bits
|
||
|
|
||
|
size_in_bytes = int(math.ceil(size / 8))
|
||
|
|
||
|
if extra_bits:
|
||
|
extra_bits_byte = int_to_bytes(extra_bits)
|
||
|
else:
|
||
|
extra_bits_byte = b'\x00'
|
||
|
|
||
|
if value == '':
|
||
|
value_bytes = b''
|
||
|
else:
|
||
|
value_bytes = int_to_bytes(int(value, 2))
|
||
|
if len(value_bytes) != size_in_bytes:
|
||
|
value_bytes = (b'\x00' * (size_in_bytes - len(value_bytes))) + value_bytes
|
||
|
|
||
|
self.contents = extra_bits_byte + value_bytes
|
||
|
self._unused_bits = (0,) * extra_bits
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __getitem__(self, key):
|
||
|
"""
|
||
|
Retrieves a boolean version of one of the bits based on a name from the
|
||
|
_map
|
||
|
|
||
|
:param key:
|
||
|
The unicode string of one of the bit names
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when _map is not set or the key name is invalid
|
||
|
|
||
|
:return:
|
||
|
A boolean if the bit is set
|
||
|
"""
|
||
|
|
||
|
is_int = isinstance(key, int_types)
|
||
|
if not is_int:
|
||
|
if not isinstance(self._map, dict):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map has not been defined
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
if key not in self._reverse_map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map does not contain an entry for "%s"
|
||
|
''',
|
||
|
type_name(self),
|
||
|
key
|
||
|
))
|
||
|
|
||
|
if self._native is None:
|
||
|
self.native
|
||
|
|
||
|
if self._map is None:
|
||
|
if len(self._native) >= key + 1:
|
||
|
return bool(self._native[key])
|
||
|
return False
|
||
|
|
||
|
if is_int:
|
||
|
key = self._map.get(key, key)
|
||
|
|
||
|
return key in self._native
|
||
|
|
||
|
def __setitem__(self, key, value):
|
||
|
"""
|
||
|
Sets one of the bits based on a name from the _map
|
||
|
|
||
|
:param key:
|
||
|
The unicode string of one of the bit names
|
||
|
|
||
|
:param value:
|
||
|
A boolean value
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when _map is not set or the key name is invalid
|
||
|
"""
|
||
|
|
||
|
is_int = isinstance(key, int_types)
|
||
|
if not is_int:
|
||
|
if self._map is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map has not been defined
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
if key not in self._reverse_map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map does not contain an entry for "%s"
|
||
|
''',
|
||
|
type_name(self),
|
||
|
key
|
||
|
))
|
||
|
|
||
|
if self._native is None:
|
||
|
self.native
|
||
|
|
||
|
if self._map is None:
|
||
|
new_native = list(self._native)
|
||
|
max_key = len(new_native) - 1
|
||
|
if key > max_key:
|
||
|
new_native.extend([0] * (key - max_key))
|
||
|
new_native[key] = 1 if value else 0
|
||
|
self._native = tuple(new_native)
|
||
|
|
||
|
else:
|
||
|
if is_int:
|
||
|
key = self._map.get(key, key)
|
||
|
|
||
|
if value:
|
||
|
if key not in self._native:
|
||
|
self._native.add(key)
|
||
|
else:
|
||
|
if key in self._native:
|
||
|
self._native.remove(key)
|
||
|
|
||
|
self.set(self._native)
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
If a _map is set, a set of names, or if no _map is set, a tuple of
|
||
|
integers 1 and 0. None if no value.
|
||
|
"""
|
||
|
|
||
|
# For BitString we default the value to be all zeros
|
||
|
if self.contents is None:
|
||
|
if self._map is None:
|
||
|
self.set(())
|
||
|
else:
|
||
|
self.set(set())
|
||
|
|
||
|
if self._native is None:
|
||
|
int_value, bit_count, self._unused_bits = self._chunks_to_int()
|
||
|
bits = _int_to_bit_tuple(int_value, bit_count)
|
||
|
|
||
|
if self._map:
|
||
|
self._native = set()
|
||
|
for index, bit in enumerate(bits):
|
||
|
if bit:
|
||
|
name = self._map.get(index, index)
|
||
|
self._native.add(name)
|
||
|
else:
|
||
|
self._native = bits
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class OctetBitString(Constructable, Castable, Primitive):
|
||
|
"""
|
||
|
Represents a bit string in ASN.1 as a Python byte string
|
||
|
"""
|
||
|
|
||
|
tag = 3
|
||
|
|
||
|
# Instance attribute of (possibly-merged) byte string
|
||
|
_bytes = None
|
||
|
|
||
|
# Tuple of 1s and 0s; set through native
|
||
|
_unused_bits = ()
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A byte string
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, byte_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a byte string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._bytes = value
|
||
|
# Set the unused bits to 0
|
||
|
self.contents = b'\x00' + value
|
||
|
self._unused_bits = ()
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __bytes__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return b''
|
||
|
if self._bytes is None:
|
||
|
if not self._indefinite:
|
||
|
self._bytes, self._unused_bits = self._as_chunk()[0]
|
||
|
else:
|
||
|
chunks = self._merge_chunks()
|
||
|
self._unused_bits = ()
|
||
|
for chunk in chunks:
|
||
|
if self._unused_bits:
|
||
|
# Disallowed by X.690 §8.6.4
|
||
|
raise ValueError('Only last chunk in a bit string may have unused bits')
|
||
|
self._unused_bits = chunk[1]
|
||
|
self._bytes = b''.join(chunk[0] for chunk in chunks)
|
||
|
|
||
|
return self._bytes
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another OctetBitString object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(OctetBitString, self)._copy(other, copy_func)
|
||
|
self._bytes = other._bytes
|
||
|
self._unused_bits = other._unused_bits
|
||
|
|
||
|
def _as_chunk(self):
|
||
|
"""
|
||
|
Allows reconstructing indefinite length values
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
|
||
|
:return:
|
||
|
List with one tuple, consisting of a byte string and an integer (unused bits)
|
||
|
"""
|
||
|
|
||
|
unused_bits_len = ord(self.contents[0]) if _PY2 else self.contents[0]
|
||
|
if not unused_bits_len:
|
||
|
return [(self.contents[1:], ())]
|
||
|
|
||
|
if len(self.contents) == 1:
|
||
|
# Disallowed by X.690 §8.6.2.3
|
||
|
raise ValueError('Empty bit string has {0} unused bits'.format(unused_bits_len))
|
||
|
|
||
|
if unused_bits_len > 7:
|
||
|
# Disallowed by X.690 §8.6.2.2
|
||
|
raise ValueError('Bit string has {0} unused bits'.format(unused_bits_len))
|
||
|
|
||
|
mask = (1 << unused_bits_len) - 1
|
||
|
last_byte = ord(self.contents[-1]) if _PY2 else self.contents[-1]
|
||
|
|
||
|
# zero out the unused bits in the last byte.
|
||
|
zeroed_byte = last_byte & ~mask
|
||
|
value = self.contents[1:-1] + (chr(zeroed_byte) if _PY2 else bytes((zeroed_byte,)))
|
||
|
|
||
|
unused_bits = _int_to_bit_tuple(last_byte & mask, unused_bits_len)
|
||
|
|
||
|
return [(value, unused_bits)]
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A byte string or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
return self.__bytes__()
|
||
|
|
||
|
@property
|
||
|
def unused_bits(self):
|
||
|
"""
|
||
|
The unused bits of the bit string encoding.
|
||
|
|
||
|
:return:
|
||
|
A tuple of 1s and 0s
|
||
|
"""
|
||
|
|
||
|
# call native to set _unused_bits
|
||
|
self.native
|
||
|
|
||
|
return self._unused_bits
|
||
|
|
||
|
|
||
|
class IntegerBitString(_IntegerBitString, Constructable, Castable, Primitive):
|
||
|
"""
|
||
|
Represents a bit string in ASN.1 as a Python integer
|
||
|
"""
|
||
|
|
||
|
tag = 3
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
An integer
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, int_types):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a positive integer, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
if value < 0:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value must be a positive integer, not %d
|
||
|
''',
|
||
|
type_name(self),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
self._native = value
|
||
|
# Set the unused bits to 0
|
||
|
self.contents = b'\x00' + int_to_bytes(value, signed=True)
|
||
|
self._unused_bits = ()
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
An integer or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native, __, self._unused_bits = self._chunks_to_int()
|
||
|
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class OctetString(Constructable, Castable, Primitive):
|
||
|
"""
|
||
|
Represents a byte string in both ASN.1 and Python
|
||
|
"""
|
||
|
|
||
|
tag = 4
|
||
|
|
||
|
# Instance attribute of (possibly-merged) byte string
|
||
|
_bytes = None
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, byte_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a byte string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._bytes = value
|
||
|
self.contents = value
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __bytes__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return b''
|
||
|
if self._bytes is None:
|
||
|
self._bytes = self._merge_chunks()
|
||
|
return self._bytes
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another OctetString object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(OctetString, self)._copy(other, copy_func)
|
||
|
self._bytes = other._bytes
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A byte string or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
return self.__bytes__()
|
||
|
|
||
|
|
||
|
class IntegerOctetString(Constructable, Castable, Primitive):
|
||
|
"""
|
||
|
Represents a byte string in ASN.1 as a Python integer
|
||
|
"""
|
||
|
|
||
|
tag = 4
|
||
|
|
||
|
# An explicit length in bytes the integer should be encoded to. This should
|
||
|
# generally not be used since DER defines a canonical encoding, however some
|
||
|
# use of this, such as when storing elliptic curve private keys, requires an
|
||
|
# exact number of bytes, even if the leading bytes are null.
|
||
|
_encoded_width = None
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
An integer
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, int_types):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a positive integer, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
if value < 0:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value must be a positive integer, not %d
|
||
|
''',
|
||
|
type_name(self),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
self._native = value
|
||
|
self.contents = int_to_bytes(value, signed=False, width=self._encoded_width)
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
An integer or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native = int_from_bytes(self._merge_chunks())
|
||
|
return self._native
|
||
|
|
||
|
def set_encoded_width(self, width):
|
||
|
"""
|
||
|
Set the explicit enoding width for the integer
|
||
|
|
||
|
:param width:
|
||
|
An integer byte width to encode the integer to
|
||
|
"""
|
||
|
|
||
|
self._encoded_width = width
|
||
|
# Make sure the encoded value is up-to-date with the proper width
|
||
|
if self.contents is not None and len(self.contents) != width:
|
||
|
self.set(self.native)
|
||
|
|
||
|
|
||
|
class ParsableOctetString(Constructable, Castable, Primitive):
|
||
|
|
||
|
tag = 4
|
||
|
|
||
|
_parsed = None
|
||
|
|
||
|
# Instance attribute of (possibly-merged) byte string
|
||
|
_bytes = None
|
||
|
|
||
|
def __init__(self, value=None, parsed=None, **kwargs):
|
||
|
"""
|
||
|
Allows providing a parsed object that will be serialized to get the
|
||
|
byte string value
|
||
|
|
||
|
:param value:
|
||
|
A native Python datatype to initialize the object value with
|
||
|
|
||
|
:param parsed:
|
||
|
If value is None and this is an Asn1Value object, this will be
|
||
|
set as the parsed value, and the value will be obtained by calling
|
||
|
.dump() on this object.
|
||
|
"""
|
||
|
|
||
|
set_parsed = False
|
||
|
if value is None and parsed is not None and isinstance(parsed, Asn1Value):
|
||
|
value = parsed.dump()
|
||
|
set_parsed = True
|
||
|
|
||
|
Primitive.__init__(self, value=value, **kwargs)
|
||
|
|
||
|
if set_parsed:
|
||
|
self._parsed = (parsed, parsed.__class__, None)
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, byte_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a byte string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._bytes = value
|
||
|
self.contents = value
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def parse(self, spec=None, spec_params=None):
|
||
|
"""
|
||
|
Parses the contents generically, or using a spec with optional params
|
||
|
|
||
|
:param spec:
|
||
|
A class derived from Asn1Value that defines what class_ and tag the
|
||
|
value should have, and the semantics of the encoded value. The
|
||
|
return value will be of this type. If omitted, the encoded value
|
||
|
will be decoded using the standard universal tag based on the
|
||
|
encoded tag number.
|
||
|
|
||
|
:param spec_params:
|
||
|
A dict of params to pass to the spec object
|
||
|
|
||
|
:return:
|
||
|
An object of the type spec, or if not present, a child of Asn1Value
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None or self._parsed[1:3] != (spec, spec_params):
|
||
|
parsed_value, _ = _parse_build(self.__bytes__(), spec=spec, spec_params=spec_params)
|
||
|
self._parsed = (parsed_value, spec, spec_params)
|
||
|
return self._parsed[0]
|
||
|
|
||
|
def __bytes__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return b''
|
||
|
if self._bytes is None:
|
||
|
self._bytes = self._merge_chunks()
|
||
|
return self._bytes
|
||
|
|
||
|
def _setable_native(self):
|
||
|
"""
|
||
|
Returns a byte string that can be passed into .set()
|
||
|
|
||
|
:return:
|
||
|
A python value that is valid to pass to .set()
|
||
|
"""
|
||
|
|
||
|
return self.__bytes__()
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another ParsableOctetString object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(ParsableOctetString, self)._copy(other, copy_func)
|
||
|
self._bytes = other._bytes
|
||
|
self._parsed = copy_func(other._parsed)
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A byte string or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._parsed is not None:
|
||
|
return self._parsed[0].native
|
||
|
else:
|
||
|
return self.__bytes__()
|
||
|
|
||
|
@property
|
||
|
def parsed(self):
|
||
|
"""
|
||
|
Returns the parsed object from .parse()
|
||
|
|
||
|
:return:
|
||
|
The object returned by .parse()
|
||
|
"""
|
||
|
|
||
|
if self._parsed is None:
|
||
|
self.parse()
|
||
|
|
||
|
return self._parsed[0]
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._indefinite:
|
||
|
force = True
|
||
|
|
||
|
if force:
|
||
|
if self._parsed is not None:
|
||
|
native = self.parsed.dump(force=force)
|
||
|
else:
|
||
|
native = self.native
|
||
|
self.contents = None
|
||
|
self.set(native)
|
||
|
|
||
|
return Asn1Value.dump(self)
|
||
|
|
||
|
|
||
|
class ParsableOctetBitString(ParsableOctetString):
|
||
|
|
||
|
tag = 3
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A byte string
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, byte_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a byte string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._bytes = value
|
||
|
# Set the unused bits to 0
|
||
|
self.contents = b'\x00' + value
|
||
|
self._header = None
|
||
|
if self._indefinite:
|
||
|
self._indefinite = False
|
||
|
self.method = 0
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def _as_chunk(self):
|
||
|
"""
|
||
|
Allows reconstructing indefinite length values
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
|
||
|
:return:
|
||
|
A byte string
|
||
|
"""
|
||
|
|
||
|
unused_bits_len = ord(self.contents[0]) if _PY2 else self.contents[0]
|
||
|
if unused_bits_len:
|
||
|
raise ValueError('ParsableOctetBitString should have no unused bits')
|
||
|
|
||
|
return self.contents[1:]
|
||
|
|
||
|
|
||
|
class Null(Primitive):
|
||
|
"""
|
||
|
Represents a null value in ASN.1 as None in Python
|
||
|
"""
|
||
|
|
||
|
tag = 5
|
||
|
|
||
|
contents = b''
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
None
|
||
|
"""
|
||
|
|
||
|
self.contents = b''
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
None
|
||
|
"""
|
||
|
|
||
|
return None
|
||
|
|
||
|
|
||
|
class ObjectIdentifier(Primitive, ValueMap):
|
||
|
"""
|
||
|
Represents an object identifier in ASN.1 as a Python unicode dotted
|
||
|
integer string
|
||
|
"""
|
||
|
|
||
|
tag = 6
|
||
|
|
||
|
# A unicode string of the dotted form of the object identifier
|
||
|
_dotted = None
|
||
|
|
||
|
@classmethod
|
||
|
def map(cls, value):
|
||
|
"""
|
||
|
Converts a dotted unicode string OID into a mapped unicode string
|
||
|
|
||
|
:param value:
|
||
|
A dotted unicode string OID
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when no _map dict has been defined on the class
|
||
|
TypeError - when value is not a unicode string
|
||
|
|
||
|
:return:
|
||
|
A mapped unicode string
|
||
|
"""
|
||
|
|
||
|
if cls._map is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map has not been defined
|
||
|
''',
|
||
|
type_name(cls)
|
||
|
))
|
||
|
|
||
|
if not isinstance(value, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
value must be a unicode string, not %s
|
||
|
''',
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
return cls._map.get(value, value)
|
||
|
|
||
|
@classmethod
|
||
|
def unmap(cls, value):
|
||
|
"""
|
||
|
Converts a mapped unicode string value into a dotted unicode string OID
|
||
|
|
||
|
:param value:
|
||
|
A mapped unicode string OR dotted unicode string OID
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when no _map dict has been defined on the class or the value can't be unmapped
|
||
|
TypeError - when value is not a unicode string
|
||
|
|
||
|
:return:
|
||
|
A dotted unicode string OID
|
||
|
"""
|
||
|
|
||
|
if cls not in _SETUP_CLASSES:
|
||
|
cls()._setup()
|
||
|
_SETUP_CLASSES[cls] = True
|
||
|
|
||
|
if cls._map is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map has not been defined
|
||
|
''',
|
||
|
type_name(cls)
|
||
|
))
|
||
|
|
||
|
if not isinstance(value, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
value must be a unicode string, not %s
|
||
|
''',
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
if value in cls._reverse_map:
|
||
|
return cls._reverse_map[value]
|
||
|
|
||
|
if not _OID_RE.match(value):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s._map does not contain an entry for "%s"
|
||
|
''',
|
||
|
type_name(cls),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
return value
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A unicode string. May be a dotted integer string, or if _map is
|
||
|
provided, one of the mapped values.
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be a unicode string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
self._native = value
|
||
|
|
||
|
if self._map is not None:
|
||
|
if value in self._reverse_map:
|
||
|
value = self._reverse_map[value]
|
||
|
|
||
|
self.contents = b''
|
||
|
first = None
|
||
|
for index, part in enumerate(value.split('.')):
|
||
|
part = int(part)
|
||
|
|
||
|
# The first two parts are merged into a single byte
|
||
|
if index == 0:
|
||
|
first = part
|
||
|
continue
|
||
|
elif index == 1:
|
||
|
if first > 2:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
First arc must be one of 0, 1 or 2, not %s
|
||
|
''',
|
||
|
repr(first)
|
||
|
))
|
||
|
elif first < 2 and part >= 40:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Second arc must be less than 40 if first arc is 0 or
|
||
|
1, not %s
|
||
|
''',
|
||
|
repr(part)
|
||
|
))
|
||
|
part = (first * 40) + part
|
||
|
|
||
|
encoded_part = chr_cls(0x7F & part)
|
||
|
part = part >> 7
|
||
|
while part > 0:
|
||
|
encoded_part = chr_cls(0x80 | (0x7F & part)) + encoded_part
|
||
|
part = part >> 7
|
||
|
self.contents += encoded_part
|
||
|
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def __unicode__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string
|
||
|
"""
|
||
|
|
||
|
return self.dotted
|
||
|
|
||
|
@property
|
||
|
def dotted(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A unicode string of the object identifier in dotted notation, thus
|
||
|
ignoring any mapped value
|
||
|
"""
|
||
|
|
||
|
if self._dotted is None:
|
||
|
output = []
|
||
|
|
||
|
part = 0
|
||
|
for byte in self.contents:
|
||
|
if _PY2:
|
||
|
byte = ord(byte)
|
||
|
part = part * 128
|
||
|
part += byte & 127
|
||
|
# Last byte in subidentifier has the eighth bit set to 0
|
||
|
if byte & 0x80 == 0:
|
||
|
if len(output) == 0:
|
||
|
if part >= 80:
|
||
|
output.append(str_cls(2))
|
||
|
output.append(str_cls(part - 80))
|
||
|
elif part >= 40:
|
||
|
output.append(str_cls(1))
|
||
|
output.append(str_cls(part - 40))
|
||
|
else:
|
||
|
output.append(str_cls(0))
|
||
|
output.append(str_cls(part))
|
||
|
else:
|
||
|
output.append(str_cls(part))
|
||
|
part = 0
|
||
|
|
||
|
self._dotted = '.'.join(output)
|
||
|
return self._dotted
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A unicode string or None. If _map is not defined, the unicode string
|
||
|
is a string of dotted integers. If _map is defined and the dotted
|
||
|
string is present in the _map, the mapped value is returned.
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native = self.dotted
|
||
|
if self._map is not None and self._native in self._map:
|
||
|
self._native = self._map[self._native]
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class ObjectDescriptor(Primitive):
|
||
|
"""
|
||
|
Represents an object descriptor from ASN.1 - no Python implementation
|
||
|
"""
|
||
|
|
||
|
tag = 7
|
||
|
|
||
|
|
||
|
class InstanceOf(Primitive):
|
||
|
"""
|
||
|
Represents an instance from ASN.1 - no Python implementation
|
||
|
"""
|
||
|
|
||
|
tag = 8
|
||
|
|
||
|
|
||
|
class Real(Primitive):
|
||
|
"""
|
||
|
Represents a real number from ASN.1 - no Python implementation
|
||
|
"""
|
||
|
|
||
|
tag = 9
|
||
|
|
||
|
|
||
|
class Enumerated(Integer):
|
||
|
"""
|
||
|
Represents a enumerated list of integers from ASN.1 as a Python
|
||
|
unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 10
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
An integer or a unicode string from _map
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if not isinstance(value, int_types) and not isinstance(value, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be an integer or a unicode string, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(value)
|
||
|
))
|
||
|
|
||
|
if isinstance(value, str_cls):
|
||
|
if value not in self._reverse_map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value "%s" is not a valid value
|
||
|
''',
|
||
|
type_name(self),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
value = self._reverse_map[value]
|
||
|
|
||
|
elif value not in self._map:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
%s value %s is not a valid value
|
||
|
''',
|
||
|
type_name(self),
|
||
|
value
|
||
|
))
|
||
|
|
||
|
Integer.set(self, value)
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A unicode string or None
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
self._native = self._map[self.__int__()]
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class UTF8String(AbstractString):
|
||
|
"""
|
||
|
Represents a UTF-8 string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 12
|
||
|
_encoding = 'utf-8'
|
||
|
|
||
|
|
||
|
class RelativeOid(ObjectIdentifier):
|
||
|
"""
|
||
|
Represents an object identifier in ASN.1 as a Python unicode dotted
|
||
|
integer string
|
||
|
"""
|
||
|
|
||
|
tag = 13
|
||
|
|
||
|
|
||
|
class Sequence(Asn1Value):
|
||
|
"""
|
||
|
Represents a sequence of fields from ASN.1 as a Python object with a
|
||
|
dict-like interface
|
||
|
"""
|
||
|
|
||
|
tag = 16
|
||
|
|
||
|
class_ = 0
|
||
|
method = 1
|
||
|
|
||
|
# A list of child objects, in order of _fields
|
||
|
children = None
|
||
|
|
||
|
# Sequence overrides .contents to be a property so that the mutated state
|
||
|
# of child objects can be checked to ensure everything is up-to-date
|
||
|
_contents = None
|
||
|
|
||
|
# Variable to track if the object has been mutated
|
||
|
_mutated = False
|
||
|
|
||
|
# A list of tuples in one of the following forms.
|
||
|
#
|
||
|
# Option 1, a unicode string field name and a value class
|
||
|
#
|
||
|
# ("name", Asn1ValueClass)
|
||
|
#
|
||
|
# Option 2, same as Option 1, but with a dict of class params
|
||
|
#
|
||
|
# ("name", Asn1ValueClass, {'explicit': 5})
|
||
|
_fields = []
|
||
|
|
||
|
# A dict with keys being the name of a field and the value being a unicode
|
||
|
# string of the method name on self to call to get the spec for that field
|
||
|
_spec_callbacks = None
|
||
|
|
||
|
# A dict that maps unicode string field names to an index in _fields
|
||
|
_field_map = None
|
||
|
|
||
|
# A list in the same order as _fields that has tuples in the form (class_, tag)
|
||
|
_field_ids = None
|
||
|
|
||
|
# An optional 2-element tuple that defines the field names of an OID field
|
||
|
# and the field that the OID should be used to help decode. Works with the
|
||
|
# _oid_specs attribute.
|
||
|
_oid_pair = None
|
||
|
|
||
|
# A dict with keys that are unicode string OID values and values that are
|
||
|
# Asn1Value classes to use for decoding a variable-type field.
|
||
|
_oid_specs = None
|
||
|
|
||
|
# A 2-element tuple of the indexes in _fields of the OID and value fields
|
||
|
_oid_nums = None
|
||
|
|
||
|
# Predetermined field specs to optimize away calls to _determine_spec()
|
||
|
_precomputed_specs = None
|
||
|
|
||
|
def __init__(self, value=None, default=None, **kwargs):
|
||
|
"""
|
||
|
Allows setting field values before passing everything else along to
|
||
|
Asn1Value.__init__()
|
||
|
|
||
|
:param value:
|
||
|
A native Python datatype to initialize the object value with
|
||
|
|
||
|
:param default:
|
||
|
The default value if no value is specified
|
||
|
"""
|
||
|
|
||
|
Asn1Value.__init__(self, **kwargs)
|
||
|
|
||
|
check_existing = False
|
||
|
if value is None and default is not None:
|
||
|
check_existing = True
|
||
|
if self.children is None:
|
||
|
if self.contents is None:
|
||
|
check_existing = False
|
||
|
else:
|
||
|
self._parse_children()
|
||
|
value = default
|
||
|
|
||
|
if value is not None:
|
||
|
try:
|
||
|
# Fields are iterated in definition order to allow things like
|
||
|
# OID-based specs. Otherwise sometimes the value would be processed
|
||
|
# before the OID field, resulting in invalid value object creation.
|
||
|
if self._fields:
|
||
|
keys = [info[0] for info in self._fields]
|
||
|
unused_keys = set(value.keys())
|
||
|
else:
|
||
|
keys = value.keys()
|
||
|
unused_keys = set(keys)
|
||
|
|
||
|
for key in keys:
|
||
|
# If we are setting defaults, but a real value has already
|
||
|
# been set for the field, then skip it
|
||
|
if check_existing:
|
||
|
index = self._field_map[key]
|
||
|
if index < len(self.children) and self.children[index] is not VOID:
|
||
|
if key in unused_keys:
|
||
|
unused_keys.remove(key)
|
||
|
continue
|
||
|
|
||
|
if key in value:
|
||
|
self.__setitem__(key, value[key])
|
||
|
unused_keys.remove(key)
|
||
|
|
||
|
if len(unused_keys):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
One or more unknown fields was passed to the constructor
|
||
|
of %s: %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
', '.join(sorted(list(unused_keys)))
|
||
|
))
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
@property
|
||
|
def contents(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string of the DER-encoded contents of the sequence
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
return self._contents
|
||
|
|
||
|
if self._is_mutated():
|
||
|
self._set_contents()
|
||
|
|
||
|
return self._contents
|
||
|
|
||
|
@contents.setter
|
||
|
def contents(self, value):
|
||
|
"""
|
||
|
:param value:
|
||
|
A byte string of the DER-encoded contents of the sequence
|
||
|
"""
|
||
|
|
||
|
self._contents = value
|
||
|
|
||
|
def _is_mutated(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A boolean - if the sequence or any children (recursively) have been
|
||
|
mutated
|
||
|
"""
|
||
|
|
||
|
mutated = self._mutated
|
||
|
if self.children is not None:
|
||
|
for child in self.children:
|
||
|
if isinstance(child, Sequence) or isinstance(child, SequenceOf):
|
||
|
mutated = mutated or child._is_mutated()
|
||
|
|
||
|
return mutated
|
||
|
|
||
|
def _lazy_child(self, index):
|
||
|
"""
|
||
|
Builds a child object if the child has only been parsed into a tuple so far
|
||
|
"""
|
||
|
|
||
|
child = self.children[index]
|
||
|
if child.__class__ == tuple:
|
||
|
child = self.children[index] = _build(*child)
|
||
|
return child
|
||
|
|
||
|
def __len__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
Integer
|
||
|
"""
|
||
|
# We inline this check to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
return len(self.children)
|
||
|
|
||
|
def __getitem__(self, key):
|
||
|
"""
|
||
|
Allows accessing fields by name or index
|
||
|
|
||
|
:param key:
|
||
|
A unicode string of the field name, or an integer of the field index
|
||
|
|
||
|
:raises:
|
||
|
KeyError - when a field name or index is invalid
|
||
|
|
||
|
:return:
|
||
|
The Asn1Value object of the field specified
|
||
|
"""
|
||
|
|
||
|
# We inline this check to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
if not isinstance(key, int_types):
|
||
|
if key not in self._field_map:
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No field named "%s" defined for %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
key = self._field_map[key]
|
||
|
|
||
|
if key >= len(self.children):
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No field numbered %s is present in this %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
try:
|
||
|
return self._lazy_child(key)
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def __setitem__(self, key, value):
|
||
|
"""
|
||
|
Allows settings fields by name or index
|
||
|
|
||
|
:param key:
|
||
|
A unicode string of the field name, or an integer of the field index
|
||
|
|
||
|
:param value:
|
||
|
A native Python datatype to set the field value to. This method will
|
||
|
construct the appropriate Asn1Value object from _fields.
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when a field name or index is invalid
|
||
|
"""
|
||
|
|
||
|
# We inline this check to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
if not isinstance(key, int_types):
|
||
|
if key not in self._field_map:
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No field named "%s" defined for %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
key = self._field_map[key]
|
||
|
|
||
|
field_name, field_spec, value_spec, field_params, _ = self._determine_spec(key)
|
||
|
|
||
|
new_value = self._make_value(field_name, field_spec, value_spec, field_params, value)
|
||
|
|
||
|
invalid_value = False
|
||
|
if isinstance(new_value, Any):
|
||
|
invalid_value = new_value.parsed is None
|
||
|
else:
|
||
|
invalid_value = new_value.contents is None
|
||
|
|
||
|
if invalid_value:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Value for field "%s" of %s is not set
|
||
|
''',
|
||
|
field_name,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self.children[key] = new_value
|
||
|
|
||
|
if self._native is not None:
|
||
|
self._native[self._fields[key][0]] = self.children[key].native
|
||
|
self._mutated = True
|
||
|
|
||
|
def __delitem__(self, key):
|
||
|
"""
|
||
|
Allows deleting optional or default fields by name or index
|
||
|
|
||
|
:param key:
|
||
|
A unicode string of the field name, or an integer of the field index
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when a field name or index is invalid, or the field is not optional or defaulted
|
||
|
"""
|
||
|
|
||
|
# We inline this check to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
if not isinstance(key, int_types):
|
||
|
if key not in self._field_map:
|
||
|
raise KeyError(unwrap(
|
||
|
'''
|
||
|
No field named "%s" defined for %s
|
||
|
''',
|
||
|
key,
|
||
|
type_name(self)
|
||
|
))
|
||
|
key = self._field_map[key]
|
||
|
|
||
|
name, _, params = self._fields[key]
|
||
|
if not params or ('default' not in params and 'optional' not in params):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Can not delete the value for the field "%s" of %s since it is
|
||
|
not optional or defaulted
|
||
|
''',
|
||
|
name,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
if 'optional' in params:
|
||
|
self.children[key] = VOID
|
||
|
if self._native is not None:
|
||
|
self._native[name] = None
|
||
|
else:
|
||
|
self.__setitem__(key, None)
|
||
|
self._mutated = True
|
||
|
|
||
|
def __iter__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An iterator of field key names
|
||
|
"""
|
||
|
|
||
|
for info in self._fields:
|
||
|
yield info[0]
|
||
|
|
||
|
def _set_contents(self, force=False):
|
||
|
"""
|
||
|
Updates the .contents attribute of the value with the encoded value of
|
||
|
all of the child objects
|
||
|
|
||
|
:param force:
|
||
|
Ensure all contents are in DER format instead of possibly using
|
||
|
cached BER-encoded data
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
contents = BytesIO()
|
||
|
for index, info in enumerate(self._fields):
|
||
|
child = self.children[index]
|
||
|
if child is None:
|
||
|
child_dump = b''
|
||
|
elif child.__class__ == tuple:
|
||
|
if force:
|
||
|
child_dump = self._lazy_child(index).dump(force=force)
|
||
|
else:
|
||
|
child_dump = child[3] + child[4] + child[5]
|
||
|
else:
|
||
|
child_dump = child.dump(force=force)
|
||
|
# Skip values that are the same as the default
|
||
|
if info[2] and 'default' in info[2]:
|
||
|
default_value = info[1](**info[2])
|
||
|
if default_value.dump() == child_dump:
|
||
|
continue
|
||
|
contents.write(child_dump)
|
||
|
self._contents = contents.getvalue()
|
||
|
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def _setup(self):
|
||
|
"""
|
||
|
Generates _field_map, _field_ids and _oid_nums for use in parsing
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
cls._field_map = {}
|
||
|
cls._field_ids = []
|
||
|
cls._precomputed_specs = []
|
||
|
for index, field in enumerate(cls._fields):
|
||
|
if len(field) < 3:
|
||
|
field = field + ({},)
|
||
|
cls._fields[index] = field
|
||
|
cls._field_map[field[0]] = index
|
||
|
cls._field_ids.append(_build_id_tuple(field[2], field[1]))
|
||
|
|
||
|
if cls._oid_pair is not None:
|
||
|
cls._oid_nums = (cls._field_map[cls._oid_pair[0]], cls._field_map[cls._oid_pair[1]])
|
||
|
|
||
|
for index, field in enumerate(cls._fields):
|
||
|
has_callback = cls._spec_callbacks is not None and field[0] in cls._spec_callbacks
|
||
|
is_mapped_oid = cls._oid_nums is not None and cls._oid_nums[1] == index
|
||
|
if has_callback or is_mapped_oid:
|
||
|
cls._precomputed_specs.append(None)
|
||
|
else:
|
||
|
cls._precomputed_specs.append((field[0], field[1], field[1], field[2], None))
|
||
|
|
||
|
def _determine_spec(self, index):
|
||
|
"""
|
||
|
Determine how a value for a field should be constructed
|
||
|
|
||
|
:param index:
|
||
|
The field number
|
||
|
|
||
|
:return:
|
||
|
A tuple containing the following elements:
|
||
|
- unicode string of the field name
|
||
|
- Asn1Value class of the field spec
|
||
|
- Asn1Value class of the value spec
|
||
|
- None or dict of params to pass to the field spec
|
||
|
- None or Asn1Value class indicating the value spec was derived from an OID or a spec callback
|
||
|
"""
|
||
|
|
||
|
name, field_spec, field_params = self._fields[index]
|
||
|
value_spec = field_spec
|
||
|
spec_override = None
|
||
|
|
||
|
if self._spec_callbacks is not None and name in self._spec_callbacks:
|
||
|
callback = self._spec_callbacks[name]
|
||
|
spec_override = callback(self)
|
||
|
if spec_override:
|
||
|
# Allow a spec callback to specify both the base spec and
|
||
|
# the override, for situations such as OctetString and parse_as
|
||
|
if spec_override.__class__ == tuple and len(spec_override) == 2:
|
||
|
field_spec, value_spec = spec_override
|
||
|
if value_spec is None:
|
||
|
value_spec = field_spec
|
||
|
spec_override = None
|
||
|
# When no field spec is specified, use a single return value as that
|
||
|
elif field_spec is None:
|
||
|
field_spec = spec_override
|
||
|
value_spec = field_spec
|
||
|
spec_override = None
|
||
|
else:
|
||
|
value_spec = spec_override
|
||
|
|
||
|
elif self._oid_nums is not None and self._oid_nums[1] == index:
|
||
|
oid = self._lazy_child(self._oid_nums[0]).native
|
||
|
if oid in self._oid_specs:
|
||
|
spec_override = self._oid_specs[oid]
|
||
|
value_spec = spec_override
|
||
|
|
||
|
return (name, field_spec, value_spec, field_params, spec_override)
|
||
|
|
||
|
def _make_value(self, field_name, field_spec, value_spec, field_params, value):
|
||
|
"""
|
||
|
Contructs an appropriate Asn1Value object for a field
|
||
|
|
||
|
:param field_name:
|
||
|
A unicode string of the field name
|
||
|
|
||
|
:param field_spec:
|
||
|
An Asn1Value class that is the field spec
|
||
|
|
||
|
:param value_spec:
|
||
|
An Asn1Value class that is the vaue spec
|
||
|
|
||
|
:param field_params:
|
||
|
None or a dict of params for the field spec
|
||
|
|
||
|
:param value:
|
||
|
The value to construct an Asn1Value object from
|
||
|
|
||
|
:return:
|
||
|
An instance of a child class of Asn1Value
|
||
|
"""
|
||
|
|
||
|
if value is None and 'optional' in field_params:
|
||
|
return VOID
|
||
|
|
||
|
specs_different = field_spec != value_spec
|
||
|
is_any = issubclass(field_spec, Any)
|
||
|
|
||
|
if issubclass(value_spec, Choice):
|
||
|
is_asn1value = isinstance(value, Asn1Value)
|
||
|
is_tuple = isinstance(value, tuple) and len(value) == 2
|
||
|
is_dict = isinstance(value, dict) and len(value) == 1
|
||
|
if not is_asn1value and not is_tuple and not is_dict:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Can not set a native python value to %s, which has the
|
||
|
choice type of %s - value must be an instance of Asn1Value
|
||
|
''',
|
||
|
field_name,
|
||
|
type_name(value_spec)
|
||
|
))
|
||
|
if is_tuple or is_dict:
|
||
|
value = value_spec(value)
|
||
|
if not isinstance(value, value_spec):
|
||
|
wrapper = value_spec()
|
||
|
wrapper.validate(value.class_, value.tag, value.contents)
|
||
|
wrapper._parsed = value
|
||
|
new_value = wrapper
|
||
|
else:
|
||
|
new_value = value
|
||
|
|
||
|
elif isinstance(value, field_spec):
|
||
|
new_value = value
|
||
|
if specs_different:
|
||
|
new_value.parse(value_spec)
|
||
|
|
||
|
elif (not specs_different or is_any) and not isinstance(value, value_spec):
|
||
|
if (not is_any or specs_different) and isinstance(value, Asn1Value):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be %s, not %s
|
||
|
''',
|
||
|
field_name,
|
||
|
type_name(value_spec),
|
||
|
type_name(value)
|
||
|
))
|
||
|
new_value = value_spec(value, **field_params)
|
||
|
|
||
|
else:
|
||
|
if isinstance(value, value_spec):
|
||
|
new_value = value
|
||
|
else:
|
||
|
if isinstance(value, Asn1Value):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
%s value must be %s, not %s
|
||
|
''',
|
||
|
field_name,
|
||
|
type_name(value_spec),
|
||
|
type_name(value)
|
||
|
))
|
||
|
new_value = value_spec(value)
|
||
|
|
||
|
# For when the field is OctetString or OctetBitString with embedded
|
||
|
# values we need to wrap the value in the field spec to get the
|
||
|
# appropriate encoded value.
|
||
|
if specs_different and not is_any:
|
||
|
wrapper = field_spec(value=new_value.dump(), **field_params)
|
||
|
wrapper._parsed = (new_value, new_value.__class__, None)
|
||
|
new_value = wrapper
|
||
|
|
||
|
new_value = _fix_tagging(new_value, field_params)
|
||
|
|
||
|
return new_value
|
||
|
|
||
|
def _parse_children(self, recurse=False):
|
||
|
"""
|
||
|
Parses the contents and generates Asn1Value objects based on the
|
||
|
definitions from _fields.
|
||
|
|
||
|
:param recurse:
|
||
|
If child objects that are Sequence or SequenceOf objects should
|
||
|
be recursively parsed
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an error occurs parsing child objects
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
if self._contents is None:
|
||
|
if self._fields:
|
||
|
self.children = [VOID] * len(self._fields)
|
||
|
for index, (_, _, params) in enumerate(self._fields):
|
||
|
if 'default' in params:
|
||
|
if cls._precomputed_specs[index]:
|
||
|
field_name, field_spec, value_spec, field_params, _ = cls._precomputed_specs[index]
|
||
|
else:
|
||
|
field_name, field_spec, value_spec, field_params, _ = self._determine_spec(index)
|
||
|
self.children[index] = self._make_value(field_name, field_spec, value_spec, field_params, None)
|
||
|
return
|
||
|
|
||
|
try:
|
||
|
self.children = []
|
||
|
contents_length = len(self._contents)
|
||
|
child_pointer = 0
|
||
|
field = 0
|
||
|
field_len = len(self._fields)
|
||
|
parts = None
|
||
|
again = child_pointer < contents_length
|
||
|
while again:
|
||
|
if parts is None:
|
||
|
parts, child_pointer = _parse(self._contents, contents_length, pointer=child_pointer)
|
||
|
again = child_pointer < contents_length
|
||
|
|
||
|
if field < field_len:
|
||
|
_, field_spec, value_spec, field_params, spec_override = (
|
||
|
cls._precomputed_specs[field] or self._determine_spec(field))
|
||
|
|
||
|
# If the next value is optional or default, allow it to be absent
|
||
|
if field_params and ('optional' in field_params or 'default' in field_params):
|
||
|
if self._field_ids[field] != (parts[0], parts[2]) and field_spec != Any:
|
||
|
|
||
|
# See if the value is a valid choice before assuming
|
||
|
# that we have a missing optional or default value
|
||
|
choice_match = False
|
||
|
if issubclass(field_spec, Choice):
|
||
|
try:
|
||
|
tester = field_spec(**field_params)
|
||
|
tester.validate(parts[0], parts[2], parts[4])
|
||
|
choice_match = True
|
||
|
except (ValueError):
|
||
|
pass
|
||
|
|
||
|
if not choice_match:
|
||
|
if 'optional' in field_params:
|
||
|
self.children.append(VOID)
|
||
|
else:
|
||
|
self.children.append(field_spec(**field_params))
|
||
|
field += 1
|
||
|
again = True
|
||
|
continue
|
||
|
|
||
|
if field_spec is None or (spec_override and issubclass(field_spec, Any)):
|
||
|
field_spec = value_spec
|
||
|
spec_override = None
|
||
|
|
||
|
if spec_override:
|
||
|
child = parts + (field_spec, field_params, value_spec)
|
||
|
else:
|
||
|
child = parts + (field_spec, field_params)
|
||
|
|
||
|
# Handle situations where an optional or defaulted field definition is incorrect
|
||
|
elif field_len > 0 and field + 1 <= field_len:
|
||
|
missed_fields = []
|
||
|
prev_field = field - 1
|
||
|
while prev_field >= 0:
|
||
|
prev_field_info = self._fields[prev_field]
|
||
|
if len(prev_field_info) < 3:
|
||
|
break
|
||
|
if 'optional' in prev_field_info[2] or 'default' in prev_field_info[2]:
|
||
|
missed_fields.append(prev_field_info[0])
|
||
|
prev_field -= 1
|
||
|
plural = 's' if len(missed_fields) > 1 else ''
|
||
|
missed_field_names = ', '.join(missed_fields)
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Data for field %s (%s class, %s method, tag %s) does
|
||
|
not match the field definition%s of %s
|
||
|
''',
|
||
|
field + 1,
|
||
|
CLASS_NUM_TO_NAME_MAP.get(parts[0]),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(parts[1]),
|
||
|
parts[2],
|
||
|
plural,
|
||
|
missed_field_names
|
||
|
))
|
||
|
|
||
|
else:
|
||
|
child = parts
|
||
|
|
||
|
if recurse:
|
||
|
child = _build(*child)
|
||
|
if isinstance(child, (Sequence, SequenceOf)):
|
||
|
child._parse_children(recurse=True)
|
||
|
|
||
|
self.children.append(child)
|
||
|
field += 1
|
||
|
parts = None
|
||
|
|
||
|
index = len(self.children)
|
||
|
while index < field_len:
|
||
|
name, field_spec, field_params = self._fields[index]
|
||
|
if 'default' in field_params:
|
||
|
self.children.append(field_spec(**field_params))
|
||
|
elif 'optional' in field_params:
|
||
|
self.children.append(VOID)
|
||
|
else:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Field "%s" is missing from structure
|
||
|
''',
|
||
|
name
|
||
|
))
|
||
|
index += 1
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
self.children = None
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def spec(self, field_name):
|
||
|
"""
|
||
|
Determines the spec to use for the field specified. Depending on how
|
||
|
the spec is determined (_oid_pair or _spec_callbacks), it may be
|
||
|
necessary to set preceding field values before calling this. Usually
|
||
|
specs, if dynamic, are controlled by a preceding ObjectIdentifier
|
||
|
field.
|
||
|
|
||
|
:param field_name:
|
||
|
A unicode string of the field name to get the spec for
|
||
|
|
||
|
:return:
|
||
|
A child class of asn1crypto.core.Asn1Value that the field must be
|
||
|
encoded using
|
||
|
"""
|
||
|
|
||
|
if not isinstance(field_name, str_cls):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
field_name must be a unicode string, not %s
|
||
|
''',
|
||
|
type_name(field_name)
|
||
|
))
|
||
|
|
||
|
if self._fields is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Unable to retrieve spec for field %s in the class %s because
|
||
|
_fields has not been set
|
||
|
''',
|
||
|
repr(field_name),
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
index = self._field_map[field_name]
|
||
|
info = self._determine_spec(index)
|
||
|
|
||
|
return info[2]
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
An OrderedDict or None. If an OrderedDict, all child values are
|
||
|
recursively converted to native representation also.
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
if self.children is None:
|
||
|
self._parse_children(recurse=True)
|
||
|
try:
|
||
|
self._native = OrderedDict()
|
||
|
for index, child in enumerate(self.children):
|
||
|
if child.__class__ == tuple:
|
||
|
child = _build(*child)
|
||
|
self.children[index] = child
|
||
|
try:
|
||
|
name = self._fields[index][0]
|
||
|
except (IndexError):
|
||
|
name = str_cls(index)
|
||
|
self._native[name] = child.native
|
||
|
except (ValueError, TypeError) as e:
|
||
|
self._native = None
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
return self._native
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another Sequence object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(Sequence, self)._copy(other, copy_func)
|
||
|
if self.children is not None:
|
||
|
self.children = []
|
||
|
for child in other.children:
|
||
|
if child.__class__ == tuple:
|
||
|
self.children.append(child)
|
||
|
else:
|
||
|
self.children.append(child.copy())
|
||
|
|
||
|
def debug(self, nest_level=1):
|
||
|
"""
|
||
|
Show the binary data and parsed data in a tree structure
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
prefix = ' ' * nest_level
|
||
|
_basic_debug(prefix, self)
|
||
|
for field_name in self:
|
||
|
child = self._lazy_child(self._field_map[field_name])
|
||
|
if child is not VOID:
|
||
|
print('%s Field "%s"' % (prefix, field_name))
|
||
|
child.debug(nest_level + 3)
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._header is not None and self._header[-1:] == b'\x80':
|
||
|
force = True
|
||
|
|
||
|
if force:
|
||
|
self._set_contents(force=force)
|
||
|
|
||
|
if self._fields and self.children is not None:
|
||
|
for index, (field_name, _, params) in enumerate(self._fields):
|
||
|
if self.children[index] is not VOID:
|
||
|
continue
|
||
|
if 'default' in params or 'optional' in params:
|
||
|
continue
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Field "%s" is missing from structure
|
||
|
''',
|
||
|
field_name
|
||
|
))
|
||
|
|
||
|
return Asn1Value.dump(self)
|
||
|
|
||
|
|
||
|
class SequenceOf(Asn1Value):
|
||
|
"""
|
||
|
Represents a sequence (ordered) of a single type of values from ASN.1 as a
|
||
|
Python object with a list-like interface
|
||
|
"""
|
||
|
|
||
|
tag = 16
|
||
|
|
||
|
class_ = 0
|
||
|
method = 1
|
||
|
|
||
|
# A list of child objects
|
||
|
children = None
|
||
|
|
||
|
# SequenceOf overrides .contents to be a property so that the mutated state
|
||
|
# of child objects can be checked to ensure everything is up-to-date
|
||
|
_contents = None
|
||
|
|
||
|
# Variable to track if the object has been mutated
|
||
|
_mutated = False
|
||
|
|
||
|
# An Asn1Value class to use when parsing children
|
||
|
_child_spec = None
|
||
|
|
||
|
def __init__(self, value=None, default=None, contents=None, spec=None, **kwargs):
|
||
|
"""
|
||
|
Allows setting child objects and the _child_spec via the spec parameter
|
||
|
before passing everything else along to Asn1Value.__init__()
|
||
|
|
||
|
:param value:
|
||
|
A native Python datatype to initialize the object value with
|
||
|
|
||
|
:param default:
|
||
|
The default value if no value is specified
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the encoded contents of the value
|
||
|
|
||
|
:param spec:
|
||
|
A class derived from Asn1Value to use to parse children
|
||
|
"""
|
||
|
|
||
|
if spec:
|
||
|
self._child_spec = spec
|
||
|
|
||
|
Asn1Value.__init__(self, **kwargs)
|
||
|
|
||
|
try:
|
||
|
if contents is not None:
|
||
|
self.contents = contents
|
||
|
else:
|
||
|
if value is None and default is not None:
|
||
|
value = default
|
||
|
|
||
|
if value is not None:
|
||
|
for index, child in enumerate(value):
|
||
|
self.__setitem__(index, child)
|
||
|
|
||
|
# Make sure a blank list is serialized
|
||
|
if self.contents is None:
|
||
|
self._set_contents()
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while constructing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
@property
|
||
|
def contents(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A byte string of the DER-encoded contents of the sequence
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
return self._contents
|
||
|
|
||
|
if self._is_mutated():
|
||
|
self._set_contents()
|
||
|
|
||
|
return self._contents
|
||
|
|
||
|
@contents.setter
|
||
|
def contents(self, value):
|
||
|
"""
|
||
|
:param value:
|
||
|
A byte string of the DER-encoded contents of the sequence
|
||
|
"""
|
||
|
|
||
|
self._contents = value
|
||
|
|
||
|
def _is_mutated(self):
|
||
|
"""
|
||
|
:return:
|
||
|
A boolean - if the sequence or any children (recursively) have been
|
||
|
mutated
|
||
|
"""
|
||
|
|
||
|
mutated = self._mutated
|
||
|
if self.children is not None:
|
||
|
for child in self.children:
|
||
|
if isinstance(child, Sequence) or isinstance(child, SequenceOf):
|
||
|
mutated = mutated or child._is_mutated()
|
||
|
|
||
|
return mutated
|
||
|
|
||
|
def _lazy_child(self, index):
|
||
|
"""
|
||
|
Builds a child object if the child has only been parsed into a tuple so far
|
||
|
"""
|
||
|
|
||
|
child = self.children[index]
|
||
|
if child.__class__ == tuple:
|
||
|
child = _build(*child)
|
||
|
self.children[index] = child
|
||
|
return child
|
||
|
|
||
|
def _make_value(self, value):
|
||
|
"""
|
||
|
Constructs a _child_spec value from a native Python data type, or
|
||
|
an appropriate Asn1Value object
|
||
|
|
||
|
:param value:
|
||
|
A native Python value, or some child of Asn1Value
|
||
|
|
||
|
:return:
|
||
|
An object of type _child_spec
|
||
|
"""
|
||
|
|
||
|
if isinstance(value, self._child_spec):
|
||
|
new_value = value
|
||
|
|
||
|
elif issubclass(self._child_spec, Any):
|
||
|
if isinstance(value, Asn1Value):
|
||
|
new_value = value
|
||
|
else:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Can not set a native python value to %s where the
|
||
|
_child_spec is Any - value must be an instance of Asn1Value
|
||
|
''',
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
elif issubclass(self._child_spec, Choice):
|
||
|
if not isinstance(value, Asn1Value):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Can not set a native python value to %s where the
|
||
|
_child_spec is the choice type %s - value must be an
|
||
|
instance of Asn1Value
|
||
|
''',
|
||
|
type_name(self),
|
||
|
self._child_spec.__name__
|
||
|
))
|
||
|
if not isinstance(value, self._child_spec):
|
||
|
wrapper = self._child_spec()
|
||
|
wrapper.validate(value.class_, value.tag, value.contents)
|
||
|
wrapper._parsed = value
|
||
|
value = wrapper
|
||
|
new_value = value
|
||
|
|
||
|
else:
|
||
|
return self._child_spec(value=value)
|
||
|
|
||
|
params = {}
|
||
|
if self._child_spec.explicit:
|
||
|
params['explicit'] = self._child_spec.explicit
|
||
|
if self._child_spec.implicit:
|
||
|
params['implicit'] = (self._child_spec.class_, self._child_spec.tag)
|
||
|
return _fix_tagging(new_value, params)
|
||
|
|
||
|
def __len__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An integer
|
||
|
"""
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
return len(self.children)
|
||
|
|
||
|
def __getitem__(self, key):
|
||
|
"""
|
||
|
Allows accessing children via index
|
||
|
|
||
|
:param key:
|
||
|
Integer index of child
|
||
|
"""
|
||
|
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
return self._lazy_child(key)
|
||
|
|
||
|
def __setitem__(self, key, value):
|
||
|
"""
|
||
|
Allows overriding a child via index
|
||
|
|
||
|
:param key:
|
||
|
Integer index of child
|
||
|
|
||
|
:param value:
|
||
|
Native python datatype that will be passed to _child_spec to create
|
||
|
new child object
|
||
|
"""
|
||
|
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
new_value = self._make_value(value)
|
||
|
|
||
|
# If adding at the end, create a space for the new value
|
||
|
if key == len(self.children):
|
||
|
self.children.append(None)
|
||
|
if self._native is not None:
|
||
|
self._native.append(None)
|
||
|
|
||
|
self.children[key] = new_value
|
||
|
|
||
|
if self._native is not None:
|
||
|
self._native[key] = self.children[key].native
|
||
|
|
||
|
self._mutated = True
|
||
|
|
||
|
def __delitem__(self, key):
|
||
|
"""
|
||
|
Allows removing a child via index
|
||
|
|
||
|
:param key:
|
||
|
Integer index of child
|
||
|
"""
|
||
|
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
self.children.pop(key)
|
||
|
if self._native is not None:
|
||
|
self._native.pop(key)
|
||
|
|
||
|
self._mutated = True
|
||
|
|
||
|
def __iter__(self):
|
||
|
"""
|
||
|
:return:
|
||
|
An iter() of child objects
|
||
|
"""
|
||
|
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
for index in range(0, len(self.children)):
|
||
|
yield self._lazy_child(index)
|
||
|
|
||
|
def __contains__(self, item):
|
||
|
"""
|
||
|
:param item:
|
||
|
An object of the type cls._child_spec
|
||
|
|
||
|
:return:
|
||
|
A boolean if the item is contained in this SequenceOf
|
||
|
"""
|
||
|
|
||
|
if item is None or item is VOID:
|
||
|
return False
|
||
|
|
||
|
if not isinstance(item, self._child_spec):
|
||
|
raise TypeError(unwrap(
|
||
|
'''
|
||
|
Checking membership in %s is only available for instances of
|
||
|
%s, not %s
|
||
|
''',
|
||
|
type_name(self),
|
||
|
type_name(self._child_spec),
|
||
|
type_name(item)
|
||
|
))
|
||
|
|
||
|
for child in self:
|
||
|
if child == item:
|
||
|
return True
|
||
|
|
||
|
return False
|
||
|
|
||
|
def append(self, value):
|
||
|
"""
|
||
|
Allows adding a child to the end of the sequence
|
||
|
|
||
|
:param value:
|
||
|
Native python datatype that will be passed to _child_spec to create
|
||
|
new child object
|
||
|
"""
|
||
|
|
||
|
# We inline this checks to prevent method invocation each time
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
self.children.append(self._make_value(value))
|
||
|
|
||
|
if self._native is not None:
|
||
|
self._native.append(self.children[-1].native)
|
||
|
|
||
|
self._mutated = True
|
||
|
|
||
|
def _set_contents(self, force=False):
|
||
|
"""
|
||
|
Encodes all child objects into the contents for this object
|
||
|
|
||
|
:param force:
|
||
|
Ensure all contents are in DER format instead of possibly using
|
||
|
cached BER-encoded data
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
contents = BytesIO()
|
||
|
for child in self:
|
||
|
contents.write(child.dump(force=force))
|
||
|
self._contents = contents.getvalue()
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
def _parse_children(self, recurse=False):
|
||
|
"""
|
||
|
Parses the contents and generates Asn1Value objects based on the
|
||
|
definitions from _child_spec.
|
||
|
|
||
|
:param recurse:
|
||
|
If child objects that are Sequence or SequenceOf objects should
|
||
|
be recursively parsed
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an error occurs parsing child objects
|
||
|
"""
|
||
|
|
||
|
try:
|
||
|
self.children = []
|
||
|
if self._contents is None:
|
||
|
return
|
||
|
contents_length = len(self._contents)
|
||
|
child_pointer = 0
|
||
|
while child_pointer < contents_length:
|
||
|
parts, child_pointer = _parse(self._contents, contents_length, pointer=child_pointer)
|
||
|
if self._child_spec:
|
||
|
child = parts + (self._child_spec,)
|
||
|
else:
|
||
|
child = parts
|
||
|
if recurse:
|
||
|
child = _build(*child)
|
||
|
if isinstance(child, (Sequence, SequenceOf)):
|
||
|
child._parse_children(recurse=True)
|
||
|
self.children.append(child)
|
||
|
except (ValueError, TypeError) as e:
|
||
|
self.children = None
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def spec(self):
|
||
|
"""
|
||
|
Determines the spec to use for child values.
|
||
|
|
||
|
:return:
|
||
|
A child class of asn1crypto.core.Asn1Value that child values must be
|
||
|
encoded using
|
||
|
"""
|
||
|
|
||
|
return self._child_spec
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A list or None. If a list, all child values are recursively
|
||
|
converted to native representation also.
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
if self.children is None:
|
||
|
self._parse_children(recurse=True)
|
||
|
try:
|
||
|
self._native = [child.native for child in self]
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
return self._native
|
||
|
|
||
|
def _copy(self, other, copy_func):
|
||
|
"""
|
||
|
Copies the contents of another SequenceOf object to itself
|
||
|
|
||
|
:param object:
|
||
|
Another instance of the same class
|
||
|
|
||
|
:param copy_func:
|
||
|
An reference of copy.copy() or copy.deepcopy() to use when copying
|
||
|
lists, dicts and objects
|
||
|
"""
|
||
|
|
||
|
super(SequenceOf, self)._copy(other, copy_func)
|
||
|
if self.children is not None:
|
||
|
self.children = []
|
||
|
for child in other.children:
|
||
|
if child.__class__ == tuple:
|
||
|
self.children.append(child)
|
||
|
else:
|
||
|
self.children.append(child.copy())
|
||
|
|
||
|
def debug(self, nest_level=1):
|
||
|
"""
|
||
|
Show the binary data and parsed data in a tree structure
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
prefix = ' ' * nest_level
|
||
|
_basic_debug(prefix, self)
|
||
|
for child in self:
|
||
|
child.debug(nest_level + 1)
|
||
|
|
||
|
def dump(self, force=False):
|
||
|
"""
|
||
|
Encodes the value using DER
|
||
|
|
||
|
:param force:
|
||
|
If the encoded contents already exist, clear them and regenerate
|
||
|
to ensure they are in DER format instead of BER format
|
||
|
|
||
|
:return:
|
||
|
A byte string of the DER-encoded value
|
||
|
"""
|
||
|
|
||
|
# If the length is indefinite, force the re-encoding
|
||
|
if self._header is not None and self._header[-1:] == b'\x80':
|
||
|
force = True
|
||
|
|
||
|
if force:
|
||
|
self._set_contents(force=force)
|
||
|
|
||
|
return Asn1Value.dump(self)
|
||
|
|
||
|
|
||
|
class Set(Sequence):
|
||
|
"""
|
||
|
Represents a set of fields (unordered) from ASN.1 as a Python object with a
|
||
|
dict-like interface
|
||
|
"""
|
||
|
|
||
|
method = 1
|
||
|
class_ = 0
|
||
|
tag = 17
|
||
|
|
||
|
# A dict of 2-element tuples in the form (class_, tag) as keys and integers
|
||
|
# as values that are the index of the field in _fields
|
||
|
_field_ids = None
|
||
|
|
||
|
def _setup(self):
|
||
|
"""
|
||
|
Generates _field_map, _field_ids and _oid_nums for use in parsing
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
cls._field_map = {}
|
||
|
cls._field_ids = {}
|
||
|
cls._precomputed_specs = []
|
||
|
for index, field in enumerate(cls._fields):
|
||
|
if len(field) < 3:
|
||
|
field = field + ({},)
|
||
|
cls._fields[index] = field
|
||
|
cls._field_map[field[0]] = index
|
||
|
cls._field_ids[_build_id_tuple(field[2], field[1])] = index
|
||
|
|
||
|
if cls._oid_pair is not None:
|
||
|
cls._oid_nums = (cls._field_map[cls._oid_pair[0]], cls._field_map[cls._oid_pair[1]])
|
||
|
|
||
|
for index, field in enumerate(cls._fields):
|
||
|
has_callback = cls._spec_callbacks is not None and field[0] in cls._spec_callbacks
|
||
|
is_mapped_oid = cls._oid_nums is not None and cls._oid_nums[1] == index
|
||
|
if has_callback or is_mapped_oid:
|
||
|
cls._precomputed_specs.append(None)
|
||
|
else:
|
||
|
cls._precomputed_specs.append((field[0], field[1], field[1], field[2], None))
|
||
|
|
||
|
def _parse_children(self, recurse=False):
|
||
|
"""
|
||
|
Parses the contents and generates Asn1Value objects based on the
|
||
|
definitions from _fields.
|
||
|
|
||
|
:param recurse:
|
||
|
If child objects that are Sequence or SequenceOf objects should
|
||
|
be recursively parsed
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an error occurs parsing child objects
|
||
|
"""
|
||
|
|
||
|
cls = self.__class__
|
||
|
if self._contents is None:
|
||
|
if self._fields:
|
||
|
self.children = [VOID] * len(self._fields)
|
||
|
for index, (_, _, params) in enumerate(self._fields):
|
||
|
if 'default' in params:
|
||
|
if cls._precomputed_specs[index]:
|
||
|
field_name, field_spec, value_spec, field_params, _ = cls._precomputed_specs[index]
|
||
|
else:
|
||
|
field_name, field_spec, value_spec, field_params, _ = self._determine_spec(index)
|
||
|
self.children[index] = self._make_value(field_name, field_spec, value_spec, field_params, None)
|
||
|
return
|
||
|
|
||
|
try:
|
||
|
child_map = {}
|
||
|
contents_length = len(self.contents)
|
||
|
child_pointer = 0
|
||
|
seen_field = 0
|
||
|
while child_pointer < contents_length:
|
||
|
parts, child_pointer = _parse(self.contents, contents_length, pointer=child_pointer)
|
||
|
|
||
|
id_ = (parts[0], parts[2])
|
||
|
|
||
|
field = self._field_ids.get(id_)
|
||
|
if field is None:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Data for field %s (%s class, %s method, tag %s) does
|
||
|
not match any of the field definitions
|
||
|
''',
|
||
|
seen_field,
|
||
|
CLASS_NUM_TO_NAME_MAP.get(parts[0]),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(parts[1]),
|
||
|
parts[2],
|
||
|
))
|
||
|
|
||
|
_, field_spec, value_spec, field_params, spec_override = (
|
||
|
cls._precomputed_specs[field] or self._determine_spec(field))
|
||
|
|
||
|
if field_spec is None or (spec_override and issubclass(field_spec, Any)):
|
||
|
field_spec = value_spec
|
||
|
spec_override = None
|
||
|
|
||
|
if spec_override:
|
||
|
child = parts + (field_spec, field_params, value_spec)
|
||
|
else:
|
||
|
child = parts + (field_spec, field_params)
|
||
|
|
||
|
if recurse:
|
||
|
child = _build(*child)
|
||
|
if isinstance(child, (Sequence, SequenceOf)):
|
||
|
child._parse_children(recurse=True)
|
||
|
|
||
|
child_map[field] = child
|
||
|
seen_field += 1
|
||
|
|
||
|
total_fields = len(self._fields)
|
||
|
|
||
|
for index in range(0, total_fields):
|
||
|
if index in child_map:
|
||
|
continue
|
||
|
|
||
|
name, field_spec, value_spec, field_params, spec_override = (
|
||
|
cls._precomputed_specs[index] or self._determine_spec(index))
|
||
|
|
||
|
if field_spec is None or (spec_override and issubclass(field_spec, Any)):
|
||
|
field_spec = value_spec
|
||
|
spec_override = None
|
||
|
|
||
|
missing = False
|
||
|
|
||
|
if not field_params:
|
||
|
missing = True
|
||
|
elif 'optional' not in field_params and 'default' not in field_params:
|
||
|
missing = True
|
||
|
elif 'optional' in field_params:
|
||
|
child_map[index] = VOID
|
||
|
elif 'default' in field_params:
|
||
|
child_map[index] = field_spec(**field_params)
|
||
|
|
||
|
if missing:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Missing required field "%s" from %s
|
||
|
''',
|
||
|
name,
|
||
|
type_name(self)
|
||
|
))
|
||
|
|
||
|
self.children = []
|
||
|
for index in range(0, total_fields):
|
||
|
self.children.append(child_map[index])
|
||
|
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(self),) + args
|
||
|
raise e
|
||
|
|
||
|
def _set_contents(self, force=False):
|
||
|
"""
|
||
|
Encodes all child objects into the contents for this object.
|
||
|
|
||
|
This method is overridden because a Set needs to be encoded by
|
||
|
removing defaulted fields and then sorting the fields by tag.
|
||
|
|
||
|
:param force:
|
||
|
Ensure all contents are in DER format instead of possibly using
|
||
|
cached BER-encoded data
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
child_tag_encodings = []
|
||
|
for index, child in enumerate(self.children):
|
||
|
child_encoding = child.dump(force=force)
|
||
|
|
||
|
# Skip encoding defaulted children
|
||
|
name, spec, field_params = self._fields[index]
|
||
|
if 'default' in field_params:
|
||
|
if spec(**field_params).dump() == child_encoding:
|
||
|
continue
|
||
|
|
||
|
child_tag_encodings.append((child.tag, child_encoding))
|
||
|
child_tag_encodings.sort(key=lambda ct: ct[0])
|
||
|
|
||
|
self._contents = b''.join([ct[1] for ct in child_tag_encodings])
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
|
||
|
class SetOf(SequenceOf):
|
||
|
"""
|
||
|
Represents a set (unordered) of a single type of values from ASN.1 as a
|
||
|
Python object with a list-like interface
|
||
|
"""
|
||
|
|
||
|
tag = 17
|
||
|
|
||
|
def _set_contents(self, force=False):
|
||
|
"""
|
||
|
Encodes all child objects into the contents for this object.
|
||
|
|
||
|
This method is overridden because a SetOf needs to be encoded by
|
||
|
sorting the child encodings.
|
||
|
|
||
|
:param force:
|
||
|
Ensure all contents are in DER format instead of possibly using
|
||
|
cached BER-encoded data
|
||
|
"""
|
||
|
|
||
|
if self.children is None:
|
||
|
self._parse_children()
|
||
|
|
||
|
child_encodings = []
|
||
|
for child in self:
|
||
|
child_encodings.append(child.dump(force=force))
|
||
|
|
||
|
self._contents = b''.join(sorted(child_encodings))
|
||
|
self._header = None
|
||
|
if self._trailer != b'':
|
||
|
self._trailer = b''
|
||
|
|
||
|
|
||
|
class EmbeddedPdv(Sequence):
|
||
|
"""
|
||
|
A sequence structure
|
||
|
"""
|
||
|
|
||
|
tag = 11
|
||
|
|
||
|
|
||
|
class NumericString(AbstractString):
|
||
|
"""
|
||
|
Represents a numeric string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 18
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class PrintableString(AbstractString):
|
||
|
"""
|
||
|
Represents a printable string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 19
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class TeletexString(AbstractString):
|
||
|
"""
|
||
|
Represents a teletex string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 20
|
||
|
_encoding = 'teletex'
|
||
|
|
||
|
|
||
|
class VideotexString(OctetString):
|
||
|
"""
|
||
|
Represents a videotex string from ASN.1 as a Python byte string
|
||
|
"""
|
||
|
|
||
|
tag = 21
|
||
|
|
||
|
|
||
|
class IA5String(AbstractString):
|
||
|
"""
|
||
|
Represents an IA5 string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 22
|
||
|
_encoding = 'ascii'
|
||
|
|
||
|
|
||
|
class AbstractTime(AbstractString):
|
||
|
"""
|
||
|
Represents a time from ASN.1 as a Python datetime.datetime object
|
||
|
"""
|
||
|
|
||
|
@property
|
||
|
def _parsed_time(self):
|
||
|
"""
|
||
|
The parsed datetime string.
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
|
||
|
:return:
|
||
|
A dict with the parsed values
|
||
|
"""
|
||
|
|
||
|
string = str_cls(self)
|
||
|
|
||
|
m = self._TIMESTRING_RE.match(string)
|
||
|
if not m:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s to a %s
|
||
|
''',
|
||
|
string,
|
||
|
type_name(self),
|
||
|
))
|
||
|
|
||
|
groups = m.groupdict()
|
||
|
|
||
|
tz = None
|
||
|
if groups['zulu']:
|
||
|
tz = timezone.utc
|
||
|
elif groups['dsign']:
|
||
|
sign = 1 if groups['dsign'] == '+' else -1
|
||
|
tz = create_timezone(sign * timedelta(
|
||
|
hours=int(groups['dhour']),
|
||
|
minutes=int(groups['dminute'] or 0)
|
||
|
))
|
||
|
|
||
|
if groups['fraction']:
|
||
|
# Compute fraction in microseconds
|
||
|
fract = Fraction(
|
||
|
int(groups['fraction']),
|
||
|
10 ** len(groups['fraction'])
|
||
|
) * 1000000
|
||
|
|
||
|
if groups['minute'] is None:
|
||
|
fract *= 3600
|
||
|
elif groups['second'] is None:
|
||
|
fract *= 60
|
||
|
|
||
|
fract_usec = int(fract.limit_denominator(1))
|
||
|
|
||
|
else:
|
||
|
fract_usec = 0
|
||
|
|
||
|
return {
|
||
|
'year': int(groups['year']),
|
||
|
'month': int(groups['month']),
|
||
|
'day': int(groups['day']),
|
||
|
'hour': int(groups['hour']),
|
||
|
'minute': int(groups['minute'] or 0),
|
||
|
'second': int(groups['second'] or 0),
|
||
|
'tzinfo': tz,
|
||
|
'fraction': fract_usec,
|
||
|
}
|
||
|
|
||
|
@property
|
||
|
def native(self):
|
||
|
"""
|
||
|
The native Python datatype representation of this value
|
||
|
|
||
|
:return:
|
||
|
A datetime.datetime object, asn1crypto.util.extended_datetime object or
|
||
|
None. The datetime object is usually timezone aware. If it's naive, then
|
||
|
it's in the sender's local time; see X.680 sect. 42.3
|
||
|
"""
|
||
|
|
||
|
if self.contents is None:
|
||
|
return None
|
||
|
|
||
|
if self._native is None:
|
||
|
parsed = self._parsed_time
|
||
|
|
||
|
fraction = parsed.pop('fraction', 0)
|
||
|
|
||
|
value = self._get_datetime(parsed)
|
||
|
|
||
|
if fraction:
|
||
|
value += timedelta(microseconds=fraction)
|
||
|
|
||
|
self._native = value
|
||
|
|
||
|
return self._native
|
||
|
|
||
|
|
||
|
class UTCTime(AbstractTime):
|
||
|
"""
|
||
|
Represents a UTC time from ASN.1 as a timezone aware Python datetime.datetime object
|
||
|
"""
|
||
|
|
||
|
tag = 23
|
||
|
|
||
|
# Regular expression for UTCTime as described in X.680 sect. 43 and ISO 8601
|
||
|
_TIMESTRING_RE = re.compile(r'''
|
||
|
^
|
||
|
# YYMMDD
|
||
|
(?P<year>\d{2})
|
||
|
(?P<month>\d{2})
|
||
|
(?P<day>\d{2})
|
||
|
|
||
|
# hhmm or hhmmss
|
||
|
(?P<hour>\d{2})
|
||
|
(?P<minute>\d{2})
|
||
|
(?P<second>\d{2})?
|
||
|
|
||
|
# Matches nothing, needed because GeneralizedTime uses this.
|
||
|
(?P<fraction>)
|
||
|
|
||
|
# Z or [-+]hhmm
|
||
|
(?:
|
||
|
(?P<zulu>Z)
|
||
|
|
|
||
|
(?:
|
||
|
(?P<dsign>[-+])
|
||
|
(?P<dhour>\d{2})
|
||
|
(?P<dminute>\d{2})
|
||
|
)
|
||
|
)
|
||
|
$
|
||
|
''', re.X)
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A unicode string or a datetime.datetime object
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if isinstance(value, datetime):
|
||
|
if not value.tzinfo:
|
||
|
raise ValueError('Must be timezone aware')
|
||
|
|
||
|
# Convert value to UTC.
|
||
|
value = value.astimezone(utc_with_dst)
|
||
|
|
||
|
if not 1950 <= value.year <= 2049:
|
||
|
raise ValueError('Year of the UTCTime is not in range [1950, 2049], use GeneralizedTime instead')
|
||
|
|
||
|
value = value.strftime('%y%m%d%H%M%SZ')
|
||
|
if _PY2:
|
||
|
value = value.decode('ascii')
|
||
|
|
||
|
AbstractString.set(self, value)
|
||
|
# Set it to None and let the class take care of converting the next
|
||
|
# time that .native is called
|
||
|
self._native = None
|
||
|
|
||
|
def _get_datetime(self, parsed):
|
||
|
"""
|
||
|
Create a datetime object from the parsed time.
|
||
|
|
||
|
:return:
|
||
|
An aware datetime.datetime object
|
||
|
"""
|
||
|
|
||
|
# X.680 only specifies that UTCTime is not using a century.
|
||
|
# So "18" could as well mean 2118 or 1318.
|
||
|
# X.509 and CMS specify to use UTCTime for years earlier than 2050.
|
||
|
# Assume that UTCTime is only used for years [1950, 2049].
|
||
|
if parsed['year'] < 50:
|
||
|
parsed['year'] += 2000
|
||
|
else:
|
||
|
parsed['year'] += 1900
|
||
|
|
||
|
return datetime(**parsed)
|
||
|
|
||
|
|
||
|
class GeneralizedTime(AbstractTime):
|
||
|
"""
|
||
|
Represents a generalized time from ASN.1 as a Python datetime.datetime
|
||
|
object or asn1crypto.util.extended_datetime object in UTC
|
||
|
"""
|
||
|
|
||
|
tag = 24
|
||
|
|
||
|
# Regular expression for GeneralizedTime as described in X.680 sect. 42 and ISO 8601
|
||
|
_TIMESTRING_RE = re.compile(r'''
|
||
|
^
|
||
|
# YYYYMMDD
|
||
|
(?P<year>\d{4})
|
||
|
(?P<month>\d{2})
|
||
|
(?P<day>\d{2})
|
||
|
|
||
|
# hh or hhmm or hhmmss
|
||
|
(?P<hour>\d{2})
|
||
|
(?:
|
||
|
(?P<minute>\d{2})
|
||
|
(?P<second>\d{2})?
|
||
|
)?
|
||
|
|
||
|
# Optional fraction; [.,]dddd (one or more decimals)
|
||
|
# If Seconds are given, it's fractions of Seconds.
|
||
|
# Else if Minutes are given, it's fractions of Minutes.
|
||
|
# Else it's fractions of Hours.
|
||
|
(?:
|
||
|
[,.]
|
||
|
(?P<fraction>\d+)
|
||
|
)?
|
||
|
|
||
|
# Optional timezone. If left out, the time is in local time.
|
||
|
# Z or [-+]hh or [-+]hhmm
|
||
|
(?:
|
||
|
(?P<zulu>Z)
|
||
|
|
|
||
|
(?:
|
||
|
(?P<dsign>[-+])
|
||
|
(?P<dhour>\d{2})
|
||
|
(?P<dminute>\d{2})?
|
||
|
)
|
||
|
)?
|
||
|
$
|
||
|
''', re.X)
|
||
|
|
||
|
def set(self, value):
|
||
|
"""
|
||
|
Sets the value of the object
|
||
|
|
||
|
:param value:
|
||
|
A unicode string, a datetime.datetime object or an
|
||
|
asn1crypto.util.extended_datetime object
|
||
|
|
||
|
:raises:
|
||
|
ValueError - when an invalid value is passed
|
||
|
"""
|
||
|
|
||
|
if isinstance(value, (datetime, extended_datetime)):
|
||
|
if not value.tzinfo:
|
||
|
raise ValueError('Must be timezone aware')
|
||
|
|
||
|
# Convert value to UTC.
|
||
|
value = value.astimezone(utc_with_dst)
|
||
|
|
||
|
if value.microsecond:
|
||
|
fraction = '.' + str(value.microsecond).zfill(6).rstrip('0')
|
||
|
else:
|
||
|
fraction = ''
|
||
|
|
||
|
value = value.strftime('%Y%m%d%H%M%S') + fraction + 'Z'
|
||
|
if _PY2:
|
||
|
value = value.decode('ascii')
|
||
|
|
||
|
AbstractString.set(self, value)
|
||
|
# Set it to None and let the class take care of converting the next
|
||
|
# time that .native is called
|
||
|
self._native = None
|
||
|
|
||
|
def _get_datetime(self, parsed):
|
||
|
"""
|
||
|
Create a datetime object from the parsed time.
|
||
|
|
||
|
:return:
|
||
|
A datetime.datetime object or asn1crypto.util.extended_datetime object.
|
||
|
It may or may not be aware.
|
||
|
"""
|
||
|
|
||
|
if parsed['year'] == 0:
|
||
|
# datetime does not support year 0. Use extended_datetime instead.
|
||
|
return extended_datetime(**parsed)
|
||
|
else:
|
||
|
return datetime(**parsed)
|
||
|
|
||
|
|
||
|
class GraphicString(AbstractString):
|
||
|
"""
|
||
|
Represents a graphic string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 25
|
||
|
# This is technically not correct since this type can contain any charset
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class VisibleString(AbstractString):
|
||
|
"""
|
||
|
Represents a visible string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 26
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class GeneralString(AbstractString):
|
||
|
"""
|
||
|
Represents a general string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 27
|
||
|
# This is technically not correct since this type can contain any charset
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class UniversalString(AbstractString):
|
||
|
"""
|
||
|
Represents a universal string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 28
|
||
|
_encoding = 'utf-32-be'
|
||
|
|
||
|
|
||
|
class CharacterString(AbstractString):
|
||
|
"""
|
||
|
Represents a character string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 29
|
||
|
# This is technically not correct since this type can contain any charset
|
||
|
_encoding = 'latin1'
|
||
|
|
||
|
|
||
|
class BMPString(AbstractString):
|
||
|
"""
|
||
|
Represents a BMP string from ASN.1 as a Python unicode string
|
||
|
"""
|
||
|
|
||
|
tag = 30
|
||
|
_encoding = 'utf-16-be'
|
||
|
|
||
|
|
||
|
def _basic_debug(prefix, self):
|
||
|
"""
|
||
|
Prints out basic information about an Asn1Value object. Extracted for reuse
|
||
|
among different classes that customize the debug information.
|
||
|
|
||
|
:param prefix:
|
||
|
A unicode string of spaces to prefix output line with
|
||
|
|
||
|
:param self:
|
||
|
The object to print the debugging information about
|
||
|
"""
|
||
|
|
||
|
print('%s%s Object #%s' % (prefix, type_name(self), id(self)))
|
||
|
if self._header:
|
||
|
print('%s Header: 0x%s' % (prefix, binascii.hexlify(self._header or b'').decode('utf-8')))
|
||
|
|
||
|
has_header = self.method is not None and self.class_ is not None and self.tag is not None
|
||
|
if has_header:
|
||
|
method_name = METHOD_NUM_TO_NAME_MAP.get(self.method)
|
||
|
class_name = CLASS_NUM_TO_NAME_MAP.get(self.class_)
|
||
|
|
||
|
if self.explicit is not None:
|
||
|
for class_, tag in self.explicit:
|
||
|
print(
|
||
|
'%s %s tag %s (explicitly tagged)' %
|
||
|
(
|
||
|
prefix,
|
||
|
CLASS_NUM_TO_NAME_MAP.get(class_),
|
||
|
tag
|
||
|
)
|
||
|
)
|
||
|
if has_header:
|
||
|
print('%s %s %s %s' % (prefix, method_name, class_name, self.tag))
|
||
|
|
||
|
elif self.implicit:
|
||
|
if has_header:
|
||
|
print('%s %s %s tag %s (implicitly tagged)' % (prefix, method_name, class_name, self.tag))
|
||
|
|
||
|
elif has_header:
|
||
|
print('%s %s %s tag %s' % (prefix, method_name, class_name, self.tag))
|
||
|
|
||
|
if self._trailer:
|
||
|
print('%s Trailer: 0x%s' % (prefix, binascii.hexlify(self._trailer or b'').decode('utf-8')))
|
||
|
|
||
|
print('%s Data: 0x%s' % (prefix, binascii.hexlify(self.contents or b'').decode('utf-8')))
|
||
|
|
||
|
|
||
|
def _tag_type_to_explicit_implicit(params):
|
||
|
"""
|
||
|
Converts old-style "tag_type" and "tag" params to "explicit" and "implicit"
|
||
|
|
||
|
:param params:
|
||
|
A dict of parameters to convert from tag_type/tag to explicit/implicit
|
||
|
"""
|
||
|
|
||
|
if 'tag_type' in params:
|
||
|
if params['tag_type'] == 'explicit':
|
||
|
params['explicit'] = (params.get('class', 2), params['tag'])
|
||
|
elif params['tag_type'] == 'implicit':
|
||
|
params['implicit'] = (params.get('class', 2), params['tag'])
|
||
|
del params['tag_type']
|
||
|
del params['tag']
|
||
|
if 'class' in params:
|
||
|
del params['class']
|
||
|
|
||
|
|
||
|
def _fix_tagging(value, params):
|
||
|
"""
|
||
|
Checks if a value is properly tagged based on the spec, and re/untags as
|
||
|
necessary
|
||
|
|
||
|
:param value:
|
||
|
An Asn1Value object
|
||
|
|
||
|
:param params:
|
||
|
A dict of spec params
|
||
|
|
||
|
:return:
|
||
|
An Asn1Value that is properly tagged
|
||
|
"""
|
||
|
|
||
|
_tag_type_to_explicit_implicit(params)
|
||
|
|
||
|
retag = False
|
||
|
if 'implicit' not in params:
|
||
|
if value.implicit is not False:
|
||
|
retag = True
|
||
|
else:
|
||
|
if isinstance(params['implicit'], tuple):
|
||
|
class_, tag = params['implicit']
|
||
|
else:
|
||
|
tag = params['implicit']
|
||
|
class_ = 'context'
|
||
|
if value.implicit is False:
|
||
|
retag = True
|
||
|
elif value.class_ != CLASS_NAME_TO_NUM_MAP[class_] or value.tag != tag:
|
||
|
retag = True
|
||
|
|
||
|
if params.get('explicit') != value.explicit:
|
||
|
retag = True
|
||
|
|
||
|
if retag:
|
||
|
return value.retag(params)
|
||
|
return value
|
||
|
|
||
|
|
||
|
def _build_id_tuple(params, spec):
|
||
|
"""
|
||
|
Builds a 2-element tuple used to identify fields by grabbing the class_
|
||
|
and tag from an Asn1Value class and the params dict being passed to it
|
||
|
|
||
|
:param params:
|
||
|
A dict of params to pass to spec
|
||
|
|
||
|
:param spec:
|
||
|
An Asn1Value class
|
||
|
|
||
|
:return:
|
||
|
A 2-element integer tuple in the form (class_, tag)
|
||
|
"""
|
||
|
|
||
|
# Handle situations where the spec is not known at setup time
|
||
|
if spec is None:
|
||
|
return (None, None)
|
||
|
|
||
|
required_class = spec.class_
|
||
|
required_tag = spec.tag
|
||
|
|
||
|
_tag_type_to_explicit_implicit(params)
|
||
|
|
||
|
if 'explicit' in params:
|
||
|
if isinstance(params['explicit'], tuple):
|
||
|
required_class, required_tag = params['explicit']
|
||
|
else:
|
||
|
required_class = 2
|
||
|
required_tag = params['explicit']
|
||
|
elif 'implicit' in params:
|
||
|
if isinstance(params['implicit'], tuple):
|
||
|
required_class, required_tag = params['implicit']
|
||
|
else:
|
||
|
required_class = 2
|
||
|
required_tag = params['implicit']
|
||
|
if required_class is not None and not isinstance(required_class, int_types):
|
||
|
required_class = CLASS_NAME_TO_NUM_MAP[required_class]
|
||
|
|
||
|
required_class = params.get('class_', required_class)
|
||
|
required_tag = params.get('tag', required_tag)
|
||
|
|
||
|
return (required_class, required_tag)
|
||
|
|
||
|
|
||
|
def _int_to_bit_tuple(value, bits):
|
||
|
"""
|
||
|
Format value as a tuple of 1s and 0s.
|
||
|
|
||
|
:param value:
|
||
|
A non-negative integer to format
|
||
|
|
||
|
:param bits:
|
||
|
Number of bits in the output
|
||
|
|
||
|
:return:
|
||
|
A tuple of 1s and 0s with bits members.
|
||
|
"""
|
||
|
|
||
|
if not value and not bits:
|
||
|
return ()
|
||
|
|
||
|
result = tuple(map(int, format(value, '0{0}b'.format(bits))))
|
||
|
if len(result) != bits:
|
||
|
raise ValueError('Result too large: {0} > {1}'.format(len(result), bits))
|
||
|
|
||
|
return result
|
||
|
|
||
|
|
||
|
_UNIVERSAL_SPECS = {
|
||
|
1: Boolean,
|
||
|
2: Integer,
|
||
|
3: BitString,
|
||
|
4: OctetString,
|
||
|
5: Null,
|
||
|
6: ObjectIdentifier,
|
||
|
7: ObjectDescriptor,
|
||
|
8: InstanceOf,
|
||
|
9: Real,
|
||
|
10: Enumerated,
|
||
|
11: EmbeddedPdv,
|
||
|
12: UTF8String,
|
||
|
13: RelativeOid,
|
||
|
16: Sequence,
|
||
|
17: Set,
|
||
|
18: NumericString,
|
||
|
19: PrintableString,
|
||
|
20: TeletexString,
|
||
|
21: VideotexString,
|
||
|
22: IA5String,
|
||
|
23: UTCTime,
|
||
|
24: GeneralizedTime,
|
||
|
25: GraphicString,
|
||
|
26: VisibleString,
|
||
|
27: GeneralString,
|
||
|
28: UniversalString,
|
||
|
29: CharacterString,
|
||
|
30: BMPString
|
||
|
}
|
||
|
|
||
|
|
||
|
def _build(class_, method, tag, header, contents, trailer, spec=None, spec_params=None, nested_spec=None):
|
||
|
"""
|
||
|
Builds an Asn1Value object generically, or using a spec with optional params
|
||
|
|
||
|
:param class_:
|
||
|
An integer representing the ASN.1 class
|
||
|
|
||
|
:param method:
|
||
|
An integer representing the ASN.1 method
|
||
|
|
||
|
:param tag:
|
||
|
An integer representing the ASN.1 tag
|
||
|
|
||
|
:param header:
|
||
|
A byte string of the ASN.1 header (class, method, tag, length)
|
||
|
|
||
|
:param contents:
|
||
|
A byte string of the ASN.1 value
|
||
|
|
||
|
:param trailer:
|
||
|
A byte string of any ASN.1 trailer (only used by indefinite length encodings)
|
||
|
|
||
|
:param spec:
|
||
|
A class derived from Asn1Value that defines what class_ and tag the
|
||
|
value should have, and the semantics of the encoded value. The
|
||
|
return value will be of this type. If omitted, the encoded value
|
||
|
will be decoded using the standard universal tag based on the
|
||
|
encoded tag number.
|
||
|
|
||
|
:param spec_params:
|
||
|
A dict of params to pass to the spec object
|
||
|
|
||
|
:param nested_spec:
|
||
|
For certain Asn1Value classes (such as OctetString and BitString), the
|
||
|
contents can be further parsed and interpreted as another Asn1Value.
|
||
|
This parameter controls the spec for that sub-parsing.
|
||
|
|
||
|
:return:
|
||
|
An object of the type spec, or if not specified, a child of Asn1Value
|
||
|
"""
|
||
|
|
||
|
if spec_params is not None:
|
||
|
_tag_type_to_explicit_implicit(spec_params)
|
||
|
|
||
|
if header is None:
|
||
|
return VOID
|
||
|
|
||
|
header_set = False
|
||
|
|
||
|
# If an explicit specification was passed in, make sure it matches
|
||
|
if spec is not None:
|
||
|
# If there is explicit tagging and contents, we have to split
|
||
|
# the header and trailer off before we do the parsing
|
||
|
no_explicit = spec_params and 'no_explicit' in spec_params
|
||
|
if not no_explicit and (spec.explicit or (spec_params and 'explicit' in spec_params)):
|
||
|
if spec_params:
|
||
|
value = spec(**spec_params)
|
||
|
else:
|
||
|
value = spec()
|
||
|
original_explicit = value.explicit
|
||
|
explicit_info = reversed(original_explicit)
|
||
|
parsed_class = class_
|
||
|
parsed_method = method
|
||
|
parsed_tag = tag
|
||
|
to_parse = contents
|
||
|
explicit_header = header
|
||
|
explicit_trailer = trailer or b''
|
||
|
for expected_class, expected_tag in explicit_info:
|
||
|
if parsed_class != expected_class:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - explicitly-tagged class should have been
|
||
|
%s, but %s was found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
CLASS_NUM_TO_NAME_MAP.get(expected_class),
|
||
|
CLASS_NUM_TO_NAME_MAP.get(parsed_class, parsed_class)
|
||
|
))
|
||
|
if parsed_method != 1:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - explicitly-tagged method should have
|
||
|
been %s, but %s was found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(1),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(parsed_method, parsed_method)
|
||
|
))
|
||
|
if parsed_tag != expected_tag:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - explicitly-tagged tag should have been
|
||
|
%s, but %s was found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
expected_tag,
|
||
|
parsed_tag
|
||
|
))
|
||
|
info, _ = _parse(to_parse, len(to_parse))
|
||
|
parsed_class, parsed_method, parsed_tag, parsed_header, to_parse, parsed_trailer = info
|
||
|
|
||
|
if not isinstance(value, Choice):
|
||
|
explicit_header += parsed_header
|
||
|
explicit_trailer = parsed_trailer + explicit_trailer
|
||
|
|
||
|
value = _build(*info, spec=spec, spec_params={'no_explicit': True})
|
||
|
value._header = explicit_header
|
||
|
value._trailer = explicit_trailer
|
||
|
value.explicit = original_explicit
|
||
|
header_set = True
|
||
|
else:
|
||
|
if spec_params:
|
||
|
value = spec(contents=contents, **spec_params)
|
||
|
else:
|
||
|
value = spec(contents=contents)
|
||
|
|
||
|
if spec is Any:
|
||
|
pass
|
||
|
|
||
|
elif isinstance(value, Choice):
|
||
|
value.validate(class_, tag, contents)
|
||
|
try:
|
||
|
# Force parsing the Choice now
|
||
|
value.contents = header + value.contents
|
||
|
header = b''
|
||
|
value.parse()
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(value),) + args
|
||
|
raise e
|
||
|
|
||
|
else:
|
||
|
if class_ != value.class_:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - class should have been %s, but %s was
|
||
|
found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
CLASS_NUM_TO_NAME_MAP.get(value.class_),
|
||
|
CLASS_NUM_TO_NAME_MAP.get(class_, class_)
|
||
|
))
|
||
|
if method != value.method:
|
||
|
# Allow parsing a primitive method as constructed if the value
|
||
|
# is indefinite length. This is to allow parsing BER.
|
||
|
ber_indef = method == 1 and value.method == 0 and trailer == b'\x00\x00'
|
||
|
if not ber_indef or not isinstance(value, Constructable):
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - method should have been %s, but %s was found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(value.method),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(method, method)
|
||
|
))
|
||
|
else:
|
||
|
value.method = method
|
||
|
value._indefinite = True
|
||
|
if tag != value.tag:
|
||
|
if isinstance(value._bad_tag, tuple):
|
||
|
is_bad_tag = tag in value._bad_tag
|
||
|
else:
|
||
|
is_bad_tag = tag == value._bad_tag
|
||
|
if not is_bad_tag:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Error parsing %s - tag should have been %s, but %s was found
|
||
|
''',
|
||
|
type_name(value),
|
||
|
value.tag,
|
||
|
tag
|
||
|
))
|
||
|
|
||
|
# For explicitly tagged, un-speced parsings, we use a generic container
|
||
|
# since we will be parsing the contents and discarding the outer object
|
||
|
# anyway a little further on
|
||
|
elif spec_params and 'explicit' in spec_params:
|
||
|
original_value = Asn1Value(contents=contents, **spec_params)
|
||
|
original_explicit = original_value.explicit
|
||
|
|
||
|
to_parse = contents
|
||
|
explicit_header = header
|
||
|
explicit_trailer = trailer or b''
|
||
|
for expected_class, expected_tag in reversed(original_explicit):
|
||
|
info, _ = _parse(to_parse, len(to_parse))
|
||
|
_, _, _, parsed_header, to_parse, parsed_trailer = info
|
||
|
explicit_header += parsed_header
|
||
|
explicit_trailer = parsed_trailer + explicit_trailer
|
||
|
value = _build(*info, spec=spec, spec_params={'no_explicit': True})
|
||
|
value._header = header + value._header
|
||
|
value._trailer += trailer or b''
|
||
|
value.explicit = original_explicit
|
||
|
header_set = True
|
||
|
|
||
|
# If no spec was specified, allow anything and just process what
|
||
|
# is in the input data
|
||
|
else:
|
||
|
if tag not in _UNIVERSAL_SPECS:
|
||
|
raise ValueError(unwrap(
|
||
|
'''
|
||
|
Unknown element - %s class, %s method, tag %s
|
||
|
''',
|
||
|
CLASS_NUM_TO_NAME_MAP.get(class_),
|
||
|
METHOD_NUM_TO_NAME_MAP.get(method),
|
||
|
tag
|
||
|
))
|
||
|
|
||
|
spec = _UNIVERSAL_SPECS[tag]
|
||
|
|
||
|
value = spec(contents=contents, class_=class_)
|
||
|
ber_indef = method == 1 and value.method == 0 and trailer == b'\x00\x00'
|
||
|
if ber_indef and isinstance(value, Constructable):
|
||
|
value._indefinite = True
|
||
|
value.method = method
|
||
|
|
||
|
if not header_set:
|
||
|
value._header = header
|
||
|
value._trailer = trailer or b''
|
||
|
|
||
|
# Destroy any default value that our contents have overwritten
|
||
|
value._native = None
|
||
|
|
||
|
if nested_spec:
|
||
|
try:
|
||
|
value.parse(nested_spec)
|
||
|
except (ValueError, TypeError) as e:
|
||
|
args = e.args[1:]
|
||
|
e.args = (e.args[0] + '\n while parsing %s' % type_name(value),) + args
|
||
|
raise e
|
||
|
|
||
|
return value
|
||
|
|
||
|
|
||
|
def _parse_build(encoded_data, pointer=0, spec=None, spec_params=None, strict=False):
|
||
|
"""
|
||
|
Parses a byte string generically, or using a spec with optional params
|
||
|
|
||
|
:param encoded_data:
|
||
|
A byte string that contains BER-encoded data
|
||
|
|
||
|
:param pointer:
|
||
|
The index in the byte string to parse from
|
||
|
|
||
|
:param spec:
|
||
|
A class derived from Asn1Value that defines what class_ and tag the
|
||
|
value should have, and the semantics of the encoded value. The
|
||
|
return value will be of this type. If omitted, the encoded value
|
||
|
will be decoded using the standard universal tag based on the
|
||
|
encoded tag number.
|
||
|
|
||
|
:param spec_params:
|
||
|
A dict of params to pass to the spec object
|
||
|
|
||
|
:param strict:
|
||
|
A boolean indicating if trailing data should be forbidden - if so, a
|
||
|
ValueError will be raised when trailing data exists
|
||
|
|
||
|
:return:
|
||
|
A 2-element tuple:
|
||
|
- 0: An object of the type spec, or if not specified, a child of Asn1Value
|
||
|
- 1: An integer indicating how many bytes were consumed
|
||
|
"""
|
||
|
|
||
|
encoded_len = len(encoded_data)
|
||
|
info, new_pointer = _parse(encoded_data, encoded_len, pointer)
|
||
|
if strict and new_pointer != pointer + encoded_len:
|
||
|
extra_bytes = pointer + encoded_len - new_pointer
|
||
|
raise ValueError('Extra data - %d bytes of trailing data were provided' % extra_bytes)
|
||
|
return (_build(*info, spec=spec, spec_params=spec_params), new_pointer)
|