Skip to content

Commit 230280d

Browse files
jbowesjbowes
committed
Add some notes to the readme
1 parent e05cc30 commit 230280d

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

‎README.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -82,33 +82,33 @@ This implementation is based on version `05` of [Signing HTTP Messages][msgsig]
8282
computation is based on version `05` of [Digest Headers][dighdr]
8383
(`draft-ietf-httpbis-digest-headers-05` from 13 April 2021).
8484

85-
| Feature | | |
86-
| ------------------------------- | - | - |
87-
| sign requests | ✅ | |
88-
| verify requests | ✅ | |
89-
| sign responses | | ❌ |
90-
| verify responses | | ❌ |
91-
| enforce `expires` | | ❌ |
92-
| create multiple signatures | ✅ | |
93-
| verify from multiple signatures | ✅ | |
94-
| `rsa-pss-sha512` | ✅ | |
95-
| `rsa-v1_5-sha256` | | ❌ |
96-
| `hmac-sha256` | ✅ | |
97-
| `ecdsa-p256-sha256` | ✅ | |
98-
| custom signature formats | | ❌ |
99-
| JSON Web Signatures | | ❌ |
100-
| request digests | ✅ | |
101-
| response digests | | ❌ |
102-
| multiple digests | | ❌ |
103-
| digest: `sha-256` | | ❌ |
104-
| digest: `sha-512` | | ❌ |
105-
| digest: `md5` | | ❌ |
106-
| digest: `sha` | | ❌ |
107-
| digest: `unixsum` | | ❌ |
108-
| digest: `unixcksum` | | ❌ |
109-
| digest: `id-sha-512` | | ❌ |
110-
| digest: `id-sha-256` | ✅ | |
111-
| custom digest formats | | ❌ |
85+
| Feature | | | Notes |
86+
| ------------------------------- | - | - | ---------------------------------------------------------------------- |
87+
| sign requests | ✅ | | |
88+
| verify requests | ✅ | | |
89+
| sign responses | | ❌ | |
90+
| verify responses | | ❌ | |
91+
| enforce `expires` | | ❌ | sorely needed |
92+
| create multiple signatures | ✅ | | |
93+
| verify from multiple signatures | ✅ | | |
94+
| `rsa-pss-sha512` | ✅ | | |
95+
| `rsa-v1_5-sha256` | | ❌ | |
96+
| `hmac-sha256` | ✅ | | |
97+
| `ecdsa-p256-sha256` | ✅ | | |
98+
| custom signature formats | | ❌ | `eddsa` is not part of the spec, so custom support here would be nice! |
99+
| JSON Web Signatures | | ❌ | JWS doesn't support any additional algs, but it is part of the spec |
100+
| request digests | ✅ | | |
101+
| response digests | | ❌ | Tricky to support for signature use according to the spec |
102+
| multiple digests | | ❌ | |
103+
| digest: `sha-256` | | ❌ | |
104+
| digest: `sha-512` | | ❌ | |
105+
| digest: `md5` | | ❌ | Deprecated in the spec. Unlikely to be supported. |
106+
| digest: `sha` | | ❌ | Deprecated in the spec. Unlikely to be supported. |
107+
| digest: `unixsum` | | ❌ | |
108+
| digest: `unixcksum` | | ❌ | |
109+
| digest: `id-sha-512` | | ❌ | |
110+
| digest: `id-sha-256` | ✅ | | `id-*` digests are more resilient for `content-encoding` support |
111+
| custom digest formats | | ❌ | |
112112

113113
## Contributing
114114

0 commit comments

Comments
 (0)