Skip to content

Commit 27d2fbf

Browse files
author
Michael Davis
committed
Update README.md
1 parent 95c890d commit 27d2fbf

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,24 @@ A JOSE implementation in Python
44

55
[![Build Status](https://travis-ci.org/mpdavis/python-jose.svg?branch=master)](https://travis-ci.org/mpdavis/python-jose) [![Coverage Status](https://coveralls.io/repos/mpdavis/python-jose/badge.svg)](https://coveralls.io/r/mpdavis/python-jose)
66

7+
The JavaScript Object Signing and Encryption (JOSE) technologies -
8+
JSON Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key
9+
(JWK), and JSON Web Algorithms (JWA) - collectively can be used to
10+
encrypt and/or sign content using a variety of algorithms. While the
11+
full set of permutations is extremely large, and might be daunting to
12+
some, it is expected that most applications will only use a small set
13+
of algorithms to meet their needs.
14+
715
## Principles
816

917
This is a JOSE implementation that is meant to be simple to use, both on and off of AppEngine.
1018

1119
## Examples
1220

21+
### JSON Web Signature
22+
23+
JSON Web Signatures (JWS) are used to digitally sign a JSON encoded object and represent it as a compact URL-safe string.
24+
1325
#### Signing tokens
1426

1527
```python
@@ -25,6 +37,11 @@ This is a JOSE implementation that is meant to be simple to use, both on and off
2537
{'a': 'b'}
2638
```
2739

40+
### JSON Web Token
41+
42+
JSON Web Tokens are a JWS with a set of reserved claims to be used in a standardized manner.
43+
44+
2845
## Algorithms
2946

3047
The following algorithms are currently supported.

0 commit comments

Comments
 (0)