Compare commits
No commits in common. "master" and "0.3.2" have entirely different histories.
|
|
@ -1,5 +1,3 @@
|
|||
secrets.php
|
||||
proxy/file_cache
|
||||
proxy/config.php
|
||||
debug.log
|
||||
.idea
|
||||
|
|
|
|||
|
|
@ -1,8 +0,0 @@
|
|||
# You may find this Dockerfile useful in development or production
|
||||
# From the CiviProxy directory
|
||||
# * Build a docker image with `docker build . -t civiproxy`
|
||||
# * Run a development container with `run -d -p 4050:80 -v $PWD/proxy:/var/www/html --name civiproxy civiproxy`
|
||||
|
||||
FROM php:7-apache
|
||||
|
||||
COPY proxy/ /var/www/html
|
||||
73
README.md
73
README.md
|
|
@ -1,8 +1,67 @@
|
|||
## About
|
||||
CiviProxy is a tool to set up a security proxy server specifically for your CiviCRM instance. It uses whitelisting and parameter sanitation to allow only legitimate requests to pass through.
|
||||
## Documentation
|
||||
The documentation on CiviProxy can be found here: https://docs.civicrm.org/civiproxy/en/latest/
|
||||
## We need your support
|
||||
This software is provided as Free and Open Source Software, and we are happy if you find it useful. However, we have put a lot of work into it (and continue to do so), much of it unpaid for. So if you benefit from our software, please consider making a financial contribution so we can continue to maintain and develop it further.
|
||||
# CiviProxy - Security proxy for CiviCRM
|
||||
|
||||
If you are willing to support us in developing this tool, please send an email to info@systopia.de to get an invoice or agree a different payment method. Thank you!
|
||||
Does your CiviCRM server contain confidential data on your organsiation and your constituents? Couldn't this data be used against you, to scam your donors or simply undermine your constituents' trust in you?
|
||||
|
||||
CiviCRM ist *not* an unsafe system, but exposing the whole server with all its components to the internet yields a lot of attack vectors - for targeted attacks and scripted mass-exploits alike.
|
||||
|
||||
CiviProxy aims at minimising this exposure.
|
||||
|
||||
## How does it work
|
||||
|
||||
The basic idea is to first put your CiviCRM server into a VPN. This makes the server virtually inaccessible from the internet, and your users or your whole office will access it via a secure connection.
|
||||
|
||||
But what about your public web pages, donation pages, data exchange with other systems? This is where CiviProxy comes in: You get a small, secure, extra server and give it access to both, the internet and your VPN. It will act as a safe gateway for selected features of your CiviCRM that you would like to expose.
|
||||
|
||||
|
||||
|
||||
|
||||
## What can it do?
|
||||
|
||||
Currently CiviProxy can expose/relay the following CiviCRM functions
|
||||
|
||||
1. Serve resources for newsletters and mailings
|
||||
2. Cache those ressources, taking load off your CiviCRM server
|
||||
3. Pass-through of tracking data on opening and click-through rates
|
||||
5. Sign-on and off of your newsletter (Webpage templates)
|
||||
6. Relay of whitelisted REST API calls for data exchange with other systems
|
||||
7. Perform input sanitation and parameter whitelisting for the REST API calls
|
||||
|
||||
DISCLAIMER: This software has not (yet) been audited for security.
|
||||
|
||||
|
||||
## How to install
|
||||
|
||||
The best option to install CiviProxy is a simple managed webspace, that you can rent cheaply from the hoster of your choice. It should have its own IP address, but other than that there are virtually no restrictions. This approach comes with a lot of advantages:
|
||||
|
||||
1. Since there are a multitude of clients like you on such a server, the level of security can be expected to be very high, and it should be managed and monitored by professionals 24/7.
|
||||
|
||||
2. For the same reason, the bandwith and connectivity of such a server should be very high as well.
|
||||
|
||||
|
||||
### Installation
|
||||
|
||||
The installation is as simple as it gets:
|
||||
|
||||
1. Download the ``proxy`` folder of this git repository
|
||||
2. Edit the ``config.php`` file. It should be fairly self-explanatory.
|
||||
3. Upload the contents of the ``proxy`` folder to your webspace.
|
||||
4. If you want to send newsletters from behind the firewall, you will also have to install the ``de.systopia.civiproxy`` extension in your CiviCRM. This extension will automatically modify the URLs of links and resources in your outgoing newsletters, so they point to your proxy instead. You will have to configure this extension via the settings page, which is listed on the CiviCRM administration console.
|
||||
5. Done. All you have to do now is put your CiviCRM in a VPN and allow traffic only from the IP of your CiviProxy.
|
||||
|
||||
### Requirements
|
||||
|
||||
There shouldn't be any requirements that any web hoster wouldn't comply with, but here they are:
|
||||
|
||||
1. PHP 5.3+
|
||||
2. Read/write permissions on your webspace
|
||||
3. Reasonable amount of protection, i.e. only authorised users (you) can upload/download the files
|
||||
4. Ideally with it's own IP address (makes configuring the VPN easier)
|
||||
|
||||
|
||||
## Why not an application firewall?
|
||||
|
||||
The traditional approach to this problem would be an application firewall / reverse proxy setup. However, CiviCRM can have very complex interactions with other systems (e.g. via the API), and a malicious request can sometimes only be detected by understanding the meaning of the individual parameters.
|
||||
|
||||
Creating firewall rules for this level of detail is very complex and is very hard to maintain.
|
||||
|
||||
For this reason we wanted to take another approach and build a simple "bridgehead" system that *understands* CiviCRM, thus making its configuration and maintenance as easy as possible.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/*-------------------------------------------------------+
|
||||
| CiviProxy |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+--------------------------------------------------------+
|
||||
|
|
@ -105,9 +105,9 @@ class CRM_Admin_Form_Setting_ProxySettings extends CRM_Admin_Form_Setting
|
|||
if($response === FALSE) {
|
||||
return array('is_error' => 1, 'message' => sprintf(ts('Error: cannot access "%s"'), $url));
|
||||
}else{
|
||||
$result = preg_match("/<p id=\"version\">CiviProxy Version (([0-9]+\.[0-9]+|[0-9]+\.[0-9]+\.[0-9]+)(?:-[0-9A-Za-z-]+)?)<\/p>/", $response, $output_array);
|
||||
$result = preg_match("/<p id=\"version\">CiviProxy Version ([0-9]+\.[0-9]+|[0-9]+\.[0-9]+\.[0-9]+)<\/p>/", $response, $output_array);
|
||||
if ($result === FALSE || $result === 0){
|
||||
return array('is_error' => 1, 'message' => sprintf(ts('Error: failed to parse version information: (%s)'), $url));
|
||||
return array('is_error' => 1, 'message' => sprintf(ts('Error: failed to parse version information'), $url));
|
||||
}else{
|
||||
return array('is_error' => 0, 'version' => $output_array[1]);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/*-------------------------------------------------------+
|
||||
| CiviProxy |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+--------------------------------------------------------+
|
||||
|
|
@ -17,23 +17,12 @@ class CRM_Civiproxy_Mailer {
|
|||
* this is the orginal, wrapped mailer
|
||||
*/
|
||||
protected $mailer = NULL;
|
||||
/**
|
||||
* @var Mail Driver
|
||||
*/
|
||||
protected $driver = NULL;
|
||||
|
||||
/**
|
||||
* @var array Mail Params, currently not used
|
||||
*/
|
||||
protected $params = [];
|
||||
|
||||
/**
|
||||
* construct this mailer wrapping another one
|
||||
*/
|
||||
public function __construct($mailer, $driver, $params) {
|
||||
public function __construct($mailer) {
|
||||
$this->mailer = $mailer;
|
||||
$this->driver = $driver;
|
||||
$this->params = $params;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -41,9 +30,7 @@ class CRM_Civiproxy_Mailer {
|
|||
* mending the URLs contained
|
||||
*/
|
||||
function send($recipients, $headers, $body) {
|
||||
foreach ($headers as &$header) {
|
||||
CRM_CiviProxy_Mailer::mendURLs($header);
|
||||
}
|
||||
CRM_CiviProxy_Mailer::mendURLs($headers);
|
||||
CRM_CiviProxy_Mailer::mendURLs($body);
|
||||
$this->mailer->send($recipients, $headers, $body);
|
||||
}
|
||||
|
|
@ -58,26 +45,15 @@ class CRM_Civiproxy_Mailer {
|
|||
$enabled = CRM_Core_BAO_Setting::getItem('CiviProxy Settings', 'proxy_enabled');
|
||||
if (!$enabled) return;
|
||||
|
||||
$mosaico = CRM_Civiproxy_Mosaico::singleton();
|
||||
|
||||
// get the URLs
|
||||
$config = CRM_Core_Config::singleton();
|
||||
$system_base = $config->userFrameworkBaseURL;
|
||||
$proxy_base = CRM_Core_BAO_Setting::getItem('CiviProxy Settings', 'proxy_url');
|
||||
|
||||
// General external functions
|
||||
$value = preg_replace("#{$system_base}civicrm/mailing/url#i", $proxy_base.'/url.php', $value);
|
||||
$value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/url.php#i", $proxy_base.'/url.php', $value);
|
||||
$value = preg_replace("#{$system_base}civicrm/mailing/open#i", $proxy_base.'/open.php', $value);
|
||||
$value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/open.php#i", $proxy_base.'/open.php', $value);
|
||||
$value = preg_replace("#{$system_base}sites/default/files/civicrm/persist/#i", $proxy_base.'/file.php?id=', $value);
|
||||
$value = preg_replace("#{$system_base}civicrm/mosaico/img\?src=#i", $proxy_base.'/mosaico.php?id=', $value);
|
||||
$value = preg_replace("#{$system_base}civicrm/mosaico/img/\?src=#i", $proxy_base.'/mosaico.php?id=', $value);
|
||||
if ($mosaico->isMosaicoInstalled()) {
|
||||
$value = preg_replace_callback("#({$mosaico->getMosaicoExtensionUrl()}/packages/mosaico/templates/)(\S*)([\"'])#i", function($matches) use ($proxy_base) {
|
||||
return $proxy_base . '/mosaico.php?template_url=' . urlencode($matches[2]) . $matches[3];
|
||||
}, $value);
|
||||
}
|
||||
$value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/url.php#i", $proxy_base.'/url.php', $value);
|
||||
$value = preg_replace("#{$system_base}sites/all/modules/civicrm/extern/open.php#i", $proxy_base.'/open.php', $value);
|
||||
$value = preg_replace("#{$system_base}sites/default/files/civicrm/persist/#i", $proxy_base.'/file.php?id=', $value);
|
||||
|
||||
// Mailing related functions
|
||||
$value = preg_replace("#{$system_base}civicrm/mailing/view#i", $proxy_base.'/mailing/mail.php', $value);
|
||||
|
|
@ -92,11 +68,4 @@ class CRM_Civiproxy_Mailer {
|
|||
$value = preg_replace("#{$system_base}civicrm/mailing/{$function}#i", $new_url, $value);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Mail|null
|
||||
*/
|
||||
public function getDriver() {
|
||||
return $this->driver;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,70 +0,0 @@
|
|||
<?php
|
||||
/**
|
||||
* Copyright (C) 2021 Jaap Jansma (jaap.jansma@civicoop.org)
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as published by
|
||||
* the Free Software Foundation, either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
class CRM_Civiproxy_Mosaico {
|
||||
|
||||
/**
|
||||
* @var CRM_Civiproxy_Mosaico
|
||||
*/
|
||||
private static $singleton;
|
||||
|
||||
/**
|
||||
* @var String
|
||||
*/
|
||||
private $mosiacoExtenionUrl;
|
||||
|
||||
/**
|
||||
* @var bool
|
||||
*/
|
||||
private $isMosaicoInstalled = false;
|
||||
|
||||
private function __construct() {
|
||||
try {
|
||||
$mosaicoExt = civicrm_api3('Extension', 'getsingle', ['full_name' => "uk.co.vedaconsulting.mosaico"]);
|
||||
$this->isMosaicoInstalled = true;
|
||||
$this->mosiacoExtenionUrl = CRM_Mosaico_ExtensionUtil::url();
|
||||
} catch (\Exception $ex) {
|
||||
// Do nothing
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @return CRM_Civiproxy_Mosaico
|
||||
*/
|
||||
public static function singleton() {
|
||||
if (!self::$singleton) {
|
||||
self::$singleton = new CRM_Civiproxy_Mosaico();
|
||||
}
|
||||
return self::$singleton;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
public function isMosaicoInstalled() {
|
||||
return $this->isMosaicoInstalled;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getMosaicoExtensionUrl() {
|
||||
return $this->mosiacoExtenionUrl;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -3,199 +3,240 @@
|
|||
// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
|
||||
|
||||
/**
|
||||
* The ExtensionUtil class provides small stubs for accessing resources of this
|
||||
* extension.
|
||||
* (Delegated) Implementation of hook_civicrm_config
|
||||
*/
|
||||
class CRM_Civiproxy_ExtensionUtil {
|
||||
const SHORT_NAME = 'civiproxy';
|
||||
const LONG_NAME = 'de.systopia.civiproxy';
|
||||
const CLASS_PREFIX = 'CRM_Civiproxy';
|
||||
|
||||
/**
|
||||
* Translate a string using the extension's domain.
|
||||
*
|
||||
* If the extension doesn't have a specific translation
|
||||
* for the string, fallback to the default translations.
|
||||
*
|
||||
* @param string $text
|
||||
* Canonical message text (generally en_US).
|
||||
* @param array $params
|
||||
* @return string
|
||||
* Translated text.
|
||||
* @see ts
|
||||
*/
|
||||
public static function ts($text, $params = []): string {
|
||||
if (!array_key_exists('domain', $params)) {
|
||||
$params['domain'] = [self::LONG_NAME, NULL];
|
||||
}
|
||||
return ts($text, $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the URL of a resource file (in this extension).
|
||||
*
|
||||
* @param string|NULL $file
|
||||
* Ex: NULL.
|
||||
* Ex: 'css/foo.css'.
|
||||
* @return string
|
||||
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
|
||||
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
|
||||
*/
|
||||
public static function url($file = NULL): string {
|
||||
if ($file === NULL) {
|
||||
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
|
||||
}
|
||||
return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the path of a resource file (in this extension).
|
||||
*
|
||||
* @param string|NULL $file
|
||||
* Ex: NULL.
|
||||
* Ex: 'css/foo.css'.
|
||||
* @return string
|
||||
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
|
||||
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'.
|
||||
*/
|
||||
public static function path($file = NULL) {
|
||||
// return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file);
|
||||
return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the name of a class within this extension.
|
||||
*
|
||||
* @param string $suffix
|
||||
* Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
|
||||
* @return string
|
||||
* Ex: 'CRM_Foo_Page_HelloWorld'.
|
||||
*/
|
||||
public static function findClass($suffix) {
|
||||
return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
use CRM_Civiproxy_ExtensionUtil as E;
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_config().
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_config($config = NULL) {
|
||||
function _civiproxy_civix_civicrm_config(&$config = NULL) {
|
||||
static $configured = FALSE;
|
||||
if ($configured) {
|
||||
return;
|
||||
}
|
||||
if ($configured) return;
|
||||
$configured = TRUE;
|
||||
|
||||
$extRoot = __DIR__ . DIRECTORY_SEPARATOR;
|
||||
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
|
||||
set_include_path($include_path);
|
||||
// Based on <compatibility>, this does not currently require mixin/polyfill.php.
|
||||
$template =& CRM_Core_Smarty::singleton();
|
||||
|
||||
$extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
|
||||
$extDir = $extRoot . 'templates';
|
||||
|
||||
if ( is_array( $template->template_dir ) ) {
|
||||
array_unshift( $template->template_dir, $extDir );
|
||||
} else {
|
||||
$template->template_dir = array( $extDir, $template->template_dir );
|
||||
}
|
||||
|
||||
$include_path = $extRoot . PATH_SEPARATOR . get_include_path( );
|
||||
set_include_path( $include_path );
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_civicrm_install().
|
||||
* (Delegated) Implementation of hook_civicrm_xmlMenu
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
|
||||
* @param $files array(string)
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_xmlMenu(&$files) {
|
||||
foreach (_civiproxy_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
|
||||
$files[] = $file;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_install
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_install() {
|
||||
_civiproxy_civix_civicrm_config();
|
||||
// Based on <compatibility>, this does not currently require mixin/polyfill.php.
|
||||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
return $upgrader->onInstall();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_enable().
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
|
||||
* Implementation of hook_civicrm_uninstall
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_enable(): void {
|
||||
function _civiproxy_civix_civicrm_uninstall() {
|
||||
_civiproxy_civix_civicrm_config();
|
||||
// Based on <compatibility>, this does not currently require mixin/polyfill.php.
|
||||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
return $upgrader->onUninstall();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a navigation menu item at a given place in the hierarchy.
|
||||
*
|
||||
* @param array $menu - menu hierarchy
|
||||
* @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
|
||||
* 'Mailing', or 'Administer/System Settings'
|
||||
* @param array $item - the item to insert (parent/child attributes will be
|
||||
* filled for you)
|
||||
*
|
||||
* @return bool
|
||||
* (Delegated) Implementation of hook_civicrm_enable
|
||||
*/
|
||||
function _civiproxy_civix_insert_navigation_menu(&$menu, $path, $item) {
|
||||
function _civiproxy_civix_civicrm_enable() {
|
||||
_civiproxy_civix_civicrm_config();
|
||||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
if (is_callable(array($upgrader, 'onEnable'))) {
|
||||
return $upgrader->onEnable();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implementation of hook_civicrm_disable
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_disable() {
|
||||
_civiproxy_civix_civicrm_config();
|
||||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
if (is_callable(array($upgrader, 'onDisable'))) {
|
||||
return $upgrader->onDisable();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implementation of hook_civicrm_upgrade
|
||||
*
|
||||
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
|
||||
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
|
||||
*
|
||||
* @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
|
||||
* for 'enqueue', returns void
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
return $upgrader->onUpgrade($op, $queue);
|
||||
}
|
||||
}
|
||||
|
||||
function _civiproxy_civix_upgrader() {
|
||||
if (!file_exists(__DIR__.'/CRM/Civiproxy/Upgrader.php')) {
|
||||
return NULL;
|
||||
} else {
|
||||
return CRM_Civiproxy_Upgrader_Base::instance();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search directory tree for files which match a glob pattern
|
||||
*
|
||||
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
|
||||
* Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
|
||||
*
|
||||
* @param $dir string, base dir
|
||||
* @param $pattern string, glob pattern, eg "*.txt"
|
||||
* @return array(string)
|
||||
*/
|
||||
function _civiproxy_civix_find_files($dir, $pattern) {
|
||||
if (is_callable(array('CRM_Utils_File', 'findFiles'))) {
|
||||
return CRM_Utils_File::findFiles($dir, $pattern);
|
||||
}
|
||||
|
||||
$todos = array($dir);
|
||||
$result = array();
|
||||
while (!empty($todos)) {
|
||||
$subdir = array_shift($todos);
|
||||
foreach (_civiproxy_civix_glob("$subdir/$pattern") as $match) {
|
||||
if (!is_dir($match)) {
|
||||
$result[] = $match;
|
||||
}
|
||||
}
|
||||
if ($dh = opendir($subdir)) {
|
||||
while (FALSE !== ($entry = readdir($dh))) {
|
||||
$path = $subdir . DIRECTORY_SEPARATOR . $entry;
|
||||
if ($entry{0} == '.') {
|
||||
} elseif (is_dir($path)) {
|
||||
$todos[] = $path;
|
||||
}
|
||||
}
|
||||
closedir($dh);
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
/**
|
||||
* (Delegated) Implementation of hook_civicrm_managed
|
||||
*
|
||||
* Find any *.mgd.php files, merge their content, and return.
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_managed(&$entities) {
|
||||
$mgdFiles = _civiproxy_civix_find_files(__DIR__, '*.mgd.php');
|
||||
foreach ($mgdFiles as $file) {
|
||||
$es = include $file;
|
||||
foreach ($es as $e) {
|
||||
if (empty($e['module'])) {
|
||||
$e['module'] = 'de.systopia.civiproxy';
|
||||
}
|
||||
$entities[] = $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implementation of hook_civicrm_caseTypes
|
||||
*
|
||||
* Find any and return any files matching "xml/case/*.xml"
|
||||
*
|
||||
* Note: This hook only runs in CiviCRM 4.4+.
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_caseTypes(&$caseTypes) {
|
||||
if (!is_dir(__DIR__ . '/xml/case')) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (_civiproxy_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
|
||||
$name = preg_replace('/\.xml$/', '', basename($file));
|
||||
if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
|
||||
$errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
|
||||
CRM_Core_Error::fatal($errorMessage);
|
||||
// throw new CRM_Core_Exception($errorMessage);
|
||||
}
|
||||
$caseTypes[$name] = array(
|
||||
'module' => 'de.systopia.civiproxy',
|
||||
'name' => $name,
|
||||
'file' => $file,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Glob wrapper which is guaranteed to return an array.
|
||||
*
|
||||
* The documentation for glob() says, "On some systems it is impossible to
|
||||
* distinguish between empty match and an error." Anecdotally, the return
|
||||
* result for an empty match is sometimes array() and sometimes FALSE.
|
||||
* This wrapper provides consistency.
|
||||
*
|
||||
* @see http://php.net/glob
|
||||
* @param string $pattern
|
||||
* @return array, possibly empty
|
||||
*/
|
||||
function _civiproxy_civix_glob($pattern) {
|
||||
$result = glob($pattern);
|
||||
return is_array($result) ? $result : array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a navigation menu item at a given place in the hierarchy
|
||||
*
|
||||
* $menu - menu hierarchy
|
||||
* $path - path where insertion should happen (ie. Administer/System Settings)
|
||||
* $item - menu you need to insert (parent/child attributes will be filled for you)
|
||||
* $parentId - used internally to recurse in the menu structure
|
||||
*/
|
||||
function _civiproxy_civix_insert_navigation_menu(&$menu, $path, $item, $parentId = NULL) {
|
||||
static $navId;
|
||||
|
||||
// If we are done going down the path, insert menu
|
||||
if (empty($path)) {
|
||||
$menu[] = [
|
||||
'attributes' => array_merge([
|
||||
'label' => $item['name'] ?? NULL,
|
||||
'active' => 1,
|
||||
], $item),
|
||||
];
|
||||
return TRUE;
|
||||
}
|
||||
else {
|
||||
if (!$navId) $navId = CRM_Core_DAO::singleValueQuery("SELECT max(id) FROM civicrm_navigation");
|
||||
$navId ++;
|
||||
$menu[$navId] = array (
|
||||
'attributes' => array_merge($item, array(
|
||||
'label' => CRM_Utils_Array::value('name', $item),
|
||||
'active' => 1,
|
||||
'parentID' => $parentId,
|
||||
'navID' => $navId,
|
||||
))
|
||||
);
|
||||
return true;
|
||||
} else {
|
||||
// Find an recurse into the next level down
|
||||
$found = FALSE;
|
||||
$found = false;
|
||||
$path = explode('/', $path);
|
||||
$first = array_shift($path);
|
||||
foreach ($menu as $key => &$entry) {
|
||||
if ($entry['attributes']['name'] == $first) {
|
||||
if (!isset($entry['child'])) {
|
||||
$entry['child'] = [];
|
||||
}
|
||||
$found = _civiproxy_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
|
||||
if (!$entry['child']) $entry['child'] = array();
|
||||
$found = _civiproxy_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key);
|
||||
}
|
||||
}
|
||||
return $found;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_navigationMenu().
|
||||
*/
|
||||
function _civiproxy_civix_navigationMenu(&$nodes) {
|
||||
if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
|
||||
_civiproxy_civix_fixNavigationMenu($nodes);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a navigation menu, generate navIDs for any items which are
|
||||
* missing them.
|
||||
*/
|
||||
function _civiproxy_civix_fixNavigationMenu(&$nodes) {
|
||||
$maxNavID = 1;
|
||||
array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
|
||||
if ($key === 'navID') {
|
||||
$maxNavID = max($maxNavID, $item);
|
||||
}
|
||||
});
|
||||
_civiproxy_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
|
||||
}
|
||||
|
||||
function _civiproxy_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
|
||||
$origKeys = array_keys($nodes);
|
||||
foreach ($origKeys as $origKey) {
|
||||
if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
|
||||
$nodes[$origKey]['attributes']['parentID'] = $parentID;
|
||||
}
|
||||
// If no navID, then assign navID and fix key.
|
||||
if (!isset($nodes[$origKey]['attributes']['navID'])) {
|
||||
$newKey = ++$maxNavID;
|
||||
$nodes[$origKey]['attributes']['navID'] = $newKey;
|
||||
$nodes[$newKey] = $nodes[$origKey];
|
||||
unset($nodes[$origKey]);
|
||||
$origKey = $newKey;
|
||||
}
|
||||
if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
|
||||
_civiproxy_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/*-------------------------------------------------------+
|
||||
| CiviProxy |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+--------------------------------------------------------+
|
||||
|
|
@ -15,7 +15,7 @@ require_once 'civiproxy.civix.php';
|
|||
* so we can mend all the URLs in outgoing emails
|
||||
*/
|
||||
function civiproxy_civicrm_alterMailer(&$mailer, $driver, $params) {
|
||||
$mailer = new CRM_Civiproxy_Mailer($mailer, $driver, $params);
|
||||
$mailer = new CRM_Civiproxy_Mailer($mailer);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -25,6 +25,15 @@ function civiproxy_civicrm_config(&$config) {
|
|||
_civiproxy_civix_civicrm_config($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_xmlMenu
|
||||
*
|
||||
* @param $files array(string)
|
||||
*/
|
||||
function civiproxy_civicrm_xmlMenu(&$files) {
|
||||
_civiproxy_civix_civicrm_xmlMenu($files);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_install
|
||||
*/
|
||||
|
|
@ -32,6 +41,13 @@ function civiproxy_civicrm_install() {
|
|||
return _civiproxy_civix_civicrm_install();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_uninstall
|
||||
*/
|
||||
function civiproxy_civicrm_uninstall() {
|
||||
return _civiproxy_civix_civicrm_uninstall();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_enable
|
||||
*/
|
||||
|
|
@ -39,9 +55,61 @@ function civiproxy_civicrm_enable() {
|
|||
return _civiproxy_civix_civicrm_enable();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_disable
|
||||
*/
|
||||
function civiproxy_civicrm_disable() {
|
||||
return _civiproxy_civix_civicrm_disable();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_upgrade
|
||||
*
|
||||
* @param $op string, the type of operation being performed; 'check' or 'enqueue'
|
||||
* @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
|
||||
*
|
||||
* @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
|
||||
* for 'enqueue', returns void
|
||||
*/
|
||||
function civiproxy_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
||||
return _civiproxy_civix_civicrm_upgrade($op, $queue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_managed
|
||||
*
|
||||
* Generate a list of entities to create/deactivate/delete when this module
|
||||
* is installed, disabled, uninstalled.
|
||||
*/
|
||||
function civiproxy_civicrm_managed(&$entities) {
|
||||
return _civiproxy_civix_civicrm_managed($entities);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_caseTypes
|
||||
*
|
||||
* Generate a list of case-types
|
||||
*
|
||||
* Note: This hook only runs in CiviCRM 4.4+.
|
||||
*/
|
||||
function civiproxy_civicrm_caseTypes(&$caseTypes) {
|
||||
_civiproxy_civix_civicrm_caseTypes($caseTypes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_alterSettingsFolders
|
||||
*
|
||||
* Scan for settings in custom folder and import them
|
||||
*
|
||||
*/
|
||||
function civiproxy_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
|
||||
static $configured = FALSE;
|
||||
if ($configured) return;
|
||||
$configured = TRUE;
|
||||
|
||||
$extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
|
||||
$extDir = $extRoot . 'settings';
|
||||
if(!in_array($extDir, $metaDataFolders)){
|
||||
$metaDataFolders[] = $extDir;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,36 +3,19 @@
|
|||
<file>civiproxy</file>
|
||||
<name>CiviProxy</name>
|
||||
<description>This will enable CiviProxy support for mailings</description>
|
||||
<license>AGPL</license>
|
||||
<license></license>
|
||||
<maintainer>
|
||||
<author>B. Endres</author>
|
||||
<email>endres@systopia.de</email>
|
||||
</maintainer>
|
||||
<urls>
|
||||
<url desc="Main Extension Page">https://github.com/systopia/CiviProxy</url>
|
||||
<url desc="Documentation">https://docs.civicrm.org/civiproxy/en/latest/</url>
|
||||
<url desc="Support">https://github.com/systopia/CiviProxy/issues</url>
|
||||
<url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
|
||||
</urls>
|
||||
<releaseDate>2024-01-07</releaseDate>
|
||||
<version>1.0.0-beta</version>
|
||||
<develStage>beta</develStage>
|
||||
<releaseDate>2015-10-22</releaseDate>
|
||||
<version>0.3.2</version>
|
||||
<develStage>stable</develStage>
|
||||
<compatibility>
|
||||
<ver>5.45</ver>
|
||||
<ver>4.4</ver>
|
||||
</compatibility>
|
||||
<comments>This is the companion extension to SYSTOPIA's CiviProxy security system</comments>
|
||||
<comments>This is an addition to SYSTOPIA's CiviProxy security system</comments>
|
||||
<civix>
|
||||
<namespace>CRM/Civiproxy</namespace>
|
||||
<format>24.09.1</format>
|
||||
</civix>
|
||||
<mixins>
|
||||
<mixin>menu-xml@1.0.0</mixin>
|
||||
<mixin>setting-php@1.0.0</mixin>
|
||||
<mixin>smarty-v2@1.0.3</mixin>
|
||||
<mixin>entity-types-php@2.0.0</mixin>
|
||||
</mixins>
|
||||
<classloader>
|
||||
<psr0 prefix="CRM_" path="."/>
|
||||
<psr4 prefix="Civi\" path="Civi"/>
|
||||
</classloader>
|
||||
</extension>
|
||||
|
|
|
|||
|
|
@ -1,40 +0,0 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Auto-register entity declarations from `schema/*.entityType.php`.
|
||||
*
|
||||
* @mixinName entity-types-php
|
||||
* @mixinVersion 2.0.0
|
||||
* @since 5.73
|
||||
*
|
||||
* Changelog:
|
||||
* - v2.0 scans /schema directory instead of /xml/schema/*
|
||||
* - v2.0 supports only one entity per file
|
||||
* - v2.0 adds 'module' key to each entity
|
||||
*
|
||||
* @param CRM_Extension_MixInfo $mixInfo
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
* @param \CRM_Extension_BootCache $bootCache
|
||||
* On newer deployments, this will be an instance of BootCache. On older deployments, Civix may polyfill with a work-a-like.
|
||||
*/
|
||||
return function ($mixInfo, $bootCache) {
|
||||
|
||||
/**
|
||||
* @param \Civi\Core\Event\GenericHookEvent $e
|
||||
* @see CRM_Utils_Hook::entityTypes()
|
||||
*/
|
||||
Civi::dispatcher()->addListener('hook_civicrm_entityTypes', function ($e) use ($mixInfo) {
|
||||
// When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
|
||||
if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('schema'))) {
|
||||
return;
|
||||
}
|
||||
|
||||
$files = (array) glob($mixInfo->getPath('schema/*.entityType.php'));
|
||||
foreach ($files as $file) {
|
||||
$entity = include $file;
|
||||
$entity['module'] = $mixInfo->longName;
|
||||
$e->entityTypes[$entity['name']] = $entity;
|
||||
}
|
||||
});
|
||||
|
||||
};
|
||||
|
|
@ -1,78 +0,0 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Auto-register "templates/" folder.
|
||||
*
|
||||
* @mixinName smarty-v2
|
||||
* @mixinVersion 1.0.3
|
||||
* @since 5.59
|
||||
*
|
||||
* @deprecated - it turns out that the mixin is not version specific so the 'smarty'
|
||||
* mixin is preferred over smarty-v2 (they are the same but not having the version
|
||||
* in the name is less misleading.)
|
||||
*
|
||||
* @param CRM_Extension_MixInfo $mixInfo
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
* @param \CRM_Extension_BootCache $bootCache
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
*/
|
||||
return function ($mixInfo, $bootCache) {
|
||||
$dir = $mixInfo->getPath('templates');
|
||||
if (!file_exists($dir)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$register = function($newDirs) {
|
||||
$smarty = CRM_Core_Smarty::singleton();
|
||||
$v2 = isset($smarty->_version) && version_compare($smarty->_version, 3, '<');
|
||||
$templateDirs = (array) ($v2 ? $smarty->template_dir : $smarty->getTemplateDir());
|
||||
$templateDirs = array_merge($newDirs, $templateDirs);
|
||||
$templateDirs = array_unique(array_map(function($v) {
|
||||
$v = str_replace(DIRECTORY_SEPARATOR, '/', $v);
|
||||
$v = rtrim($v, '/') . '/';
|
||||
return $v;
|
||||
}, $templateDirs));
|
||||
if ($v2) {
|
||||
$smarty->template_dir = $templateDirs;
|
||||
}
|
||||
else {
|
||||
$smarty->setTemplateDir($templateDirs);
|
||||
}
|
||||
};
|
||||
|
||||
// Let's figure out what environment we're in -- so that we know the best way to call $register().
|
||||
|
||||
if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) {
|
||||
// Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`.
|
||||
if ($mixInfo->isActive()) {
|
||||
$register([$dir]);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) {
|
||||
// New Install, Standard Loader: The extension has just been enabled, and we're now setting it up.
|
||||
// System has already booted. New templates may be needed for upcoming installation steps.
|
||||
$register([$dir]);
|
||||
return;
|
||||
}
|
||||
|
||||
// Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online.
|
||||
// We need to bundle-up all dirs -- Smarty 3/4/5 is inefficient with processing repeated calls to `getTemplateDir()`+`setTemplateDir()`
|
||||
if (!isset(Civi::$statics[__FILE__]['event'])) {
|
||||
Civi::$statics[__FILE__]['event'] = 'civi.smarty-v2.addPaths.' . md5(__FILE__);
|
||||
Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($register) {
|
||||
$dirs = [];
|
||||
$event = \Civi\Core\Event\GenericHookEvent::create(['dirs' => &$dirs]);
|
||||
Civi::dispatcher()->dispatch(Civi::$statics[__FILE__]['event'], $event);
|
||||
$register($dirs);
|
||||
});
|
||||
}
|
||||
|
||||
Civi::dispatcher()->addListener(Civi::$statics[__FILE__]['event'], function($event) use ($mixInfo, $dir) {
|
||||
if ($mixInfo->isActive()) {
|
||||
array_unshift($event->dirs, $dir);
|
||||
}
|
||||
});
|
||||
|
||||
};
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{*-------------------------------------------------------+
|
||||
| CiviProxy |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+--------------------------------------------------------+
|
||||
|
|
@ -27,6 +27,6 @@
|
|||
|
||||
{htxt id='id-custom-mailing-base'}
|
||||
<p>
|
||||
{ts}The path for the default unsubscribe page. You can use the default in CiviProxy or create your own and add the path here{/ts}
|
||||
{ts}TADDAAAA{/ts}
|
||||
</p>
|
||||
{/htxt}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{*-------------------------------------------------------+
|
||||
| CiviProxy |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+--------------------------------------------------------+
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -1,223 +0,0 @@
|
|||
# How to configure CiviProxy
|
||||
!!! caution
|
||||
We assume you have a very basic understanding of PHP and editing PHP files. If you do not, it is probably a good idea to get some support from a CiviCRM expert. You can find one on [Find an Expert](https://civicrm.org/partners-contributors).
|
||||
## Configuration of the CiviCRM extension
|
||||
You can use CiviProxy to do a couple of things related to mails and mailing for you.
|
||||
|
||||
* You can still see all the stuff on the CiviMailing report like the click-throughs and bounces and such.
|
||||
* You do not want the links in your bulk mailing or individual mails to immediately feed back to your CiviCRM installation but pass through CiviProxy.
|
||||
* You want your subscribe/unsubscribe links to pass through CiviProxy rather than go directly to your CiviCRM installation.
|
||||
|
||||
If you want to do any of these things, you will need to install and configure the CiviCRM extension **de.systopia.civiproxy** in your CiviCRM installation.
|
||||
|
||||
If you have not installed the extension already, check [Installing CiviCRM](installation.md) for instructions how to.
|
||||
|
||||
!!! note
|
||||
If you do not install the **de.systopia.civiproxy** extension you can still use CiviProxy to whitelist your API requests.
|
||||
|
||||
Once you have installed the CiviCRM extension you will need to configure the CiviProxy settings. To do this, go to **Administer>Administration Console**. You will see the CiviProxy Settings in the System Settings section of the menu as you can see below.
|
||||
|
||||
|
||||
|
||||
If you click on the CiviProxy Settings you will get a page with a few settings for CiviProxy. If you access the page for the first time these will be empty. The settings you can enter are:
|
||||
|
||||
1. A checkbox CiviProxy Enabled to enable or disable the CiviProxy functionality with your CiviCRM mailing links.
|
||||
1. A text field Proxy URL where you can add the URL of your CiviProxy server. This link will be validated and the version of the CiviProxy will be shown. If the URL does not meet the validation (does not contain a valid CiviProxy installation), there will be an error message.
|
||||
1. A text field Custom Subscribe/Unsubscribe Pages for a path to the unsubscribe page that will be used. There is a basic unsubscribe page on your CiviProxy server, the path to this page will be the default. If the default unsubscribe page is not what you would like, then you can either update the page in the CiviProxy installation on your server or create your own page and set the URL here.
|
||||
|
||||
!!! note
|
||||
If you do create your own subscription page make sure the parameters and returns and such are the same as in the default unsubscribe page!
|
||||
|
||||
In the screen print below you can see the CiviProxy Settings page with the values I have used for my test installation when producing this guide.
|
||||
|
||||
|
||||
## Configuration of the CiviProxy server
|
||||
The CiviProxy server is the actual policeman that receives all requests and decides if they are allowed to send data to or retrieve data from CiviCRM. It consists of a series of scripts which you need to install on the server as explained in [Installing CiviProxy](installation.md).
|
||||
|
||||
Once you have installed your CiviProxy server you need to complete a few configuration steps.
|
||||
### The Config.php file
|
||||
|
||||
The configuration of CiviProxy is mainly controlled with one PHP file called `config.php`. Create this file by copying or renaming the `config.dist.php` file.
|
||||
|
||||
|
||||
|
||||
### Configuring the URL of your CiviProxy server
|
||||
|
||||
First thing you need to configure is the base URL of your CiviProxy server using the `$proxy_base` variable in the `config.php` file. As I have used a local test installation I have used `http://localhost/proxy`:
|
||||
```php
|
||||
// this should point to the base address of the CiviProxy installation
|
||||
$proxy_base = 'http://localhost/proxy';
|
||||
```
|
||||
|
||||
!!! note
|
||||
This guide assumes a Drupal7 target CiviCRM with clean URLs enabled. If this is not the case for you, you might have to adjust the URLs and/or encounter issues. If so, please report on GitHub!
|
||||
|
||||
### Configuring the link to the secure target CiviCRM
|
||||
|
||||
Next thing you want to configure is what your target CiviCRM is. This is the CiviCRM installation which you want CiviProxy to police, so the one where the actual data resides and is collected from or sent to.
|
||||
|
||||
The assumption is that this CiviCRM resides in some kind of VPN and will accept traffic only from the CiviProxy IP address (and probably a few trusted others like home workers or support people).
|
||||
You can set the URL of the target CiviCRM using the variable `$target_civirm` in the `config.php` file. Again, I have used a local test installation:
|
||||
```php
|
||||
// this should point to the target CiviCRM system
|
||||
$target_civicrm = 'http://localhost/ehdev';
|
||||
```
|
||||
### Setting for the click tracking url
|
||||
There is a setting in CiviCRM which is used for tracking the clicks in your mailing. On your CiviProxy server this setting is captured in the variable `$target_url` in the `config.php` file:
|
||||
```php
|
||||
$target_url = $target_civicrm . '/civicrm/mailing/url';
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
### Setting for the open tracking
|
||||
CiviCRM tracks if a mailing has been opened in a certain way. CiviProxy has this setting in the variable `$target_open` in the `config.php` file:
|
||||
```php
|
||||
$target_open = $target_civicrm . '/civicrm/mailing/url/open.php';
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
### Setting for the location of images and included files in your mail(ing)
|
||||
CiviCRM stores images and attachments you include in your (bulk) mail in a specific folder. In CiviProxy the name of this folder is stored in variable `$target_file` in the `config.php` file:
|
||||
```php
|
||||
$target_file = $target_civicrm . '/sites/default/files/civicrm/persist/';
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
|
||||
!!! note
|
||||
By default CiviProxy will cache the files so it does not have to file from CiviCRM for each individual mail that is part of a bulk mailing. The default settings can be found in the `config.php` file:
|
||||
```php
|
||||
/****************************************************************
|
||||
** File Caching Options **
|
||||
****************************************************************/
|
||||
// define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
|
||||
$file_cache_options = array(
|
||||
'cacheDir' => 'file_cache/',
|
||||
'lifeTime' => 86400
|
||||
);
|
||||
// define regex patterns that shoud NOT be accepted
|
||||
$file_cache_exclude = array();
|
||||
// if set, cached file must match at least one of these regex patterns
|
||||
$file_cache_include = array(
|
||||
//'#.+[.](png|jpe?g|gif)#i' // only media files
|
||||
);
|
||||
```
|
||||
You can update these settings if you should want to.
|
||||
|
||||
You can find documentation on the caching engine used in CiviProxy [here](http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php)
|
||||
### Setting for the view unformatted mail link
|
||||
If CiviCRM sends a mail you can get a link to view the mail unformatted. CiviProxy keeps this setting in a variable `$target_mail_view` in the `config.php` file:
|
||||
```php
|
||||
$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
### Setting for the REST API requests
|
||||
When you want to use the CiviCRM API from another server than the one CiviCRM itself resides on you will do so using the REST interface.
|
||||
|
||||
!!! seealso
|
||||
Generic information on CiviCRM with REST [here](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface)
|
||||
|
||||
CiviProxy has a setting which specifies where the REST script is located in the variable `$target_rest` in the `config.php` file:
|
||||
```php
|
||||
$target_rest = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
### Configuring the API key for (un)subscribe
|
||||
CiviCRM allows subscribe/unsubscribe links in mailings. To process these a user needs to be configured with a specific API key. In CiviProxy this API key is held in the `config.php` file in variable ``:
|
||||
```php
|
||||
$mail_subscription_user_key = 123teSt!ExaMpl1;
|
||||
```
|
||||
If you set it to the value NULL this functionality will not be available on your CiviProxy server.
|
||||
### Configuring the API and Site key
|
||||
To be able to access your target CiviCRM with the API using REST you will need to configure an API key and a site key. Actually, you will most likely need more to be able if more outside applications are allowed to access your target CiviCRM.
|
||||
|
||||
!!! seealso
|
||||
Generic information on CiviCRM with REST [here](https://wiki.civicrm.org/confluence/display/CRMDOC/REST+interface)
|
||||
|
||||
In CiviProxy you can either store the API and Site keys directly in the `config.php` file or you can include a `secrets.php` file in your installation which holds your key values.
|
||||
|
||||
Whatever method you prefer, you will have to end up with an array like the one below:
|
||||
```php
|
||||
$api_key_map = array('eR1k!tSt4321' => 'cal1Mer0#tST');
|
||||
$sys_key_map = array('1234#tsT#eR1k' => 'p1P0!tEst1Ng5678');
|
||||
```
|
||||
As you can see you can give the application that is accessing you different keys than the ones you use to access your target CiviCRM.
|
||||
|
||||
So in this example I will explain to the party wanting to access my CiviProxy that they have to use the key _1234#tsT#eR1k_ and the api key _eR1k!tSt4321_. My target CiviCRM will expect site key _p1P0!tEst1Ng5678_ and the api key _cal1Mer0#tST_.
|
||||
|
||||
### Whitelisting API requests
|
||||
Even if you have entered your API and Site key, and the setting for the target REST is ok, you will not be able to use any API calls through CiviProxy just yet. As CiviProxy uses the **whitelisting** principle by default **no** API calls are allowed unless they have been whilelisted.
|
||||
|
||||
Also **parameter sanitation** is used. This means that only the specified parameters are allowed, and only content data of the specified type will be allowed.
|
||||
|
||||
You can whitelist an API entity and action (and a set of allowed parameters) for all request from outside, but you can also whitelist an API entity and action ONLY if it comes from a specific IP address.
|
||||
|
||||
!!! note
|
||||
The address of the request is checked with the PHP variable `$_SERVER['REMOTE_ADDR']`
|
||||
|
||||
In the example below you will see the possible configuration:
|
||||
|
||||
* the API `Contact getsingle` with parameter `email` is allowed for all servers making a request to CiviProxy,
|
||||
* the API `Contact getsingle` with parameters `first_name` and `last_name` is only allowed if it is requested from IP address 123.45.678.1.
|
||||
|
||||
```php
|
||||
$rest_allowed_actions = array(
|
||||
'all' => array(
|
||||
'Contact' => array(
|
||||
'getsingle' => array(
|
||||
'email' => 'string',
|
||||
),
|
||||
),
|
||||
),
|
||||
'123.45.678.1' => array(
|
||||
'Contact' => array(
|
||||
'getsingle' => array(
|
||||
'first_name' => 'string',
|
||||
'last_name' => 'string',
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
```
|
||||
|
||||
!!! note
|
||||
In earlier versions of CiviProxy this format was allowed for `$rest_allowed_actions`:
|
||||
```php
|
||||
$rest_allowed_actions = array(
|
||||
'Contact' => array(
|
||||
'getsingle' => array(
|
||||
'email' => 'string',
|
||||
),
|
||||
),
|
||||
);
|
||||
```
|
||||
That format will still work, but is considered **deprecated** and you are encouraged to adapt to the new format described in the section above.
|
||||
|
||||
!!! caution
|
||||
A little bit of developer background....Obviously you can use the core CiviCRM API's but you have to think carefully of the parameter sanitation. Techically what happens is that if any parameters are passed to CiviProxy that are not _allowed_, they are ignored when the API request is passed to CiviCRM. This could lead to undesired behaviour. Consider this example:
|
||||
|
||||
* we have allowed the `Contact Get` API with only the parameter `email`
|
||||
|
||||
* the request we get in CiviProxy has the `Contact Get` but the parameters `first_name` and `last_name`
|
||||
|
||||
* because `first_name` and `last_name` are not whitelisted, they get ignored and a `Contact Get` without parameters if passed to the target CiviCRM, returning the first 25 contacts are a result...which is not what we wanted.
|
||||
|
||||
We recommend solving these situations by developing specific API's rather than using the core ones. And if you think of a good solution feel free to raise an issue or do a PR!
|
||||
|
||||
### Debug setting
|
||||
CiviProxy has a `$debug` setting which allows you to add the name of a text file where all requests are send to. This can be used during the initial testing to see if everything is processed correcty.
|
||||
```php
|
||||
// CAREFUL: only enable temporarily on debug systems. Will log all queries to given PUBLIC file
|
||||
$debug = NULL; //'debug.log';
|
||||
```
|
||||
If you set the `$debug` setting to NULL this feature will not be used.
|
||||
|
||||
!!! warning
|
||||
We recommend only using this debug feature in the testing face, never on an active production installation as it can produce a massive log file quite easily.
|
||||
### Target Interface setting
|
||||
There is a setting for a local network interface or IP to be used for relayed queries. If you have no idea what this is about, just leave it as is.
|
||||
```php
|
||||
// Local network interface or IP to be used for the relayed query
|
||||
// This is usefull in some VPN configurations (see CURLOPT_INTERFACE)
|
||||
$target_interface = NULL;
|
||||
```
|
||||
|
||||
!!! tip
|
||||
We do advice you to monitor what request are still being fired directly to your target CiviCRM once you installed and configured CiviProxy, and then find solutions for the situations if you still see some undesired access requests.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
# Future enhancements for CiviProxy
|
||||
At the moment there are a few future enhancements, bug fixes and small suggested changes, as you can see on the [issue list](https://github.com/systopia/CiviProxy/issues).
|
||||
|
||||
!!! tip
|
||||
If you want to report bugs or suggest future enhancements please do so on the [issue list](https://github.com/systopia/CiviProxy/issues).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 531 KiB |
|
|
@ -1,68 +0,0 @@
|
|||
# Introduction
|
||||
|
||||
## Public facing website and CiviCRM
|
||||
In the CiviCRM world it is a fairly typical requirement to want your public facing website and CiviCRM to communicate with each other.
|
||||
You would probably want to do stuff like:
|
||||
|
||||
* Allow website visitors to sign a petition, make a donation or register for an event.
|
||||
* Allow registered website visitors to view and perhaps update their own data.
|
||||
* Get website visitors to sign up (or unsubscribe) for newsletters.
|
||||
|
||||
However, for security and maintainability purposes it is recommended that you separate your CiviCRM installation and your public facing website. Factors that might influence this:
|
||||
|
||||
* Your biggest security risk is probably your public facing website where you want the whole world to be able to check, browse and do stuff, even without identifying themselves.
|
||||
* The data you want to protect the most is quite likely to be part of CiviCRM (data on your donors, peope who sign petitions, email addresses etc.).
|
||||
* You will need to install security upgrades on your website regularly as this is exposed to the public. However, you do not want to test all your business processes with each upgrade (which you will need to do if you have both website and CiviCRM on the same server to be sure they continue to work together).
|
||||
|
||||
So we think it is a sound practise to separate CiviCRM and your public facing website, and mainly use the CiviCRM API to send data to or get data from CiviCRM.
|
||||
|
||||
However, we do not want every authorized user to be able to use all the API possibilities. And we also do not want to allow any user access to the CiviCRM API.
|
||||
|
||||
And that is where **CiviProxy** comes in!
|
||||
## How does it work?
|
||||
The basic idea is to first put your CiviCRM (with probably a dummy CMS which you could use for your intranet) server into a VPN. This makes the server virtually inaccessible from the internet, and your users or your whole office will access it via a secure connection.
|
||||
|
||||
But what about your public web pages, donation pages, data exchange with other systems, API request? This is where CiviProxy comes in: You get a small, secure, extra server and give it access to both, the internet and your VPN. It will act as a safe gateway for selected features of your CiviCRM that you would like to expose.
|
||||
|
||||
In an example picture:
|
||||
|
||||
|
||||
|
||||
The advantages in a nutshell :thumbsup:
|
||||
|
||||
* CiviProxy is CiviCRM specific, so it kind of understands how CiviCRM works. It is **designed** to work with CiviCRM in a fairly simple way.
|
||||
* CiviProxy uses **whitelisting**. This means it starts with the principle _nothing is allowed_ and then lets you configure what is allowed, rather than the other way around.
|
||||
* CiviProxy uses **parameter sanitation**, meaning that only named parameters are allowed, and then only with the allowed content type (string, integer etc.).
|
||||
## What can it do?
|
||||
Currently CiviProxy can expose/relay the following CiviCRM functions
|
||||
|
||||
1. Serve resources for newsletters and mailings.
|
||||
1. Cache those resources, taking load off your CiviCRM server.
|
||||
1. Pass-through of tracking data on opening and click-through rates.
|
||||
1. Sign-on and off of your newsletter (Webpage templates).
|
||||
1. Relay of whitelisted REST API calls for data exchange with other systems.
|
||||
1. Perform input sanitation and parameter whitelisting for the REST API calls.
|
||||
|
||||
!!! attention
|
||||
This software has not (yet) been audited for security.
|
||||
## Why not an application firewall?
|
||||
The traditional approach to this problem would be an application firewall / reverse proxy setup. However, CiviCRM can have very complex interactions with other systems (e.g. via the API), and a malicious request can sometimes only be detected by understanding the meaning of the individual parameters.
|
||||
|
||||
Creating firewall rules for this level of detail is very complex and is very hard to maintain.
|
||||
|
||||
For this reason we wanted to take another approach and build a simple "bridgehead" system that *understands* CiviCRM, thus making its configuration and maintenance as easy as possible.
|
||||
|
||||
## Contents of this guide
|
||||
In this guide you will find pages on:
|
||||
|
||||
* [technical requirements for CiviProxy](requirements.md)
|
||||
* [how to install CiviProxy](installation.md)
|
||||
* [how to configure CiviProxy](configuration.md)
|
||||
* [what to do if an outside application wants to communicate with CiviProxy](outside.md)
|
||||
* [future enhancements for CiviProxy](enhancements.md)
|
||||
|
||||
!!! note
|
||||
This documentation is based on release 0.4 of CiviProxy.
|
||||
|
||||
!!! note
|
||||
In the guide we assume Drupal is the CMS of your target CiviCRM. Most of the stuff is CMS agnostic but you might have to change some of the URL's in the examples.
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
# Installation
|
||||
CiviProxy has to run on its own server (with its own IP address) for maximum effect.
|
||||
|
||||
The best option for a server on which you can install CiviProxy is a simple managed webspace, that you can rent cheaply from the hoster of your choice. It should have its own IP address, but other than that there are virtually no restrictions. This approach comes with a lot of advantages:
|
||||
|
||||
* Since there are a multitude of clients like you on such a server, the level of security can be expected to be very high, and it should be managed and monitored by professionals 24/7.
|
||||
* For the same reason, the bandwith and connectivity of such a server should be very high as well.
|
||||
* The price should not have to be huge.
|
||||
|
||||
!!! note
|
||||
Obviously there is nothing stopping you from installing CiviProxy on a server you manage yourself, but that then automatically means you have to ensure you maintain a high level of security and update the stuff regularly!
|
||||
|
||||
Installing CiviProxy should be pretty straightforward:
|
||||
|
||||
* Download the GitHub repository from [https://github.com/systopia/CiviProxy](https://github.com/systopia/CiviProxy).
|
||||
* In your repository are actually two relevant parts:
|
||||
|
||||
* A CiviCRM extension called **de.systopia.civiproxy** that you can use to send mailings (newsletters) from CiviCRM. This should be installed on your target CiviCRM installation.
|
||||
* A **proxy** folder with the scripts that you need to install on your CiviProxy server.
|
||||
* On top of that there will also be a **docs** folder containing this guide and a few necessary files (which are needed but you can ignore):
|
||||
* LIBRARIES.md
|
||||
* LICENSE
|
||||
* README.md
|
||||
* mkdocs.yml
|
||||
## Installing the CiviCRM extension on your target CiviCRM
|
||||
* copy the folder **de.systopia.civiproxy** that you downloaded in the previous step into your CiviCRM extensions folder. You should be able to find your civicrm extensions folder in **Administer>System Settings>Directories**. If you have never touched or changed this it will look like screen print below. In that case your folder is probably `<your civicrm folder>/sites/default/files/civicrm/ext/`
|
||||
|
||||
!!! seealso
|
||||
|
||||
|
||||
* go to **Administer>System Settings>Extensions** to see a page with all the installed extensions on your CiviCRM installation. You will have to click the **Refresh** button to see the **de.systopia.civiproxy** extension. Click the **Install** action listed behind the extension information. Upon successfull installation you should see a list like the one below (although you will probably see a larger list as you will have more extensions installed).
|
||||
|
||||
!!! seealso
|
||||
|
||||
|
||||
* type the URL`http://example.org/civicrm/clearcache` to clear the caches and rebuild the menu. This is necessary to add the CiviProxy settings page to CiviCRM.
|
||||
|
||||
!!! note
|
||||
use the URL `http://example.org/?q=civicrm/clearcache` if CleanUrls are not enabled
|
||||
|
||||
* you should now be able to access the CiviProxy Settings page with **Administer>Administration Console** (in the menu section System Settings) or with the URL `http://example.org/civicrm/admin/setting/civiproxy`.
|
||||
|
||||
!!! note
|
||||
use the URL `http://example.org/?q=civicrm/admin/setting/civiproxy` if CleanUrls are not enabled
|
||||
|
||||
!!! note
|
||||
If you want to you can add the CiviProxy Settings page to your Administration menu with Administer/Customize Data and Screens/Navigation Menu.
|
||||
|
||||
* check the [Configuring CiviProxy](configuration.md) page to see how to configure the CiviProxy extension.
|
||||
|
||||
## Installing the Proxy scripts your your CiviProxy server
|
||||
|
||||
1. Copy the **proxy** folder on the webspace you want to use for CiviProxy
|
||||
2. Create a `config.php` file using `config.dist.php` as a template.
|
||||
|
||||
See [Configuring CiviProxy](configuration.md) for details on what you need to include in the `config.php` file.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 185 KiB |
|
|
@ -1,12 +0,0 @@
|
|||
# What to do if an outside application wants to communicate with CiviProxy
|
||||
In most cases when an outside application (for example the public website, or maybe even a center webservice) wants to access CiviProxy to be able to retreive data from CiviCRM or send data to CiviCRM they will want to use the API.
|
||||
|
||||
In that case you should provide them with the Site key and an API key they can use. We recommend you do NOT use the CiviCRM Site Key and API Key.
|
||||
|
||||
!!! tip
|
||||
If you do not know how to do this check [Configuring CiviProxy](configuration.md).
|
||||
|
||||
They will have to use your CiviProxy URL in their REST request, and you will need to provide them with that URL. In my local example the call to the CiviProxy server would be:
|
||||
```
|
||||
http://localhost/proxy/rest.php?entity=Contact&action=getsingle&key=erikhtestkey&version=3&json=1&api_key=testerikhapikey&email=pipotest@example.org
|
||||
```
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
# Technical Requirements
|
||||
|
||||
There shouldn't be any requirements that any web hoster wouldn't comply with, but here they are:
|
||||
|
||||
1. PHP 5.3+
|
||||
2. PHP PEAR (to install on Debian/Ubuntu, run `apt-get install php-pear`)
|
||||
3. The `php-curl` module
|
||||
4. Read/write permissions on your webspace
|
||||
5. Reasonable amount of protection, i.e. only authorised users (you) can upload/download the files
|
||||
6. Ideally with it's own IP address (makes configuring the VPN easier)
|
||||
25
mkdocs.yml
25
mkdocs.yml
|
|
@ -1,25 +0,0 @@
|
|||
site_name: CiviProxy Guide
|
||||
site_description: Guide using and installing CiviProxy to manage the traffic to and from your CiviCRM installation
|
||||
repo_url: https://github.com/systopia/CiviProxy
|
||||
theme:
|
||||
name: material
|
||||
nav:
|
||||
- Introduction: index.md
|
||||
- Technical Requirements: requirements.md
|
||||
- Installing CiviProxy: installation.md
|
||||
- Configuring CiviProxy: configuration.md
|
||||
- Directing an outside application to CiviProxy: outside.md
|
||||
- Future enhancements to CiviProxy: enhancements.md
|
||||
|
||||
markdown_extensions:
|
||||
- attr_list
|
||||
- admonition
|
||||
- def_list
|
||||
- codehilite
|
||||
- toc:
|
||||
permalink: true
|
||||
- pymdownx.superfences
|
||||
- pymdownx.emoji
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
# Serve
|
||||
<IfModule mod_rewrite.c>
|
||||
RewriteEngine on
|
||||
RewriteCond %{REQUEST_URI} ^/civicrm/ajax/api4
|
||||
RewriteRule ^civicrm/ajax/api4/([^/]*)/([^/]*) rest4.php?entity=$1&action=$2 [QSA,B]
|
||||
</IfModule>
|
||||
|
|
@ -1,82 +0,0 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* generates a CiviCRM REST API compliant error
|
||||
* and ends processing
|
||||
*/
|
||||
function civiproxy_rest_error($message) {
|
||||
$error = array( 'is_error' => 1,
|
||||
'error_message' => $message);
|
||||
// TODO: Implement header();
|
||||
print json_encode($error);
|
||||
exit();
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates $credentials['api_key'] in-place, or displays an error if api key
|
||||
* is missing or does not correspond to an entry in $api_key_map (which should
|
||||
* be set in config.php).
|
||||
* @param array $credentials
|
||||
* @param array $api_key_map
|
||||
*/
|
||||
function civiproxy_map_api_key(array &$credentials, array $api_key_map) {
|
||||
if (empty($credentials['api_key'])) {
|
||||
civiproxy_rest_error("No API key given");
|
||||
}
|
||||
else {
|
||||
if (isset($api_key_map[$credentials['api_key']])) {
|
||||
$credentials['api_key'] = $api_key_map[$credentials['api_key']];
|
||||
}
|
||||
else {
|
||||
civiproxy_rest_error("Invalid api key");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates $credentials['key'] in-place, or displays an error if site key
|
||||
* is missing or does not correspond to an entry in $sys_key_map (which should
|
||||
* be set in config.php).
|
||||
* @param array $credentials
|
||||
* @param array $sys_key_map
|
||||
*/
|
||||
function civiproxy_map_site_key(array &$credentials, array $sys_key_map) {
|
||||
if (empty($credentials['key'])) {
|
||||
civiproxy_rest_error("No site key given");
|
||||
}
|
||||
else {
|
||||
if (isset($sys_key_map[$credentials['key']])) {
|
||||
$credentials['key'] = $sys_key_map[$credentials['key']];
|
||||
}
|
||||
else {
|
||||
civiproxy_rest_error("Invalid site key");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $action should have both 'entity' and 'action' keys set
|
||||
* @param array $rest_allowed_actions from config.php
|
||||
* @return array
|
||||
*/
|
||||
function civiproxy_get_valid_parameters(array $action, array $rest_allowed_actions) {
|
||||
// in release 0.4, allowed entity/actions per IP were introduced. To introduce backward compatibility,
|
||||
// the previous test is still used when no 'all' key is found in the array
|
||||
if (isset($rest_allowed_actions['all'])) {
|
||||
// get valid key for the rest_allowed_actions
|
||||
$valid_allowed_key = civiproxy_get_valid_allowed_actions_key($action, $rest_allowed_actions);
|
||||
$valid_parameters = civiproxy_retrieve_api_parameters($valid_allowed_key, $action['entity'], $action['action'], $rest_allowed_actions);
|
||||
if (!$valid_parameters) {
|
||||
civiproxy_rest_error("Invalid entity/action.");
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (isset($rest_allowed_actions[$action['entity']]) && isset($rest_allowed_actions[$action['entity']][$action['action']])) {
|
||||
$valid_parameters = $rest_allowed_actions[$action['entity']][$action['action']];
|
||||
}
|
||||
else {
|
||||
civiproxy_rest_error("Invalid entity/action.");
|
||||
}
|
||||
}
|
||||
return $valid_parameters;
|
||||
}
|
||||
|
|
@ -1,217 +0,0 @@
|
|||
<?php
|
||||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** INSTALLATION **
|
||||
** **
|
||||
** 0. Read https://docs.civicrm.org/civiproxy/en/latest **
|
||||
** 1. Make a copy of this file called config.php **
|
||||
** 2. Adjust the parameters and enable needed features **
|
||||
** 3. Some features (like mailings) require the CiviProxy **
|
||||
** extension to be enabled on the target CiviCRM **
|
||||
** **
|
||||
****************************************************************/
|
||||
|
||||
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** URLS **
|
||||
****************************************************************/
|
||||
// this should point to the base address of the CiviProxy installation
|
||||
$proxy_base = 'https://proxy.yourdomain.org';
|
||||
|
||||
// this should point to the target CiviCRM system
|
||||
$target_civicrm = 'https://your.civicrm.installation.org';
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** FEATURES / DEFAULT PATHS **
|
||||
** **
|
||||
** set to NULL to disable a feature **
|
||||
****************************************************************/
|
||||
|
||||
// default paths, override if you want. Set to NULL to disable
|
||||
$target_rest = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
|
||||
// base URL for api4 calls. Will append entity and action path segments
|
||||
$target_rest4 = $target_civicrm . '/civicrm/ajax/api4/';
|
||||
$target_file = $target_civicrm . '/sites/default/files/civicrm/persist/';
|
||||
$target_mosaico = NULL; // (disabled by default): $target_civicrm . '/civicrm/mosaico/img?src=';
|
||||
$target_mosaico_template_url = NULL; // (disabled by default): $target_civicrm . '/wp-content/uploads/civicrm/ext/uk.co.vedaconsulting.mosaico/packages/mosaico/templates/';
|
||||
$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
|
||||
$target_url = $target_civicrm . '/civicrm/mailing/url';
|
||||
$target_open = $target_civicrm . '/civicrm/mailing/open';
|
||||
|
||||
// CAUTION: use the following for CiviCRM < 5.27 or "Extern URL Style" = "Standalone Scripts"
|
||||
//$target_url = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
|
||||
//$target_open = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
|
||||
|
||||
/****************************************************************
|
||||
** GENERAL OPTIONS **
|
||||
****************************************************************/
|
||||
|
||||
// This logo is shown if the proxy server is address with a web browser
|
||||
// add your own logo here
|
||||
$civiproxy_logo = "<img src='{$proxy_base}/static/images/proxy-logo.png' alt='SYSTOPIA Organisationsberatung'></img>";
|
||||
|
||||
// Set api-key for mail subscribe/unsubscribe user
|
||||
// Set to NULL/FALSE to disable the feature
|
||||
// Can/shoud also be defined in secrets.php
|
||||
$mail_subscription_user_key = NULL;
|
||||
|
||||
// CAREFUL: only enable temporarily on debug systems.
|
||||
// Will log all queries to given PUBLIC file
|
||||
// Also: use some random name (not this one!)
|
||||
$debug = NULL; //'LUXFbiaoz4dVWuAHEcuBAe7YQ4YP96rN4MCDmKj89p.log';
|
||||
|
||||
// Local network interface or IP to be used for the relayed query
|
||||
// This is useful in some VPN configurations (see CURLOPT_INTERFACE)
|
||||
$target_interface = NULL;
|
||||
|
||||
|
||||
/***************************************************************
|
||||
** Authentication Options **
|
||||
***************************************************************/
|
||||
// API and SITE keys (you may add keys here)
|
||||
$api_key_map = [
|
||||
'my_api_key' => 'my_api_key', // use this to allow API key
|
||||
'ext_api_key' => 'real_api_key' // use this to allow and map API key
|
||||
];
|
||||
$sys_key_map = [
|
||||
'REAL_SITE_KEY' => 'REAL_SITE_KEY', // use this to allow site key
|
||||
'EXT_SITE_KEY' => 'REAL_SITE_KEY' // use this to allow and map site key
|
||||
];
|
||||
|
||||
// source secrets.php to overwrite keys
|
||||
if (file_exists(dirname(__FILE__)."/secrets.php")) {
|
||||
// keys can also be stored in 'secrets.php'
|
||||
require "secrets.php";
|
||||
}
|
||||
|
||||
// Parameter whitelisting for open tracking and URL tracking
|
||||
// basic civicrm URL/open parameter are u, q and qid (as int)
|
||||
// If additional parameters are needed, best practise would be to whitelist each one as needed in
|
||||
// $valid_url_parameters and/or $valid_open_parameters.
|
||||
// Alternatively it is also possible to allow all parameters with the wildcard parameter '*' => 'string'
|
||||
$valid_url_parameters = [
|
||||
'u' => 'int',
|
||||
'q' => 'int',
|
||||
'qid' => 'int',
|
||||
// '*' => 'string' // whildcard, whitelist all url parameters
|
||||
];
|
||||
$valid_open_parameters = [
|
||||
'u' => 'int',
|
||||
'q' => 'int',
|
||||
'qid' => 'int',
|
||||
// '*' => 'string' // wildcard, whitelist *all* open parameters
|
||||
];
|
||||
// CiviCRM's API can authenticate with different flows
|
||||
// https://docs.civicrm.org/dev/en/latest/framework/authx/#flows
|
||||
// CiviProxy supports 'header', 'xheader', 'legacyrest', and 'param'.
|
||||
// These flows are supported for API4 but could be extended to API3.
|
||||
// $authx_internal_flow controls how CiviProxy sends credentials to CiviCRM, and
|
||||
// $authx_external_flow where CiviProxy looks for credentials on incoming requests.
|
||||
// The internal setting needs to have a single scalar value, but the
|
||||
// external setting can be an array of accepted flows.
|
||||
// There is no standard header for site key, so in both header and xheader
|
||||
// flows it uses X-Civi-Key
|
||||
$authx_internal_flow = 'header';
|
||||
$authx_external_flow = ['legacyrest'];
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** File Caching Options **
|
||||
****************************************************************/
|
||||
|
||||
// define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
|
||||
$file_cache_options = [
|
||||
'cacheDir' => 'file_cache/',
|
||||
'lifeTime' => 86400
|
||||
];
|
||||
|
||||
// define regex patterns that shoud NOT be accepted
|
||||
$file_cache_exclude = [];
|
||||
|
||||
// if set, cached file must match at least one of these regex patterns
|
||||
$file_cache_include = [
|
||||
//'#.+[.](png|jpe?g|gif)#i' // only media files
|
||||
];
|
||||
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** REST API OPTIONS **
|
||||
****************************************************************/
|
||||
|
||||
// if you enable this, the system will also try to
|
||||
// parse the 'json' parameter, which holds additional
|
||||
// input data according to the CiviCRM REST API specs
|
||||
$rest_evaluate_json_parameter = FALSE;
|
||||
|
||||
// whitelisting is done per IP address ($_SERVER['REMOTE_ADDR']) with a 'all' for the generic stuff that applies to all IP addresses
|
||||
// - if a request comes in and the IP is not a key in the array, the whitelisted in 'all' are used
|
||||
// - if a request comes in and the IP is indeed a key in the array, the whitelisted in the IP are checked first. If nothing is
|
||||
// found ,the 'all' ones are checked next.
|
||||
$rest_allowed_actions = [
|
||||
'all' => [
|
||||
'Contact' => [
|
||||
'getsingle' => [
|
||||
'email' => 'string',
|
||||
],
|
||||
],
|
||||
],
|
||||
'123.45.67.8' => [
|
||||
'Contact' => [
|
||||
'getsingle' => [
|
||||
'first_name' => 'string',
|
||||
'last_name' => 'string',
|
||||
// the following means *all* remaining parameters will be
|
||||
// added and sanitised as 'string'. Better leave it out
|
||||
// if you know which parameters you expect
|
||||
'*' => 'string',
|
||||
],
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** WebHook2API CONFIGURATIONS **
|
||||
** Translates typical webhook calls into CiviCRM API calls **
|
||||
****************************************************************/
|
||||
// Example configuration:
|
||||
// remove if you don't want this feature or rename to $webhook2api to activate
|
||||
$_webhook2api = [
|
||||
"configurations" => [
|
||||
"default" => [
|
||||
"name" => "Example",
|
||||
"ip_sources" => ['172.10.0.1/24', '192.168.1.1/24'], // only accept source ID from the given range
|
||||
"data_sources" => ["POST/json", "REQUEST"], // POST/json json-decodes the post data, REQUEST is PHP's $_REQUEST array
|
||||
"sentinel" => [["type", "equal:customer.created"]], // only execute if all of these are true
|
||||
"entity" => "Contact",
|
||||
"action" => "create",
|
||||
"api_key" => "api key",
|
||||
"parameter_mapping" => [
|
||||
[["data", "object", "metadata", "salutation"], ["prefix_id"]],
|
||||
[["data", "object", "metadata", "first_name"], ["first_name"]],
|
||||
[["data", "object", "metadata", "last_name"], ["last_name"]],
|
||||
[["data", "object", "metadata", "street"], ["street_address"]],
|
||||
[["data", "object", "metadata", "zip_code"], ["postal_code"]],
|
||||
[["data", "object", "metadata", "city"], ["city"]],
|
||||
[["data", "object", "metadata", "country"], ["country_id"]],
|
||||
[["data", "object", "metadata", "telephone"], ["phone"]],
|
||||
[["data", "object", "metadata", "birthday"], ["birth_date"]],
|
||||
[["data", "object", "metadata", "email"], ["email"]]
|
||||
],
|
||||
"parameter_sanitation" => [],
|
||||
]
|
||||
]
|
||||
];
|
||||
|
|
@ -0,0 +1,84 @@
|
|||
<?php
|
||||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** URLS **
|
||||
****************************************************************/
|
||||
// this should point to the base address of the CiviProxy installation
|
||||
$proxy_base = 'https://proxy.yourdomain.org';
|
||||
|
||||
// this should point to the target CiviCRM system
|
||||
$target_civicrm = 'https://your.civicrm.installation.org';
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** DEFAULT PATHS **
|
||||
** **
|
||||
** set to NULL to disable a feature **
|
||||
****************************************************************/
|
||||
|
||||
// default paths, override if you want. Set to NULL to disable
|
||||
$target_rest = $target_civicrm . '/sites/all/modules/civicrm/extern/rest.php';
|
||||
$target_url = $target_civicrm . '/sites/all/modules/civicrm/extern/url.php';
|
||||
$target_open = $target_civicrm . '/sites/all/modules/civicrm/extern/open.php';
|
||||
$target_file = $target_civicrm . '/sites/default/files/civicrm/persist/';
|
||||
$target_mail_view = $target_civicrm . '/civicrm/mailing/view';
|
||||
|
||||
// Set api-key for mail subscribe/unsubscribe user
|
||||
// Set to NULL/FALSE to disable the feature
|
||||
$mail_subscription_user_key = NULL;
|
||||
|
||||
// CAREFUL: only enable temporarily on debug systems. Will log all queries to given PUBLIC file
|
||||
$debug = NULL; //'debug.log';
|
||||
|
||||
// Local network interface or IP to be used for the relayed query
|
||||
// This is usefull in some VPN configurations (see CURLOPT_INTERFACE)
|
||||
$target_interface = NULL;
|
||||
|
||||
/****************************************************************
|
||||
** File Caching Options **
|
||||
****************************************************************/
|
||||
|
||||
// API and SITE keys
|
||||
$api_key_map = array();
|
||||
$sys_key_map = array();
|
||||
|
||||
if (file_exists(dirname(__FILE__)."/secrets.php")) {
|
||||
// keys can also be stored in 'secrets.php'
|
||||
require "secrets.php";
|
||||
}
|
||||
|
||||
// define file cache options, see http://pear.php.net/manual/en/package.caching.cache-lite.cache-lite.cache-lite.php
|
||||
$file_cache_options = array(
|
||||
'cacheDir' => 'file_cache/',
|
||||
'lifeTime' => 86400
|
||||
);
|
||||
|
||||
// define regex patterns that shoud NOT be accepted
|
||||
$file_cache_exclude = array();
|
||||
|
||||
// if set, cached file must match at least one of these regex patterns
|
||||
$file_cache_include = array(
|
||||
//'#.+[.](png|jpe?g|gif)#i' // only media files
|
||||
);
|
||||
|
||||
|
||||
|
||||
/****************************************************************
|
||||
** REST API OPTIONS **
|
||||
****************************************************************/
|
||||
$rest_allowed_actions = array(
|
||||
// this is an example:
|
||||
'Contact' => array(
|
||||
'getsingle' => array(
|
||||
'email' => 'string'
|
||||
),
|
||||
)
|
||||
);
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -15,6 +15,7 @@ require_once "proxy.php";
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Error</title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -76,7 +76,7 @@ curl_setopt($curlSession, CURLOPT_URL, $url);
|
|||
curl_setopt($curlSession, CURLOPT_HEADER, 1);
|
||||
curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
|
||||
curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 1);
|
||||
if (!empty($target_interface)) {
|
||||
curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -16,6 +16,7 @@ require_once "proxy.php";
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Version <?php echo $civiproxy_version;?></title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -294,7 +294,7 @@ class Cache_Lite
|
|||
* @param array $options options
|
||||
* @access public
|
||||
*/
|
||||
function __construct($options = array(NULL))
|
||||
function Cache_Lite($options = array(NULL))
|
||||
{
|
||||
foreach($options as $key => $value) {
|
||||
$this->setOption($key, $value);
|
||||
|
|
@ -304,16 +304,6 @@ class Cache_Lite
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* PHP4 constructor for backwards compatibility with older code
|
||||
*
|
||||
* @param array $options Options
|
||||
*/
|
||||
function Cache_Lite($options = array(NULL))
|
||||
{
|
||||
self::__construct($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generic way to set a Cache_Lite option
|
||||
*
|
||||
|
|
@ -564,6 +554,7 @@ class Cache_Lite
|
|||
*/
|
||||
function raiseError($msg, $code)
|
||||
{
|
||||
include_once('PEAR.php');
|
||||
return PEAR::raiseError($msg, $code, $this->_pearErrorMode);
|
||||
}
|
||||
|
||||
|
|
@ -638,7 +629,7 @@ class Cache_Lite
|
|||
return true;
|
||||
}
|
||||
}
|
||||
if (!($dh = @opendir($dir))) {
|
||||
if (!($dh = opendir($dir))) {
|
||||
return $this->raiseError('Cache_Lite : Unable to open cache directory !', -4);
|
||||
}
|
||||
$result = true;
|
||||
|
|
@ -707,10 +698,8 @@ class Cache_Lite
|
|||
$this->_touchCacheFile();
|
||||
$this->_memoryCachingArray[$this->_file] = $data;
|
||||
if ($this->_memoryCachingCounter >= $this->_memoryCachingLimit) {
|
||||
$key = key($this->_memoryCachingArray);
|
||||
next($this->_memoryCachingArray);
|
||||
list($key, ) = each($this->_memoryCachingArray);
|
||||
unset($this->_memoryCachingArray[$key]);
|
||||
|
||||
} else {
|
||||
$this->_memoryCachingCounter = $this->_memoryCachingCounter + 1;
|
||||
}
|
||||
|
|
@ -755,7 +744,7 @@ class Cache_Lite
|
|||
if ($this->_fileLocking) @flock($fp, LOCK_SH);
|
||||
clearstatcache();
|
||||
$length = @filesize($this->_file);
|
||||
$mqr = (function_exists('get_magic_quotes_runtime') ? @get_magic_quotes_runtime() : 0);
|
||||
$mqr = get_magic_quotes_runtime();
|
||||
if ($mqr) {
|
||||
set_magic_quotes_runtime(0);
|
||||
}
|
||||
|
|
@ -834,7 +823,7 @@ class Cache_Lite
|
|||
if ($this->_readControl) {
|
||||
@fwrite($fp, $this->_hash($data, $this->_readControlType), 32);
|
||||
}
|
||||
$mqr = (function_exists('get_magic_quotes_runtime') ? @get_magic_quotes_runtime() : 0);
|
||||
$mqr = get_magic_quotes_runtime();
|
||||
if ($mqr) {
|
||||
set_magic_quotes_runtime(0);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -52,10 +52,10 @@ class Cache_Lite_File extends Cache_Lite
|
|||
* @param array $options options
|
||||
* @access public
|
||||
*/
|
||||
function __construct($options = array(NULL))
|
||||
function Cache_Lite_File($options = array(NULL))
|
||||
{
|
||||
$options['lifetime'] = 0;
|
||||
parent::__construct($options);
|
||||
$this->Cache_Lite($options);
|
||||
if (isset($options['masterFile'])) {
|
||||
$this->_masterFile = $options['masterFile'];
|
||||
} else {
|
||||
|
|
@ -66,16 +66,6 @@ class Cache_Lite_File extends Cache_Lite
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* PHP4 constructor for backwards compatibility with older code
|
||||
*
|
||||
* @param array $options Options
|
||||
*/
|
||||
function Cache_Lite_File($options = array(NULL))
|
||||
{
|
||||
self::__construct($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test if a cache is available and (if yes) return it
|
||||
*
|
||||
|
|
|
|||
|
|
@ -81,27 +81,17 @@ class Cache_Lite_Function extends Cache_Lite
|
|||
* @param array $options options
|
||||
* @access public
|
||||
*/
|
||||
function __construct($options = array(NULL))
|
||||
function Cache_Lite_Function($options = array(NULL))
|
||||
{
|
||||
$availableOptions = array('debugCacheLiteFunction', 'defaultGroup', 'dontCacheWhenTheOutputContainsNOCACHE', 'dontCacheWhenTheResultIsFalse', 'dontCacheWhenTheResultIsNull');
|
||||
foreach ($options as $name => $value) {
|
||||
while (list($name, $value) = each($options)) {
|
||||
if (in_array($name, $availableOptions)) {
|
||||
$property = '_'.$name;
|
||||
$this->$property = $value;
|
||||
}
|
||||
}
|
||||
reset($options);
|
||||
parent::__construct($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* PHP4 constructor for backwards compatibility with older code
|
||||
*
|
||||
* @param array $options Options
|
||||
*/
|
||||
function Cache_Lite_Function($options = array(NULL))
|
||||
{
|
||||
self::__construct($options);
|
||||
$this->Cache_Lite($options);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -26,19 +26,9 @@ class Cache_Lite_Output extends Cache_Lite
|
|||
* @param array $options options
|
||||
* @access public
|
||||
*/
|
||||
function __construct($options)
|
||||
function Cache_Lite_Output($options)
|
||||
{
|
||||
parent::__construct($options);
|
||||
}
|
||||
|
||||
/**
|
||||
* PHP4 constructor for backwards compatibility with older code
|
||||
*
|
||||
* @param array $options Options
|
||||
*/
|
||||
function Cache_Lite_Output($options = array(NULL))
|
||||
{
|
||||
self::__construct($options);
|
||||
$this->Cache_Lite($options);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1,25 +1,19 @@
|
|||
# PEAR Cache_Lite
|
||||
|
||||
Fast and safe little cache system.
|
||||
|
||||
This package is a little cache system optimized for file containers.
|
||||
t is fast and safe (because it uses file locking and/or anti-corruption tests).
|
||||
|
||||
[](https://travis-ci.org/pear/Cache_Lite)
|
||||
|
||||
This package is [Cache_Lite](http://pear.php.net/package/Cache_Lite).
|
||||
|
||||
Please report all new issues via the [PEAR bug tracker](http://pear.php.net/bugs/).
|
||||
|
||||
## Building
|
||||
To test this package, run
|
||||
|
||||
phpunit tests/
|
||||
|
||||
To build, simply execute
|
||||
To build, simply
|
||||
|
||||
pear package
|
||||
|
||||
|
||||
## Installation
|
||||
### PEAR
|
||||
To install from scratch
|
||||
|
||||
pear install package.xml
|
||||
|
|
@ -27,15 +21,3 @@ To install from scratch
|
|||
To upgrade
|
||||
|
||||
pear upgrade -f package.xml
|
||||
|
||||
### Composer
|
||||
|
||||
composer require pear/cache_lite
|
||||
|
||||
|
||||
## Links
|
||||
- Homepage: http://pear.php.net/package/Cache_Lite
|
||||
- Source code: https://github.com/pear/Cache_Lite
|
||||
- Issue tracker: http://pear.php.net/bugs/search.php?cmd=display&package_name[]=Cache_Lite
|
||||
- Unit test status: https://travis-ci.org/pear/Cache_Lite
|
||||
- Packagist: https://packagist.org/packages/pear/cache_lite
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -19,7 +19,7 @@ civiproxy_security_check('mail-confirm');
|
|||
// basic restraints
|
||||
$valid_parameters = array( 'sid' => 'int',
|
||||
'cid' => 'int',
|
||||
'h' => 'string');
|
||||
'h' => 'hex');
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
||||
// check if parameters specified
|
||||
|
|
@ -45,6 +45,7 @@ if (!empty($group_query['is_error'])) {
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Version <?php echo $civiproxy_version;?></title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -17,7 +17,7 @@ if (!$target_mail_view) civiproxy_http_error("Feature disabled", 405);
|
|||
civiproxy_security_check('mail-view');
|
||||
|
||||
// basic restraints
|
||||
$valid_parameters = array( 'id' => 'int', 'cid' => 'int', 'cs' => 'string' );
|
||||
$valid_parameters = array( 'id' => 'int' );
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
||||
// check if id specified
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -19,7 +19,7 @@ civiproxy_security_check('mail-resubscribe');
|
|||
// basic restraints
|
||||
$valid_parameters = array( 'jid' => 'int',
|
||||
'qid' => 'int',
|
||||
'h' => 'string');
|
||||
'h' => 'hex');
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
||||
// check if parameters specified
|
||||
|
|
@ -45,6 +45,7 @@ if (!empty($group_query['is_error'])) {
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Version <?php echo $civiproxy_version;?></title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -83,6 +83,7 @@ if (!empty($_REQUEST['email'])) {
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Version <?php echo $civiproxy_version;?></title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -19,7 +19,7 @@ civiproxy_security_check('mail-unsubscribe');
|
|||
// basic restraints
|
||||
$valid_parameters = array( 'jid' => 'int',
|
||||
'qid' => 'int',
|
||||
'h' => 'string');
|
||||
'h' => 'hex');
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
||||
// check if parameters specified
|
||||
|
|
@ -45,6 +45,7 @@ if (!empty($group_query['is_error'])) {
|
|||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>CiviProxy Version <?php echo $civiproxy_version;?></title>
|
||||
<link href="http://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet" type="text/css">
|
||||
<style type="text/css">
|
||||
body {
|
||||
margin: 0;
|
||||
|
|
|
|||
|
|
@ -1,146 +0,0 @@
|
|||
<?php
|
||||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2017-2021 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
require_once "config.php";
|
||||
require_once "proxy.php";
|
||||
|
||||
// see if file caching is enabled
|
||||
if (!$target_mosaico) civiproxy_http_error("Feature disabled", 405);
|
||||
|
||||
// basic check
|
||||
civiproxy_security_check('file');
|
||||
|
||||
// basic restraints
|
||||
$valid_parameters = array( 'id' => 'string', 'template_url' => 'string' );
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
||||
if (!empty($parameters['id'])) {
|
||||
// check restrictions
|
||||
if (!empty($file_cache_exclude)) {
|
||||
foreach ($file_cache_exclude as $pattern) {
|
||||
if (preg_match($pattern, $parameters['id'])) {
|
||||
civiproxy_http_error("Invalid Resource", 403);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!empty($file_cache_include)) {
|
||||
$accept_id = FALSE;
|
||||
foreach ($file_cache_include as $pattern) {
|
||||
if (preg_match($pattern, $parameters['id'])) {
|
||||
$accept_id = TRUE;
|
||||
}
|
||||
}
|
||||
if (!$accept_id) {
|
||||
civiproxy_http_error("Invalid Resource", 403);
|
||||
}
|
||||
}
|
||||
|
||||
// look up the required resource
|
||||
$header_key = 'header&' . $parameters['id'];
|
||||
$data_key = 'data&' . $parameters['id'];
|
||||
$url = $target_mosaico . $parameters['id'];
|
||||
} elseif (!empty($parameters['template_url'])) {
|
||||
// check restrictions
|
||||
if (!empty($file_cache_exclude)) {
|
||||
foreach ($file_cache_exclude as $pattern) {
|
||||
if (preg_match($pattern, $parameters['template_url'])) {
|
||||
civiproxy_http_error("Invalid Resource", 403);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!empty($file_cache_include)) {
|
||||
$accept_id = FALSE;
|
||||
foreach ($file_cache_include as $pattern) {
|
||||
if (preg_match($pattern, $parameters['template_url'])) {
|
||||
$accept_id = TRUE;
|
||||
}
|
||||
}
|
||||
if (!$accept_id) {
|
||||
civiproxy_http_error("Invalid Resource", 403);
|
||||
}
|
||||
}
|
||||
|
||||
// look up the required resource
|
||||
$header_key = 'header&' . $parameters['template_url'];
|
||||
$data_key = 'data&' . $parameters['template_url'];
|
||||
$url = $target_mosaico_template_url . $parameters['template_url'];
|
||||
} else {
|
||||
civiproxy_http_error("Resource not found");
|
||||
}
|
||||
|
||||
// load PEAR file cache
|
||||
ini_set('include_path', ini_get('include_path') . PATH_SEPARATOR . 'libs');
|
||||
if (!file_exists($file_cache_options['cacheDir'])) mkdir($file_cache_options['cacheDir']);
|
||||
require_once('Cache/Lite.php');
|
||||
$file_cache = new Cache_Lite($file_cache_options);
|
||||
|
||||
|
||||
$header = $file_cache->get($header_key);
|
||||
$data = $file_cache->get($data_key);
|
||||
|
||||
if ($header && $data) {
|
||||
// error_log("CACHE HIT");
|
||||
$header_lines = json_decode($header);
|
||||
foreach ($header_lines as $header_line) {
|
||||
header($header_line);
|
||||
}
|
||||
|
||||
print $data;
|
||||
exit();
|
||||
}
|
||||
|
||||
// if we get here, we have a cache miss => load
|
||||
$curlSession = curl_init();
|
||||
curl_setopt($curlSession, CURLOPT_URL, $url);
|
||||
curl_setopt($curlSession, CURLOPT_HEADER, 1);
|
||||
curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
|
||||
curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
|
||||
if (!empty($target_interface)) {
|
||||
curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
|
||||
}
|
||||
if (file_exists(dirname(__FILE__).'/target.pem')) {
|
||||
curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
|
||||
}
|
||||
|
||||
//Send the request and store the result in an array
|
||||
$response = curl_exec($curlSession);
|
||||
|
||||
// Check that a connection was made
|
||||
if (curl_error($curlSession)) {
|
||||
error_log(curl_error($curlSession));
|
||||
civiproxy_http_error(curl_error($curlSession), curl_errno($curlSession));
|
||||
}
|
||||
|
||||
// process the results
|
||||
$content = explode("\r\n\r\n", $response, 2);
|
||||
$header = $content[0];
|
||||
$body = $content[1];
|
||||
|
||||
// extract headers
|
||||
$header_lines = explode(chr(10), $header);
|
||||
|
||||
// Remove chunked encoding header
|
||||
foreach ($header_lines as $k => $header_line) {
|
||||
if(strpos($header_line,'Transfer-Encoding: chunked') !== FALSE) {
|
||||
unset($header_lines[$k]);
|
||||
}
|
||||
}
|
||||
|
||||
// store the information in the cache
|
||||
$file_cache->save(json_encode($header_lines), $header_key);
|
||||
$file_cache->save($body, $data_key);
|
||||
|
||||
// and reply
|
||||
foreach ($header_lines as $header_line) {
|
||||
header($header_line);
|
||||
}
|
||||
|
||||
print $body;
|
||||
curl_close ($curlSession);
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -16,5 +16,8 @@ if (!$target_open) civiproxy_http_error("Feature disabled", 405);
|
|||
// basic check
|
||||
civiproxy_security_check('open');
|
||||
|
||||
$parameters = civiproxy_get_parameters($valid_open_parameters);
|
||||
// basic restraints
|
||||
$valid_parameters = array( 'q' => 'int' );
|
||||
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
civiproxy_redirect($target_open, $parameters);
|
||||
|
|
|
|||
448
proxy/proxy.php
448
proxy/proxy.php
|
|
@ -2,13 +2,14 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
require_once "config.php";
|
||||
$civiproxy_version = '1.0.0-beta';
|
||||
$civiproxy_version = '0.3.2';
|
||||
$civiproxy_logo = "<img src='{$proxy_base}/static/images/proxy-logo.png' alt='SYSTOPIA Organisationsberatung'></img>";
|
||||
|
||||
/**
|
||||
* this will redirect the request to another URL,
|
||||
|
|
@ -48,7 +49,7 @@ function civiproxy_redirect($url_requested, $parameters) {
|
|||
curl_setopt($curlSession, CURLOPT_HEADER, 1);
|
||||
curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
|
||||
curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 1);
|
||||
if (!empty($target_interface)) {
|
||||
curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
|
||||
}
|
||||
|
|
@ -90,180 +91,28 @@ function civiproxy_redirect($url_requested, $parameters) {
|
|||
curl_close ($curlSession);
|
||||
}
|
||||
|
||||
/**
|
||||
* this will redirect the request to an API4 URL,
|
||||
* i.e. will pass the reply on to this request
|
||||
*
|
||||
* @see losely based on https://code.google.com/p/php-proxy/
|
||||
*
|
||||
* @param $url_requested string the URL to which the request should be sent
|
||||
* @param $parameters array
|
||||
* @param $credentials array
|
||||
*/
|
||||
function civiproxy_redirect4($url_requested, $parameters, $credentials) {
|
||||
global $target_interface, $authx_internal_flow;
|
||||
$url = $url_requested;
|
||||
$curlSession = curl_init();
|
||||
$credential_params = civiproxy_build_credential_params($credentials, $authx_internal_flow);
|
||||
$credential_headers = civiproxy_build_credential_headers($credentials, $authx_internal_flow);
|
||||
|
||||
if ($_SERVER['REQUEST_METHOD'] == 'POST'){
|
||||
// POST requests should be passed on as POST
|
||||
curl_setopt($curlSession, CURLOPT_POST, 1);
|
||||
$urlparams = 'params=' . urlencode(json_encode($parameters)) . $credential_params;
|
||||
curl_setopt($curlSession, CURLOPT_POSTFIELDS, $urlparams);
|
||||
} else {
|
||||
// GET requests will get the parameters as url params
|
||||
if (!empty($parameters)) {
|
||||
$url .= '?params=' . urlencode(json_encode($parameters)) . $credential_params;
|
||||
}
|
||||
}
|
||||
|
||||
curl_setopt($curlSession, CURLOPT_HTTPHEADER, array_merge([
|
||||
'Content-Type: application/x-www-form-urlencoded'
|
||||
], $credential_headers));
|
||||
curl_setopt($curlSession, CURLOPT_URL, $url);
|
||||
curl_setopt($curlSession, CURLOPT_HEADER, 1);
|
||||
curl_setopt($curlSession, CURLOPT_RETURNTRANSFER,1);
|
||||
curl_setopt($curlSession, CURLOPT_TIMEOUT, 30);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
|
||||
if (!empty($target_interface)) {
|
||||
curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
|
||||
}
|
||||
if (file_exists(dirname(__FILE__).'/target.pem')) {
|
||||
curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
|
||||
}
|
||||
|
||||
//Send the request and store the result in an array
|
||||
$response = curl_exec($curlSession);
|
||||
|
||||
// Check that a connection was made
|
||||
if (curl_error($curlSession)){
|
||||
civiproxy_http_error(curl_error($curlSession), curl_errno($curlSession));
|
||||
|
||||
} else {
|
||||
//clean duplicate header that seems to appear on fastcgi with output buffer on some servers!!
|
||||
$response = str_replace("HTTP/1.1 100 Continue\r\n\r\n","",$response);
|
||||
|
||||
// split header / content
|
||||
$content = explode("\r\n\r\n", $response, 2);
|
||||
$header = $content[0];
|
||||
$body = $content[1];
|
||||
|
||||
// handle headers - simply re-outputing them
|
||||
$header_ar = explode(chr(10), $header);
|
||||
foreach ($header_ar as $header_line){
|
||||
if (!preg_match("/^Transfer-Encoding/", $header_line)){
|
||||
civiproxy_mend_URLs($header_line);
|
||||
header(trim($header_line));
|
||||
}
|
||||
}
|
||||
|
||||
//rewrite all hard coded urls to ensure the links still work!
|
||||
civiproxy_mend_URLs($body);
|
||||
|
||||
print $body;
|
||||
}
|
||||
|
||||
curl_close($curlSession);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a string with the API credentials to be appended to an API4 GET or POST request.
|
||||
* When $api4_internal_auth_flow is 'header' or 'xheader', returns a blank string
|
||||
*
|
||||
* @param array $credentials
|
||||
* @param string $authx_internal_flow
|
||||
* @return string credential string, including leading '&'
|
||||
*/
|
||||
function civiproxy_build_credential_params(array $credentials, string $authx_internal_flow): string {
|
||||
switch($authx_internal_flow) {
|
||||
case 'legacyrest':
|
||||
$map = ['api_key' => 'api_key', 'key' => 'key'];
|
||||
break;
|
||||
case 'param':
|
||||
$map = ['api_key' => '_authx', 'key' => '_authxSiteKey'];
|
||||
break;
|
||||
default:
|
||||
return '';
|
||||
}
|
||||
$params = [];
|
||||
foreach($map as $credential_key => $param_name) {
|
||||
if (isset($credentials[$credential_key])) {
|
||||
$credential_value = $credentials[$credential_key];
|
||||
if ($param_name === '_authx') {
|
||||
$credential_value = 'Bearer ' . $credential_value;
|
||||
}
|
||||
$params[$param_name] = $credential_value;
|
||||
}
|
||||
}
|
||||
|
||||
$param_string = http_build_query($params);
|
||||
if (!empty($param_string)) {
|
||||
$param_string = '&' . $param_string;
|
||||
}
|
||||
return $param_string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds an array of headers to send on an API4 request. When $api4_internal_auth_flow
|
||||
* is 'param' or 'legacyrest', will always return an empty array.
|
||||
*
|
||||
* @param array $credentials
|
||||
* @param string $authx_internal_flow
|
||||
* @return array
|
||||
*/
|
||||
function civiproxy_build_credential_headers(array $credentials, string $authx_internal_flow): array {
|
||||
switch($authx_internal_flow) {
|
||||
case 'header':
|
||||
$map = ['api_key' => 'Authorization: Bearer', 'key' => 'X-Civi-Key:'];
|
||||
break;
|
||||
case 'xheader':
|
||||
$map = ['api_key' => 'X-Civi-Auth: Bearer', 'key' => 'X-Civi-Key:'];
|
||||
break;
|
||||
default:
|
||||
return [];
|
||||
}
|
||||
$headers = [];
|
||||
foreach($map as $credential_key => $header_prefix) {
|
||||
if (isset($credentials[$credential_key])) {
|
||||
$headers[] = $header_prefix . ' ' . $credentials[$credential_key];
|
||||
}
|
||||
}
|
||||
return $headers;
|
||||
}
|
||||
|
||||
/**
|
||||
* Will mend all the URLs in the string that point to the target,
|
||||
* so they will point to this proxy instead
|
||||
*/
|
||||
function civiproxy_mend_URLs(&$string) {
|
||||
global $target_rest, $target_url, $target_open, $target_file, $target_mail, $proxy_base, $target_mosaico, $target_civicrm;
|
||||
global $target_rest, $target_url, $target_open, $target_file, $target_mail, $proxy_base;
|
||||
|
||||
if ($target_rest) {
|
||||
$string = preg_replace("#{$target_rest}#", $proxy_base . '/rest.php', $string);
|
||||
$string = preg_replace("#$target_rest#", $proxy_base . '/rest.php', $string);
|
||||
}
|
||||
if ($target_url) {
|
||||
$string = preg_replace("#{$target_url}#", $proxy_base . '/url.php', $string);
|
||||
$string = preg_replace("#$target_url#", $proxy_base . '/url.php', $string);
|
||||
}
|
||||
if ($target_open) {
|
||||
$string = preg_replace("#{$target_open}#", $proxy_base . '/open.php', $string);
|
||||
$string = preg_replace("#$target_open#", $proxy_base . '/open.php', $string);
|
||||
}
|
||||
if ($target_mail) {
|
||||
$string = preg_replace("#{$target_mail}#", $proxy_base . '/mail.php', $string);
|
||||
$string = preg_replace("#$target_mail#", $proxy_base . '/mail.php', $string);
|
||||
}
|
||||
if ($target_file) {
|
||||
$string = preg_replace("#{$target_file}#", $proxy_base . '/file.php?id=', $string);
|
||||
// https://github.com/systopia/CiviProxy/issues/38
|
||||
// fix for relative
|
||||
if ($target_mosaico) {
|
||||
$string = preg_replace("#src=\"\/sites\/default\/files\/civicrm\/persist\/#", 'src="' . $proxy_base . '/file.php?id=', $string);
|
||||
}
|
||||
}
|
||||
if ($target_mosaico) {
|
||||
// replace full, and relative URL
|
||||
// $string = preg_replace("#{$target_mosaico}#", $proxy_base . '/mosaico.php?id=', $string);
|
||||
$string = preg_replace("#{$target_civicrm}/civicrm/mosaico/img\?src=#", $proxy_base . '/mosaico.php?id=', $string);
|
||||
$string = preg_replace("#$target_file#", $proxy_base . '/file.php?id=', $string);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -273,12 +122,11 @@ function civiproxy_mend_URLs(&$string) {
|
|||
* unauthorized access quantities, etc.
|
||||
*
|
||||
* @param $target
|
||||
* @param $quit bool if TRUE, quit immediately if access denied
|
||||
* @param $log_headers array add these headers (sanitized) to log data
|
||||
* @param $quit if TRUE, quit immediately if access denied
|
||||
*
|
||||
* @return TRUE if allowed, FALSE if not (or quits if $quit is set)
|
||||
*/
|
||||
function civiproxy_security_check($target, $quit=TRUE, $log_headers = []) {
|
||||
function civiproxy_security_check($target, $quit=TRUE) {
|
||||
// verify that we're SSL encrypted
|
||||
if ($_SERVER['HTTPS'] != "on") {
|
||||
civiproxy_http_error("This CiviProxy installation requires SSL encryption.", 400);
|
||||
|
|
@ -286,159 +134,69 @@ function civiproxy_security_check($target, $quit=TRUE, $log_headers = []) {
|
|||
|
||||
global $debug;
|
||||
if (!empty($debug)) {
|
||||
// filter log data
|
||||
$log_data = $_REQUEST;
|
||||
$sanitize_params = ['api_key', 'key', '_authxSiteKey', '_authx'];
|
||||
foreach ($sanitize_params as $param) {
|
||||
if (isset($log_data[$param])) {
|
||||
$log_data[$param] = substr($log_data[$param], 0, 4) . '...';
|
||||
}
|
||||
}
|
||||
|
||||
foreach($log_headers as $header) {
|
||||
if (!empty($_SERVER[$header]))
|
||||
$log_data[$header] = substr($_SERVER[$header], 0, 4) . '...';
|
||||
}
|
||||
|
||||
// log
|
||||
civiproxy_log("REQUEST FROM " . $_SERVER['REMOTE_ADDR'] . " ON " . date('Y-m-d H:i:s') . ' -- ' . print_r($log_data ,1));
|
||||
$file = fopen($debug, 'a');
|
||||
fwrite($file, "REQUEST FROM " . $_SERVER['REMOTE_ADDR'] . " ON " . date('Y-m-d H:i:s') . ' -- ' . print_r($_REQUEST,1));
|
||||
fclose($file);
|
||||
}
|
||||
|
||||
// TODO: implement
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Log a message to the proxy log - if enabled
|
||||
*
|
||||
* @param $message string the log message
|
||||
*/
|
||||
function civiproxy_log($message) {
|
||||
global $debug;
|
||||
if (!empty($debug)) {
|
||||
$file = fopen($debug, 'a');
|
||||
fwrite($file, $message);
|
||||
fclose($file);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* extract and type check the parameters from the call params
|
||||
*
|
||||
* @param $valid_parameters array '<parameter name> => '<expected type>'
|
||||
* where type can be 'int', 'string' (unchecked),
|
||||
* @param $request provides the request data to use,
|
||||
* defaults to $_REQUEST
|
||||
*/
|
||||
function civiproxy_get_parameters($valid_parameters, $request = NULL) {
|
||||
if ($request === NULL) {
|
||||
$request = $_REQUEST;
|
||||
}
|
||||
|
||||
function civiproxy_get_parameters($valid_parameters) {
|
||||
$result = array();
|
||||
$default_sanitation = NULL;
|
||||
|
||||
foreach ($valid_parameters as $name => $type) {
|
||||
if ($name == '*') {
|
||||
// this sets default_sanitation
|
||||
$default_sanitation = $type;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (isset($request[$name])) {
|
||||
$result[$name] = civiproxy_sanitise($request[$name], $type);
|
||||
}
|
||||
}
|
||||
// process wildcard elements
|
||||
if ($default_sanitation !== NULL) {
|
||||
// i.e. we want the others too
|
||||
$remove_parameters = array('key', 'api_key', '_authx', '_authxSiteKey', 'version', 'entity', 'action');
|
||||
foreach ($request as $name => $value) {
|
||||
if (!in_array($name, $remove_parameters) && !isset($valid_parameters[$name])) {
|
||||
$result[$name] = civiproxy_sanitise($value, $default_sanitation);
|
||||
if (isset($_REQUEST[$name])) {
|
||||
$value = $_REQUEST[$name];
|
||||
if ($type=='int') {
|
||||
$value = (int) $value;
|
||||
} elseif ($type == 'string') {
|
||||
// TODO: sanitize? SQL?
|
||||
$value = $value;
|
||||
} elseif ($type == 'float2') {
|
||||
// TODO: check if safe wrt l10n. rather use sprintf
|
||||
$value = number_format($value, 2, '.', '');
|
||||
} elseif ($type == 'hex') {
|
||||
// hex code
|
||||
if (!preg_match("#^[0-9a-f]*$#i", $value)) {
|
||||
error_log("CiviProxy: removed invalid hex parameter: " . $value);
|
||||
$value = '';
|
||||
}
|
||||
} elseif ($type == 'email') {
|
||||
// valid email
|
||||
if (!preg_match("#^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,3})$#i", $value)) {
|
||||
error_log("CiviProxy: removed invalid email parameter: " . $value);
|
||||
$value = '';
|
||||
}
|
||||
} elseif (is_array($type)) {
|
||||
// this is a list of valid options
|
||||
$requested_value = $value;
|
||||
$value = '';
|
||||
foreach ($type as $allowed_value) {
|
||||
if ($requested_value === $allowed_value) {
|
||||
$value = $requested_value;
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
error_log("CiviProxy: unknown type '$type'. Ignored.");
|
||||
$value = '';
|
||||
}
|
||||
$result[$name] = $value;
|
||||
}
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of a header on the incoming request
|
||||
*
|
||||
* @param string $header name of the header, in all uppercase
|
||||
* @param string $prefix to be stripped off the value of the header
|
||||
* @return string|null value of the header, or null if not found.
|
||||
*/
|
||||
function civiproxy_get_header($header, $prefix = ''): ?string {
|
||||
if (!empty($_SERVER['HTTP_' . $header])) {
|
||||
$value = $_SERVER['HTTP_' . $header];
|
||||
if ($prefix === '') {
|
||||
return $value;
|
||||
}
|
||||
if (strpos($value, $prefix) === 0) {
|
||||
return trim(substr($value, strlen($prefix)));
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/**
|
||||
* sanitise the given value with the given sanitiation type
|
||||
*/
|
||||
function civiproxy_sanitise($value, $type) {
|
||||
if ($type=='int') {
|
||||
$value = (int) $value;
|
||||
} elseif ($type == 'string') {
|
||||
// TODO: sanitize? SQL?
|
||||
$value = $value;
|
||||
} elseif ($type == 'float2') {
|
||||
// TODO: check if safe wrt l10n. rather use sprintf
|
||||
$value = number_format($value, 2, '.', '');
|
||||
} elseif ($type == 'hex') {
|
||||
// hex code
|
||||
if (!preg_match("#^[0-9a-f]*$#i", $value)) {
|
||||
error_log("CiviProxy: removed invalid hex parameter: " . $value);
|
||||
$value = '';
|
||||
}
|
||||
} elseif ($type == 'email') {
|
||||
// valid email
|
||||
if (!preg_match("#^[_a-z0-9-]+[._a-z0-9-+]*@[a-z0-9-]+[.a-z0-9-]*\.[a-z]{2,3}$#i", $value)) {
|
||||
error_log("CiviProxy: removed invalid email parameter: " . $value);
|
||||
$value = '';
|
||||
}
|
||||
} elseif ($type == 'json') {
|
||||
// valid json
|
||||
$json_data = json_decode($value, true);
|
||||
if ($json_data === NULL) {
|
||||
$value = '';
|
||||
} else {
|
||||
$value = json_encode($value);
|
||||
}
|
||||
} elseif ($type == 'array') {
|
||||
// this should only happen _inside_ the json field
|
||||
if (!is_array($value)) {
|
||||
$value = '';
|
||||
}
|
||||
} elseif (is_array($type)) {
|
||||
// this is a list of valid options
|
||||
$requested_value = $value;
|
||||
$value = '';
|
||||
foreach ($type as $allowed_value) {
|
||||
if ($requested_value === $allowed_value) {
|
||||
$value = $requested_value;
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
error_log("CiviProxy: unknown type '$type'. Ignored.");
|
||||
$value = '';
|
||||
}
|
||||
return $value;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* generates a CiviCRM REST API compliant error
|
||||
* and ends processing
|
||||
|
|
@ -483,7 +241,7 @@ function civicrm_api3($entity, $action, $data) {
|
|||
curl_setopt($curlSession, CURLOPT_INTERFACE, $target_interface);
|
||||
}
|
||||
// curl_setopt($curlSession, CURLOPT_SSL_VERIFYPEER, 1);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 2);
|
||||
curl_setopt($curlSession, CURLOPT_SSL_VERIFYHOST, 1);
|
||||
if (file_exists(dirname(__FILE__).'/target.pem')) {
|
||||
curl_setopt($curlSession, CURLOPT_CAINFO, dirname(__FILE__).'/target.pem');
|
||||
}
|
||||
|
|
@ -497,103 +255,3 @@ function civicrm_api3($entity, $action, $data) {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to get the valid rest_allowed_actions key
|
||||
*
|
||||
* @param $action
|
||||
* @param $rest_allowed_actions
|
||||
* @return bool
|
||||
*/
|
||||
function civiproxy_get_valid_allowed_actions_key($action, $rest_allowed_actions) {
|
||||
$remote_addr = $_SERVER['REMOTE_ADDR'];
|
||||
// check IP specific whitelisting if specified for this address
|
||||
if (isset($rest_allowed_actions[$remote_addr])) {
|
||||
if (civiproxy_validate_api_entity_and_action($remote_addr, $action['entity'], $action['action'], $rest_allowed_actions)) {
|
||||
$valid_key = $remote_addr;
|
||||
} else {
|
||||
$valid_key = 'all';
|
||||
}
|
||||
} else {
|
||||
$valid_key = 'all';
|
||||
}
|
||||
return $valid_key;
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to check whether the api entity and api action are valid for the remote address.
|
||||
* This function does a case insensitive comparison.
|
||||
*
|
||||
* @param $remote_addr
|
||||
* 'all', or the remote address.
|
||||
* @param $api_entity
|
||||
* The api entity.
|
||||
* @param $api_action
|
||||
* The api action.
|
||||
* @param $rest_allowed_actions
|
||||
* The array with the allowed actions.
|
||||
* @return bool
|
||||
*/
|
||||
function civiproxy_validate_api_entity_and_action($remote_addr, $api_entity, $api_action, $rest_allowed_actions) {
|
||||
if (!isset($rest_allowed_actions[$remote_addr])) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$api_entity = strtolower($api_entity);
|
||||
$api_action = strtolower($api_action);
|
||||
if (isset($rest_allowed_actions[$remote_addr][$api_entity]) && isset($rest_allowed_actions[$remote_addr][$api_entity][$api_action])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Did not find the lower case variant.
|
||||
// loop through the array
|
||||
foreach($rest_allowed_actions[$remote_addr] as $allowed_entity => $allowed_actions) {
|
||||
if (strtolower($allowed_entity) == $api_entity) {
|
||||
foreach($allowed_actions as $allowed_action => $fields) {
|
||||
if (strtolower($allowed_action) == $api_action) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to retrieve the valid parameters of an api call
|
||||
* This function does a case insensitive comparison.
|
||||
*
|
||||
* @param $remote_addr
|
||||
* 'all', or the remote address.
|
||||
* @param $api_entity
|
||||
* The api entity.
|
||||
* @param $api_action
|
||||
* The api action.
|
||||
* @param $rest_allowed_actions
|
||||
* The array with the allowed actions.
|
||||
* @return array()|null
|
||||
**/
|
||||
function civiproxy_retrieve_api_parameters($remote_addr, $api_entity, $api_action, $rest_allowed_actions) {
|
||||
if (!isset($rest_allowed_actions[$remote_addr])) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$api_entity = strtolower($api_entity);
|
||||
$api_action = strtolower($api_action);
|
||||
if (isset($rest_allowed_actions[$remote_addr][$api_entity]) && isset($rest_allowed_actions[$remote_addr][$api_entity][$api_action])) {
|
||||
return $rest_allowed_actions[$remote_addr][$api_entity][$api_action];
|
||||
}
|
||||
|
||||
// Did not find the lower case variant.
|
||||
// loop through the array
|
||||
foreach($rest_allowed_actions[$remote_addr] as $allowed_entity => $allowed_actions) {
|
||||
if (strtolower($allowed_entity) == $api_entity) {
|
||||
foreach($allowed_actions as $allowed_action => $parameters) {
|
||||
if (strtolower($allowed_action) == $api_action) {
|
||||
return $parameters;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -2,18 +2,18 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
require_once "config.php";
|
||||
require_once "proxy.php";
|
||||
require_once "checks.php";
|
||||
|
||||
// see if REST API is enabled
|
||||
if (!$target_rest) civiproxy_http_error("Feature disabled", 405);
|
||||
|
||||
|
||||
// basic check
|
||||
if (!civiproxy_security_check('rest')) {
|
||||
civiproxy_rest_error("Access denied.");
|
||||
|
|
@ -21,17 +21,36 @@ if (!civiproxy_security_check('rest')) {
|
|||
|
||||
// check credentials
|
||||
$credentials = civiproxy_get_parameters(array('key' => 'string', 'api_key' => 'string'));
|
||||
if (empty($credentials['key'])) {
|
||||
civiproxy_rest_error("No site key given");
|
||||
} else {
|
||||
if (isset($sys_key_map[$credentials['key']])) {
|
||||
$credentials['key'] = $sys_key_map[$credentials['key']];
|
||||
} else {
|
||||
civiproxy_rest_error("Invalid site key");
|
||||
}
|
||||
}
|
||||
|
||||
civiproxy_map_site_key($credentials, $sys_key_map);
|
||||
civiproxy_map_api_key($credentials, $api_key_map);
|
||||
if (empty($credentials['api_key'])) {
|
||||
civiproxy_rest_error("No API key given");
|
||||
} else {
|
||||
if (isset($api_key_map[$credentials['api_key']])) {
|
||||
$credentials['api_key'] = $api_key_map[$credentials['api_key']];
|
||||
} else {
|
||||
civiproxy_rest_error("Invalid api key");
|
||||
}
|
||||
}
|
||||
|
||||
// check if the call itself is allowed
|
||||
$action = civiproxy_get_parameters(array('entity' => 'string', 'action' => 'string', 'version' => 'int', 'json' => 'int', 'sequential' => 'int'));
|
||||
if (!isset($action['version']) || $action['version'] != 3) {
|
||||
civiproxy_rest_error("API 'version' information missing.");
|
||||
civiproxy_rest_error("Invalid entity/action.");
|
||||
}
|
||||
if (isset($rest_allowed_actions[$action['entity']]) && isset($rest_allowed_actions[$action['entity']][$action['action']])) {
|
||||
$valid_parameters = $rest_allowed_actions[$action['entity']][$action['action']];
|
||||
} else {
|
||||
civiproxy_rest_error("Invalid entity/action.");
|
||||
}
|
||||
|
||||
$valid_parameters= civiproxy_get_valid_parameters($action, $rest_allowed_actions);
|
||||
|
||||
// extract parameters and add credentials and action data
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
|
|
@ -42,18 +61,19 @@ foreach ($action as $key => $value) {
|
|||
$parameters[$key] = $value;
|
||||
}
|
||||
|
||||
// evaluate the JSON parameter
|
||||
global $rest_evaluate_json_parameter;
|
||||
if ($rest_evaluate_json_parameter) {
|
||||
if (isset($_REQUEST['json'])) {
|
||||
$json_data = json_decode($_REQUEST['json'], true);
|
||||
if (!empty($json_data) && is_array($json_data)) {
|
||||
$json_parameters = civiproxy_get_parameters($valid_parameters, $json_data);
|
||||
$parameters['json'] = json_encode($json_parameters);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// finally execute query
|
||||
civiproxy_log($target_rest);
|
||||
civiproxy_redirect($target_rest, $parameters);
|
||||
|
||||
|
||||
/**
|
||||
* generates a CiviCRM REST API compliant error
|
||||
* and ends processing
|
||||
*/
|
||||
function civiproxy_rest_error($message) {
|
||||
$error = array( 'is_error' => 1,
|
||||
'error_message' => $message);
|
||||
// TODO: Implement
|
||||
//header();
|
||||
print json_encode($error);
|
||||
exit();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,89 +0,0 @@
|
|||
<?php
|
||||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
require_once "config.php";
|
||||
require_once "proxy.php";
|
||||
require_once "checks.php";
|
||||
|
||||
// see if REST API is enabled
|
||||
if (!$target_rest4) {
|
||||
civiproxy_http_error("Feature disabled");
|
||||
}
|
||||
$valid_flows = ['header', 'xheader', 'legacyrest', 'param'];
|
||||
$headers_by_flow = [
|
||||
'header' => ['HTTP_AUTHORIZATION', 'HTTP_X_CIVI_KEY'],
|
||||
'xheader' => ['HTTP_X_CIVI_AUTH', 'HTTP_X_CIVI_KEY'],
|
||||
'legacyrest' => [],
|
||||
'param' => [],
|
||||
];
|
||||
if (!in_array($authx_internal_flow, $valid_flows)) {
|
||||
civiproxy_http_error("Invalid internal auth flow '$authx_internal_flow'", 500);
|
||||
}
|
||||
$headers_to_log = [];
|
||||
foreach ($authx_external_flow as $external_flow) {
|
||||
if (!in_array($external_flow, $valid_flows)) {
|
||||
civiproxy_http_error("Invalid external auth flow '$external_flow'", 500);
|
||||
}
|
||||
$headers_to_log = array_merge($headers_to_log, $headers_by_flow[$external_flow]);
|
||||
}
|
||||
|
||||
// basic check
|
||||
if (!civiproxy_security_check('rest', TRUE, $headers_to_log)) {
|
||||
civiproxy_rest_error("Access denied.");
|
||||
}
|
||||
|
||||
$credentials = [];
|
||||
// Find credentials on the incoming request
|
||||
foreach ($authx_external_flow as $external_flow) {
|
||||
switch($external_flow) {
|
||||
case 'header':
|
||||
$credentials['api_key'] = civiproxy_get_header('AUTHORIZATION', 'Bearer ');
|
||||
$credentials['key'] = civiproxy_get_header('HTTP_X_CIVI_KEY');
|
||||
break;
|
||||
case 'xheader':
|
||||
$credentials['api_key'] = civiproxy_get_header('X_CIVI_AUTH', 'Bearer ');
|
||||
$credentials['key'] = civiproxy_get_header('HTTP_X_CIVI_KEY');
|
||||
break;
|
||||
case 'legacyrest':
|
||||
$credentials = civiproxy_get_parameters(array('api_key' => 'string', 'key' => 'string'));
|
||||
break;
|
||||
case 'param':
|
||||
$authx_credentials = civiproxy_get_parameters(array('_authx' => 'string', '_authxSiteKey' => 'string'));
|
||||
if (!empty($authx_credentials['_authx'])) {
|
||||
// Snip off leading 'Bearer ' or 'Bearer+'
|
||||
if (substr($authx_credentials['_authx'], 0, 6) === 'Bearer') {
|
||||
$credentials['api_key'] = substr($authx_credentials['_authx'], 7);
|
||||
}
|
||||
}
|
||||
if (!empty($authx_credentials['_authxSiteKey'])) {
|
||||
$credentials['key'] = $authx_credentials['_authxSiteKey'];
|
||||
}
|
||||
break;
|
||||
}
|
||||
if (!empty($credentials['api_key'])) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
civiproxy_map_api_key($credentials, $api_key_map);
|
||||
if (!empty($credentials['key'])) {
|
||||
civiproxy_map_site_key( $credentials, $sys_key_map);
|
||||
}
|
||||
|
||||
// check if the call itself is allowed
|
||||
$action = civiproxy_get_parameters(array('entity' => 'string', 'action' => 'string'));
|
||||
|
||||
$valid_parameters = civiproxy_get_valid_parameters($action, $rest_allowed_actions);
|
||||
|
||||
// extract parameters and add action data
|
||||
$parameters = civiproxy_get_parameters($valid_parameters, json_decode($_REQUEST['params'], true));
|
||||
|
||||
// finally execute query
|
||||
civiproxy_log($target_rest4);
|
||||
civiproxy_redirect4($target_rest4 . $action['entity'] . '/' . $action['action'] , $parameters, $credentials);
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2015-2021 SYSTOPIA |
|
||||
| Copyright (C) 2015 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
|
@ -16,5 +16,10 @@ if (!$target_url) civiproxy_http_error("Feature disabled", 405);
|
|||
// basic check
|
||||
civiproxy_security_check('url');
|
||||
|
||||
$parameters = civiproxy_get_parameters($valid_url_parameters);
|
||||
// basic restraints
|
||||
$valid_parameters = array( 'u' => 'int',
|
||||
'q' => 'int',
|
||||
'qid' => 'int');
|
||||
|
||||
$parameters = civiproxy_get_parameters($valid_parameters);
|
||||
civiproxy_redirect($target_url, $parameters);
|
||||
|
|
|
|||
|
|
@ -1,298 +0,0 @@
|
|||
<?php
|
||||
/*--------------------------------------------------------+
|
||||
| SYSTOPIA CiviProxy |
|
||||
| a simple proxy solution for external access to CiviCRM |
|
||||
| Copyright (C) 2019-2021 SYSTOPIA |
|
||||
| Author: B. Endres (endres -at- systopia.de) |
|
||||
| http://www.systopia.de/ |
|
||||
+---------------------------------------------------------*/
|
||||
|
||||
require_once "config.php";
|
||||
require_once "proxy.php";
|
||||
|
||||
// first check if webhooks are enabled
|
||||
if (empty($webhook2api)) civiproxy_http_error("Feature disabled", 405);
|
||||
|
||||
// basic check
|
||||
if (!civiproxy_security_check('webhook2api')) {
|
||||
civiproxy_http_error("Access denied", 403);
|
||||
}
|
||||
|
||||
// find the right configuration
|
||||
if (!empty($_REQUEST['id']) && isset($webhook2api['configurations'][$_REQUEST['id']])) {
|
||||
// we found the if in the configurations
|
||||
$configurations = [$webhook2api['configurations'][$_REQUEST['id']]];
|
||||
} elseif (empty($_REQUEST['id']) && isset($webhook2api['configurations']['default'])) {
|
||||
// this is teh default configuration
|
||||
$configurations = [$webhook2api['configurations']['default']];
|
||||
} else {
|
||||
// use all of them (first one matching is executed)
|
||||
$configurations = $webhook2api['configurations'];
|
||||
}
|
||||
|
||||
// read some input
|
||||
$post_input = @file_get_contents('php://input');
|
||||
|
||||
// MAIN: iterate through all (eligible) configurations
|
||||
$last_error = ["No handler found", 501];
|
||||
foreach ($configurations as $configuration) {
|
||||
$last_error = webhook2api_processConfiguration($configuration, $post_input);
|
||||
if ($last_error == NULL) {
|
||||
// success!
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// finally - if there was only errors, return the last one
|
||||
if ($last_error) {
|
||||
civiproxy_http_error($last_error[0], $last_error[1]);
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Apply the given configuration. If it matches and executes,
|
||||
* it returns NULL, otherwise
|
||||
*
|
||||
* @param $configuration array configuration/specification
|
||||
* @return null|array [status_code, error message]
|
||||
*/
|
||||
function webhook2api_processConfiguration($configuration, $post_input) {
|
||||
// check the IP/range restrictions
|
||||
if (!empty($configuration['ip_sources']) && is_array($configuration['ip_sources'])) {
|
||||
$ip = $_SERVER['REMOTE_ADDR'];
|
||||
$access_granted = FALSE;
|
||||
foreach ($configuration['ip_sources'] as $netmask) {
|
||||
// copied from https://secure.php.net/manual/de/ref.network.php
|
||||
list ($net, $mask) = explode("/", $netmask);
|
||||
$ip_net = ip2long ($net);
|
||||
$ip_mask = ~((1 << (32 - $mask)) - 1);
|
||||
$ip_ip = ip2long ($ip);
|
||||
$ip_ip_net = $ip_ip & $ip_mask;
|
||||
if ($ip_ip_net == $ip_net) {
|
||||
$access_granted = TRUE;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!$access_granted) {
|
||||
// this configuration is not eligible
|
||||
return ["Access denied", 403];
|
||||
}
|
||||
}
|
||||
|
||||
// gather source data
|
||||
$data = [];
|
||||
if (!empty($configuration['data_sources']) && is_array($configuration['data_sources'])) {
|
||||
foreach ($configuration['data_sources'] as $data_source) {
|
||||
switch ($data_source) {
|
||||
case 'POST/json': # JSON data in POST field
|
||||
$more_data = json_decode($post_input, TRUE);
|
||||
$data = array_merge_recursive($data, $more_data);
|
||||
break;
|
||||
case 'REQUEST': # simple request parameters
|
||||
$data = array_merge_recursive($data, $_REQUEST);
|
||||
break;
|
||||
default:
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: unknown source '{$data_source}' in configuration. Ignored.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// default return code if everything goes according to plan
|
||||
$http_code = 200;
|
||||
// check if we have a json_array and react accordingly
|
||||
if (isset($data[0]) && is_array($data[0])) {
|
||||
foreach ($data as $d) {
|
||||
$result = webhook2api_callCiviApi($configuration, $d);
|
||||
if(isset($result['internal_error'])) {
|
||||
// internal communication Error occurred. Aborting process
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: internal error occurred: " . json_encode($result['internal_error']));
|
||||
return $result['internal_error'];
|
||||
}
|
||||
if (!empty($result['values']['http_code'])) {
|
||||
$http_code = $result['values']['http_code'];
|
||||
} else {
|
||||
$http_code = 403;
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$result = webhook2api_callCiviApi($configuration, $data);
|
||||
if(isset($result['internal_error'])) {
|
||||
// internal communication Error occurred. Aborting process
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: internal error occurred: " . json_encode($result['internal_error']));
|
||||
return $result['internal_error'];
|
||||
}
|
||||
if (!empty($result['values']['http_code'])) {
|
||||
$http_code = $result['values']['http_code'];
|
||||
} elseif ($result['is_error'] != 0) {
|
||||
$http_code = 403;
|
||||
}
|
||||
}
|
||||
if ($http_code != '200') {
|
||||
// we received and parsed the webhook event successfully, but an error occurred with civicrm:
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: Internal CiviCRM Error. Error Code: {$http_code}. Full Message: " . json_encode($result));
|
||||
}
|
||||
|
||||
// process result
|
||||
if (!empty($configuration['response_mapping']) && is_array($configuration['response_mapping'])) {
|
||||
// TODO: implement
|
||||
http_response_code('200');
|
||||
civiproxy_log("Webhook successful, response mapped.");
|
||||
} else {
|
||||
// default behaviour:
|
||||
http_response_code('200');
|
||||
civiproxy_log("Webhook successful.");
|
||||
}
|
||||
// all done
|
||||
exit();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Parse Configuration and given data set, apply it and send it to civicrm.
|
||||
* Returns an internal error if communication to civicrm isn't successful
|
||||
*
|
||||
* @param $configuration
|
||||
* @param $data
|
||||
*
|
||||
* @return array|mixed|void
|
||||
* @throws \CiviCRM_API3_Exception
|
||||
*/
|
||||
function webhook2api_callCiviApi($configuration, $data) {
|
||||
// evaluate sentinels
|
||||
if (!empty($configuration['sentinel']) && is_array($configuration['sentinel'])) {
|
||||
foreach ($configuration['sentinel'] as $sentinel) {
|
||||
list($value_source, $check) = $sentinel;
|
||||
$value = webhook2api_getValue($data, $value_source);
|
||||
if (substr($check, 0, 6) == "equal:") {
|
||||
// check if terms a equal
|
||||
if (substr($check, 6) != $value) {
|
||||
return ["internal_error" => "Access denied", 403];
|
||||
}
|
||||
} else {
|
||||
echo "Error";
|
||||
// unknown instruction
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: don't understand sentinel '{$check}'. Ignored.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// compile API query
|
||||
$params = [];
|
||||
if (!empty($configuration['parameter_mapping']) && is_array($configuration['parameter_mapping'])) {
|
||||
foreach ($configuration['parameter_mapping'] as $mapping) {
|
||||
$source_path = $mapping[0];
|
||||
$target_path = $mapping[1];
|
||||
$modifiers = isset($mapping[2]) ? $mapping[2] : [];
|
||||
|
||||
// get value
|
||||
$value = webhook2api_getValue($data, $source_path);
|
||||
|
||||
// run modifiers
|
||||
foreach ($modifiers as $modifier) {
|
||||
// TODO: implement
|
||||
|
||||
civiproxy_log("Webhook2API.modifiers: not implemented!");
|
||||
}
|
||||
|
||||
// set to target
|
||||
webhook2api_setValue($params, $target_path, $value);
|
||||
}
|
||||
} else {
|
||||
$params = $data;
|
||||
}
|
||||
|
||||
// sanitise data
|
||||
if (!empty($configuration['parameter_sanitation']) && is_array($configuration['parameter_sanitation'])) {
|
||||
// TODO: implement
|
||||
civiproxy_log("Webhook2API.sanitation: not implemented!");
|
||||
}
|
||||
|
||||
// send to target REST API
|
||||
if (empty($configuration['entity']) || empty($configuration['action'])) {
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: Missing entity/action.");
|
||||
return ["internal_error" => "Configuration error", 403];
|
||||
}
|
||||
if (empty($configuration['api_key'])) {
|
||||
civiproxy_log("Webhook2API[{$configuration['name']}]: Missing api_key.");
|
||||
return ["internal_error" => "Configuration error", 403];
|
||||
}
|
||||
$params['api_key'] = $configuration['api_key'];
|
||||
|
||||
// run API call
|
||||
return civicrm_api3($configuration['entity'], $configuration['action'], $params);
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get the value from a multidimensional array,
|
||||
* specified by the path
|
||||
*
|
||||
* @param $data array multidimensional data array
|
||||
* @param $path array|string path description
|
||||
* @return mixed value
|
||||
*/
|
||||
function webhook2api_getValue($data, $path) {
|
||||
if (is_string($path)) {
|
||||
if (isset($data[$path])) {
|
||||
return $data[$path];
|
||||
} else {
|
||||
return NULL;
|
||||
}
|
||||
} elseif (is_array($path)) {
|
||||
if (count($path) == 0) {
|
||||
return NULL;
|
||||
} elseif (count($path) == 1) {
|
||||
return webhook2api_getValue($data, $path[0]);
|
||||
} else {
|
||||
$path_element = array_shift($path);
|
||||
$sub_data = webhook2api_getValue($data, $path_element);
|
||||
if (is_array($sub_data)) {
|
||||
return webhook2api_getValue($sub_data, $path);
|
||||
} else {
|
||||
return NULL;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the value from a multidimensional array as specified by the path
|
||||
*
|
||||
* @param $data array the data
|
||||
* @param $target_path array destination
|
||||
* @param $value mixed value
|
||||
*/
|
||||
function webhook2api_setValue(&$data, $target_path, $value) {
|
||||
if (is_array($target_path)) {
|
||||
if (count($target_path) == 0) {
|
||||
civiproxy_log("Webhook2API.setValue: Empty target path!");
|
||||
return;
|
||||
|
||||
} elseif (count($target_path) == 1) {
|
||||
// last element -> set value
|
||||
$data[$target_path[0]] = $value;
|
||||
|
||||
} else {
|
||||
// not last element
|
||||
$element = array_shift($target_path);
|
||||
if (!isset($data[$element])) {
|
||||
$data[$element] = [];
|
||||
}
|
||||
if (is_array($data[$element])) {
|
||||
webhook2api_setValue($data[$element], $target_path, $value);
|
||||
} else {
|
||||
civiproxy_log("Webhook2API.setValue: path node is not an array!");
|
||||
}
|
||||
}
|
||||
|
||||
} elseif (is_string($target_path)) {
|
||||
webhook2api_setValue($data, [$target_path], $value);
|
||||
|
||||
} else {
|
||||
civiproxy_log("Webhook2API.setValue: path neither string nor array!");
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue