Skip to content

Document how proxy_{get,set}_property expects paths to be serialized. #94

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

Merged
merged 3 commits into from
Oct 30, 2025
Merged

Document how proxy_{get,set}_property expects paths to be serialized. #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fffaa5
document how proxy_{get,set}_property expects paths to be serialized
mpwarres Oct 9, 2025
85847b3
Update to state that 0x00 is a separator rather than terminator
mpwarres Oct 14, 2025
f9667d1
Update v0.2.0 and vNEXT specs to match
mpwarres Oct 24, 2025
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
16 changes: 16 additions & 0 deletions abi-versions/v0.2.0/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1687,6 +1687,8 @@ Returned `status` value is:
Retrieves value (`return_value_data`, `return_value_size`)
of the property (`path_data`, `path_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand All @@ -1709,6 +1711,8 @@ Returned `status` value is:
Sets value of the property (`path_data`, `path_size`) to the provided
value (`value_data`, `value_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand Down Expand Up @@ -1920,6 +1924,18 @@ e.g. the map `{{"a": "1"}, {"b": "22"}}` would be serialized as:
An empty map may be represented either as an empty value (`size=0`), or as
a single `0x00` byte (`size=1`).

#### Property path names

Path data for the [proxy_get_property] and [property_set_property] hostcalls
consists of a sequence of path segments. The path segments are separated by
`NULL` (`0x00`) characters.

e.g. the path segments `["foo", "bar"]` would be serialized as:
- `0x66`, `0x6f`, `0x6f`, `0x00`, `0x62`, `0x61`, `0x72`

Host implementations should tolerate a `NULL` character at the end of the
combined path data string, if present.


# Security Considerations

Expand Down
16 changes: 16 additions & 0 deletions abi-versions/v0.2.1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1710,6 +1710,8 @@ Returned `status` value is:
Retrieves value (`return_value_data`, `return_value_size`)
of the property (`path_data`, `path_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand All @@ -1732,6 +1734,8 @@ Returned `status` value is:
Sets value of the property (`path_data`, `path_size`) to the provided
value (`value_data`, `value_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand Down Expand Up @@ -1943,6 +1947,18 @@ e.g. the map `{{"a": "1"}, {"b": "22"}}` would be serialized as:
An empty map may be represented either as an empty value (`size=0`), or as
a single `0x00` byte (`size=1`).

#### Property path names

Path data for the [proxy_get_property] and [property_set_property] hostcalls
consists of a sequence of path segments. The path segments are separated by
`NULL` (`0x00`) characters.

e.g. the path segments `["foo", "bar"]` would be serialized as:
- `0x66`, `0x6f`, `0x6f`, `0x00`, `0x62`, `0x61`, `0x72`

Host implementations should tolerate a `NULL` character at the end of the
combined path data string, if present.


# Security Considerations

Expand Down
16 changes: 16 additions & 0 deletions abi-versions/vNEXT/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1710,6 +1710,8 @@ Returned `status` value is:
Retrieves value (`return_value_data`, `return_value_size`)
of the property (`path_data`, `path_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand All @@ -1732,6 +1734,8 @@ Returned `status` value is:
Sets value of the property (`path_data`, `path_size`) to the provided
value (`value_data`, `value_size`).

`path_data` is a [serialized] list of path segments.

Returned `status` value is:
- `OK` on success.
- `NOT_FOUND` when there was no property found at the requested `path`.
Expand Down Expand Up @@ -1943,6 +1947,18 @@ e.g. the map `{{"a": "1"}, {"b": "22"}}` would be serialized as:
An empty map may be represented either as an empty value (`size=0`), or as
a single `0x00` byte (`size=1`).

#### Property path names

Path data for the [proxy_get_property] and [property_set_property] hostcalls
consists of a sequence of path segments. The path segments are separated by
`NULL` (`0x00`) characters.

e.g. the path segments `["foo", "bar"]` would be serialized as:
- `0x66`, `0x6f`, `0x6f`, `0x00`, `0x62`, `0x61`, `0x72`

Host implementations should tolerate a `NULL` character at the end of the
combined path data string, if present.


# Security Considerations

Expand Down