Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
beatt83 committed Jan 20, 2024
1 parent 9e3fdf2 commit e6c0149
Showing 1 changed file with 53 additions and 28 deletions.
81 changes: 53 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ This library provides comprehensive support for the Jose suite of standards, inc
## Available Algorithms

<table>
<tr><th>JWS Supported Algorithms </th><th>JWE Supported Algorithms</th><th>JWK Supported Key Types</th></tr>
<tr><th>JWS Supported Algorithms </th><th>JWE Supported Algorithms</th><th>JWK Supported Key Types</th><th>JWT Supported</th></tr>
<tr><td valign="top">

| Algorithm | Supported |
|-----------------|-----------|
| Algorithm | Supported |
|-----------------|------------------|
| HS256 |:white_check_mark:|
| HS384 |:white_check_mark:|
| HS512 |:white_check_mark:|
Expand All @@ -48,29 +48,29 @@ This library provides comprehensive support for the Jose suite of standards, inc

</td><td valign="top">

| Algorithm | Supported |
|-----------------|-----------|
| RSA1_5 |:white_check_mark:|
| RSA-OAEP |:white_check_mark:|
| RSA-OAEP-256 |:white_check_mark:|
| A128KW |:white_check_mark:|
| A192KW |:white_check_mark:|
| A256KW |:white_check_mark:|
| DIRECT |:white_check_mark:|
| ECDH-ES |:white_check_mark:|
| ECDH-ES+A128KW |:white_check_mark:|
| ECDH-ES+A192KW |:white_check_mark:|
| ECDH-ES+A256KW |:white_check_mark:|
| A128GCMKW |:white_check_mark:|
| A192GCMKW |:white_check_mark:|
| A256GCMKW |:white_check_mark:|
| PBES2-HS256+A128KW | |
| PBES2-HS384+A192KW | |
| PBES2-HS512+A256KW | |


| Encoding Algorithm | Supported |
|-----------------|-----------|
| Algorithm | Supported |
|--------------------|------------------|
| RSA1_5 |:white_check_mark:|
| RSA-OAEP |:white_check_mark:|
| RSA-OAEP-256 |:white_check_mark:|
| A128KW |:white_check_mark:|
| A192KW |:white_check_mark:|
| A256KW |:white_check_mark:|
| DIRECT |:white_check_mark:|
| ECDH-ES |:white_check_mark:|
| ECDH-ES+A128KW |:white_check_mark:|
| ECDH-ES+A192KW |:white_check_mark:|
| ECDH-ES+A256KW |:white_check_mark:|
| A128GCMKW |:white_check_mark:|
| A192GCMKW |:white_check_mark:|
| A256GCMKW |:white_check_mark:|
| PBES2-HS256+A128KW | |
| PBES2-HS384+A192KW | |
| PBES2-HS512+A256KW | |


| Encoding Algorithm | Supported |
|-----------------|------------------|
| A128CBC-HS256 |:white_check_mark:|
| A128CBC-HS384 |:white_check_mark:|
| A128CBC-HS512 |:white_check_mark:|
Expand All @@ -80,13 +80,38 @@ This library provides comprehensive support for the Jose suite of standards, inc

</td><td valign="top">

| Key Type | Supported |
|----------|-----------|
| Key Type | Supported |
|----------|------------------|
| EC |:white_check_mark:|
| RSA |:white_check_mark:|
| OKT |:white_check_mark:|
| OCK |:white_check_mark:|

</td><td valign="top">

| Algorithms | Supported |
|------------------------------|------------------|
| All supported JWE algorithms |:white_check_mark:|
| All supported JWS algorithms |:white_check_mark:|

| Types | Supported |
|------------------|------------------|
| Signed |:white_check_mark:|
| Encrypted |:white_check_mark:|
| Nested Signed |:white_check_mark:|
| Nested Encrypted |:white_check_mark:|

| Claims Validation | Supported |
|-------------------|------------------|
| iss |:white_check_mark:|
| sub |:white_check_mark:|
| aud |:white_check_mark:|
| nbf |:white_check_mark:|
| exp |:white_check_mark:|
| iat |:white_check_mark:|
| typ |:white_check_mark:|
| cty |:white_check_mark:|

</td></tr> </table>

## Requirements
Expand Down

0 comments on commit e6c0149

Please sign in to comment.