Updated documentation

Author: rohe

src/oidcmsg/jwt.py

@@ -16,9 +16,23 @@ def __init__(self, keyjar, iss='', lifetime=0, sign=True, sign_alg='RS256',
         self.keyjar = keyjar
 
     def receiver_keys(self, receiver):
+        """
+        Get all the keys I have for a specific entity
+
+        :param receiver: The entity ID
+        :return: A list of keys
+        """
         return self.keyjar.get_issuer_keys(receiver)
 
     def receivers_keys(self):
+        """
+        Reorganize all the keys in the key jar into a dictionary disregarding
+        keybundle dependencies. The keys of the dictionary are the isseur IDs
+        and the values are all the keys that are connected to a specific
+        issuer.
+
+        :return: A dictionary
+        """
         res = {}
         for owner in self.keyjar.owners():
             if owner == '':
@@ -28,5 +42,11 @@ def receivers_keys(self):
         return res
 
     def my_keys(self, id=''):
+        """
+        My default issuer/entity ID in the key jar is ''
+
+        :param id: An entity ID
+        :return: A list of keys
+        """
         return self.keyjar.get_issuer_keys(id)
 

src/oidcmsg/key_bundle.py

@@ -391,7 +391,8 @@ def _uptodate(self):
     def update(self):
         """
         Reload the keys if necessary
-        This is a forced update, will happen even if cache time has not elapsed
+        This is a forced update, will happen even if cache time has not elapsed.
+
         Replaced keys will be marked as inactive and not removed.        
         """
         res = True  # An update was successful
@@ -466,7 +467,7 @@ def active_keys(self):
 
     def remove_keys_by_type(self, typ):
         """
-        Remove keys that are of a specific kind or kind and value.
+        Remove keys that are of a specific type.
         
         :param typ: Type of key (rsa, ec, oct, ..)
         """
@@ -481,7 +482,7 @@ def jwks(self, private=False):
         Create a JWKS
         
         :param private: Whether private key information should be included.
-        :return: A JWKS representation of the keys in this bundle 
+        :return: A JWKS JSON representation of the keys in this bundle
         """
         self._uptodate()
         keys = list()
@@ -524,7 +525,7 @@ def __len__(self):
 
     def get_key_with_kid(self, kid):
         """
-        Return the key that as specific key ID (kid)
+        Return the key that has a specific key ID (kid)
         
         :param kid: The Key ID 
         :return: The key or None
@@ -544,8 +545,9 @@ def get_key_with_kid(self, kid):
 
     def kids(self):
         """
-        Return a list of key IDs. Note that list list may be shorter then
-        the list of keys.
+        Return a list of key IDs. Note that this list may be shorter then
+        the list of keys. The reason might be that there are some keys with
+        no key ID.
         
         :return: A list of all the key IDs that exists in this bundle 
         """
@@ -595,6 +597,11 @@ def __contains__(self, key):
         return key in self._keys
 
     def copy(self):
+        """
+        Make deep copy of this KeyBundle
+
+        :return: The copy
+        """
         kb = KeyBundle()
         kb._keys = self._keys[:]