package updates

2018-12-19 23:27:43 -06:00
parent aa1da4d4fb
commit 1ffd21369f
1181 changed files with 51194 additions and 11046 deletions
@@ -0,0 +1,136 @@
+<?php
+/**
+ * Nexmo Client Library for PHP
+ *
+ * @copyright Copyright (c) 2016 Nexmo, Inc. (http://nexmo.com)
+ * @license   https://github.com/Nexmo/nexmo-php/blob/master/LICENSE.txt MIT License
+ */
+
+namespace Nexmo\Client;
+
+use Nexmo\Client\Exception\Exception;
+
+class Signature
+{
+    /**
+     * Params to Sign
+     * @var array
+     */
+    protected $params;
+
+    /**
+     * Params with Signature (and timestamp if not present)
+     * @var array
+     */
+    protected $signed;
+
+    /**
+     * Create a signature from a set of parameters.
+     *
+     * @param array $params
+     * @param $secret
+     */
+    public function __construct(array $params, $secret, $signatureMethod)
+    {
+        $this->params = $params;
+        $this->signed = $params;
+
+        if(!isset($this->signed['timestamp'])){
+            $this->signed['timestamp'] = time();
+        }
+
+        //remove signature if present
+        unset($this->signed['sig']);
+
+        //sort params
+        ksort($this->signed);
+
+        $signed = [];
+        foreach ($this->signed as $key => $value) {
+            $signed[$key] = str_replace(array("&", "="), "_", $value);
+        }
+
+        //create base string
+        $base = '&'.urldecode(http_build_query($signed));
+
+        $this->signed['sig'] = $this->sign($signatureMethod, $base, $secret);
+    }
+
+    protected function sign($signatureMethod, $data, $secret) {
+       switch($signatureMethod) {
+            case 'md5hash':
+                // md5hash needs the secret appended
+                $data .= $secret;
+                return md5($data);
+                break;
+            case 'md5':
+            case 'sha1':
+            case 'sha256':
+            case 'sha512':
+                return hash_hmac($signatureMethod, $data, $secret);
+                break;
+            default:
+                throw new Exception('Unknown signature algorithm: '.$signatureMethod.'. Expected: md5hash, md5, sha1, sha256, or sha512');
+        }
+    }
+
+    /**
+     * Get the original parameters.
+     *
+     * @return array
+     */
+    public function getParams()
+    {
+        return $this->params;
+    }
+
+    /**
+     * Get the signature for the parameters.
+     *
+     * @return string
+     */
+    public function getSignature()
+    {
+        return $this->signed['sig'];
+    }
+
+    /**
+     * Get a full set of parameters including the signature and timestamp.
+     *
+     * @return array
+     */
+    public function getSignedParams()
+    {
+        return $this->signed;
+    }
+
+    /**
+     * Check that a signature (or set of parameters) is valid.
+     *
+     * @param array| string $signature
+     * @return bool
+     * @throws \InvalidArgumentException
+     */
+    public function check($signature)
+    {
+        if(is_array($signature) AND isset($signature['sig'])){
+            $signature = $signature['sig'];
+        }
+
+        if(!is_string($signature)){
+            throw new \InvalidArgumentException('signature must be string, or present in array or parameters');
+        }
+
+        return $signature == $this->signed['sig'];
+    }
+
+    /**
+     * Allow easy comparison.
+     * 
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->getSignature();
+    }
+}