def test_OneOf(self): # Test conditions for valid arguments. oneof_schema = SCHEMA.OneOf([ SCHEMA.ListOf(SCHEMA.Integer()), SCHEMA.String('Hello'), SCHEMA.String('bye') ]) self.assertTrue(oneof_schema.matches([])) self.assertTrue(oneof_schema.matches('bye')) self.assertTrue(oneof_schema.matches([1, 2])) # Test conditions for invalid arguments. self.assertFalse(oneof_schema.matches(3)) self.assertFalse(oneof_schema.matches(['Hi'])) # Test conditions for invalid arguments in a schema definition. self.assertRaises(securesystemslib.exceptions.FormatError, SCHEMA.OneOf, 1) self.assertRaises(securesystemslib.exceptions.FormatError, SCHEMA.OneOf, [1]) self.assertRaises(securesystemslib.exceptions.FormatError, SCHEMA.OneOf, {'a': 1}) self.assertRaises(securesystemslib.exceptions.FormatError, SCHEMA.OneOf, [SCHEMA.AnyString(), 1])
# A string representing a named object. NAME_SCHEMA = SCHEMA.AnyString() NAMES_SCHEMA = SCHEMA.ListOf(NAME_SCHEMA) # A byte string representing data. DATA_SCHEMA = SCHEMA.AnyBytes() # A text string. For instance, a string entered by the user. TEXT_SCHEMA = SCHEMA.AnyString() # Supported hash algorithms. HASHALGORITHMS_SCHEMA = SCHEMA.ListOf( SCHEMA.OneOf([ SCHEMA.String('md5'), SCHEMA.String('sha1'), SCHEMA.String('sha224'), SCHEMA.String('sha256'), SCHEMA.String('sha384'), SCHEMA.String('sha512') ])) # The contents of an encrypted key. Encrypted keys are saved to files # in this format. ENCRYPTEDKEY_SCHEMA = SCHEMA.AnyString() # A value that is either True or False, on or off, etc. BOOLEAN_SCHEMA = SCHEMA.Boolean() # The minimum number of bits for an RSA key. Must be 2048 bits, or greater # (recommended by TUF). Recommended RSA key sizes: # http://www.emc.com/emc-plus/rsa-labs/historical/twirl-and-rsa-key-size.htm#table1 RSAKEYBITS_SCHEMA = SCHEMA.Integer(lo=2048)
from securesystemslib import schema as SCHEMA import tuf from tuf import exceptions # As per TUF spec 1.0.0 the spec version field must follow the Semantic # Versioning 2.0.0 (semver) format. The regex pattern is provided by semver. # https://semver.org/spec/v2.0.0.html#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string SEMVER_2_0_0_SCHEMA = SCHEMA.RegularExpression( r'(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)' r'(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)' r'(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?' r'(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?') SPECIFICATION_VERSION_SCHEMA = SCHEMA.OneOf([ # However, temporarily allow "1.0" for backwards-compatibility in tuf-0.12.PATCH. SCHEMA.String("1.0"), SEMVER_2_0_0_SCHEMA ]) # A datetime in 'YYYY-MM-DDTHH:MM:SSZ' ISO 8601 format. The "Z" zone designator # for the zero UTC offset is always used (i.e., a numerical offset is not # supported.) Example: '2015-10-21T13:20:00Z'. Note: This is a simple format # check, and an ISO8601 string should be fully verified when it is parsed. ISO8601_DATETIME_SCHEMA = SCHEMA.RegularExpression( r'\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z') # An integer representing the numbered version of a metadata file. # Must be 1, or greater. METADATAVERSION_SCHEMA = SCHEMA.Integer(lo=0) # A relative file path (e.g., 'metadata/root/').
# Information about target files, like file length and file hash(es). This # schema allows the storage of multiple hashes for the same file (e.g., sha256 # and sha512 may be computed for the same file and stored). FILEINFO_SCHEMA = SCHEMA.Object( object_name='FILEINFO_SCHEMA', length=LENGTH_SCHEMA, hashes=HASHDICT_SCHEMA, version=SCHEMA.Optional(METADATAVERSION_SCHEMA), custom=SCHEMA.Optional(SCHEMA.Object())) # A dict holding the version or file information for a particular metadata # role. The dict keys hold the relative file paths, and the dict values the # corresponding version numbers and/or file information. FILEINFODICT_SCHEMA = SCHEMA.DictOf(key_schema=RELPATH_SCHEMA, value_schema=SCHEMA.OneOf( [VERSIONINFO_SCHEMA, FILEINFO_SCHEMA])) # A dict holding the information for a particular target / file. The dict keys # hold the relative file paths, and the dict values the corresponding file # information. FILEDICT_SCHEMA = SCHEMA.DictOf(key_schema=RELPATH_SCHEMA, value_schema=FILEINFO_SCHEMA) # A dict holding a target info. TARGETINFO_SCHEMA = SCHEMA.Object(object_name='TARGETINFO_SCHEMA', filepath=RELPATH_SCHEMA, fileinfo=FILEINFO_SCHEMA) # A list of TARGETINFO_SCHEMA. TARGETINFOS_SCHEMA = SCHEMA.ListOf(TARGETINFO_SCHEMA)
in_toto.gpg.formats.<SCHEMA>.check_match(<object to verify>) in_toto.gpg.formats.<SCHEMA>.matches(<object to verify>) `check_match` raises a securesystemslib.exceptions.FormatError and `matches` returns False if the verified object does not match the schema (True otherwise). """ import in_toto.gpg.formats as gpg_formats import securesystemslib.schema as ssl_schema import securesystemslib.formats as ssl_formats # Note: Verification keys can have private portions but in case of GPG we # only have a PUBKEY_SCHEMA (because we never export private gpg keys from # the gpg keyring) ANY_VERIFICATION_KEY_SCHEMA = ssl_schema.OneOf( [ssl_formats.ANYKEY_SCHEMA, gpg_formats.PUBKEY_SCHEMA]) ANY_VERIFICATION_KEY_DICT_SCHEMA = ssl_schema.DictOf( key_schema=ssl_formats.KEYID_SCHEMA, value_schema=ANY_VERIFICATION_KEY_SCHEMA) ANY_PUBKEY_SCHEMA = ssl_schema.OneOf( [ssl_formats.PUBLIC_KEY_SCHEMA, gpg_formats.PUBKEY_SCHEMA]) ANY_PUBKEY_DICT_SCHEMA = ssl_schema.DictOf(key_schema=ssl_formats.KEYID_SCHEMA, value_schema=ANY_PUBKEY_SCHEMA) ANY_SIGNATURE_SCHEMA = ssl_schema.OneOf( [ssl_formats.SIGNATURE_SCHEMA, gpg_formats.SIGNATURE_SCHEMA]) ANY_STRING_SCHEMA = ssl_schema.AnyString()
LOGLEVEL_SCHEMA = SCHEMA.Integer(lo=0, hi=50) # A string representing a named object. NAME_SCHEMA = SCHEMA.AnyString() NAMES_SCHEMA = SCHEMA.ListOf(NAME_SCHEMA) # A byte string representing data. DATA_SCHEMA = SCHEMA.AnyBytes() # A text string. For instance, a string entered by the user. TEXT_SCHEMA = SCHEMA.AnyString() # Supported hash algorithms. HASHALGORITHMS_SCHEMA = SCHEMA.ListOf(SCHEMA.OneOf( [SCHEMA.String('md5'), SCHEMA.String('sha1'), SCHEMA.String('sha224'), SCHEMA.String('sha256'), SCHEMA.String('sha384'), SCHEMA.String('sha512'), SCHEMA.String('blake2s'), SCHEMA.String('blake2b'), SCHEMA.String('blake2b-256')])) # The contents of an encrypted key. Encrypted keys are saved to files # in this format. ENCRYPTEDKEY_SCHEMA = SCHEMA.AnyString() # A value that is either True or False, on or off, etc. BOOLEAN_SCHEMA = SCHEMA.Boolean() # The minimum number of bits for an RSA key. Must be 2048 bits, or greater # (recommended by TUF). Recommended RSA key sizes: # http://www.emc.com/emc-plus/rsa-labs/historical/twirl-and-rsa-key-size.htm#table1 RSAKEYBITS_SCHEMA = SCHEMA.Integer(lo=2048)
# A string representing a named object. NAME_SCHEMA = SCHEMA.AnyString() NAMES_SCHEMA = SCHEMA.ListOf(NAME_SCHEMA) # A byte string representing data. DATA_SCHEMA = SCHEMA.AnyBytes() # A text string. For instance, a string entered by the user. TEXT_SCHEMA = SCHEMA.AnyString() # Supported hash algorithms. HASHALGORITHMS_SCHEMA = SCHEMA.ListOf( SCHEMA.OneOf([ SCHEMA.String('md5'), SCHEMA.String('sha1'), SCHEMA.String('sha224'), SCHEMA.String('sha256'), SCHEMA.String('sha384'), SCHEMA.String('sha512') ])) # The contents of an encrypted TUF key. Encrypted TUF keys are saved to files # in this format. ENCRYPTEDKEY_SCHEMA = SCHEMA.AnyString() # A value that is either True or False, on or off, etc. BOOLEAN_SCHEMA = SCHEMA.Boolean() # A role's threshold value (i.e., the minimum number # of signatures required to sign a metadata file). # Must be 1 and greater. THRESHOLD_SCHEMA = SCHEMA.Integer(lo=1)
# We have to define DSA_PUBKEY_SCHEMA in two steps, because it is # self-referential. Here we define a shallow _DSA_PUBKEY_SCHEMA, which we use # below to create the self-referential DSA_PUBKEY_SCHEMA. _DSA_PUBKEY_SCHEMA = ssl_schema.Object( object_name = "DSA_PUBKEY_SCHEMA", type = ssl_schema.String("dsa"), method = ssl_schema.String(PGP_DSA_PUBKEY_METHOD_STRING), hashes = ssl_schema.ListOf(ssl_schema.String(GPG_HASH_ALGORITHM_STRING)), keyid = ssl_formats.KEYID_SCHEMA, keyval = ssl_schema.Object( public = DSA_PUBKEYVAL_SCHEMA, private = ssl_schema.String("") ) ) DSA_PUBKEY_SCHEMA = _create_pubkey_with_subkey_schema( _DSA_PUBKEY_SCHEMA) PUBKEY_SCHEMA = ssl_schema.OneOf([RSA_PUBKEY_SCHEMA, DSA_PUBKEY_SCHEMA]) SIGNATURE_SCHEMA = ssl_schema.Object( object_name = "SIGNATURE_SCHEMA", keyid = ssl_formats.KEYID_SCHEMA, short_keyid = ssl_schema.Optional(ssl_formats.KEYID_SCHEMA), other_headers = ssl_formats.HEX_SCHEMA, signature = ssl_formats.HEX_SCHEMA )