Skip to content

Commit

Permalink
handle host detector with custom error handler and open_basedir
Browse files Browse the repository at this point in the history
if open_basedir is configured such that files that it tries to open are denied with a php warning, and
a custom error handler is installed which converts warnings to exceptions, an unhandled exception occurs.
add a test for this, and some try/catch/ignore blocks around the code that can trigger this.
  • Loading branch information
brettmc committed Dec 13, 2024
1 parent 4a021fb commit c88a1dc
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 6 deletions.
23 changes: 17 additions & 6 deletions src/SDK/Resource/Detectors/Host.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use OpenTelemetry\SDK\Resource\ResourceInfo;
use OpenTelemetry\SemConv\ResourceAttributes;
use function php_uname;
use Throwable;

/**
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/host.md#host
Expand Down Expand Up @@ -53,10 +54,15 @@ private function getLinuxId(): ?string

foreach ($paths as $path) {
$file = $this->dir . $path;
if (is_file($file) && is_readable($file)) {
$contents = file_get_contents($file);

return $contents !== false ? trim($contents) : null;
try {
if (is_file($file) && is_readable($file)) {
$contents = file_get_contents($file);

return $contents !== false ? trim($contents) : null;
}
} catch (Throwable $t) {
//do nothing
}
}

Expand All @@ -66,10 +72,15 @@ private function getLinuxId(): ?string
private function getBsdId(): ?string
{
$file = $this->dir . self::PATH_ETC_HOSTID;
if (is_file($file) && is_readable($file)) {
$contents = file_get_contents($file);

return $contents !== false ? trim($contents) : null;
try {
if (is_file($file) && is_readable($file)) {
$contents = file_get_contents($file);

return $contents !== false ? trim($contents) : null;
}
} catch (Throwable $t) {
//do nothing
}

$out = exec('which kenv && kenv -q smbios.system.uuid');
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
--TEST--
Host detector with custom error handler and open_basedir
--DESCRIPTION--
An error handler is installed which converts PHP warnings to exceptions, and open_basedir
is configured such that /etc/machine-id and friends cannot be read
--SKIPIF--
<?php if (!in_array(PHP_OS_FAMILY, ['Linux', 'BSD'])) die('skip requires Linux or BSD'); ?>
--ENV--
OTEL_PHP_FIBERS_ENABLED=0
--INI--
open_basedir=${PWD}
--FILE--
<?php
use OpenTelemetry\SDK\Resource\Detectors\Host;

require_once 'vendor/autoload.php';

function warningToException($errno, $errstr, $errfile, $errline)
{
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
}
set_error_handler('warningToException');

$detector = new Host();
$resource = $detector->getResource();
var_dump($resource->getAttributes()->toArray());
?>
--EXPECTF--
array(2) {
["host.name"]=>
string(%d) "%s"
["host.arch"]=>
string(%d) "%s"
}

0 comments on commit c88a1dc

Please sign in to comment.