diff --git a/.gitignore b/.gitignore index 35ab904fdabd..64fd87124b7c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ .use-civicrm-setup /ext/* !/ext/afform +!/ext/authx !/ext/sequentialcreditnotes !/ext/flexmailer !/ext/eventcart diff --git a/CRM/Core/Invoke.php b/CRM/Core/Invoke.php index bcb6da8a9892..bc537d6b269f 100644 --- a/CRM/Core/Invoke.php +++ b/CRM/Core/Invoke.php @@ -64,6 +64,7 @@ public static function _invoke($args) { // may exit self::hackMenuRebuild($args); self::init($args); + Civi::dispatcher()->dispatch('civi.invoke.auth', \Civi\Core\Event\GenericHookEvent::create(['args' => $args])); $item = self::getItem($args); return self::runItem($item); } diff --git a/CRM/Core/Session.php b/CRM/Core/Session.php index 7ca6a46ead25..698b25eb9ddf 100644 --- a/CRM/Core/Session.php +++ b/CRM/Core/Session.php @@ -86,6 +86,39 @@ public static function &singleton() { return self::$_singleton; } + /** + * Replace the session object with a fake session. + */ + public static function useFakeSession() { + self::$_singleton = new class() extends CRM_Core_Session { + + public function initialize($isRead = FALSE) { + if ($isRead) { + return; + } + + if (!isset($this->_session)) { + $this->_session = []; + } + + if (!isset($this->_session[$this->_key]) || !is_array($this->_session[$this->_key])) { + $this->_session[$this->_key] = []; + } + } + + public function isEmpty() { + return empty($this->_session); + } + + }; + self::$_singleton->_session = NULL; + // This is not a revocable proposition. Should survive, even with things 'System.flush'. + if (!defined('_CIVICRM_FAKE_SESSION')) { + define('_CIVICRM_FAKE_SESSION', TRUE); + } + return self::$_singleton; + } + /** * Creates an array in the session. * diff --git a/CRM/Utils/System/Drupal.php b/CRM/Utils/System/Drupal.php index fea28fb6a4f4..34742a094fd2 100644 --- a/CRM/Utils/System/Drupal.php +++ b/CRM/Utils/System/Drupal.php @@ -850,7 +850,9 @@ public function onCiviExit() { if (!defined('MAINTENANCE_MODE') || MAINTENANCE_MODE != 'update') { module_invoke_all('exit'); } - drupal_session_commit(); + if (!defined('_CIVICRM_FAKE_SESSION')) { + drupal_session_commit(); + } } } diff --git a/distmaker/dists/common.sh b/distmaker/dists/common.sh index 7c07c8ae7193..e7fb58ef9b15 100644 --- a/distmaker/dists/common.sh +++ b/distmaker/dists/common.sh @@ -125,6 +125,7 @@ function dm_core_exts() { echo ext/ewaysingle echo ext/financialacls echo ext/afform + echo ext/authx echo ext/greenwich echo ext/contributioncancelactions echo ext/oauth-client diff --git a/ext/authx/CRM/Authx/Page/AJAX.php b/ext/authx/CRM/Authx/Page/AJAX.php new file mode 100644 index 000000000000..ecdba043b23f --- /dev/null +++ b/ext/authx/CRM/Authx/Page/AJAX.php @@ -0,0 +1,44 @@ + CRM_Core_Session::getLoggedInContactID(), + 'user_id' => $authxUf->getCurrentUserId(), + ]; + + CRM_Utils_JSON::output($response); + } + + /** + * Present the outcome of an authx login. + * + * Note that the actual authentication is handled in the authentication layer. + * This method just renders the response page after a successful login. + */ + public static function login() { + self::getId(); + } + + /** + * Logout of Civi+CMS. + * + * GET /civicrm/authx/logout + * POST /civicrm/authx/logout + */ + public static function logout() { + _authx_uf()->logoutSession(); + CRM_Utils_JSON::output([]); + } + +} diff --git a/ext/authx/Civi/Authx/Authenticator.php b/ext/authx/Civi/Authx/Authenticator.php new file mode 100644 index 000000000000..c83ac1d64741 --- /dev/null +++ b/ext/authx/Civi/Authx/Authenticator.php @@ -0,0 +1,326 @@ +authxUf = _authx_uf(); + } + + /** + * Run the entire authentication routine, checking credentials, checking policy, + * and ultimately logging in. + * + * @param \Civi\Core\Event\GenericHookEvent $e + * Details for the 'civi.invoke.auth' event. + * @param array $details + * Mix of these properties: + * - string $flow (required); + * The type of authentication flow being used + * Ex: 'param', 'header', 'auto' + * - string $cred (required) + * The credential, as formatted in the 'Authorization' header. + * Ex: 'Bearer 12345', 'Basic ASDFFDSA==' + * - bool $useSession (default FALSE) + * If TRUE, then the authentication should be persistent (in a session variable). + * If FALSE, then the authentication should be ephemeral (single page-request). + * @return bool + * Returns TRUE on success. + * Exits with failure + * @throws \Exception + */ + public function auth($e, $details) { + $tgt = AuthenticatorTarget::create([ + 'flow' => $details['flow'], + 'cred' => $details['cred'], + 'useSession' => $details['useSession'] ?? FALSE, + ]); + if ($principal = $this->checkCredential($tgt)) { + $tgt->setPrincipal($principal); + } + $this->checkPolicy($tgt); + $this->login($tgt); + return TRUE; + } + + /** + * Assess the credential ($tgt->cred) and determine the matching principal. + * + * @param \Civi\Authx\AuthenticatorTarget $tgt + * @return array|NULL + * Array describing the authenticated principal represented by this credential. + * Ex: ['userId' => 123] + * Format should match setPrincipal(). + * @see \Civi\Authx\AuthenticatorTarget::setPrincipal() + */ + protected function checkCredential($tgt) { + [$credFmt, $credValue] = explode(' ', $tgt->cred, 2); + + switch ($credFmt) { + case 'Basic': + [$user, $pass] = explode(':', base64_decode($credValue), 2); + if ($userId = $this->authxUf->checkPassword($user, $pass)) { + return ['userId' => $userId, 'credType' => 'pass']; + } + break; + + case 'Bearer': + $c = \CRM_Core_DAO::singleValueQuery('SELECT id FROM civicrm_contact WHERE api_key = %1', [ + 1 => [$credValue, 'String'], + ]); + if ($c) { + return ['contactId' => $c, 'credType' => 'api_key']; + } + + try { + $claims = \Civi::service('crypto.jwt')->decode($credValue); + $scopes = isset($claims['scope']) ? explode(' ', $claims['scope']) : []; + if (!in_array('authx', $scopes)) { + $this->reject('JWT does not permit general authentication'); + } + if (empty($claims['sub']) || substr($claims['sub'], 0, 4) !== 'cid:') { + $this->reject('JWT does not specify the contact ID (sub)'); + } + $contactId = substr($claims['sub'], 4); + return ['contactId' => $contactId, 'credType' => 'jwt', 'jwt' => $claims]; + } + catch (CryptoException $e) { + // Invalid JWT. Proceed to check any other token sources. + } + + break; + } + + return NULL; + } + + /** + * Does our policy permit this login? + * + * @param \Civi\Authx\AuthenticatorTarget $tgt + */ + protected function checkPolicy(AuthenticatorTarget $tgt) { + if (!$tgt->hasPrincipal()) { + $this->reject('Invalid credential'); + } + + $allowCreds = \Civi::settings()->get('authx_' . $tgt->flow . '_cred'); + if (!in_array($tgt->credType, $allowCreds)) { + $this->reject(sprintf('Authentication type "%s" is not allowed for this principal.', $tgt->credType)); + } + + $userMode = \Civi::settings()->get('authx_' . $tgt->flow . '_user'); + switch ($userMode) { + case 'ignore': + $tgt->userId = NULL; + break; + + case 'require': + if (empty($tgt->userId)) { + $this->reject('Cannot login. No matching user is available.'); + } + break; + } + } + + /** + * Update Civi and UF to recognize the authenticated user. + * + * @param AuthenticatorTarget $tgt + * Summary of the authentication request + * @throws \Exception + */ + protected function login(AuthenticatorTarget $tgt) { + $isSameValue = function($a, $b) { + return !empty($a) && (string) $a === (string) $b; + }; + + if (\CRM_Core_Session::getLoggedInContactID() || $this->authxUf->getCurrentUserId()) { + if ($isSameValue(\CRM_Core_Session::getLoggedInContactID(), $tgt->contactId) && $isSameValue($this->authxUf->getCurrentUserId(), $tgt->userId)) { + // Already logged in. Nothing to do. + return; + } + else { + // This is plausible if you have a dev or admin experimenting. + // We should probably show a more useful page - e.g. ask if they want + // logout and/or suggest using private browser window. + $this->reject('Cannot login. Session already active.'); + // @see \Civi\Authx\AllFlowsTest::testStatefulStatelessOverlap() + } + } + + if (empty($tgt->contactId)) { + // It shouldn't be possible to get here due policy checks. But just in case. + throw new \LogicException("Cannot login. Failed to determine contact ID."); + } + + if (!($tgt->useSession)) { + \CRM_Core_Session::useFakeSession(); + } + + if ($tgt->userId && $tgt->useSession) { + $this->authxUf->loginSession($tgt->userId); + } + if ($tgt->userId && !($tgt->useSession)) { + $this->authxUf->loginStateless($tgt->userId); + } + + // Post-login Civi stuff... + + $session = \CRM_Core_Session::singleton(); + $session->set('ufID', $tgt->userId); + $session->set('userID', $tgt->contactId); + + \CRM_Core_DAO::executeQuery('SET @civicrm_user_id = %1', + [1 => [$tgt->contactId, 'Integer']] + ); + } + + /** + * Reject a bad authentication attempt. + * + * @param string $message + */ + protected function reject($message = 'Authentication failed') { + $r = new Response(401, ['Content-Type' => 'text/plain'], "HTTP 401 $message"); + \CRM_Utils_System::sendResponse($r); + } + +} + +class AuthenticatorTarget { + + /** + * The authentication-flow by which we received the credential. + * + * @var string + * Ex: 'param', 'header', 'xheader', 'auto' + */ + public $flow; + + /** + * @var bool + */ + public $useSession; + + /** + * The raw credential as submitted. + * + * @var string + * Ex: 'Basic AbCd123=' or 'Bearer xYz.321' + */ + public $cred; + + /** + * (Authenticated) The type of credential. + * + * @var string + * Ex: 'pass', 'api_key', 'jwt' + */ + public $credType; + + /** + * (Authenticated) UF user ID + * + * @var int|string|null + */ + public $userId; + + /** + * (Authenticated) CiviCRM contact ID + * + * @var int|null + */ + public $contactId; + + /** + * (Authenticated) JWT claims (if applicable). + * + * @var array|null + */ + public $jwt = NULL; + + /** + * @param array $args + * @return $this + */ + public static function create($args = []) { + return (new static())->set($args); + } + + /** + * @param array $args + * @return $this + */ + public function set($args) { + foreach ($args as $k => $v) { + $this->{$k} = $v; + } + return $this; + } + + /** + * Specify the authenticated principal for this request. + * + * @param array $args + * Mix of: 'userId', 'contactId', 'credType' + * It is valid to give 'userId' or 'contactId' - the missing one will be + * filled in via UFMatch (if available). + * @return $this + */ + public function setPrincipal($args) { + if (empty($args['userId']) && empty($args['contactId'])) { + throw new \InvalidArgumentException("Must specify principal by userId and/or contactId"); + } + if (empty($args['credType'])) { + throw new \InvalidArgumentException("Must specify the type of credential used to identify the principal"); + } + if ($this->hasPrincipal()) { + throw new \LogicException("Principal has already been specified"); + } + + if (empty($args['contactId']) && !empty($args['userId'])) { + $args['contactId'] = \CRM_Core_BAO_UFMatch::getContactId($args['userId']); + } + if (empty($args['userId']) && !empty($args['contactId'])) { + $args['userId'] = \CRM_Core_BAO_UFMatch::getUFId($args['contactId']); + } + + return $this->set($args); + } + + /** + * @return bool + */ + public function hasPrincipal(): bool { + return !empty($this->userId) || !empty($this->contactId); + } + +} diff --git a/ext/authx/Civi/Authx/AuthxInterface.php b/ext/authx/Civi/Authx/AuthxInterface.php new file mode 100644 index 000000000000..8a7cc367d256 --- /dev/null +++ b/ext/authx/Civi/Authx/AuthxInterface.php @@ -0,0 +1,74 @@ +uid ? $user->uid : NULL; + } + +} diff --git a/ext/authx/Civi/Authx/Drupal.php b/ext/authx/Civi/Authx/Drupal.php new file mode 100644 index 000000000000..e9722cab205a --- /dev/null +++ b/ext/authx/Civi/Authx/Drupal.php @@ -0,0 +1,58 @@ +uid ? $user->uid : NULL; + } + +} diff --git a/ext/authx/Civi/Authx/Drupal8.php b/ext/authx/Civi/Authx/Drupal8.php new file mode 100644 index 000000000000..34debea936ba --- /dev/null +++ b/ext/authx/Civi/Authx/Drupal8.php @@ -0,0 +1,60 @@ +authenticate($username, $password); + // Ensure strict nullness. + return $uid ? $uid : NULL; + } + + /** + * @inheritDoc + */ + public function loginSession($userId) { + $user = user_load($userId); + user_login_finalize($user); + } + + /** + * @inheritDoc + */ + public function logoutSession() { + user_logout(); + } + + /** + * @inheritDoc + */ + public function loginStateless($userId) { + $user = user_load($userId); + // In theory, we could use either account_switcher->switchTo() or current_user->setAccount(). + // switchTo() sounds more conscientious, but setAccount() might be a more accurate rendition + // of "stateless login". At time of writing, there doesn't seem to be a compelling difference. + // But if you're looking at this line while investigating some bug... then maybe there is? + \Drupal::service('account_switcher')->switchTo($user); + } + + /** + * @inheritDoc + */ + public function getCurrentUserId() { + $user = \Drupal::currentUser(); + return $user ? $user->getAccount()->id() : NULL; + } + +} diff --git a/ext/authx/Civi/Authx/Joomla.php b/ext/authx/Civi/Authx/Joomla.php new file mode 100644 index 000000000000..51b9f4d1bc91 --- /dev/null +++ b/ext/authx/Civi/Authx/Joomla.php @@ -0,0 +1,98 @@ +getDbo(); + $query = $db->getQuery(TRUE); + $query->select('id, name, username, email, password'); + $query->from($JUserTable->getTableName()); + $query->where('(LOWER(username) = LOWER(' . $db->quote($username) . ')) AND (block = 0)'); + $db->setQuery($query, 0, 0); + $users = $db->loadObjectList(); + + if (!empty($users)) { + $user = array_shift($users); + if (is_callable(['JUserHelper', 'verifyPassword'])) { + $verified = \JUserHelper::verifyPassword($password, $user->password, $user->id); + return $verified ? $user->id : NULL; + } + else { + throw new \CRM_Core_Exception("This version of Joomla does not support verifyPassword()."); + } + } + + return NULL; + } + + /** + * @inheritDoc + */ + public function loginSession($userId) { + $user = new \JUser($userId); + $session = \JFactory::getSession(); + $session->set('user', $user); + } + + /** + * @inheritDoc + */ + public function logoutSession() { + \JFactory::getSession()->destroy(); + } + + /** + * @inheritDoc + */ + public function loginStateless($userId) { + // Joomla CMSApplication always starts a session. It is impossible for any extension/plugin/component to influence this. + // See eg https://github.com/joomla/joomla-cms/issues/8772 + // Our implementation here uses a simple (if ugly) mitigation to ensure that + // (1) all data is thread-local and (2) nothing is persisted from the request. + + // I'm not aware of a more canonical solution. Since this tied-up with the `AbstractApplication` class + // hierarchy, perhaps one is supposed to make a new entry-point (`[cms.root]/components/com_civicrm/myapp.php`)? + + // In any event, this work-around passes `AllFlowsTest::testMultipleStateless`. + + \JFactory::getSession()->destroy(); + \JFactory::getSession()->setHandler(new \CRM_Utils_FakeJoomlaSession('CIVISCRIPT')); + $user = new \JUser($userId); + $session = \JFactory::getSession(); + $session->set('user', $user); + } + + /** + * @inheritDoc + */ + public function getCurrentUserId() { + $user = \JFactory::getUser(); + return ($user->guest) ? NULL : $user->id; + } + +} diff --git a/ext/authx/Civi/Authx/Meta.php b/ext/authx/Civi/Authx/Meta.php new file mode 100644 index 000000000000..9e5915cec9c8 --- /dev/null +++ b/ext/authx/Civi/Authx/Meta.php @@ -0,0 +1,44 @@ + E::ts('JSON Web Token'), + 'api_key' => E::ts('API Key'), + 'pass' => E::ts('User Password'), + ]; + } + + /** + * @return array + */ + public static function getUserModes() { + return [ + 'ignore' => E::ts('Ignore user accounts'), + 'optional' => E::ts('Optionally load user accounts'), + 'require' => E::ts('Require user accounts'), + ]; + } + + /** + * @return array + */ + public static function getFlowTypes() { + return [ + 'param' => E::ts('Ephemeral: Paramter'), + 'header' => E::ts('Ephemeral: Common Header'), + 'xheader' => E::ts('Ephemeral: X-Header'), + 'login' => E::ts('Persistent: Login session'), + 'auto' => E::ts('Persistent: Auto session'), + ]; + } + +} diff --git a/ext/authx/Civi/Authx/None.php b/ext/authx/Civi/Authx/None.php new file mode 100644 index 000000000000..8401d5abfc3e --- /dev/null +++ b/ext/authx/Civi/Authx/None.php @@ -0,0 +1,51 @@ +ID; + } + + /** + * @inheritDoc + */ + public function loginSession($userId) { + // We use wp_signon() to try to fire any session-related events. + // Note that we've already authenticated the user, so we filter 'authenticate' + // to signal the chosen user. + + $user = get_user_by('id', $userId); + $pickUser = function () use ($user) { + return $user; + }; + try { + add_filter('authenticate', $pickUser); + wp_signon(); + wp_set_current_user($userId); + } finally { + remove_filter('authenticate', $pickUser); + } + } + + /** + * @inheritDoc + */ + public function logoutSession() { + wp_logout(); + } + + /** + * @inheritDoc + */ + public function loginStateless($userId) { + wp_set_current_user($userId); + } + + /** + * @inheritDoc + */ + public function getCurrentUserId() { + $id = \get_current_user_id(); + return empty($id) ? NULL : $id; + } + +} diff --git a/ext/authx/LICENSE.txt b/ext/authx/LICENSE.txt new file mode 100644 index 000000000000..40ab3dd4a7c0 --- /dev/null +++ b/ext/authx/LICENSE.txt @@ -0,0 +1,667 @@ +Package: authx +Copyright (C) 2021, Tim Otten +Licensed under the GNU Affero Public License 3.0 (below). + +------------------------------------------------------------------------------- + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/ext/authx/README.md b/ext/authx/README.md new file mode 100644 index 000000000000..f0515b8a3eca --- /dev/null +++ b/ext/authx/README.md @@ -0,0 +1,126 @@ +# AuthX + +The AuthX extension provides support for additional authentication protocols on CiviCRM pages. +This is useful for automated testing and developing multi-modal pageflows (eg email => HTTP). + +## Overview + +There are two general flows of authentication, each with a few variations: + +* __Ephemeral / Stateless__: The client submits a singlular request (such as an API call) which includes credentials. The request is authenticated and processed, but then it is abandoned. + There are a couple flavors of stateless authentication: + * __Parameter (`param`)__: The credential is submitted with an HTTP GET or POST parameter (`?_authx=`) + * __Common Header (`header`)__: The credential is submitted with an HTTP (`Authorization:`). Depending on the credential, this will use either `Basic` or `Bearer`. + The standard header is easier to integrate with external applications; however, other features or plugins in the CMS may interfere with correct operation. + * __X-Header (`xheader`)__: The credential is again submitted with an HTTP header (`X-Civi-Auth:`). The header behaves the same as the common header. The + differing name means that clients must specifically support it, but it also reduces the odsd of interference. +* __Persistent / Stateful__: The client makes a request for a persistent session, attaching the contact ID and/or user ID. These will be used in subsequent requests. + * __End-point session (`login`)__: The client submits an explicit authentication request (`POST /civicrm/authx/login?_authx=`) which creates a session and cookie. + The authenticated session endures until one logs out (`/civicrm/authx/logout`). + * __Auto session (`auto`)__: The clients submits a GET request for any page (`?_authx=&_authxSes=1`). The session is initialized. The user redirects + to original page. + +Each flow may (configurably) accept any of these credentials: + +* __JSON Web Tokens (`jwt`)__: These tokens must be generated by Civi using a cryptographic signing key and expiration time. + The client submits the token as its sole credential. +* __API Key (`api_key`)__: The user configures a value for `civicrm_contact.api_key`. The client submits + the token as its sole credential. +* __Username/Password (`pass`)__: The client submits the username and password for a CMS user. + +CiviCRM `Contact` records are often linked to CMS `User` records -- but not always. There are different ways to approach this matching: + +* __Ignore__: Ignore any related `User` accounts. From a CMS perspective, the user is anonymous. +* __Optional__: If there is a correlated CMS `User`, then load it. If there isn't, leave the CMS user as anonymous. +* __Require__: Only allow authentication if proceed if there is a correlated user account. + +## Configuration + +For each authentication flow, one may toggle support for different credentials and user-links. Here is the default configuration: + +* Ephemeral: Parameter flow + * Accepted credentials (`authx_param_cred`): `['jwt']` + * User link (`authx_param_user`): `'optional'` +* Ephemeral: Common header flow + * Accepted credentials (`authx_header_cred`): `['jwt']` + * User link (`authx_header_user`): `'optional'` +* Ephemeral: X header flow + * Accepted credentials (`authx_xheader_cred`): `['jwt']` + * User link (`authx_xheader_user`): `'optional'` +* Persistent: End-point session flow + * Accepted credentials (`authx_login_cred`): `['jwt']` + * User link (`authx_login_user`): `require` +* Persistent: Auto session flow + * Accepted credentials (`authx_auto_cred`): `['paramalogin']` for Joomla, and `[]` for all others + * User link (`authx_auto_user`): `require` + +## Quirks and Compatibility + +Some modes may not be supported in some environments. For example: + +* __Joomla, WordPress__: Creates extraneous sessions (e.g. even if the request is for stateless authentication). +* __WordPress__: The default `.htaccess` in WordPress may obscure the common `Authorization:` header. Fix this by adding: + ``` + SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1 + ``` + +## Examples + +### JSON Web Token + +By default, JSON Web Tokens are accepted for authentication in all flows. + +To use JWT authentication, you must first prepare a token on the server: + +```php +$token = Civi::service('crypto.jwt')->encode([ + 'exp' => time() + 5*60, // Expires in 5 minutes + 'sub' => 'cid:203', // Subject (contact ID) + 'scope' => 'authx', // Allow general authentication +]); +``` + +This `$token` should be given to some other agent (e.g. web browser, custom script, or email client). + +For example, here's a custom script which uses the `$token` to call APIv3 (`Contact.get`). The token is based with the common HTTP authorization header: + +```php +$options = ['http' => [ + 'method' => 'GET', + 'header' => "Authorization: Bearer $token", +]]; +$url = 'https://example.org/civicrm/ajax/rest?entity=Contact&action=get&json=' + . urlencode(json_encode(["id" => "user_contact_id"])); +$context = stream_context_create($options); +$response = file_get_contents($url, false, $context); +``` + +Alternatively, if you needed to send an email with a sign-in link, the JWT could be passed as an `?_authx` parameter. + +```php +$url = CRM_Utils_System::url('civicrm/dashboard', [ + '_authx' => "Bearer $token", + '_authxSes' => 1, +], TRUE, NULL, FALSE); +$html = sprintf('Here is your login link: %s', + htmlentities($url), htmlentities($url)); +CRM_Utils_Mail::send([...'html' => $html...]); +``` + +### Username and Password + +By default, username/password authentication is not enabled. + +``` +$ curl 'https://demouser:demopass@example.org/civicrm/authx/id' +HTTP 401 Password authentication is not supported +``` + +However, if you activate it, then it will work with standard HTTP clients: + +``` +$ cv ev 'Civi::settings()->set("authx_header_cred", ["pass","jwt"]);' + +$ curl 'https://demouser:demopass@example.org/civicrm/authx/id' +{"contact_id":203,"user_id":"2"} +``` diff --git a/ext/authx/authx.civix.php b/ext/authx/authx.civix.php new file mode 100644 index 000000000000..a1ab61ebe325 --- /dev/null +++ b/ext/authx/authx.civix.php @@ -0,0 +1,477 @@ +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_Authx_ExtensionUtil as E; + +/** + * (Delegated) Implements hook_civicrm_config(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config + */ +function _authx_civix_civicrm_config(&$config = NULL) { + static $configured = FALSE; + if ($configured) { + return; + } + $configured = TRUE; + + $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 = [$extDir, $template->template_dir]; + } + + $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); + set_include_path($include_path); +} + +/** + * (Delegated) Implements hook_civicrm_xmlMenu(). + * + * @param $files array(string) + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu + */ +function _authx_civix_civicrm_xmlMenu(&$files) { + foreach (_authx_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { + $files[] = $file; + } +} + +/** + * Implements hook_civicrm_install(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install + */ +function _authx_civix_civicrm_install() { + _authx_civix_civicrm_config(); + if ($upgrader = _authx_civix_upgrader()) { + $upgrader->onInstall(); + } +} + +/** + * Implements hook_civicrm_postInstall(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall + */ +function _authx_civix_civicrm_postInstall() { + _authx_civix_civicrm_config(); + if ($upgrader = _authx_civix_upgrader()) { + if (is_callable([$upgrader, 'onPostInstall'])) { + $upgrader->onPostInstall(); + } + } +} + +/** + * Implements hook_civicrm_uninstall(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall + */ +function _authx_civix_civicrm_uninstall() { + _authx_civix_civicrm_config(); + if ($upgrader = _authx_civix_upgrader()) { + $upgrader->onUninstall(); + } +} + +/** + * (Delegated) Implements hook_civicrm_enable(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable + */ +function _authx_civix_civicrm_enable() { + _authx_civix_civicrm_config(); + if ($upgrader = _authx_civix_upgrader()) { + if (is_callable([$upgrader, 'onEnable'])) { + $upgrader->onEnable(); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_disable(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable + * @return mixed + */ +function _authx_civix_civicrm_disable() { + _authx_civix_civicrm_config(); + if ($upgrader = _authx_civix_upgrader()) { + if (is_callable([$upgrader, 'onDisable'])) { + $upgrader->onDisable(); + } + } +} + +/** + * (Delegated) Implements 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 + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade + */ +function _authx_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + if ($upgrader = _authx_civix_upgrader()) { + return $upgrader->onUpgrade($op, $queue); + } +} + +/** + * @return CRM_Authx_Upgrader + */ +function _authx_civix_upgrader() { + if (!file_exists(__DIR__ . '/CRM/Authx/Upgrader.php')) { + return NULL; + } + else { + return CRM_Authx_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 string $dir base dir + * @param string $pattern , glob pattern, eg "*.txt" + * + * @return array + */ +function _authx_civix_find_files($dir, $pattern) { + if (is_callable(['CRM_Utils_File', 'findFiles'])) { + return CRM_Utils_File::findFiles($dir, $pattern); + } + + $todos = [$dir]; + $result = []; + while (!empty($todos)) { + $subdir = array_shift($todos); + foreach (_authx_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) Implements hook_civicrm_managed(). + * + * Find any *.mgd.php files, merge their content, and return. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed + */ +function _authx_civix_civicrm_managed(&$entities) { + $mgdFiles = _authx_civix_find_files(__DIR__, '*.mgd.php'); + sort($mgdFiles); + foreach ($mgdFiles as $file) { + $es = include $file; + foreach ($es as $e) { + if (empty($e['module'])) { + $e['module'] = E::LONG_NAME; + } + if (empty($e['params']['version'])) { + $e['params']['version'] = '3'; + } + $entities[] = $e; + } + } +} + +/** + * (Delegated) Implements hook_civicrm_caseTypes(). + * + * Find any and return any files matching "xml/case/*.xml" + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes + */ +function _authx_civix_civicrm_caseTypes(&$caseTypes) { + if (!is_dir(__DIR__ . '/xml/case')) { + return; + } + + foreach (_authx_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)); + throw new CRM_Core_Exception($errorMessage); + } + $caseTypes[$name] = [ + 'module' => E::LONG_NAME, + 'name' => $name, + 'file' => $file, + ]; + } +} + +/** + * (Delegated) Implements hook_civicrm_angularModules(). + * + * Find any and return any files matching "ang/*.ang.php" + * + * Note: This hook only runs in CiviCRM 4.5+. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules + */ +function _authx_civix_civicrm_angularModules(&$angularModules) { + if (!is_dir(__DIR__ . '/ang')) { + return; + } + + $files = _authx_civix_glob(__DIR__ . '/ang/*.ang.php'); + foreach ($files as $file) { + $name = preg_replace(':\.ang\.php$:', '', basename($file)); + $module = include $file; + if (empty($module['ext'])) { + $module['ext'] = E::LONG_NAME; + } + $angularModules[$name] = $module; + } +} + +/** + * (Delegated) Implements hook_civicrm_themes(). + * + * Find any and return any files matching "*.theme.php" + */ +function _authx_civix_civicrm_themes(&$themes) { + $files = _authx_civix_glob(__DIR__ . '/*.theme.php'); + foreach ($files as $file) { + $themeMeta = include $file; + if (empty($themeMeta['name'])) { + $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file)); + } + if (empty($themeMeta['ext'])) { + $themeMeta['ext'] = E::LONG_NAME; + } + $themes[$themeMeta['name']] = $themeMeta; + } +} + +/** + * 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. + * + * @link http://php.net/glob + * @param string $pattern + * + * @return array + */ +function _authx_civix_glob($pattern) { + $result = glob($pattern); + return is_array($result) ? $result : []; +} + +/** + * 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 + */ +function _authx_civix_insert_navigation_menu(&$menu, $path, $item) { + // If we are done going down the path, insert menu + if (empty($path)) { + $menu[] = [ + 'attributes' => array_merge([ + 'label' => CRM_Utils_Array::value('name', $item), + 'active' => 1, + ], $item), + ]; + return TRUE; + } + else { + // Find an recurse into the next level down + $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 = _authx_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); + } + } + return $found; + } +} + +/** + * (Delegated) Implements hook_civicrm_navigationMenu(). + */ +function _authx_civix_navigationMenu(&$nodes) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { + _authx_civix_fixNavigationMenu($nodes); + } +} + +/** + * Given a navigation menu, generate navIDs for any items which are + * missing them. + */ +function _authx_civix_fixNavigationMenu(&$nodes) { + $maxNavID = 1; + array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { + if ($key === 'navID') { + $maxNavID = max($maxNavID, $item); + } + }); + _authx_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); +} + +function _authx_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'])) { + _authx_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_alterSettingsFolders(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders + */ +function _authx_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; + if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) { + $metaDataFolders[] = $settingsDir; + } +} + +/** + * (Delegated) Implements hook_civicrm_entityTypes(). + * + * Find any *.entityType.php files, merge their content, and return. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes + */ +function _authx_civix_civicrm_entityTypes(&$entityTypes) { + $entityTypes = array_merge($entityTypes, []); +} diff --git a/ext/authx/authx.php b/ext/authx/authx.php new file mode 100644 index 000000000000..c01aaf328977 --- /dev/null +++ b/ext/authx/authx.php @@ -0,0 +1,241 @@ +addListener('civi.invoke.auth', function($e) { + if (!empty($_SERVER['HTTP_X_CIVI_AUTH'])) { + return (new \Civi\Authx\Authenticator())->auth($e, ['flow' => 'xheader', 'cred' => $_SERVER['HTTP_X_CIVI_AUTH']]); + } + + if (!empty($_SERVER['HTTP_AUTHORIZATION'])) { + return (new \Civi\Authx\Authenticator())->auth($e, ['flow' => 'header', 'cred' => $_SERVER['HTTP_AUTHORIZATION']]); + } + + $params = ($_SERVER['REQUEST_METHOD'] === 'GET') ? $_GET : $_POST; + if (!empty($params['_authx'])) { + if ((implode('/', $e->args) === 'civicrm/authx/login')) { + (new \Civi\Authx\Authenticator())->auth($e, ['flow' => 'login', 'cred' => $params['_authx'], 'useSession' => TRUE]); + _authx_redact(['_authx']); + } + elseif (!empty($params['_authxSes'])) { + (new \Civi\Authx\Authenticator())->auth($e, ['flow' => 'auto', 'cred' => $params['_authx'], 'useSession' => TRUE]); + if ($_SERVER['REQUEST_METHOD'] === 'GET') { + _authx_reload(implode('/', $e->args), $_SERVER['QUERY_STRING']); + } + else { + _authx_redact(['_authx', '_authxSes']); + } + } + else { + (new \Civi\Authx\Authenticator())->auth($e, ['flow' => 'param', 'cred' => $params['_authx']]); + _authx_redact(['_authx']); + } + } +}); + +/** + * @return \Civi\Authx\AuthxInterface + */ +function _authx_uf() { + $class = 'Civi\\Authx\\' . CIVICRM_UF; + return class_exists($class) ? new $class() : new \Civi\Authx\None(); +} + +/** + * For parameter-based authentication, this option will hide parameters. + * This is mostly a precaution, hedging against the possibility that some routes + * make broad use of $_GET or $_PARAMS. + * + * @param array $keys + */ +function _authx_redact(array $keys) { + foreach ($keys as $key) { + unset($_POST[$key], $_GET[$key], $_REQUEST[$key]); + } +} + +/** + * Reload the current page-view. + * + * @param string $route + * @param string $queryString + */ +function _authx_reload($route, $queryString) { + parse_str($queryString, $query); + foreach (array_keys($query) as $key) { + if (CRM_Utils_String::startsWith($key, '_authx')) { + unset($query[$key]); + } + } + $url = CRM_Utils_System::url($route, $query, TRUE, NULL, FALSE, CRM_Core_Config::singleton()->userSystem->isFrontEndPage()); + CRM_Utils_System::redirect($url); +} + +/** + * Implements hook_civicrm_config(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config/ + */ +function authx_civicrm_config(&$config) { + _authx_civix_civicrm_config($config); +} + +/** + * Implements hook_civicrm_xmlMenu(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu + */ +function authx_civicrm_xmlMenu(&$files) { + _authx_civix_civicrm_xmlMenu($files); +} + +/** + * Implements hook_civicrm_install(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install + */ +function authx_civicrm_install() { + _authx_civix_civicrm_install(); +} + +/** + * Implements hook_civicrm_postInstall(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall + */ +function authx_civicrm_postInstall() { + _authx_civix_civicrm_postInstall(); +} + +/** + * Implements hook_civicrm_uninstall(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall + */ +function authx_civicrm_uninstall() { + _authx_civix_civicrm_uninstall(); +} + +/** + * Implements hook_civicrm_enable(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable + */ +function authx_civicrm_enable() { + _authx_civix_civicrm_enable(); +} + +/** + * Implements hook_civicrm_disable(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable + */ +function authx_civicrm_disable() { + _authx_civix_civicrm_disable(); +} + +/** + * Implements hook_civicrm_upgrade(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade + */ +function authx_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + return _authx_civix_civicrm_upgrade($op, $queue); +} + +/** + * Implements hook_civicrm_managed(). + * + * Generate a list of entities to create/deactivate/delete when this module + * is installed, disabled, uninstalled. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed + */ +function authx_civicrm_managed(&$entities) { + _authx_civix_civicrm_managed($entities); +} + +/** + * Implements hook_civicrm_caseTypes(). + * + * Generate a list of case-types. + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes + */ +function authx_civicrm_caseTypes(&$caseTypes) { + _authx_civix_civicrm_caseTypes($caseTypes); +} + +/** + * Implements hook_civicrm_angularModules(). + * + * Generate a list of Angular modules. + * + * Note: This hook only runs in CiviCRM 4.5+. It may + * use features only available in v4.6+. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules + */ +function authx_civicrm_angularModules(&$angularModules) { + _authx_civix_civicrm_angularModules($angularModules); +} + +/** + * Implements hook_civicrm_alterSettingsFolders(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders + */ +function authx_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + _authx_civix_civicrm_alterSettingsFolders($metaDataFolders); +} + +/** + * Implements hook_civicrm_entityTypes(). + * + * Declare entity types provided by this module. + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes + */ +function authx_civicrm_entityTypes(&$entityTypes) { + _authx_civix_civicrm_entityTypes($entityTypes); +} + +/** + * Implements hook_civicrm_thems(). + */ +function authx_civicrm_themes(&$themes) { + _authx_civix_civicrm_themes($themes); +} + +// --- Functions below this ship commented out. Uncomment as required. --- + +/** + * Implements hook_civicrm_preProcess(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_preProcess + */ +//function authx_civicrm_preProcess($formName, &$form) { +// +//} + +/** + * Implements hook_civicrm_navigationMenu(). + * + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_navigationMenu + */ +//function authx_civicrm_navigationMenu(&$menu) { +// _authx_civix_insert_navigation_menu($menu, 'Mailings', array( +// 'label' => E::ts('New subliminal message'), +// 'name' => 'mailing_subliminal_message', +// 'url' => 'civicrm/mailing/subliminal', +// 'permission' => 'access CiviMail', +// 'operator' => 'OR', +// 'separator' => 0, +// )); +// _authx_civix_navigationMenu($menu); +//} diff --git a/ext/authx/images/screenshot.png b/ext/authx/images/screenshot.png new file mode 100644 index 000000000000..6765b696fa03 Binary files /dev/null and b/ext/authx/images/screenshot.png differ diff --git a/ext/authx/info.xml b/ext/authx/info.xml new file mode 100644 index 000000000000..cfd4bdfce272 --- /dev/null +++ b/ext/authx/info.xml @@ -0,0 +1,30 @@ + + + authx + AuthX + Extended authentication module + AGPL-3.0 + + Tim Otten + totten@civicrm.org + + + http://FIXME + http://FIXME + http://FIXME + http://www.gnu.org/licenses/agpl-3.0.html + + 2021-02-11 + 1.0 + alpha + + 5.0 + + This is a new, undeveloped module + + + + + CRM/Authx + + diff --git a/ext/authx/phpunit.xml.dist b/ext/authx/phpunit.xml.dist new file mode 100644 index 000000000000..fc8f870b723b --- /dev/null +++ b/ext/authx/phpunit.xml.dist @@ -0,0 +1,18 @@ + + + + + ./tests/phpunit + + + + + ./ + + + + + + + + diff --git a/ext/authx/settings/authx.setting.php b/ext/authx/settings/authx.setting.php new file mode 100644 index 000000000000..e40bfc823324 --- /dev/null +++ b/ext/authx/settings/authx.setting.php @@ -0,0 +1,69 @@ + 'CiviCRM Preferences', + 'group' => 'authx', + 'is_domain' => 1, + 'is_contact' => 0, + 'add' => '5.36', + ]; + + $s = []; + foreach ($flows as $flow) { + $s["authx_{$flow}_cred"] = $basic + [ + 'name' => "authx_{$flow}_cred", + 'type' => 'Array', + 'quick_form_type' => 'Select', + 'html_type' => 'Select', + 'html_attributes' => [ + 'multiple' => 1, + 'class' => 'crm-select2', + ], + 'default' => ['jwt'], + 'title' => ts('Acceptable credentials (%s)'), + 'help_text' => NULL, + 'pseudoconstant' => [ + 'callback' => ['\Civi\Authx\Meta', 'getCredentialTypes'], + ], + ]; + $s["authx_{$flow}_user"] = $basic + [ + 'name' => "authx_{$flow}_user", + 'type' => 'String', + 'quick_form_type' => 'Select', + 'html_type' => 'Select', + 'html_attributes' => [ + 'class' => 'crm-select2', + ], + 'default' => 'optional', + 'title' => ts('User account requirements (%s)'), + 'help_text' => NULL, + 'pseudoconstant' => [ + 'callback' => ['\Civi\Authx\Meta', 'getUserModes'], + ], + ]; + } + return $s; +}; + +/** + * Settings metadata file + */ +return $_authx_settings(); diff --git a/ext/authx/tests/phpunit/Civi/Authx/AllFlowsTest.php b/ext/authx/tests/phpunit/Civi/Authx/AllFlowsTest.php new file mode 100644 index 000000000000..eb6eff39b77b --- /dev/null +++ b/ext/authx/tests/phpunit/Civi/Authx/AllFlowsTest.php @@ -0,0 +1,651 @@ +installMe(__DIR__) + ->callback( + function() { + \CRM_Utils_System::synchronizeUsers(); + }, + 'synchronizeUsers' + ) + ->apply(); + } + + public function setUp() { + $quirks = [ + 'Joomla' => ['sendsExcessCookies', 'authErrorShowsForm'], + 'WordPress' => ['sendsExcessCookies'], + ]; + $this->quirks = $quirks[CIVICRM_UF] ?? []; + + parent::setUp(); + $this->settingsBackup = []; + foreach (\Civi\Authx\Meta::getFlowTypes() as $flowType) { + foreach (["authx_{$flowType}_cred", "authx_{$flowType}_user"] as $setting) { + $this->settingsBackup[$setting] = \Civi::settings()->get($setting); + } + } + } + + public function tearDown() { + foreach ($this->settingsBackup as $setting => $value) { + \Civi::settings()->set($setting, $value); + } + parent::tearDown(); + } + + public function getStatelessExamples() { + $exs = []; + $exs[] = ['pass', 'param']; + $exs[] = ['pass', 'header']; + $exs[] = ['pass', 'xheader']; + $exs[] = ['api_key', 'param']; + $exs[] = ['api_key', 'header']; + $exs[] = ['api_key', 'xheader']; + $exs[] = ['jwt', 'param']; + $exs[] = ['jwt', 'header']; + $exs[] = ['jwt', 'xheader']; + return $exs; + } + + public function getCredTypes() { + $exs = []; + $exs[] = ['pass']; + $exs[] = ['api_key']; + $exs[] = ['jwt']; + return $exs; + } + + public function testAnonymous() { + $http = $this->createGuzzle(['http_errors' => FALSE]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->requestMyContact(); + $response = $http->send($request); + $this->assertAnonymousContact($response); + } + + /** + * Send a request using a stateless protocol. Assert that identities are setup correctly. + * + * @param string $credType + * The type of credential to put in the `Authorization:` header. + * @param string $flowType + * The "flow" determines how the credential is added on top of the base-request (e.g. adding a parameter or header). + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getStatelessExamples + */ + public function testStatelessContactOnly($credType, $flowType) { + if ($credType === 'pass') { + $this->assertTrue(TRUE, 'No need to test password credentials with non-user contacts'); + return; + } + $http = $this->createGuzzle(['http_errors' => FALSE]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->applyAuth($this->requestMyContact(), $credType, $flowType, $this->getLebowskiCID()); + + // Phase 1: Request fails if this credential type is not enabled + \Civi::settings()->set("authx_{$flowType}_cred", []); + $response = $http->send($request); + $this->assertFailedDueToProhibition($response); + + // Phase 2: Request succeeds if this credential type is enabled + \Civi::settings()->set("authx_{$flowType}_cred", [$credType]); + $response = $http->send($request); + $this->assertMyContact($this->getLebowskiCID(), NULL, $response); + if (!in_array('sendsExcessCookies', $this->quirks)) { + $this->assertNoCookies($response); + } + } + + /** + * Send a request using a stateless protocol. Assert that identities are setup correctly. + * + * @param string $credType + * The type of credential to put in the `Authorization:` header. + * @param string $flowType + * The "flow" determines how the credential is added on top of the base-request (e.g. adding a parameter or header). + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getStatelessExamples + */ + public function testStatelessUserContact($credType, $flowType) { + $http = $this->createGuzzle(['http_errors' => FALSE]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->applyAuth($this->requestMyContact(), $credType, $flowType, $this->getDemoCID()); + + // Phase 1: Request fails if this credential type is not enabled + \Civi::settings()->set("authx_{$flowType}_cred", []); + $response = $http->send($request); + $this->assertFailedDueToProhibition($response); + + // Phase 2: Request succeeds if this credential type is enabled + \Civi::settings()->set("authx_{$flowType}_cred", [$credType]); + $response = $http->send($request); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + if (!in_array('sendsExcessCookies', $this->quirks)) { + $this->assertNoCookies($response); + } + } + + /** + * The login flow allows you use 'civicrm/authx/login' and 'civicrm/authx/logout' + * to setup/teardown a session. + * + * @param string $credType + * The type of credential to put in the login request. + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getCredTypes + */ + public function testStatefulLoginAllowed($credType) { + $flowType = 'login'; + $credFunc = 'cred' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $credType)); + + // Phase 1: Some pages are not accessible. + $http = $this->createGuzzle(['http_errors' => FALSE]); + $http->get('civicrm/user'); + $this->assertDashboardUnauthorized(); + + // Phase 2: Request succeeds if this credential type is enabled + $cookieJar = new CookieJar(); + $http = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $cookieJar]); + \Civi::settings()->set("authx_{$flowType}_cred", [$credType]); + $response = $http->post('civicrm/authx/login', [ + 'form_params' => ['_authx' => $this->$credFunc($this->getDemoCID())], + ]); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + $this->assertHasCookies($response); + + // Phase 3: We can use cookies to request other pages + $response = $http->get('civicrm/authx/id'); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + $response = $http->get('civicrm/user'); + $this->assertDashboardOk(); + + // Phase 4: After logout, requests should fail. + $oldCookies = clone $cookieJar; + $http->get('civicrm/authx/logout'); + $this->assertStatusCode(200); + $http->get('civicrm/user'); + $this->assertDashboardUnauthorized(); + + $httpHaxor = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $oldCookies]); + $httpHaxor->get('civicrm/user'); + $this->assertDashboardUnauthorized(); + } + + /** + * The login flow 'civicrm/authx/login' may be prohibited by policy. + * + * @param string $credType + * The type of credential to put in the login request. + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getCredTypes + */ + public function testStatefulLoginProhibited($credType) { + $flowType = 'login'; + $http = $this->createGuzzle(['http_errors' => FALSE]); + $credFunc = 'cred' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $credType)); + + \Civi::settings()->set("authx_{$flowType}_cred", []); + $response = $http->post('civicrm/authx/login', [ + 'form_params' => ['_authx' => $this->$credFunc($this->getDemoCID())], + ]); + $this->assertFailedDueToProhibition($response); + } + + /** + * The auto-login flow allows you to request a specific page with specific + * credentials. The new session is setup, and the page is displayed. + * + * @param string $credType + * The type of credential to put in the login request. + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getCredTypes + */ + public function testStatefulAutoAllowed($credType) { + $flowType = 'auto'; + $cookieJar = new CookieJar(); + $http = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $cookieJar]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->applyAuth($this->requestMyContact(), $credType, $flowType, $this->getDemoCID()); + + \Civi::settings()->set("authx_{$flowType}_cred", [$credType]); + $this->assertEquals(0, $cookieJar->count()); + $response = $http->send($request); + $this->assertTrue($cookieJar->count() >= 1); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + + // FIXME: Assert that re-using cookies yields correct result. + } + + /** + * The auto-login flow allows you to request a specific page with specific + * credentials. The new session is setup, and the page is displayed. + * + * @param string $credType + * The type of credential to put in the login request. + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + * @dataProvider getCredTypes + */ + public function testStatefulAutoProhibited($credType) { + $flowType = 'auto'; + $cookieJar = new CookieJar(); + $http = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $cookieJar]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->applyAuth($this->requestMyContact(), $credType, $flowType, $this->getDemoCID()); + + \Civi::settings()->set("authx_{$flowType}_cred", []); + $response = $http->send($request); + $this->assertFailedDueToProhibition($response); + } + + /** + * Create a session for $demoCID. Within the session, make a single + * stateless request as $lebowskiCID. + * + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + */ + public function testStatefulStatelessOverlap() { + \Civi::settings()->set("authx_login_cred", ['api_key']); + \Civi::settings()->set("authx_header_cred", ['api_key']); + + $cookieJar = new CookieJar(); + $http = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $cookieJar]); + + // Phase 1: Login, create a session. + $response = $http->post('civicrm/authx/login', [ + 'form_params' => ['_authx' => $this->credApikey($this->getDemoCID())], + ]); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + $this->assertHasCookies($response); + $response = $http->get('civicrm/authx/id'); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + + // Phase 2: Make a single, stateless request with different creds + /** @var \Psr\Http\Message\RequestInterface $request */ + $request = $this->applyAuth($this->requestMyContact(), 'api_key', 'header', $this->getLebowskiCID()); + $response = $http->send($request); + $this->assertFailedDueToProhibition($response); + // The following assertion merely identifies current behavior. If you can get it working generally, then huzza. + $this->assertBodyRegexp(';Session already active;', $response); + // $this->assertMyContact($this->getLebowskiCID(), NULL, $response); + // $this->assertNoCookies($response); + + // Phase 3: Original session is still valid + $response = $http->get('civicrm/authx/id'); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response); + } + + /** + * This consumer intends to make stateless requests with a handful of different identities, + * but their browser happens to be cookie-enabled. Ensure that identities do not leak between requests. + * + * @throws \CiviCRM_API3_Exception + * @throws \GuzzleHttp\Exception\GuzzleException + */ + public function testMultipleStateless() { + \Civi::settings()->set("authx_header_cred", ['api_key']); + $cookieJar = new CookieJar(); + $http = $this->createGuzzle(['http_errors' => FALSE, 'cookies' => $cookieJar]); + + /** @var \Psr\Http\Message\RequestInterface $request */ + + // Alternate calls among (A)nonymous, (D)emo, and (L)ebowski + $planSteps = 'LADA LDLD DDLLAA'; + $actualSteps = ''; + + for ($i = 0; $i < strlen($planSteps); $i++) { + switch ($planSteps[$i]) { + case 'L': + $request = $this->applyAuth($this->requestMyContact(), 'api_key', 'header', $this->getLebowskiCID()); + $response = $http->send($request); + $this->assertMyContact($this->getLebowskiCID(), NULL, $response, 'Expected Lebowski in step #' . $i); + $actualSteps .= 'L'; + break; + + case 'A': + $request = $this->requestMyContact(); + $response = $http->send($request); + $this->assertAnonymousContact($response); + $actualSteps .= 'A'; + break; + + case 'D': + $request = $this->applyAuth($this->requestMyContact(), 'api_key', 'header', $this->getDemoCID()); + $response = $http->send($request); + $this->assertMyContact($this->getDemoCID(), $this->getDemoUID(), $response, 'Expected demo in step #' . $i); + $actualSteps .= 'D'; + break; + + case ' ': + $actualSteps .= ' '; + break; + + default: + $this->fail('Unrecognized step #' . $i); + } + } + + $this->assertEquals($actualSteps, $planSteps); + } + + /** + * Filter a request, applying the given authentication options + * + * @param \Psr\Http\Message\RequestInterface $request + * @param string $credType + * Ex: 'pass', 'jwt', 'api_key' + * @param string $flowType + * Ex: 'param', 'header', 'xheader' + * @param int $cid + * @return \Psr\Http\Message\RequestInterface + */ + protected function applyAuth($request, $credType, $flowType, $cid) { + $credFunc = 'cred' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $credType)); + $flowFunc = 'auth' . ucfirst(preg_replace(';[^a-zA-Z0-9];', '', $flowType)); + return $this->$flowFunc($request, $this->$credFunc($cid)); + } + + // ------------------------------------------------ + // Library: Base requests + + /** + * Make an AJAX request with info about the current contact. + * + * @return \GuzzleHttp\Psr7\Request + */ + public function requestMyContact() { + $p = (['where' => [['id', '=', 'user_contact_id']]]); + $uri = (new Uri('civicrm/authx/id')) + ->withQuery('params=' . urlencode(json_encode($p))); + $req = new Request('GET', $uri); + return $req; + } + + /** + * Assert the AJAX request provided the expected contact. + * + * @param int $cid + * The expected contact ID + * @param int|null $uid + * The expected user ID + * @param \Psr\Http\Message\ResponseInterface $response + */ + public function assertMyContact($cid, $uid, ResponseInterface $response) { + $this->assertContentType('application/json', $response); + $this->assertStatusCode(200, $response); + $j = json_decode((string) $response->getBody(), 1); + $formattedFailure = $this->formatFailure($response); + $this->assertEquals($cid, $j['contact_id'], "Response did not give expected contact ID\n" . $formattedFailure); + $this->assertEquals($uid, $j['user_id'], "Response did not give expected user ID\n" . $formattedFailure); + } + + /** + * Assert the AJAX request provided empty contact information + * + * @param \Psr\Http\Message\ResponseInterface $response + */ + public function assertAnonymousContact(ResponseInterface $response) { + $formattedFailure = $this->formatFailure($response); + $this->assertContentType('application/json', $response); + $this->assertStatusCode(200, $response); + $j = json_decode((string) $response->getBody(), 1); + if (json_last_error() !== JSON_ERROR_NONE || empty($j)) { + $this->fail('Malformed JSON' . $formattedFailure); + } + $this->assertTrue(array_key_exists('contact_id', $j) && $j['contact_id'] === NULL, 'contact_id should be null' . $formattedFailure); + $this->assertTrue(array_key_exists('user_id', $j) && $j['user_id'] === NULL, 'user_id should be null' . $formattedFailure); + } + + /** + * Assert that the $response indicates the user cannot view the dashboard. + * + * @param \Psr\Http\Message\ResponseInterface $response + */ + public function assertDashboardUnauthorized($response = NULL) { + $response = $this->resolveResponse($response); + if (!in_array('authErrorShowsForm', $this->quirks)) { + $this->assertStatusCode(403, $response); + } + $this->assertFalse( + (bool) preg_match(';crm-dashboard-groups;', (string) $response->getBody()), + 'Response should not contain a dashboard' . $this->formatFailure($response) + ); + } + + public function assertDashboardOk($response = NULL) { + $response = $this->resolveResponse($response); + $this->assertStatusCode(200, $response); + $this->assertContentType('text/html', $response); + // If the first two assertions pass but the next fails, then... perhaps the + // local site permissions are wrong? + $this->assertTrue( + (bool) preg_match(';crm-dashboard-groups;', (string) $response->getBody()), + 'Response should contain a dashboard' . $this->formatFailure($response) + ); + } + + // ------------------------------------------------ + // Library: Flow functions + + /** + * Add query parameter ("&_authx="). + * + * @param \GuzzleHttp\Psr7\Request $request + * @param string $cred + * The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA"). + * @return \GuzzleHttp\Psr7\Request + */ + public function authParam(Request $request, $cred) { + $query = $request->getUri()->getQuery(); + return $request->withUri( + $request->getUri()->withQuery($query . '&_authx=' . urlencode($cred)) + ); + } + + /** + * Add query parameter ("&_authx=&_authxSes=1"). + * + * @param \GuzzleHttp\Psr7\Request $request + * @param string $cred + * The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA"). + * @return \GuzzleHttp\Psr7\Request + */ + public function authAuto(Request $request, $cred) { + $query = $request->getUri()->getQuery(); + return $request->withUri( + $request->getUri()->withQuery($query . '&_authx=' . urlencode($cred) . '&_authxSes=1') + ); + } + + public function authLogin(Request $request, $cred) { + return $request->withMethod('POST') + ->withBody(new AppendStream([ + stream_for('_authx=' . urlencode($cred) . '&'), + $request->getBody(), + ])); + } + + public function authHeader(Request $request, $cred) { + return $request->withHeader('Authorization', $cred); + } + + public function authXHeader(Request $request, $cred) { + return $request->withHeader('X-Civi-Auth', $cred); + } + + public function authNone(Request $request, $cred) { + return $request; + } + + // ------------------------------------------------ + // Library: Credential functions + + /** + * @param int $cid + * @return string + * The credential add to the request (e.g. "Basic ASDF==" or "Bearer FDSA"). + */ + public function credPass($cid) { + if ($cid === $this->getDemoCID()) { + return 'Basic ' . base64_encode($GLOBALS['_CV']['DEMO_USER'] . ':' . $GLOBALS['_CV']['DEMO_PASS']); + } + else { + $this->fail("This test does have the password the requested contact."); + } + } + + public function credApikey($cid) { + $api_key = md5(\random_bytes(16)); + \civicrm_api3('Contact', 'create', [ + 'id' => $cid, + 'api_key' => $api_key, + ]); + return 'Bearer ' . $api_key; + } + + public function credJwt($cid) { + if (empty(\Civi::service('crypto.registry')->findKeysByTag('SIGN'))) { + $this->markTestIncomplete('Cannot test JWT. No CIVICRM_SIGN_KEYS are defined.'); + } + $token = \Civi::service('crypto.jwt')->encode([ + 'exp' => time() + 60 * 60, + 'sub' => "cid:$cid", + 'scope' => 'authx', + ]); + return 'Bearer ' . $token; + } + + public function credNone($cid) { + return NULL; + } + + /** + * @param \Psr\Http\Message\ResponseInterface $response + */ + private function assertFailedDueToProhibition($response) { + $this->assertBodyRegexp(';HTTP 401;', $response); + $this->assertContentType('text/plain', $response); + if (!in_array('sendsExcessCookies', $this->quirks)) { + $this->assertNoCookies($response); + } + $this->assertStatusCode(401, $response); + + } + + /** + * @param \Psr\Http\Message\ResponseInterface $response + */ + private function assertNoCookies($response = NULL) { + $response = $this->resolveResponse($response); + $this->assertEmpty( + preg_grep('/Set-Cookie/i', array_keys($response->getHeaders())), + 'Response should not have cookies' . $this->formatFailure($response) + ); + return $this; + } + + /** + * @param \Psr\Http\Message\ResponseInterface $response + */ + private function assertHasCookies($response = NULL) { + $response = $this->resolveResponse($response); + $this->assertNotEmpty( + preg_grep('/Set-Cookie/i', array_keys($response->getHeaders())), + 'Response should have cookies' . $this->formatFailure($response) + ); + return $this; + } + + /** + * @param $regexp + * @param \Psr\Http\Message\ResponseInterface $response + */ + private function assertBodyRegexp($regexp, $response = NULL) { + $response = $this->resolveResponse($response); + $this->assertRegexp($regexp, (string) $response->getBody(), + 'Response body does not match pattern' . $this->formatFailure($response)); + return $this; + } + + /** + * @return int + * @throws \CiviCRM_API3_Exception + */ + private function getDemoCID(): int { + if (!isset(\Civi::$statics[__CLASS__]['demoId'])) { + \Civi::$statics[__CLASS__]['demoId'] = (int) \civicrm_api3('Contact', 'getvalue', [ + 'id' => '@user:' . $GLOBALS['_CV']['DEMO_USER'], + 'return' => 'id', + ]); + } + return \Civi::$statics[__CLASS__]['demoId']; + } + + private function getDemoUID(): int { + return \CRM_Core_Config::singleton()->userSystem->getUfId($GLOBALS['_CV']['DEMO_USER']); + } + + public function getLebowskiCID() { + if (!isset(\Civi::$statics[__CLASS__]['lebowskiCID'])) { + $contact = \civicrm_api3('Contact', 'create', [ + 'contact_type' => 'Individual', + 'first_name' => 'Jeffrey', + 'last_name' => 'Lebowski', + 'external_identifier' => __CLASS__, + 'options' => [ + 'match' => 'external_identifier', + ], + ]); + \Civi::$statics[__CLASS__]['lebowskiCID'] = $contact['id']; + } + return \Civi::$statics[__CLASS__]['lebowskiCID']; + } + +} diff --git a/ext/authx/tests/phpunit/bootstrap.php b/ext/authx/tests/phpunit/bootstrap.php new file mode 100644 index 000000000000..a5b49253c819 --- /dev/null +++ b/ext/authx/tests/phpunit/bootstrap.php @@ -0,0 +1,63 @@ +add('CRM_', __DIR__); +$loader->add('Civi\\', __DIR__); +$loader->add('api_', __DIR__); +$loader->add('api\\', __DIR__); +$loader->register(); + +/** + * Call the "cv" command. + * + * @param string $cmd + * The rest of the command to send. + * @param string $decode + * Ex: 'json' or 'phpcode'. + * @return string + * Response output (if the command executed normally). + * @throws \RuntimeException + * If the command terminates abnormally. + */ +function cv($cmd, $decode = 'json') { + $cmd = 'cv ' . $cmd; + $descriptorSpec = array(0 => array("pipe", "r"), 1 => array("pipe", "w"), 2 => STDERR); + $oldOutput = getenv('CV_OUTPUT'); + putenv("CV_OUTPUT=json"); + + // Execute `cv` in the original folder. This is a work-around for + // phpunit/codeception, which seem to manipulate PWD. + $cmd = sprintf('cd %s; %s', escapeshellarg(getenv('PWD')), $cmd); + + $process = proc_open($cmd, $descriptorSpec, $pipes, __DIR__); + putenv("CV_OUTPUT=$oldOutput"); + fclose($pipes[0]); + $result = stream_get_contents($pipes[1]); + fclose($pipes[1]); + if (proc_close($process) !== 0) { + throw new RuntimeException("Command failed ($cmd):\n$result"); + } + switch ($decode) { + case 'raw': + return $result; + + case 'phpcode': + // If the last output is /*PHPCODE*/, then we managed to complete execution. + if (substr(trim($result), 0, 12) !== "/*BEGINPHP*/" || substr(trim($result), -10) !== "/*ENDPHP*/") { + throw new \RuntimeException("Command failed ($cmd):\n$result"); + } + return $result; + + case 'json': + return json_decode($result, 1); + + default: + throw new RuntimeException("Bad decoder format ($decode)"); + } +} diff --git a/ext/authx/xml/Menu/authx.xml b/ext/authx/xml/Menu/authx.xml new file mode 100644 index 000000000000..1f0e738339b4 --- /dev/null +++ b/ext/authx/xml/Menu/authx.xml @@ -0,0 +1,24 @@ + + + + civicrm/authx/id + CRM_Authx_Page_AJAX::getId + Id + *always allow* + true + + + civicrm/authx/login + CRM_Authx_Page_AJAX::login + Id + *always allow* + true + + + civicrm/authx/logout + CRM_Authx_Page_AJAX::logout + Id + *always allow* + true + +