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.

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

Don't require pdb-symfony-bridge #4

Merged
merged 1 commit into from
Dec 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ to these validators with the Symfony Validator component.
To install this package, add `rollerworks/x509-validator` to your composer.json:

```bash
$ php composer.phar require rollerworks/x509-validator
php composer.phar require rollerworks/x509-validator
```

Now, [Composer][composer] will automatically download all required files,
Expand Down
8 changes: 8 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
UPGRADE
=======

## Upgrade FROM 0.1.0 to 0.2.0

* The `CertificateValidator` now expects a `\Pdp\PublicSuffixList` instance
is passed as first argument, instead of a
`Rollerworks\Component\PdbSfBridge\PdpManager` instance;
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@
"mlocati/ocsp": "^1.0",
"psr/clock": "^1.0",
"rollerworks/pdb-symfony-bridge": "^1.0",
"rollerworks/pdb-validator": "^1.0",
sstok marked this conversation as resolved.
Show resolved Hide resolved
"symfony/translation-contracts": "^2.5 || ^3.0"
},
"require-dev": {
"paragonie/hidden-string": "^2.0",
"phpspec/prophecy-phpunit": "^2.0",
"phpunit/phpunit": "^10.4.2",
"rollerscapes/standards": "^1.0",
"rollerworks/pdb-symfony-bridge": "^1.0",
"symfony/clock": "^6.3",
"symfony/error-handler": "^6.3",
"symfony/http-client": "^6.3",
Expand Down
23 changes: 16 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@ See [Working with validation Violations] below.

## Using the CertificateValidator

Note that `CertificateValidator` requires a `Rollerworks\Component\PdbSfBridge\PdpManager`
instance, see https://github.com/rollerworks/PdbSfBridge to set-up a new instance.
Note that `CertificateValidator` requires a `Pdp\PublicSuffixList`
instance, see https://github.com/jeremykendall/php-domain-parser#usage
to set-up a new instance.

**Tip**: For Symfony use the https://github.com/rollerworks/PdbSfBridge
with out-of-the-box Framework integration.

The `CertificateValidator` validates:

Expand All @@ -42,13 +46,13 @@ The `CertificateValidator` validates:
or public-suffix length violations;

```php
use Rollerworks\Component\PdbSfBridge\PdpManager;
use Pdp\PublicSuffixList;
use Rollerworks\Component\X509Validator\CertificateValidator;

/** @var PdpManager $pdbManager */
$pdbManager = ...;
/** @var PublicSuffixList $publicSuffixList */
$publicSuffixList = ...;

$validator = new CertificateValidator($pdbManager, /*$dataExtractor*/);
$validator = new CertificateValidator($publicSuffixList, /*$dataExtractor*/);

// PEM X509 encoded certificate string
$certificate = '';
Expand Down Expand Up @@ -182,7 +186,12 @@ The `OCSPValidator` validates the revocation status of a certificate,
for this to work internet access is required, and the certificate must
have a CA.

First make sure the ``
First make sure the `symfony/http-client` package is installed, any
`Symfony\Contracts\HttpClient\HttpClientInterface` instance is accepted.

```bash
php composer.phar require symfony/http-client
```

This validator should be called after general validation with the `CertificateValidator`.

Expand Down
8 changes: 3 additions & 5 deletions src/CertificateValidator.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
namespace Rollerworks\Component\X509Validator;

use Pdp\Domain;
use Pdp\PublicSuffixList;
use Psr\Clock\ClockInterface;
use Rollerworks\Component\PdbSfBridge\PdpManager as PublicSuffixManager;
use Rollerworks\Component\X509Validator\Violation\CertificateHasExpired;
use Rollerworks\Component\X509Validator\Violation\GlobalWildcard;
use Rollerworks\Component\X509Validator\Violation\UnsupportedDomain;
Expand All @@ -40,7 +40,7 @@ class CertificateValidator
* @param CAResolver|null $caResolver Use a custom CAResolver that stores CAs
*/
public function __construct(
private readonly PublicSuffixManager $suffixManager,
private readonly PublicSuffixList $publicSuffixList,
X509DataExtractor $dataExtractor = null,
CAResolver $caResolver = null,
private ?ClockInterface $clock = null
Expand Down Expand Up @@ -94,8 +94,6 @@ private function validateSignatureAlgorithm(string $signatureType): void
/** @param array<array-key, string> $domains */
private function validateDomainsWildcard(array $domains): void
{
$rules = $this->suffixManager->getPublicSuffixList();

foreach ($domains as $domain) {
if (! str_contains($domain, '*')) {
continue;
Expand All @@ -105,7 +103,7 @@ private function validateDomainsWildcard(array $domains): void
throw new GlobalWildcard($domain, '*');
}

$domainInfo = $rules->resolve(Domain::fromIDNA2008($domain));
$domainInfo = $this->publicSuffixList->resolve(Domain::fromIDNA2008($domain));

if (! $domainInfo->suffix()->isKnown()) {
return;
Expand Down
12 changes: 6 additions & 6 deletions tests/CertificateValidatorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@

namespace Rollerworks\Component\X509Validator\Tests;

use Pdp\PublicSuffixList;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;
use Psr\Clock\ClockInterface;
use Rollerworks\Component\PdbSfBridge\PdpManager;
use Rollerworks\Component\PdbSfBridge\PdpMockProvider;
use Rollerworks\Component\X509Validator\CertificateValidator;
use Rollerworks\Component\X509Validator\TranslatableArgument;
Expand All @@ -38,7 +38,7 @@ final class CertificateValidatorTest extends TestCase
{
private ClockInterface $clock;
private CertificateValidator $certificateValidator;
private PdpManager $pdpManager;
private PublicSuffixList $publicSuffixList;

protected function setUp(): void
{
Expand All @@ -55,8 +55,8 @@ public function now(): \DateTimeImmutable
}
};

$this->pdpManager = PdpMockProvider::getPdpManager();
$this->certificateValidator = new CertificateValidator($this->pdpManager, clock: $this->clock);
$this->publicSuffixList = PdpMockProvider::getPdpManager()->getPublicSuffixList();
$this->certificateValidator = new CertificateValidator($this->publicSuffixList, clock: $this->clock);
}

#[Test]
Expand Down Expand Up @@ -143,7 +143,7 @@ public function validate_certificate_is_expired(): void
#[DataProvider('provideValidate_certificate_host_contains_global_wildcardCases')]
public function validate_certificate_host_contains_global_wildcard(array $domains, string $provided, string $suffixPattern): void
{
$this->certificateValidator = new FakedCertificateValidator($this->pdpManager);
$this->certificateValidator = new FakedCertificateValidator($this->publicSuffixList);
$this->certificateValidator->setFields([
'_domains' => $domains,
'_validTo' => new \DateTimeImmutable('+1 year'),
Expand Down Expand Up @@ -179,7 +179,7 @@ public static function provideValidate_certificate_host_contains_global_wildcard
#[DoesNotPerformAssertions]
public function validate_certificate_host_wildcard_without_known_prefix_does_not_fail(array $domains): void
{
$this->certificateValidator = new FakedCertificateValidator($this->pdpManager);
$this->certificateValidator = new FakedCertificateValidator($this->publicSuffixList);
$this->certificateValidator->setFields([
'_domains' => $domains,
'_validTo' => new \DateTimeImmutable('+1 year'),
Expand Down