Merge branch 'release/2.0.2'

Author: mikaelcom

.php_cs

@@ -7,25 +7,6 @@ $finder = PhpCsFixer\Finder::create()
 return PhpCsFixer\Config::create()
     ->setUsingCache(false)
     ->setRules(array(
-        '@PSR2' => true,
         '@PhpCsFixer' => true,
-        'array_syntax' => [
-            'syntax' => 'short',
-        ],
-        'binary_operator_spaces' => true,
-        'no_whitespace_in_blank_line' => true,
-        'ternary_operator_spaces' => true,
-        'cast_spaces' => true,
-        'trailing_comma_in_multiline_array' => true,
-        'concat_space' => [
-            'spacing' => 'one',
-        ],
-        'blank_line_before_statement' => [
-            'statements' => [
-                'return',
-                'declare',
-            ],
-        ],
-        'php_unit_test_class_requires_covers' => false,
     ))
     ->setFinder($finder);

CHANGELOG.md

@@ -1,7 +1,14 @@
 # CHANGELOG
 
+## 2.0.2 - 2021/02/03
+- Review .php_cs settings, apply PHP CS Fixer
+- Fix minor typo
+
+## 2.0.1 - 2021/01/28
+- Improve Travis CI settings and badge
+
 ## 2.0.0 - 2021/01/26
-- use `splitbrain/phpfarm:jessie` as Docker image and fix docker image settings
+- Use `splitbrain/phpfarm:jessie` as Docker image and fix docker image settings
 - Code requires PHP >= 7.4
 - Code cleaning
 - Update README

src/Element.php

@@ -35,36 +35,26 @@ class Element
 
     /**
      * Array of attributes that must contains the element.
-     *
-     * @var array
      */
     protected array $attributes = [];
 
     /**
      * The namespace the element belongs to.
-     *
-     * @var string
      */
     protected string $namespace = '';
 
     /**
      * Nonce used to generate digest password.
-     *
-     * @var string
      */
     protected string $nonceValue;
 
     /**
      * Timestamp used to generate digest password.
-     *
-     * @var int
      */
     protected int $timestampValue;
 
     /**
      * Current DOMDocument used to generate XML content.
-     *
-     * @var DOMDocument|null
      */
     protected static ?DOMDocument $dom = null;
 
@@ -74,7 +64,8 @@ public function __construct(string $name, string $namespace, $value = null, arra
             ->setName($name)
             ->setNamespace($namespace)
             ->setValue($value)
-            ->setAttributes($attributes);
+            ->setAttributes($attributes)
+        ;
     }
 
     /**
@@ -93,7 +84,8 @@ protected function __toSend(bool $asDomElement = false)
         // Define element value, add attributes if there are any
         $this
             ->appendValueToElementToSend($this->getValue(), $element)
-            ->appendAttributesToElementToSend($element);
+            ->appendAttributesToElementToSend($element)
+        ;
 
         // Returns element content
         if ($asDomElement) {
@@ -108,7 +100,6 @@ public function getName(): string
         return $this->name;
     }
 
-
     public function setName($name): self
     {
         $this->name = $name;
@@ -185,8 +176,6 @@ public function setNonceValue(string $nonceValue): self
     }
 
     /**
-     * @param bool $formatted
-     *
      * @return int|string
      */
     public function getTimestampValue(bool $formatted = false)
@@ -203,8 +192,6 @@ public function setTimestampValue(int $timestampValue): self
 
     /**
      * Returns the element to send as WS-Security header.
-     *
-     * @return string
      */
     public function toSend(): string
     {
@@ -216,8 +203,7 @@ public function toSend(): string
     /**
      * Handle adding value to element according to the value type.
      *
-     * @param mixed       $value
-     * @param DOMElement $element
+     * @param mixed $value
      *
      * @return Element
      */
@@ -269,26 +255,25 @@ protected function appendAttributesToElementToSend(DOMElement $element): self
 
     /**
      * Returns the name with its namespace.
-     *
-     * @return string
      */
     protected function getNamespacedName(): string
     {
         return sprintf('%s:%s', $this->getNamespacePrefix(), $this->getName());
     }
 
-    /**
-     * @return string
-     */
     private function getNamespacePrefix(): string
     {
         $namespacePrefix = '';
+
         switch ($this->getNamespace()) {
             case self::NS_WSSE:
                 $namespacePrefix = self::NS_WSSE_NAME;
+
                 break;
+
             case self::NS_WSSU:
                 $namespacePrefix = self::NS_WSSU_NAME;
+
                 break;
         }
 

src/Password.php

@@ -21,7 +21,8 @@ public function __construct(string $password, string $typeValue = self::TYPE_PAS
         $this
             ->setTypeValue($typeValue)
             ->setTimestampValue($timestampValue ? $timestampValue : time())
-            ->setNonceValue((string) mt_rand());
+            ->setNonceValue((string) mt_rand())
+        ;
 
         parent::__construct(self::NAME, $namespace, $this->convertPassword($password), [
             self::ATTRIBUTE_TYPE => $typeValue,
@@ -39,16 +40,13 @@ public function convertPassword(string $password): string
 
     /**
      * When generating the password digest, we define values (nonce and timestamp) that can be used in other place.
-     *
-     * @param string $password
-     * @return string
      */
     public function digestPassword(string $password): string
     {
         $packedNonce = pack('H*', $this->getNonceValue());
         $packedTimestamp = pack('a*', $this->getTimestampValue(true));
         $packedPassword = pack('a*', $password);
-        $hash = sha1($packedNonce . $packedTimestamp . $packedPassword);
+        $hash = sha1($packedNonce.$packedTimestamp.$packedPassword);
         $packedHash = pack('H*', $hash);
 
         return base64_encode($packedHash);

src/Security.php

@@ -25,11 +25,11 @@ public function __construct(bool $mustUnderstand = false, ?string $actor = null,
         parent::__construct(self::NAME, $namespace);
 
         if (true === $mustUnderstand) {
-            $this->setAttribute($envelopeNamespace . self::ATTRIBUTE_MUST_UNDERSTAND, $mustUnderstand);
+            $this->setAttribute($envelopeNamespace.self::ATTRIBUTE_MUST_UNDERSTAND, $mustUnderstand);
         }
 
         if (!empty($actor)) {
-            $this->setAttribute($envelopeNamespace . self::ATTRIBUTE_ACTOR, $actor);
+            $this->setAttribute($envelopeNamespace.self::ATTRIBUTE_ACTOR, $actor);
         }
     }
 

src/WsSecurity.php

@@ -19,7 +19,7 @@ protected function __construct(
         int $addExpires = 0,
         bool $mustUnderstand = false,
         ?string $actor = null,
-        ?String $usernameId = null,
+        ?string $usernameId = null,
         bool $addNonce = true,
         string $envelopeNamespace = Security::ENV_NAMESPACE
     ) {
@@ -46,7 +46,7 @@ public static function createWsSecuritySoapHeader(
         int $addExpires = 0,
         bool $returnSoapHeader = true,
         bool $mustUnderstand = false,
-        ?String $actor = null,
+        ?string $actor = null,
         ?string $usernameId = null,
         bool $addNonce = true,
         string $envelopeNamespace = Security::ENV_NAMESPACE
@@ -102,7 +102,7 @@ protected function setCreated(int $addCreated): self
     {
         $passwordDigest = $this->getPassword()->getTypeValue();
         $timestampValue = $this->getPassword()->getTimestampValue();
-        if (($addCreated || Password::TYPE_PASSWORD_DIGEST === $passwordDigest) && $timestampValue > 0) {
+        if (($addCreated || Password::TYPE_PASSWORD_DIGEST === $passwordDigest) && 0 < $timestampValue) {
             $this->getUsernameToken()->setCreated(new Created($timestampValue));
         }
 

tests/WsSecurityTest.php

@@ -9,6 +9,7 @@
 
 /**
  * @internal
+ * @coversDefaultClass
  */
 final class WsSecurityTest extends TestCase
 {