Documentation changes.

Author: rohe

doc/source/jwk.rst

@@ -36,14 +36,6 @@ cryptojwt\.jwk\.jwk module
     :undoc-members:
     :show-inheritance:
 
-cryptojwt\.jwk\.jwks module
----------------------------
-
-.. automodule:: cryptojwt.jwk.jwks
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 cryptojwt\.jwk\.rsa module
 --------------------------
 

src/cryptojwt/jwe/jwe.py

@@ -63,6 +63,7 @@ class JWE(JWx):
 
     def encrypt(self, keys=None, cek="", iv="", **kwargs):
         """
+        Encrypt a payload
 
         :param keys: A set of possibly usable keys
         :param cek: Content master key

src/cryptojwt/jwe/jwe_ec.py

@@ -180,13 +180,14 @@ def dec_setup(self, token, key=None, **kwargs):
 
     def encrypt(self, key=None, iv="", cek="", **kwargs):
         """
+        Produces a JWE as defined in RFC7516 using an Elliptic curve key
 
         :param key: *Not used>, only there to present the same API as
             JWE_RSA and JWE_SYM
-        :param iv:
-        :param cek:
-        :param kwargs:
-        :return:
+        :param iv: Initialization vector
+        :param cek: Content master key
+        :param kwargs: Extra keyword arguments
+        :return: An encrypted JWT
         """
         _msg = as_bytes(self.msg)
 

src/cryptojwt/jwe/jwe_hmac.py

@@ -24,10 +24,11 @@ class JWE_SYM(JWEKey):
 
     def encrypt(self, key, iv="", cek="", **kwargs):
         """
+        Produces a JWE as defined in RFC7516 using symmetric keys
 
         :param key: Shared symmetric key
-        :param iv: initialization vector
-        :param cek:
+        :param iv: Initialization vector
+        :param cek: Content master key
         :param kwargs: Extra keyword arguments, just ignore for now.
         :return:
         """

src/cryptojwt/jwe/jwe_rsa.py

@@ -21,13 +21,13 @@ class JWE_RSA(JWEKey):
 
     def encrypt(self, key, iv="", cek="", **kwargs):
         """
-        Produces a JWE using RSA algorithms
+        Produces a JWE as defined in RFC7516 using RSA algorithms
 
         :param key: RSA key
-        :param context:
-        :param iv:
-        :param cek:
-        :return: A jwe
+        :param iv: Initialization vector
+        :param cek: Content master key
+        :param kwargs: Extra keyword arguments
+        :return: A signed payload
         """
 
         _msg = as_bytes(self.msg)

src/cryptojwt/jws/hmac.py

@@ -22,7 +22,8 @@ def __init__(self, algorithm='SHA256'):
 
     def sign(self, msg, key):
         """
-        Create a signature over a message
+        Create a signature over a message as defined in RFC7515 using a
+        symmetric key
 
         :param msg: The message
         :param key: The key

src/cryptojwt/jws/rsa.py

@@ -12,7 +12,9 @@ def __init__(self, algorithm='RS256'):
         (self.hash, self.padding) = parse_rsa_algorithm(algorithm)
 
     def sign(self, msg, key):
-        """Computes the signature for message.
+        """
+        Create a signature over a message as defined in RFC7515 using an
+        RSA key
 
         :param msg: the message.
         :type msg: bytes

src/cryptojwt/key_bundle.py

@@ -787,7 +787,7 @@ def key_diff(key_bundle, key_defs):
     :param key_bundle: The original KeyBundle
     :param key_defs: A set of key definitions
     :return: A dictionary with possible keys 'add' and 'del'. The values
-    for the keys are lists of :py:class:`cryptojwt.jwk.JWK` instances
+        for the keys are lists of :py:class:`cryptojwt.jwk.JWK` instances
     """
 
     keys = key_bundle.get()