Skip to content

PHPC-2613: Test x509 authentication on Atlas #1858

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 5 commits into from
Aug 8, 2025
Merged

PHPC-2613: Test x509 authentication on Atlas #1858

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
033ce9c
PHPC-2613: Test x509 authentication on Atlas
alcaeus Aug 7, 2025
0e55a07
Refactor code for less duplication
alcaeus Aug 7, 2025
988c53d
Apply review feedback from Copilot
alcaeus Aug 7, 2025
78465fd
Remove unnecessary extractUri function
alcaeus Aug 8, 2025
34b9e9a
Remove unnecessary call to chmod
alcaeus Aug 8, 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
85 changes: 75 additions & 10 deletions tests/atlas.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,56 @@ Atlas Connectivity Tests
<?php
require_once __DIR__ . "/utils/basic.inc";

function extractUri(string $env): ?string
{
return getenv($env) ?: null;
}

function extractUriWithCertificate(string $env): ?array
{
$uri = getenv($env);
if (! is_string($uri)) {
return null;
}

$cert = getenv($env . '_CERT_BASE64');
if (! is_string($cert)) {
return null;
}

$certPath = tempnam(sys_get_temp_dir(), 'cert_');
$certContents = base64_decode($cert);
if (! $certPath || ! $certContents) {
return null;
}

file_put_contents($certPath, $certContents);
chmod($certPath, 0600);
Copy link
Member

Choose a reason for hiding this comment

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

Is this necessary? tempnam() should already create the file with these perms.

Copy link
Member Author

Choose a reason for hiding this comment

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

TIL:

Creates a file with a unique filename, with access permission set to 0600

Removed the chmod call.


return [
'uri' => $uri . '&tlsCertificateKeyFile=' . $certPath,
Copy link
Member

Choose a reason for hiding this comment

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

Should $certPath get URL-encoded with rawurlencode()? I expect tempnam() will only produce alphanumeric strings, so that may be superfluous.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I think it should be safe (famous last words)

'certPath' => $certPath,
];
}

function testConnection(string $uri): void
{
try {
$m = new \MongoDB\Driver\Manager($uri);
$m->executeCommand(
'admin',
new \MongoDB\Driver\Command(['ping' => 1]),
);
iterator_to_array($m->executeQuery(
'test.test',
new \MongoDB\Driver\Query([]),
));
echo "PASS\n";
} catch(Exception $e) {
echo "FAIL: ", $e->getMessage(), "\n";
}
}

$envs = [
'ATLAS_SERVERLESS',
'ATLAS_SRV_SERVERLESS',
Expand All @@ -21,28 +71,41 @@ $envs = [
'ATLAS_TLS12',
'ATLAS_SRV_TLS12',
];

$command = new \MongoDB\Driver\Command(['ping' => 1]);
$query = new \MongoDB\Driver\Query([]);
$x509Envs = [
'ATLAS_X509',
'ATLAS_X509_DEV',
];

foreach ($envs as $env) {
echo $env, ': ';
$uri = getenv($env);
$uri = extractUri($env);
Copy link
Member

Choose a reason for hiding this comment

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

It looks like the only purpose of extractUri() is to convert false return value from getenv() into null. That seems unnecessary given the conditional below that fails a non-string value.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, I was a little eager with my refactoring. Removed it in favour of getenv.


if (! is_string($uri)) {
echo "FAIL: env var is undefined\n";
continue;
}

testConnection($uri);
}

foreach ($x509Envs as $env) {
echo $env, ': ';
$uriWithCertificate = extractUriWithCertificate($env);

if (! is_array($uriWithCertificate)) {
echo "FAIL: env var is undefined\n";
continue;
}

['uri' => $uri, 'certPath' => $certPath] = $uriWithCertificate;

try {
$m = new \MongoDB\Driver\Manager($uri);
$m->executeCommand('admin', $command);
iterator_to_array($m->executeQuery('test.test', $query));
echo "PASS\n";
} catch(Exception $e) {
echo "FAIL: ", $e->getMessage(), "\n";
testConnection($uri);
} finally {
@unlink($certPath);
}
}

?>
===DONE===
<?php exit(0); ?>
Expand All @@ -59,4 +122,6 @@ ATLAS_TLS11: PASS
ATLAS_SRV_TLS11: PASS
ATLAS_TLS12: PASS
ATLAS_SRV_TLS12: PASS
ATLAS_X509: PASS
ATLAS_X509_DEV: PASS
===DONE===