Skip to content

docs: Clarify nesting of context events#285

Open
ueno wants to merge 3 commits into
latchset:mainfrom
ueno:wip/pk-update
Open

docs: Clarify nesting of context events#285
ueno wants to merge 3 commits into
latchset:mainfrom
ueno:wip/pk-update

Conversation

@ueno

@ueno ueno commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Also add pk::rsa_padding and tls::verify_cert_chain.

ueno added 3 commits July 16, 2026 18:04
Signed-off-by: Daiki Ueno <dueno@redhat.com>
Signed-off-by: Daiki Ueno <dueno@redhat.com>
Signed-off-by: Daiki Ueno <dueno@redhat.com>
@ueno
ueno requested review from The-Mule, neverpanic and t184256 July 16, 2026 09:30

@neverpanic neverpanic 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.

Some nitpicks, but in general I like the direction this is going.

Comment thread docs/registry.md
Comment on lines +9 to +10
A protocol is typically defined in a context hierarchy. In this
document they are defined in the following presentation syntax.

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.

Suggested change
A protocol is typically defined in a context hierarchy. In this
document they are defined in the following presentation syntax.
Tracing information for most protocols can be represented in a
hierarchical structure of contexts and events. This document
defines the presentation syntax for this tree.

I feel this describes better what it is we're trying to do here, let me know what you think.

Comment thread docs/registry.md
Events for generic public key cryptography are scoped with `pk` and
defined as follows:

```

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.

Should we add explanations what the various fields mean in which contexts, and what string representations we expect? Or should we leave that up to the implementations to define and then we'll have to process whatever we get from the libraries in our monitoring tooling?

If we don't define anything, we'll probably get "RSASSA-PSS", "RSA_PSS", and "PSS" all for the same padding scheme, and the same applies for algorithm, curve, and hash, too.

I also feel we may want to make it more explicit that all fields are optional, i.e., an RSA sign event might omit the curve event, and an ECDSA signature can come without rsa_padding.

Comment thread docs/registry.md
|-------------------|------------|----------------------------------------------------------------------------------------------------------------------------|
| `pk::algorithm` | string | Used algorithm name |
| `pk::curve` | string | Elliptic curve name |
| `pk::group` | string | FFDH group name |

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.

The examples above don't use group. Should the derive event use group instead of curve?

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