Clarify req argument for signing

[identitypython]

Clarify req argument for signing

[leifj]

On 10/23/2012 01:25 PM, Joachim Strömbergson wrote:

Aloha!

pyFF has a lot of good comments in the code that explains what the
function does. However, for the sign pipe (in builtins), the comment
is somewhat confusing:

"def sign(req,*opts):
"""
:param req: The request
:param opts: Options (unused)
:return: returns the signed working document

Sign the working document. The 'key' argument references either a
PKCS#11 uri or the filename containing a PEM-encoded non-password
protected private RSA key. The 'cert' argument may be empty in which
case the cert is looked up using the PKCS#11 token, or may point to a
file containing a PEM-encoded X.509 certificate."

What you might want to add is that req is a dictionary that is
expected to contain key:data pairs for key and cert. Just to make it
easier to understand.

—
Reply to this email directly or view it on GitHub
#1.

A very good point!

[leifj]

tried to clarify