diff options
| author | Simo Sorce <simo@redhat.com> | 2015-03-24 09:51:55 -0400 |
|---|---|---|
| committer | Simo Sorce <simo@redhat.com> | 2015-03-24 09:51:55 -0400 |
| commit | 876fdab2f664822952350d00cab48bef9827a5bf (patch) | |
| tree | a67a16f0fa3cefdea441694a420b1e05be4c1cbd | |
| parent | 4b458940168a8e16ff8c3c3aa099dee117c12de1 (diff) | |
| download | jwcrypto-876fdab2f664822952350d00cab48bef9827a5bf.tar.gz jwcrypto-876fdab2f664822952350d00cab48bef9827a5bf.tar.xz jwcrypto-876fdab2f664822952350d00cab48bef9827a5bf.zip | |
Add comments to push user to use JWS()
People should not use JWSCore directly unless they know exactly what
they are doing. Added doc text to that regard.
| -rw-r--r-- | jwcrypto/jws.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/jwcrypto/jws.py b/jwcrypto/jws.py index e2e97c0..2ed4698 100644 --- a/jwcrypto/jws.py +++ b/jwcrypto/jws.py @@ -159,9 +159,12 @@ class _raw_none(_raw_jws): class JWSCore(object): def __init__(self, alg, key, header, payload): - """ Generates or verifies JWS tokens. + """ Core JWS token handling. See draft-ietf-jose-json-web-signature-41 + NOTE: Users should normally use JWS, not JWSCore, + as JWS perform necessary checks not performed by JWSCore. + :param alg: The algorithm used to produce the signature. See draft-ietf-jose-json-web-algorithms-24 |