summaryrefslogtreecommitdiff
path: root/security/py-python-jose/pkg-descr
diff options
context:
space:
mode:
authorDan Langille <dvl@FreeBSD.org>2018-07-26 16:51:18 +0000
committerDan Langille <dvl@FreeBSD.org>2018-07-26 16:51:18 +0000
commit7b0f696caa5bb92e6db00e417b7d76f3870d51c6 (patch)
tree194bd9f005a8fca2f515caa9bffacf8be8a76415 /security/py-python-jose/pkg-descr
parentwww/tomcat9: mark additional config files with @sample (diff)
A JOSE implementation in Python
The JavaScript Object Signing and Encryption (JOSE) technologies - JSON Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), and JSON Web Algorithms (JWA) - collectively can be used to encrypt and/or sign content using a variety of algorithms. While the full set of permutations is extremely large, and might be daunting to some, it is expected that most applications will only use a small set of algorithms to meet their needs.
Diffstat (limited to 'security/py-python-jose/pkg-descr')
-rw-r--r--security/py-python-jose/pkg-descr20
1 files changed, 20 insertions, 0 deletions
diff --git a/security/py-python-jose/pkg-descr b/security/py-python-jose/pkg-descr
new file mode 100644
index 000000000000..ea7743d4e993
--- /dev/null
+++ b/security/py-python-jose/pkg-descr
@@ -0,0 +1,20 @@
+A JOSE implementation in Python
+
+The JavaScript Object Signing and Encryption (JOSE) technologies - JSON Web
+Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), and JSON Web
+Algorithms (JWA) - collectively can be used to encrypt and/or sign content
+using a variety of algorithms. While the full set of permutations is extremely
+large, and might be daunting to some, it is expected that most applications
+will only use a small set of algorithms to meet their needs.
+
+Usage
+
+>>> from jose import jwt
+>>> token = jwt.encode({'key': 'value'}, 'secret', algorithm='HS256')
+u'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ2YWx1ZSJ9.FG-8UppwHaFp1LgRYQQeS6EDQF7_6-bMFegNucHjmWg'
+
+>>> jwt.decode(token, 'secret', algorithms=['HS256'])
+{u'key': u'value'}
+
+
+WWW: https://github.com/mpdavis/python-jose