From b4993302a5d91cbcebc0aaef7224deab052b2cc4 Mon Sep 17 00:00:00 2001 From: vladdd Date: Sun, 10 Feb 2013 13:22:53 -0500 Subject: [PATCH] Comment added to both 'keydb.py' and 'roledb.py'. --- src/tuf/keydb.py | 4 ++-- src/tuf/roledb.py | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/tuf/keydb.py b/src/tuf/keydb.py index a1c79674..e2ee142d 100755 --- a/src/tuf/keydb.py +++ b/src/tuf/keydb.py @@ -16,13 +16,13 @@ the layout of the collection remain consistent and easily verifiable. Provided are functions to add and delete keys from the database, retrieve a single key, and assemble a collection from keys stored in TUF 'Root' Metadata - files. + files. The Update Framework process maintains a single keydb. RSA keys are currently supported and a collection of keys is organized as a dictionary indexed by key ID. Key IDs are used as identifiers for keys (e.g., RSA key). They are the hexadecimal representations of the hash of key objects (specifically, the key object containing only the public key). See 'rsa_key.py' - and the '_get_keyid()' function to see precisely how keyids are generated. + and the '_get_keyid()' function to learn precisely how keyids are generated. One may get the keyid of a key object by simply accessing the dictionary's 'keyid' key (i.e., rsakey['keyid']). diff --git a/src/tuf/roledb.py b/src/tuf/roledb.py index f8032f4e..3ea382e7 100755 --- a/src/tuf/roledb.py +++ b/src/tuf/roledb.py @@ -18,7 +18,8 @@ 'add_role()'. There are many supplemental functions included here that yield useful information about the roles contained in the database, such as extracting all the parent rolenames for a specified rolename, deleting all the - delegated roles, retrieving role paths, etc. + delegated roles, retrieving role paths, etc. The Update Framework process + maintains a single roledb. The role database is a dictionary conformant to 'tuf.formats.ROLEDICT_SCHEMA' and has the form: