diff --git a/tuf/formats.py b/tuf/formats.py index 9f8c6d2f..4640e73f 100755 --- a/tuf/formats.py +++ b/tuf/formats.py @@ -73,12 +73,10 @@ import binascii import calendar -import re import datetime import time import tuf -import tuf.formats import securesystemslib.formats import securesystemslib.schema as SCHEMA @@ -421,11 +419,11 @@ -def make_signable(object): +def make_signable(role_schema): """ - Return the role metadata 'object' in 'SIGNABLE_SCHEMA' format. - 'object' is added to the 'signed' key, and an empty list + Return the role metadata 'role_schema' in 'SIGNABLE_SCHEMA' format. + 'role_schema' is added to the 'signed' key, and an empty list initialized to the 'signatures' key. The caller adds signatures to this second field. Note: check_signable_object_format() should be called after @@ -434,7 +432,7 @@ def make_signable(object): a supported role metadata). - object: + role_schema: A role schema dict (e.g., 'ROOT_SCHEMA', 'SNAPSHOT_SCHEMA'). @@ -447,11 +445,11 @@ def make_signable(object): A dict in 'SIGNABLE_SCHEMA' format. """ - if not isinstance(object, dict) or 'signed' not in object: - return { 'signed' : object, 'signatures' : [] } + if not isinstance(role_schema, dict) or 'signed' not in role_schema: + return { 'signed' : role_schema, 'signatures' : [] } else: - return object + return role_schema @@ -500,14 +498,14 @@ def __init__(self, version, expires, filedict): @staticmethod - def from_metadata(object): - # Is 'object' a Timestamp metadata file? + def from_metadata(timestamp_metadata): + # Is 'timestamp_metadata' a Timestamp metadata file? # Raise securesystemslib.exceptions.FormatError if not. - TIMESTAMP_SCHEMA.check_match(object) + TIMESTAMP_SCHEMA.check_match(timestamp_metadata) - version = object['version'] - expires = object['expires'] - filedict = object['meta'] + version = timestamp_metadata['version'] + expires = timestamp_metadata['expires'] + filedict = timestamp_metadata['meta'] return TimestampFile(version, expires, filedict) @@ -538,16 +536,16 @@ def __init__(self, version, expires, keys, roles, consistent_snapshot): self.info['consistent_snapshot'] = consistent_snapshot @staticmethod - def from_metadata(object): - # Is 'object' a Root metadata file? + def from_metadata(root_metadata): + # Is 'root_metadata' a Root metadata file? # Raise 'securesystemslib.exceptions.FormatError' if not. - tuf.formats.ROOT_SCHEMA.check_match(object) + tuf.formats.ROOT_SCHEMA.check_match(root_metadata) - version = object['version'] - expires = object['expires'] - keys = object['keys'] - roles = object['roles'] - consistent_snapshot = object['consistent_snapshot'] + version = root_metadata['version'] + expires = root_metadata['expires'] + keys = root_metadata['keys'] + roles = root_metadata['roles'] + consistent_snapshot = root_metadata['consistent_snapshot'] return RootFile(version, expires, keys, roles, consistent_snapshot) @@ -580,14 +578,14 @@ def __init__(self, version, expires, versiondict): @staticmethod - def from_metadata(object): - # Is 'object' a Snapshot metadata file? + def from_metadata(snapshot_metadata): + # Is 'snapshot_metadata' a Snapshot metadata file? # Raise 'securesystemslib.exceptions.FormatError' if not. - SNAPSHOT_SCHEMA.check_match(object) + SNAPSHOT_SCHEMA.check_match(snapshot_metadata) - version = object['version'] - expires = object['expires'] - versiondict = object['meta'] + version = snapshot_metadata['version'] + expires = snapshot_metadata['expires'] + versiondict = snapshot_metadata['meta'] return SnapshotFile(version, expires, versiondict) @@ -623,15 +621,15 @@ def __init__(self, version, expires, filedict=None, delegations=None): @staticmethod - def from_metadata(object): - # Is 'object' a Targets metadata file? + def from_metadata(targets_metadata): + # Is 'targets_metadata' a Targets metadata file? # Raise securesystemslib.exceptions.FormatError if not. - tuf.formats.TARGETS_SCHEMA.check_match(object) + tuf.formats.TARGETS_SCHEMA.check_match(targets_metadata) - version = object['version'] - expires = object['expires'] - filedict = object.get('targets') - delegations = object.get('delegations') + version = targets_metadata['version'] + expires = targets_metadata['expires'] + filedict = targets_metadata.get('targets') + delegations = targets_metadata.get('delegations') return TargetsFile(version, expires, filedict, delegations) @@ -669,7 +667,7 @@ def __init__(self, version, expires): @staticmethod - def from_metadata(object): + def from_metadata(mirrors_metadata): raise NotImplementedError @@ -1095,10 +1093,10 @@ def expected_meta_rolename(meta_rolename): -def check_signable_object_format(object): +def check_signable_object_format(signable): """ - Ensure 'object' is properly formatted, conformant to + Ensure 'signable' is properly formatted, conformant to 'SIGNABLE_SCHEMA'. Return the signing role on success. Note: The 'signed' field of a 'SIGNABLE_SCHEMA' is checked against securesystemslib.schema.Any(). The 'signed' field, however, should @@ -1107,11 +1105,11 @@ def check_signable_object_format(object): function determines exactly which schema is listed in the 'signed' field. - object: - The object compare against 'SIGNABLE.SCHEMA'. + signable: + The signable object compared against 'SIGNABLE.SCHEMA'. - securesystemslib.exceptions.FormatError, if 'object' does not have the + securesystemslib.exceptions.FormatError, if 'signable' does not have the correct format. @@ -1122,16 +1120,16 @@ def check_signable_object_format(object): The role string is returned with characters all lower case. """ - # Does 'object' have the correct type? - # This check ensures 'object' conforms to + # Does 'signable' have the correct type? + # This check ensures 'signable' conforms to # 'SIGNABLE_SCHEMA'. - SIGNABLE_SCHEMA.check_match(object) + SIGNABLE_SCHEMA.check_match(signable) try: - role_type = object['signed']['_type'] + role_type = signable['signed']['_type'] except (KeyError, TypeError): - raise securesystemslib.exceptions.FormatError('Untyped object') + raise securesystemslib.exceptions.FormatError('Untyped signable object.') try: schema = SCHEMAS_BY_TYPE[role_type] @@ -1140,9 +1138,9 @@ def check_signable_object_format(object): raise securesystemslib.exceptions.FormatError('Unrecognized' ' type ' + repr(role_type)) - # 'securesystemslib.exceptions.FormatError' raised if 'object' does not have a - # properly formatted role schema. - schema.check_match(object['signed']) + # 'securesystemslib.exceptions.FormatError' raised if 'signable' does not + # have a properly formatted role schema. + schema.check_match(signable['signed']) return role_type.lower()