CycloneDX / transparency-exchange-api

A standard API specification for exchanging supply chain artifacts and intelligence
https://tc54.org/
Apache License 2.0
59 stars 9 forks source link

Clarify format of `domain-name` in TEI #65

Closed madpah closed 4 days ago

madpah commented 2 weeks ago

See https://cyclonedx.slack.com/archives/C04LR6R9T8E/p1730984569287219

This is to track to resolution and decision whether domain-name portion of TEI is reverse of forwards format.

Example "forwards": cyclonedx.org

Example "reverse": org.cyclonedx

There are advantages of both, but it is currently not documented which is intended in the TEI.

FYI @stevespringett @oej

oej commented 2 weeks ago

DNS names has a clear well documented format with TLD at the end. As this is a name intended for resolution in the DNS, and not as an DNS-independent identifier, I do not think doing the reverse would be helpful. It's not an IETF supported standard.

oej commented 2 weeks ago

And as a non-Java developer I did not think there was an alternative, so all examples are in FQDN form ;-)

You are right that it's not documented, it was assumed by me. We obviously need to clarify.

madpah commented 1 week ago

To be clear - I have no strong preference either way. Unless we receive any strong opinions, I'd suggest we go with domain-name in FQDN form - so cyclonedx.org and NOT org.cyclonedx.

oej commented 4 days ago

I think we're in agreement on using it the FQDN way as it is intended to be resolved using DNS. Let's close this.