Skip to content

Some minor wording adjustments - #278

Merged
davidben merged 7 commits into
ietf-plants-wg:mainfrom
ounsworth:main
Jul 27, 2026
Merged

Some minor wording adjustments#278
davidben merged 7 commits into
ietf-plants-wg:mainfrom
ounsworth:main

Conversation

@ounsworth

Copy link
Copy Markdown
Contributor

No description provided.

@davidben davidben left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks! That makes things a bit clearer! Some comments below.

Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
MTCLogEntry is an extensible structure. Future documents MAY define new values for MTCLogEntryType or MTCLogEntryExtensionType, with corresponding semantics. See {{certification-authority-cosigners}} and {{extensibility}} for additional discussion.

An MTCLogEntry's size SHOULD NOT exceed 65535 (2<sup>16</sup>-1) bytes. Doing so may exceed size limits in common log-serving protocols, such as {{TLOG-TILES}}. TBSCertificateLogEntry does not include signatures and hashes public keys, so post-quantum algorithms do not contribute to this size.
An MTCLogEntry's size SHOULD NOT exceed 65535 (2<sup>16</sup>-1) bytes. Doing so might exceed size limits in common log-serving protocols, such as {{TLOG-TILES}}, so implementer SHOULD be caution about any limits imposed by the protocls and log providers that they intend to use. TBSCertificateLogEntry does not include signatures and hashes public keys, so post-quantum algorithms do not contribute to this size.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

caution -> cautios, protocls -> protocols.
Though "should be cautious about" reads like SHOULD CONSIDER. :-)

I dunno, I guess we should sort out what we're actually trying to say here. Previously it was:

  • You probably don't want to exceed 65535. You probably are using tlog-tiles, and that is limited there
  • PS: Don't worry about PQ stuff

And I suppose the point here is that there's an implicit "you should honor the limits or whatever other things impose on you" that's... honestly tautological but perhaps a glue thought missing between them.

But also maybe this is too complicated and we just keep it simple:

Suggested change
An MTCLogEntry's size SHOULD NOT exceed 65535 (2<sup>16</sup>-1) bytes. Doing so might exceed size limits in common log-serving protocols, such as {{TLOG-TILES}}, so implementer SHOULD be caution about any limits imposed by the protocls and log providers that they intend to use. TBSCertificateLogEntry does not include signatures and hashes public keys, so post-quantum algorithms do not contribute to this size.
An MTCLogEntry's size SHOULD NOT exceed 65535 (2<sup>16</sup>-1) bytes. TBSCertificateLogEntry does not include signatures and hashes public keys, so post-quantum algorithms do not contribute to this size.

That:

  1. Makes you compatible with tlog-tiles, but that's not normative text and the little FYI seems to be too complicated.
  2. Hints that, if you're building a log protocol that's not tlog, you should maybe try to accommodate 65535

And then if hypothetically someone were building something new on top of MTCs and needed a different limit, they can sort that out then. We don't need to say "if you have other limits, you have other limits".

Thoughts?

@ounsworth ounsworth Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I agree this is a weird non-normative "but what about the children TLOG" sentence that mostly doesn't do anything. I'll give you another commit that goes halfway to Deleted.

Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
For example, the trust anchor ID 32473.1 would be encoded as the ASCII string `oid/1.3.6.1.4.1.32473.1`.

`start` and `end` MUST define a valid subtree of the log, and `subtree_hash` MUST be the subtree's hash value in the cosigner's view of the log.
`start` and `end` MUST define a valid subtree of the log {{sec-subtree}}, and `subtree_hash` MUST be the subtree's hash value {{sec-subtree}} in the cosigner's view of the log.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this will render as "start and end MUST define a valid subtree of the log Section 1.2.3". I.e. just stick "Section 1.2.3" directly inline in the text. I usually put parens like ({{sec-subtree}}) or write See {{sec-subtree}}.

Although these are both citing the same section. It's annoying that our specs don't allow more lightweight links everywhere but, failing that, perhaps:

Suggested change
`start` and `end` MUST define a valid subtree of the log {{sec-subtree}}, and `subtree_hash` MUST be the subtree's hash value {{sec-subtree}} in the cosigner's view of the log.
`start` and `end` MUST define a valid subtree of the log , and `subtree_hash` MUST be the subtree's hash value in the cosigner's view of the log. See {{sec-subtree}}.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yup, that's better.

By the way, does the {{name-of-section}} syntax work for all kramdown, or did you have to do something in the preamble to make that work?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

By the way, does the {{name-of-section}} syntax work for all kramdown, or did you have to do something in the preamble to make that work?

As far as I know, it works for all of kramdown.

Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
Comment thread draft-ietf-plants-merkle-tree-certs.md
Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated

@davidben davidben left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

One last comment but otherwise looks good. Thanks for this!

Comment thread draft-ietf-plants-merkle-tree-certs.md Outdated
@davidben
davidben merged commit 7a2d5f1 into ietf-plants-wg:main Jul 27, 2026
davidben added a commit that referenced this pull request Jul 27, 2026
@davidben

Copy link
Copy Markdown
Collaborator

Merged and then added you to acknowledgements in 2e87ea1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants