CI Fixes and Changes

* Adding PHPMD
* Removing Phive config
* Fixing phpstan issue
* Minor refactoring for better code quality

.github/workflows/ci.yml

@@ -43,7 +43,9 @@ jobs:
  uses: codecov/codecov-action@v4
  with:
  token: ${{ secrets.CODECOV_TOKEN }}
- slug: phauthentic/authentication
+ slug: burzum/authentication
+ env:
+ CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
  validation:
  name: Coding Standard & Static Analysis

.scrutinizer.yml

@@ -1,43 +1,9 @@
 build:
  nodes:
- tests-php74:
- environment:
- php:
- version: '8.0'
- ini:
- phar.readonly: 'Off'
- pecl_extensions:
- - xdebug
- tests:
- override:
- -
- command: 'XDEBUG_MODE=coverage ./bin/phpunit --coverage-clover=coverage.xml'
- coverage:
- file: 'coverage.xml'
- format: 'php-clover'
- tests-php80:
- environment:
- php:
- version: '8.3'
- ini:
- phar.readonly: 'Off'
- pecl_extensions:
- - xdebug
- tests:
- override:
- -
- command: 'XDEBUG_MODE=coverage ./bin/phpunit --coverage-clover=coverage.xml'
- coverage:
- file: 'coverage.xml'
- format: 'php-clover'
  validation:
  tests:
  override:
  - php-scrutinizer-run --enable-security-analysis
- -
- command: './bin/phpcs'
- -
- command: './bin/phpstan'
 filter:
  excluded_paths:
  - 'tests/*'

composer.json

@@ -22,6 +22,7 @@
  "firebase/php-jwt": "6.*",
  "misantron/dbunit": "dev-master",
  "nyholm/psr7": "^1.8",
+ "phpmd/phpmd": "^2.15",
  "phpstan/phpstan": "^1.10",
  "phpunit/phpunit": "^9.5",
  "squizlabs/php_codesniffer": "^3.9"
@@ -56,7 +57,9 @@
  "cs-check": "phpcs --colors -p src/ tests/",
  "cs-fix": "phpcbf --colors src/ tests/",
  "test": "phpunit",
- "test-coverage": "phpunit --coverage-clover=clover.xml"
+ "test-coverage": "phpunit --coverage-clover=clover.xml",
+ "phpmd": "bin/phpmd src/ text phpmd.xml.dist",
+ "phpmd-baseline": "bin/phpmd --generate-baseline --baseline-file phpmd.baseline.xml src/ text phpmd.xml.dist"
  },
  "config": {
  "sort-packages": true,

phpmd.baseline.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<phpmd-baseline>
+ <violation rule="PHPMD\Rule\Design\CouplingBetweenObjects" file="src/AuthenticationService.php"/>
+ <violation rule="PHPMD\Rule\CleanCode\StaticAccess" file="src/Authenticator/JwtAuthenticator.php"/>
+ <violation rule="PHPMD\Rule\UnusedFormalParameter" file="src/Identifier/Ldap/ExtensionAdapter.php"/>
+ <violation rule="PHPMD\Rule\UnusedFormalParameter" file="src/Identity/Identity.php"/>
+</phpmd-baseline>

phpmd.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<ruleset name="My first PHPMD rule set"
+ xmlns="http://pmd.sf.net/ruleset/1.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
+ http://pmd.sf.net/ruleset_xml_schema.xsd"
+ xsi:noNamespaceSchemaLocation="
+ http://pmd.sf.net/ruleset_xml_schema.xsd">
+ <description>
+ PHPMD Rules
+ </description>
+
+ <rule ref="rulesets/codesize.xml" />
+ <rule ref="rulesets/cleancode.xml" />
+ <rule ref="rulesets/design.xml">
+ </rule>
+ <rule ref="rulesets/naming.xml">
+ <exclude name="LongVariable"/>
+ <exclude name="LongClassName"/>
+ </rule>
+ <rule ref="rulesets/unusedcode.xml" />
+</ruleset>

src/Authenticator/HttpDigestAuthenticator.php

@@ -285,6 +285,16 @@ protected function getDigestOptions(ServerRequestInterface $request): array
  ];
  }
 
+ protected function formatOptions(string $key, mixed $value): string
+ {
+ if (is_bool($value)) {
+ $value = $value ? 'true' : 'false';
+ return sprintf('%s=%s', $key, $value);
+ }
+
+ return sprintf('%s="%s"', $key, $value);
+ }
+
  /**
  * Generate the login headers
  *
@@ -300,17 +310,12 @@ protected function loginHeaders(ServerRequestInterface $request): array
  $options['stale'] = true;
  }
 
- $opts = [];
- foreach ($options as $k => $v) {
- if (is_bool($v)) {
- $v = $v ? 'true' : 'false';
- $opts[] = sprintf('%s=%s', $k, $v);
- } else {
- $opts[] = sprintf('%s="%s"', $k, $v);
- }
+ $formattedOptions = [];
+ foreach ($options as $key => $value) {
+ $formattedOptions[] = $this->formatOptions($key, $value);
  }
 
- return ['WWW-Authenticate' => 'Digest ' . implode(',', $opts)];
+ return ['WWW-Authenticate' => 'Digest ' . implode(',', $formattedOptions)];
  }
 
  /**

src/Identifier/Ldap/ExtensionAdapter.php

@@ -130,6 +130,7 @@ public function setOption(int $option, $value)
  */
  public function getOption($option)
  {
+ $returnValue = null;
  $this->setErrorHandler();
  ldap_get_option($this->getConnection(), $option, $returnValue);
  $this->unsetErrorHandler();

src/Middleware/AuthenticationErrorHandlerMiddleware.php

@@ -72,20 +72,20 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
  /**
  * Creates an unauthorized response.
  *
- * @param \Phauthentic\Authentication\Authenticator\Exception\UnauthorizedException $e Exception.
+ * @param \Phauthentic\Authentication\Authenticator\Exception\UnauthorizedException $exception Exception.
  * @return \Psr\Http\Message\ResponseInterface
  */
- protected function createUnauthorizedResponse(UnauthorizedException $e): ResponseInterface
+ protected function createUnauthorizedResponse(UnauthorizedException $exception): ResponseInterface
  {
  $body = $this->streamFactory->createStream();
- $body->write($e->getBody());
+ $body->write($exception->getBody());
 
  $response = $this
  ->responseFactory
- ->createResponse($e->getCode())
+ ->createResponse($exception->getCode())
  ->withBody($body);
 
- foreach ($e->getHeaders() as $header => $value) {
+ foreach ($exception->getHeaders() as $header => $value) {
  $response = $response->withHeader($header, $value);
  }