[PP-1] `LinkCollection::validKey()` does not properly validate RFC 8288 link relation types

Open on Drupal.org →

Created on 26 April 2023, over 1 year ago

Updated 21 May 2024, 6 months ago

Problem/Motivation

The JSON:API spec states

A link object MAY also contain any of the following members:

rel: a string indicating the link’s relation type. The string MUST be a valid link relation type.

The linked RFC 8288 describes a valid extension link relation type:

Applications that don't wish to register a relation type can use an
extension relation type, which is a URI [RFC3986] that uniquely
identifies the relation type.

However, LinkCollection::validKey() validates link relation types using a custom-ish(?) method which disallows colons. Colons are valid in URIs, including URNs.

Steps to reproduce

Attempt to utilize a link relation type with a colon, e.g. urn:kinksters-link:cancel.

Proposed resolution

Validate the link relation type per the ABNF in the HTTP linking RFC.

Remaining tasks

Do the thing, add test coverage for this.

User interface changes

None.

API changes

None.

Data model changes

None.

Release notes snippet

Not necessary?

🐛 Bug report

Status

Postponed

Version

11.0 🔥

Component

Last updated 10 days ago

Maintained by
@e0ipso
🇳🇱Netherlands @bbrala
@gabesullice
🇧🇪Belgium @wim leers

Created by

🇺🇸United States bradjones1 Digital Nomad Life

Live updates comments and jobs are added and updated live.

Spec Compliance

Incomplete comments

Sign in to follow issues

Merge Requests

!3881[PP-1] `LinkCollection::validKey()` does not properly validate RFC 8288 link relation types
Open
🇺🇸United States bradjones1
updated 6 months ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Issue created by @bradjones1
Comment over 1 year ago →
🇺🇸United States bradjones1 Digital Nomad Life
Related re: URI validation in core.
Merge request !3881Issue #3356643: `LinkCollection::validKey()` does not properly validate RFC 8288 link relation types → (Open) created by bradjones1
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.1 & MySQL 5.7
last update over 1 year ago
Custom Commands Failed
Comment over 1 year ago →
🇺🇸United States bradjones1 Digital Nomad Life
The MR requires 🐛 Not all URIs are URLs, but UriWidget won't accept non-URL URIs Needs work as that provides the same URI validation logic we'll need here.
Comment 6 months ago →
🇺🇸United States bradjones1 Digital Nomad Life
PP'd on 🐛 Not all URIs are URLs, but UriWidget won't accept non-URL URIs Needs work
Pipeline finished with Failed
6 months ago
Total: 196s
#177600
Status changed to Postponed 6 months ago5:11pm 21 May 2024
Comment 6 months ago →
🇺🇸United States bradjones1 Digital Nomad Life

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024