Merge branch 'master' into fetch-with-include

Author: mtrezza

.github/workflows/ci.yml

@@ -26,11 +26,12 @@ jobs:
     strategy:
       matrix:
         include:
-          - name: PHP 8.1
-            PHP_VERSION: 8.1
           - name: PHP 8.2
             PHP_VERSION: 8.2
+          - name: PHP 8.1
+            PHP_VERSION: 8.1
       fail-fast: false
+    name: Test ${{ matrix.name }}
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js

README.md

@@ -24,6 +24,7 @@ A library that gives you access to the powerful Parse Server backend from your P
 
 ## Table of Contents <!-- omit in toc -->
 
+- [Compatibility](#compatibility)
 - [Installation](#installation)
   - [Install with Composer](#install-with-composer)
   - [Install with Git](#install-with-git)
@@ -64,6 +65,15 @@ A library that gives you access to the powerful Parse Server backend from your P
   - [Logs](#logs)
 - [Contributing / Testing](#contributing--testing)
 
+## Compatibility
+
+The Parse PHP SDK is continuously tested with the most recent releases of PHP to ensure compatibility. We follow the [PHP Long Term Support plan](https://www.php.net/supported-versions.php) and only test against versions that are officially supported and have not reached their end-of-life date.
+
+| Version | End-of-Life | Compatible |
+|---------|-------------|------------|
+| PHP 8.2 | Dec 2024    | ✅ Yes      |
+| PHP 8.1 | Nov 2023    | ✅ Yes      |
+
 ## Installation
 There are various ways to install and use this sdk. We'll elaborate on a couple here.
 Note that the Parse PHP SDK requires PHP 5.4 or newer. It can also run on HHVM (recommended 3.0 or newer).

src/Parse/HttpClients/ParseCurlHttpClient.php

@@ -306,6 +306,18 @@ public function setCAFile($caFile)
         $this->parseCurl->setOption(CURLOPT_CAINFO, $caFile);
     }
 
+    /**
+     * Sets multiple curl options
+     * https://www.php.net/manual/en/function.curl-setopt.php
+     *
+     * @param array $options    Array of options to set
+     * @throws ParseException
+     */
+    public function setHttpOptions($options)
+    {
+        $this->parseCurl->setOptionsArray($options);
+    }
+
     /**
      * Gets the error code
      *

src/Parse/HttpClients/ParseHttpable.php

@@ -63,6 +63,13 @@ public function setTimeout($timeout);
      */
     public function setCAFile($caFile);
 
+    /**
+     * Sets http options to pass to the http client
+     *
+     * @param string $httpOptions    Options to set
+     */
+    public function setHttpOptions($httpOptions);
+
     /**
      * Gets the error code
      *

src/Parse/HttpClients/ParseStreamHttpClient.php

@@ -78,6 +78,13 @@ class ParseStreamHttpClient implements ParseHttpable
      */
     private $caFile;
 
+    /**
+     * Options to pass to the stream context.
+     *
+     * @var array
+     */
+    private $httpOptions;
+
     /**
      * Optional timeout for this request
      *
@@ -195,6 +202,12 @@ public function send($url, $method = 'GET', $data = array())
             $this->options['ssl']['cafile'] = $this->caFile;
         }
 
+        if (isset($this->httpOptions)) {
+            foreach ($this->httpOptions as $key => $value) {
+                $this->options[$key] = $value;
+            }
+        }
+
         // add additional options for this request
         $this->options['http'] = array(
             'method'        => $method,
@@ -264,6 +277,7 @@ public function send($url, $method = 'GET', $data = array())
 
         // clear options
         $this->options = array();
+        $this->httpOptions = array();
 
         // flush our existing headers
         $this->headers = array();
@@ -348,6 +362,17 @@ public function setCAFile($caFile)
         $this->caFile = $caFile;
     }
 
+    /**
+     * Sets http options to pass to the stream context
+     * https://www.php.net/manual/en/context.php
+     *
+     * @param array $httpOptions    options to set
+     */
+    public function setHttpOptions($httpOptions)
+    {
+        $this->httpOptions = $httpOptions;
+    }
+
     /**
      * Sets the request timeout
      *

src/Parse/ParseClient.php

@@ -103,6 +103,13 @@ final class ParseClient
      */
     private static $caFile;
 
+    /**
+     * Options to pass to the http client.
+     *
+     * @var array
+     */
+    private static $httpOptions;
+
     /**
      * Constant for version string to include with requests.
      *
@@ -301,6 +308,21 @@ public static function setCAFile($caFile)
         self::$caFile = $caFile;
     }
 
+    /**
+     * Sets http options to pass to the http client
+     * For curl
+     * https://www.php.net/manual/en/function.curl-setopt.php
+     *
+     * For stream context
+     * https://www.php.net/manual/en/context.php
+     *
+     * @param array $httpOptions    options to set
+     */
+    public static function setHttpOptions($httpOptions)
+    {
+        self::$httpOptions = $httpOptions;
+    }
+
     /**
      * ParseClient::_encode, internal method for encoding object values.
      *
@@ -452,6 +474,9 @@ private static function getPreparedHttpClient()
             // set CA file
             $httpClient->setCAFile(self::$caFile);
         }
+        if (isset(self::$httpOptions)) {
+            $httpClient->setHttpOptions(self::$httpOptions);
+        }
 
         return $httpClient;
     }

tests/Parse/Helper.php

@@ -105,4 +105,10 @@ public static function print($text)
     {
         fwrite(STDOUT, $text . "\n");
     }
+
+    public static function printArray($array)
+    {
+        print_r($array);
+        ob_end_flush();
+    }
 }

tests/Parse/ParseClientTest.php

@@ -16,6 +16,8 @@
 
 use PHPUnit\Framework\TestCase;
 
+defined('CURLOPT_PINNEDPUBLICKEY') || define('CURLOPT_PINNEDPUBLICKEY', 10230);
+
 class ParseClientTest extends TestCase
 {
     public static function setUpBeforeClass() : void
@@ -35,6 +37,9 @@ public function tearDown() : void
 
         // unset CA file
         ParseClient::setCAFile(null);
+
+        // unset http options
+        ParseClient::setHttpOptions(null);
     }
 
     /**
@@ -667,4 +672,52 @@ public function testCheckBadServer()
             $this->assertTrue(isset($health['error_message']));
         }
     }
+
+    /**
+     * @group test-http-options
+     */
+    public function testCurlHttpOptions()
+    {
+        if (function_exists('curl_init')) {
+            ParseClient::setHttpClient(new ParseCurlHttpClient());
+            ParseClient::setServerURL('https://localhost:1338', 'parse');
+            ParseClient::setHttpOptions([
+                CURLOPT_SSL_VERIFYPEER => false,
+                CURLOPT_PINNEDPUBLICKEY => 'sha256//Oz+R70/uIv0irdBWc7RNPyCGeZNbN+CBiPLjJxXWigg=',
+                CURLOPT_SSLCERT => dirname(__DIR__).'/keys/client.crt',
+                CURLOPT_SSLKEY => dirname(__DIR__).'/keys/client.key',
+            ]);
+            $health = ParseClient::getServerHealth();
+
+            $this->assertNotNull($health);
+            $this->assertEquals($health['status'], 200);
+            $this->assertEquals($health['response']['status'], 'ok');
+            Helper::setServerURL();
+        }
+    }
+
+    /**
+     * @group test-http-options
+     */
+    public function testStreamHttpOptions()
+    {
+        ParseClient::setHttpClient(new ParseStreamHttpClient());
+        ParseClient::setServerURL('https://localhost:1338', 'parse');
+        ParseClient::setHttpOptions([
+            'ssl' => [
+                'verify_peer' => false,
+                'verify_peer_name' => false,
+                'allow_self_signed' => true,
+                'local_cert' => dirname(__DIR__).'/keys/client.crt',
+                'local_pk' => dirname(__DIR__).'/keys/client.key',
+                'peer_fingerprint' => '29F36676EFA0CA18B5B571C6144580044CB289C2',
+            ]
+        ]);
+        $health = ParseClient::getServerHealth();
+
+        $this->assertNotNull($health);
+        $this->assertEquals($health['status'], 200);
+        $this->assertEquals($health['response']['status'], 'ok');
+        Helper::setServerURL();
+    }
 }

tests/gencerts.sh

@@ -0,0 +1,75 @@
+#!/bin/bash
+# https://gist.github.com/ryankurte/bc0d8cff6e73a6bb1950
+# https://curl.se/libcurl/c/CURLOPT_PINNEDPUBLICKEY.html
+# ./gencerts.sh parseca localhost parsephp keys/
+# ./gencerts.sh parseca client parsephp keys/
+
+set -e
+
+if [ "$#" -ne 3 ] && [ "$#" -ne 4 ]; then 
+  echo "Usage: $0 CA NAME ORG"
+  echo "CA - name of fake CA"
+  echo "NAME - name of fake client"
+  echo "ORG - organisation for both"
+  echo "[DIR] - directory for cert output"
+  exit
+fi
+
+CA=$1
+NAME=$2
+ORG=$3
+
+if [ -z "$4" ]; then
+  DIR=./
+else
+  DIR=$4
+fi
+
+if [ ! -d "$DIR" ]; then
+  mkdir -p $DIR
+fi
+
+LENGTH=4096
+DAYS=1000
+
+SUBJECT=/C=NZ/ST=AKL/L=Auckland/O=$ORG
+
+if [ ! -f "$DIR/$CA.key" ]; then
+
+  echo Generating CA
+  openssl genrsa -out $DIR/$CA.key $LENGTH
+
+  echo Signing CA
+  openssl req -x509 -new -nodes -key $DIR/$CA.key -sha256 -days 1024 -out $DIR/$CA.crt -subj $SUBJECT/CN=$CA
+
+  openssl x509 -in $DIR/$CA.crt -out $DIR/$CA.pem -text
+  openssl x509 -sha1 -noout -in $DIR/$CA.pem -fingerprint | sed 's/SHA1 Fingerprint=//g' >> $DIR/$CA.fp
+
+else
+  echo Located existing CA
+fi
+
+if [ ! -f "$DIR/$NAME.key" ]; then
+
+echo Generating keys
+openssl genrsa -out $DIR/$NAME.key $LENGTH
+
+echo Generating CSR
+openssl req -new -out $DIR/$NAME.csr -key $DIR/$NAME.key -subj $SUBJECT/CN=$NAME
+
+echo Signing cert
+openssl x509 -req -days $DAYS -in $DIR/$NAME.csr -out $DIR/$NAME.crt -CA $DIR/$CA.crt -CAkey $DIR/$CA.key -CAcreateserial
+
+echo Generating PEM
+openssl x509 -in $DIR/$NAME.crt -out $DIR/$NAME.pem -text
+
+openssl x509 -sha1 -noout -in $DIR/$NAME.pem -fingerprint | sed 's/SHA1 Fingerprint=//g' > $DIR/$NAME.fp
+
+echo Cleaning Up
+rm $DIR/*.csr
+
+else
+  echo Located existing client certificate
+fi
+
+echo Done

tests/keys/client.crt

@@ -0,0 +1,30 @@
+-----BEGIN CERTIFICATE-----
+MIIFITCCAwkCCQDEwoQengRnzDANBgkqhkiG9w0BAQsFADBTMQswCQYDVQQGEwJO
+WjEMMAoGA1UECAwDQUtMMREwDwYDVQQHDAhBdWNrbGFuZDERMA8GA1UECgwIcGFy
+c2VwaHAxEDAOBgNVBAMMB3BhcnNlY2EwHhcNMjMwNTEyMjA0MzAzWhcNMjYwMjA1
+MjA0MzAzWjBSMQswCQYDVQQGEwJOWjEMMAoGA1UECAwDQUtMMREwDwYDVQQHDAhB
+dWNrbGFuZDERMA8GA1UECgwIcGFyc2VwaHAxDzANBgNVBAMMBmNsaWVudDCCAiIw
+DQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMlKDLogZSNxm5S4h97XM8A1+MsP
+RaK15g8ebVEP7OGrwX1bvLVis0U/ixwHs0mqjQ9tbuefMZyiRgdds+8tpRCCuqGo
+dwSk8YMmOlrF5xIpBT2cXJLhGvDyY0F0RLFZYBoioTYFth4i91DkzhmBaL6vjyB7
+dXduR1JQbzTpQHkhofPziQsNtinf8qBqLbH1dFaqwUUEgtsKJyaPlxJR21TF3Fv+
+2K/fmoyzP6Er7eUSCvJRRH1hCwzHxl7GqTKyQeaS1RLdrHYqZmSeiJpxwl8uSdBs
+x4y8wG4lhRdantCCANlTwLd7zPiuIu+RBP276o2+02K8my9N2STZUgHXefSoNx4M
+alYujKBUV+2qmhR9H2HlUB/C/h5Sb8PSlfWyD/bo3+agyw/1+9rfMUYCmiEtdik7
+amoBaahoqAHL8S3K19L0ytWkgFejSMzn+i4VDifnwupXHifDL7CPDX0vevFNDvC7
+HMLkBWmkNaTduDL5P3ximtIXE7akhK+ufiNoO3KLItenCENxCzUdNdDHguei2U5E
+vhTyaTmIIrkUGxQ+aVDXRF2njAeQNMdTjsCAiiSN1corYX8RXvNo8QZQUEaHG42u
+O6Yolsw8EZotbpExo1jbiDlI2pVIuwJdtaDCucPN/X6uZ8odGQ0LUeyTBYda/1OG
+VIQzPZnxSHzqPzuZAgMBAAEwDQYJKoZIhvcNAQELBQADggIBAHOLgs6FLIv+Vvpx
+fNtwabgOI2JxkFwaAujwWJS10tmczJp9qZilOlVBBhDFRBwBKqAaanHKCYkEfP6u
+dgC8RMOOYOb0gk6Tj3+zhvM4Qz+n8Cn2fA2+EtFXTKyMfJHuG/zddTLep2Phh9c9
+t5s/8aHAuqM9RGiA66V7mJiR9G5E8cNpyHniCh8Z11kABPMzAy92LyEGUlRwCrWx
+fCwItnzY2/7J8IW20rPIpb0EWmYHhxkUUzu7APQgvJpAUTdhmVKb9GLCUyY+oICE
+1WrnV9OQiqYVGFQkry9FXyKbsLVM6b6ar8DIXpYTYnd11sqFdiUUo4oItYYrO/1O
+0Bt0PX6hWYjR4r7ZT23KWAHZdlU4EFfrLJeZ6HDeYttJF68x9s8RZGgVU9Xlb/7X
+KGRVyCWI7aWzvI1lBVAnc7b7B9LrIkdHnYDt/ettmRvI/zZRBh73T7EPOQB7bEzP
+M8BXfAr/+qa2ToBWNd9AJrw7rg+OWGD801iXqsREyLr15nRIR12mGdKuyMkfghk1
+9J1Sd0fkfB2ci7Rn3afRdKksGuADQ2fvYihw0lALOPzSq/FYRqZBzwv9Qmw43CKd
+euEPcCfT7VYY47lmfFfKBcVv8d7NiJZRGkIUYUxS/UAsrLiBCgRkaUACcbLok7sJ
+jrdaTDx4EZu93dmJbEozNO6dRiLb
+-----END CERTIFICATE-----

tests/keys/client.der

@@ -0,0 +1 @@
+D7:10:BE:24:E6:85:A2:F8:79:F8:36:EF:42:A0:EC:B3:EC:93:C2:FB