Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unsupported algos #13

Merged
merged 8 commits into from
Oct 16, 2024
Merged

Unsupported algos #13

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6b0baaa
Unsupported algos
ioggstream Jul 21, 2024
fba3606
Merge branch 'main' into ioggstream-editorial-2
Acconut Jul 25, 2024
ff04ad7
OK
ioggstream Jul 25, 2024
9ec20a0
Split sentences.
ioggstream Oct 10, 2024
9b738a8
Remove misplaced header
ioggstream Oct 10, 2024
fdd4dd7
Update draft-kleidl-digest-fields-problem-types.md
Acconut Oct 16, 2024
5ee4e7f
Update draft-kleidl-digest-fields-problem-types.md
Acconut Oct 16, 2024
abbf5c7
Update draft-kleidl-digest-fields-problem-types.md
Acconut Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 53 additions & 7 deletions draft-kleidl-digest-fields-problem-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,25 +78,71 @@ interpreted as described in {{PROBLEM}}.

## Unsupported Hashing Algorithm

This section defines the "https://iana.org/assignments/http-problem-types#unsupported-hashing-algorithm" problem type. A server MAY use this problem type when responding to a request, whose integrity or integrity preference fields reference a hashing algorithm that the server can not or does not want to support for this request, and if the server wants to indicate this problem to the sender.
This section defines the "https://iana.org/assignments/http-problem-types#unsupported-hashing-algorithm" problem type.
A server MAY use this problem type if it wants to communicate to the client that
none of the hashing algorithms referenced in the integrity or integrity preference fields present in the request,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
none of the hashing algorithms referenced in the integrity or integrity preference fields present in the request,
one of the hashing algorithms referenced in the integrity or integrity preference fields present in the request,

The intention behind this problem type was that at least one algorithm is unsupported and the server wants to communicate this. Of course, the server could also just ignore that algorithm, but it might not want to do this. With this change, it sounds like the problem type is for cases when all hashing algorithms are unsupported.

Copy link
Contributor Author

@ioggstream ioggstream Jul 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. This is a tricky point, because the server is not required to process all algorithms.

We need to decide whether this problem-type applies to just one of the algorithms, or to all of the algorithms.

Probably we need to re-examine this point after some time, so I leave this thread open.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened #18 to track this question.

is supported.

For this problem type, the `unsupported-algorithm` is defined as the only extension member. It SHOULD be populated in a response using this problem type, with its value being the algorithm key of the unsupported algorithm from the request. The response SHOULD include the corresponding integrity preference field to indicate the server's algorithm support and preference.
For this problem type, the `unsupported-algorithm` is defined as the only extension member.
Acconut marked this conversation as resolved.
Show resolved Hide resolved
It SHOULD be populated in a response using this problem type, with its value being the algorithm key of the unsupported algorithm from the request.
The response SHOULD include the corresponding integrity preference field to indicate the server's algorithm support and preference.<!-- I am currently not sure whether to use normative language here. -->
Acconut marked this conversation as resolved.
Show resolved Hide resolved
Acconut marked this conversation as resolved.
Show resolved Hide resolved

The following example shows a response for a request with an integrity field utilizing an unsupported hashing algorithm `foo`. The response also includes a list of supported algorithms.
Example:

~~~ http-message
POST /books HTTP/1.1
Host: foo.example
Content-Type: application/json
Accept: application/json
Accept-Encoding: identity
Repr-Digest: sha-256=:mEkdbO7Srd9LIOegftO0aBX+VPTVz7/CSHes2Z27gc4=:

{"title": "New Title"}
~~~
{: title="A request with a sha-256 integrity field, which is not supported by the server"}

~~~ http-message
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
Want-Content-Digest: sha-512=3, sha-256=10
Want-Repr-Digest: sha-512=10, sha-256=0
Acconut marked this conversation as resolved.
Show resolved Hide resolved

{
"type": "https://iana.org/assignments/http-problem-types#unsupported-hashing-algorithm",
"title": "hashing algorithm is not supported",
"unsupported-algorithm": "foo"
"title": "Unsupported hashing algorithm",
"unsupported-algorithm": "sha-256"
}
~~~
{: title="Response Advertising the Supported Algorithms"}


This problem type is a hint to the client about algorithm support, which the client could use to retry the request with a different, supported, algorithm.

Note that a request may contain more than one integrity field,
and this problem type can be used both when a request contains an integrity preference field, e.g.
ioggstream marked this conversation as resolved.
Show resolved Hide resolved

~~~ http-message
GET /items/123 HTTP/1.1
Host: foo.example
Want-Repr-Digest: sha=10

~~~
{: title="GET Request with Want-Repr-Digest"}

~~~ http-message
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
Want-Repr-Digest: sha-512=10, sha-256=3
ioggstream marked this conversation as resolved.
Show resolved Hide resolved

{
"type": "https://iana.org/assignments/http-problem-types#unsupported-hashing-algorithm",
"title": "Unsupported hashing algorithm",
"unsupported-algorithm": "sha"
}
~~~
{: title="Response Advertising the Supported Algorithms"}



This problem type is a hint to the client about algorithm support, which the client could use to retry the request with a different algorithm supported by the server.

## Invalid Digest Value

Expand Down
Loading