Skip to content

Complete stable catalog result decoding and namespace protection #130

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
rmcdaniel merged 1 commit into from
Oct 11, 2026
Merged

Complete stable catalog result decoding and namespace protection #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/Client.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,9 @@ public function describeServiceCatalogCall(string $callId): array
{
$response = $this->serviceCatalogRead('/service-catalog/calls', id: $callId);
if (($response['payloads_in_observer_namespace'] ?? null) === true) {
$response['output_available'] = is_array($response['output_envelope'] ?? null);
$response['output_available'] = is_array($response['result_envelope'] ?? null);
$response['output'] = $response['output_available']
? $this->decodedResponsePayload($response, 'output')
? $this->decodedResponsePayload($response, 'result')
: null;
}

Expand Down
11 changes: 8 additions & 3 deletions src/Transport/RuntimePayloads.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,19 @@ public function response(array $response, string $requestPath, bool $worker): ar
$paths = [...$paths, ...$this->historyPaths(['task', 'history_events']), ...$this->historyPaths(['history_events']),
...$this->exportPaths(['task', 'history_export'])];
} else {
if (preg_match('~\A/service-catalog/calls/[^/]+\z~', $path)
&& ($response['payloads_in_observer_namespace'] ?? null) === true
$catalogCall = preg_match('~\A/service-catalog/calls/[^/]+\z~', $path) === 1;
$catalogOutputAllowed = ($response['payloads_in_observer_namespace'] ?? null) === true;
if ($catalogCall && $catalogOutputAllowed
&& !is_array($response['result_envelope'] ?? null)
&& is_array($response['output_payload_reference'] ?? null)) {
// Keep the opaque reference while hydrating only the authorized
// terminal output of this exact call, never arbitrary metadata.
$response['output_envelope'] = ['codec' => 'avro', 'external_payload' => $response['output_payload_reference']];
$response['result_envelope'] = ['codec' => 'avro', 'external_payload' => $response['output_payload_reference']];
}
foreach (['input_envelope', 'output_envelope', 'result_envelope'] as $field) {
if ($catalogCall && !$catalogOutputAllowed) {
continue;
}
$paths[] = [$field];
}
if (preg_match('~\A/activities/[^/]+\z~', $path)) {
Expand Down
17 changes: 17 additions & 0 deletions tests/ServiceCatalogReadClientTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,21 @@ public static function outputs(): array
return [[null], [false], [0], [''], [['result', ['nested' => 'value']]]];
}

#[DataProvider('outputs')]
public function testCommittedInlineResultEnvelopeIsDecoded(mixed $value): void
{
$codec = new AvroPayloadCodec();
$envelope = $codec->envelope($value);
$transport = new FakeTransport([$this->discovery(), [
'payloads_in_observer_namespace' => true, 'output_payload_reference' => null,
'result_envelope' => $envelope,
]]);
$result = (new Client('https://runtime.test', transport: $transport))->describeServiceCatalogCall('call-1');
self::assertTrue($result['output_available']);
self::assertSame($codec->encode($value), $codec->encode($result['output']));
self::assertCount(2, $transport->requests);
}

public function testExternalOutputUsesOnlyTheConfiguredRuntimeNamespaceAndOperatorCredential(): void
{
$codec = new AvroPayloadCodec();
Expand All @@ -177,6 +192,7 @@ public function testExternalOutputUsesOnlyTheConfiguredRuntimeNamespaceAndOperat
if (count($requests) === 2) {
return Create::promiseFor(new Response(200, [], json_encode([
'id' => 'call-1', 'payloads_in_observer_namespace' => true, 'output_payload_reference' => $envelope,
'result_envelope' => ['codec' => 'avro', 'external_payload' => $envelope],
], JSON_THROW_ON_ERROR)));
}

Expand Down Expand Up @@ -206,6 +222,7 @@ public function testForeignOrUnverifiedOutputsAreNotFetchedAndOwnedDownloadsHono
$transport = new FakeTransport([$this->discovery(), [
'payloads_in_observer_namespace' => $authorized,
'output_payload_reference' => $reference,
'result_envelope' => ['codec' => 'avro', 'external_payload' => $reference],
]]);
$client = new Client('https://runtime.test', transport: $transport, maxExternalPayloadBytes: 1);
try {
Expand Down
Loading