From ff45fe066894bb8ea53fc7281a7badeddec29d64 Mon Sep 17 00:00:00 2001 From: Goncalo Frade Date: Sat, 20 Jan 2024 12:55:58 +0000 Subject: [PATCH] docs: update readme --- README.md | 88 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 61 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 5c58da3..1f220d7 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,8 @@ This library provides comprehensive support for the Jose suite of standards, inc JWS Supported Algorithms JWE Supported AlgorithmsJWK Supported Key Types -| Algorithm | Supported | -|-----------------|-----------| +| Algorithm | Supported | +|-----------------|------------------| | HS256 |:white_check_mark:| | HS384 |:white_check_mark:| | HS512 |:white_check_mark:| @@ -48,29 +48,29 @@ This library provides comprehensive support for the Jose suite of standards, inc -| 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:| @@ -80,8 +80,8 @@ This library provides comprehensive support for the Jose suite of standards, inc -| Key Type | Supported | -|----------|-----------| +| Key Type | Supported | +|----------|------------------| | EC |:white_check_mark:| | RSA |:white_check_mark:| | OKT |:white_check_mark:| @@ -89,6 +89,40 @@ This library provides comprehensive support for the Jose suite of standards, inc + + + +
JWT supported algorithms JWT supported typesJWT supported claims validations
+ +| 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 | 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:| + +
+ ## Requirements - Swift 5.7.1 or later