Skip to content
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

Jump to bottom

Remove usage of getimagesize #679

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Remove usage of getimagesize #679

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
218d33d
Remove usage of getimagesize
MKodde Sep 10, 2024
268cdfe
Set the correct dev managa api credentials
MKodde Sep 16, 2024
5e5c1de
No longer request the headers in the curl response
MKodde Sep 16, 2024
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 .env.dev
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ surfconext_representative_authorization='urn:mace:surfnet.nl:surfnet.nl:sab:role

## Manage test instance
manage_test_host='https://manage.dev.openconext.local'
manage_test_username=sp-portal
manage_test_username=sp-dashboard
manage_test_password=secret
manage_test_publication_status=testaccepted

## Manage production instance
manage_prod_host='https://manage.dev.openconext.local'
manage_prod_username=sp-portal
manage_prod_username=sp-dashboard
manage_prod_password=secret
manage_prod_publication_status=prodaccepted

Expand Down
47 changes: 1 addition & 46 deletions ci/qa/phpstan-baseline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,7 +928,7 @@
];
$ignoreErrors[] = [
'message' => '#^If condition is always true\\.$#',
'count' => 2,
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php',
];
$ignoreErrors[] = [
Expand Down Expand Up @@ -991,11 +991,6 @@
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\JsonGenerator\\:\\:generateLogoMetadata\\(\\) return type has no value type specified in iterable type array\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\JsonGenerator\\:\\:generateOrganizationMetadata\\(\\) return type has no value type specified in iterable type array\\.$#',
'count' => 1,
Expand All @@ -1011,11 +1006,6 @@
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Parameter \\#1 \\$filename of function getimagesize expects string, string\\|null given\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Right side of && is always true\\.$#',
'count' => 1,
Expand Down Expand Up @@ -1181,11 +1171,6 @@
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OauthClientCredentialsClientJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\OauthClientCredentialsClientJsonGenerator\\:\\:generateLogoMetadata\\(\\) return type has no value type specified in iterable type array\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OauthClientCredentialsClientJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\OauthClientCredentialsClientJsonGenerator\\:\\:generateMetadataFields\\(\\) never returns float so it can be removed from the return type\\.$#',
'count' => 1,
Expand Down Expand Up @@ -1221,11 +1206,6 @@
'count' => 2,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OauthClientCredentialsClientJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Parameter \\#1 \\$filename of function getimagesize expects string, string\\|null given\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OauthClientCredentialsClientJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Cannot call method getClientSecret\\(\\) on Surfnet\\\\ServiceProviderDashboard\\\\Domain\\\\Entity\\\\Entity\\\\OidcClientInterface\\|null\\.$#',
'count' => 1,
Expand Down Expand Up @@ -1341,11 +1321,6 @@
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OidcngJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\OidcngJsonGenerator\\:\\:generateLogoMetadata\\(\\) return type has no value type specified in iterable type array\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OidcngJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Application\\\\Metadata\\\\OidcngJsonGenerator\\:\\:generateMetadataFields\\(\\) never returns float so it can be removed from the return type\\.$#',
'count' => 1,
Expand Down Expand Up @@ -1381,11 +1356,6 @@
'count' => 2,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OidcngJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Parameter \\#1 \\$filename of function getimagesize expects string, string\\|null given\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Application/Metadata/OidcngJsonGenerator.php',
];
$ignoreErrors[] = [
'message' => '#^Cannot call method getClientSecret\\(\\) on Surfnet\\\\ServiceProviderDashboard\\\\Domain\\\\Entity\\\\Entity\\\\OidcClientInterface\\|null\\.$#',
'count' => 1,
Expand Down Expand Up @@ -3866,11 +3836,6 @@
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Infrastructure/DashboardBundle/Service/CurlLogoValidationHelper.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Infrastructure\\\\DashboardBundle\\\\Service\\\\LogoValidationHelperInterface\\:\\:validateLogo\\(\\) has no return type specified\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Infrastructure/DashboardBundle/Service/LogoValidationHelperInterface.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Infrastructure\\\\DashboardBundle\\\\Service\\\\LogoValidationHelperInterface\\:\\:validateLogo\\(\\) has parameter \\$url with no type specified\\.$#',
'count' => 1,
Expand Down Expand Up @@ -3956,16 +3921,6 @@
'count' => 2,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Infrastructure/DashboardBundle/Validator/Constraints/ValidLogoValidator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Infrastructure\\\\DashboardBundle\\\\Validator\\\\Constraints\\\\ValidLogoValidator\\:\\:getImageSizeValidation\\(\\) has parameter \\$value with no type specified\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Infrastructure/DashboardBundle/Validator/Constraints/ValidLogoValidator.php',
];
$ignoreErrors[] = [
'message' => '#^Method Surfnet\\\\ServiceProviderDashboard\\\\Infrastructure\\\\DashboardBundle\\\\Validator\\\\Constraints\\\\ValidLogoValidator\\:\\:validate\\(\\) has parameter \\$value with no type specified\\.$#',
'count' => 1,
'path' => __DIR__ . '/../../src/Surfnet/ServiceProviderDashboard/Infrastructure/DashboardBundle/Validator/Constraints/ValidLogoValidator.php',
];
$ignoreErrors[] = [
'message' => '#^Access to an undefined property Symfony\\\\Component\\\\Validator\\\\Constraint\\:\\:\\$protocols\\.$#',
'count' => 1,
Expand Down
37 changes: 1 addition & 36 deletions src/Surfnet/ServiceProviderDashboard/Application/Metadata/JsonGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ private function generateMetadataFields(ManageEntity $entity): array
$metadata['coin:exclude_from_push'] = '0';
}
if ($entity->getMetaData()->getLogo() instanceof Logo && $entity->getMetaData()->getLogo()->getUrl() !== '') {
$metadata = array_merge($metadata, $this->generateLogoMetadata($entity));
$metadata['logo:0:url'] = $entity->getMetaData()->getLogo()->getUrl();
}
if ($entity->getMetaData()?->getCoin()->getContractualBase() !== null) {
$metadata['coin:contractual_base'] = $entity->getMetaData()->getCoin()->getContractualBase();
Expand Down Expand Up @@ -308,41 +308,6 @@ private function generateContactMetadata(string $contactType, int $index, Contac
return $metadata;
}

/**
* Generate logo metadata fields.
*
* Logo dimensions are required in the SAML spec. They are always present,
* except when the user just created the entity in the interface. We
* determine the dimensions in those situations.
*
* @SuppressWarnings(PHPMD.ErrorControlOperator)
*/
private function generateLogoMetadata(ManageEntity $entity): array
{
$logo = $entity->getMetaData()->getLogo();
$metadata = [];
if ($logo) {
$metadata = [
'logo:0:url' => $logo->getUrl(),
];

$logoData = @getimagesize(
$logo->getUrl()
);

if ($logoData !== false) {
[$width, $height] = $logoData;
} else {
$width = 50;
$height = 50;
}

$metadata['logo:0:width'] = (string)$width;
$metadata['logo:0:height'] = (string)$height;
}
return $metadata;
}

private function generateAclData(ManageEntity $entity): array
{
if ($entity->getAllowedIdentityProviders()->isAllowAll()) {
Expand Down
33 changes: 1 addition & 32 deletions ...rviceProviderDashboard/Application/Metadata/OauthClientCredentialsClientJsonGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ private function generateMetadataFields(ManageEntity $entity): int|float|array
$metadata += $this->generateOidcClient($entity);

if ($entity->getMetaData()->getLogo() instanceof Logo && $entity->getMetaData()->getLogo()->getUrl() !== '') {
$metadata += $this->generateLogoMetadata($entity);
$metadata['logo:0:url'] = $entity->getMetaData()->getLogo()->getUrl();
}

return $metadata;
Expand Down Expand Up @@ -288,37 +288,6 @@ private function generateContactMetadata(string $contactType, int $index, Contac
return $metadata;
}

/**
* Generate logo metadata fields.
*
* Logo dimensions are required in the SAML spec. They are always present,
* except when the user just created the entity in the interface. We
* determine the dimensions in those situations.
*
* @SuppressWarnings(PHPMD.ErrorControlOperator)
*/
private function generateLogoMetadata(ManageEntity $entity): array
{
$logoUrl = $entity->getMetaData()->getLogo()->getUrl();
$metadata = [
'logo:0:url' => $logoUrl,
];

$logoData = @getimagesize($logoUrl);

if ($logoData !== false) {
[$width, $height] = $logoData;
} else {
$width = 50;
$height = 50;
}

$metadata['logo:0:width'] = (string) $width;
$metadata['logo:0:height'] = (string) $height;

return $metadata;
}

private function generateAclData(ManageEntity $entity): array
{
$acl = $entity->getAllowedIdentityProviders();
Expand Down
33 changes: 1 addition & 32 deletions src/Surfnet/ServiceProviderDashboard/Application/Metadata/OidcngJsonGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ private function generateMetadataFields(ManageEntity $entity): int|float|array
$metadata += $this->generateOidcClient($entity);

if ($entity->getMetaData()->getLogo() instanceof Logo && $entity->getMetaData()->getLogo()->getUrl() !== '') {
$metadata += $this->generateLogoMetadata($entity);
$metadata['logo:0:url'] = $entity->getMetaData()->getLogo()->getUrl();
}
if ($entity->getMetaData()?->getCoin()->getContractualBase() !== null) {
$metadata['coin:contractual_base'] = $entity->getMetaData()->getCoin()->getContractualBase();
Expand Down Expand Up @@ -297,37 +297,6 @@ private function generateContactMetadata(string $contactType, int $index, Contac
return $metadata;
}

/**
* Generate logo metadata fields.
*
* Logo dimensions are required in the SAML spec. They are always present,
* except when the user just created the entity in the interface. We
* determine the dimensions in those situations.
*
* @SuppressWarnings(PHPMD.ErrorControlOperator)
*/
private function generateLogoMetadata(ManageEntity $entity): array
{
$logoUrl = $entity->getMetaData()->getLogo()->getUrl();
$metadata = [
'logo:0:url' => $logoUrl,
];

$logoData = @getimagesize($logoUrl);

if ($logoData !== false) {
[$width, $height] = $logoData;
} else {
$width = 50;
$height = 50;
}

$metadata['logo:0:width'] = (string) $width;
$metadata['logo:0:height'] = (string) $height;

return $metadata;
}

private function generateAclData(ManageEntity $entity): array
{
$acl = $entity->getAllowedIdentityProviders();
Expand Down
12 changes: 8 additions & 4 deletions ...viceProviderDashboard/Infrastructure/DashboardBundle/Service/CurlLogoValidationHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,26 @@ public function __construct(private readonly LoggerInterface $logger)
* Using Curl: tests:
* - is the curl response code erroneous (>= 400)
* - if the content type is correct
* Returns the location where the logo is stored temporarily
*
* @param $url
* @throws LogoInvalidTypeException
* @throws LogoNotFoundException
*/
public function validateLogo($url): void
public function validateLogo($url): string
{
$this->logger->debug(sprintf('Validating logo: "%s" using curl', $url));

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_VERBOSE, 1);
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);

curl_exec($ch);
$content = curl_exec($ch);
$fileLocation = '/tmp/logo-validation-' . uniqid();
file_put_contents($fileLocation, $content);

$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
$responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
Expand All @@ -76,5 +78,7 @@ public function validateLogo($url): void
$this->logger->info('The logo file type is invalid');
throw new LogoInvalidTypeException('The logo file type is invalid');
}

return $fileLocation;
}
}
4 changes: 2 additions & 2 deletions ...roviderDashboard/Infrastructure/DashboardBundle/Service/LogoValidationHelperInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ interface LogoValidationHelperInterface

/**
* Validates the logo, throws an exception if validation failed.
*
* Returns the local path to the curl'ed image
* @param $url
* @throws LogoInvalidTypeException
* @throws LogoNotFoundException
*/
public function validateLogo($url);
public function validateLogo($url): string;
}
8 changes: 4 additions & 4 deletions ...iderDashboard/Infrastructure/DashboardBundle/Validator/Constraints/ValidLogoValidator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ public function __construct(private readonly LogoValidationHelperInterface $logo
{
}

public function validate($value, Constraint $constraint): void
public function validate(mixed $value, Constraint $constraint): void
{
if (empty($value)) {
return;
}

try {
$this->logoValidationHelper->validateLogo($value);
$this->getImageSizeValidation($value, $constraint);
$filePath = $this->logoValidationHelper->validateLogo($value);
$this->getImageSizeValidation($filePath, $constraint);
} catch (LogoNotFoundException) {
$this->context->addViolation(self::STATUS_DOWNLOAD_FAILED);
return;
Expand All @@ -64,7 +64,7 @@ public function validate($value, Constraint $constraint): void
*
* @param $value
*/
private function getImageSizeValidation($value, Constraint $constraint): void
private function getImageSizeValidation(string $value, Constraint $constraint): void
{
try {
$imgData = getimagesize($value);
Expand Down
6 changes: 3 additions & 3 deletions ...tegration/Infrastructure/DashboardBundle/Validator/Constraints/ValidLogoValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public function test_success_png()

$this->validationHelper
->shouldReceive('validateLogo')
->andReturn(null);
->andReturn('file://'.__DIR__.'/fixture/logo_validator/small.png');

$this->validator->validate('file://'.__DIR__.'/fixture/logo_validator/small.png', $constraint);

Expand All @@ -60,7 +60,7 @@ public function test_success_gif()

$this->validationHelper
->shouldReceive('validateLogo')
->andReturn(null);
->andReturn('file://'.__DIR__.'/fixture/logo_validator/small.gif');

$this->validator->validate('file://'.__DIR__.'/fixture/logo_validator/small.gif', $constraint);

Expand All @@ -81,7 +81,7 @@ public function test_invalid_image()

$this->validationHelper
->shouldReceive('validateLogo')
->andReturn(null);
->andReturn('file://'.__DIR__.'/fixture/logo_validator/ufjd');

$this->validator->validate('ufjd', $constraint);

Expand Down
Loading