3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 namespace Civi\API\Subscriber
;
15 use Symfony\Component\EventDispatcher\EventSubscriberInterface
;
18 * Given an entity which dynamically attaches itself to another entity,
19 * determine if one has permission to the other entity.
21 * Example: Suppose one tries to manipulate a File which is attached to a
22 * Mailing. DynamicFKAuthorization will enforce permissions on the File by
23 * imitating the permissions of the Mailing.
25 * Note: This enforces a constraint: all matching API calls must define
26 * "id" (e.g. for the file) or "entity_table+entity_id" or
27 * "field_name+entity_id".
29 * Note: The permission guard does not exactly authorize the request, but it
30 * may veto authorization.
32 class DynamicFKAuthorization
implements EventSubscriberInterface
{
37 public static function getSubscribedEvents() {
39 Events
::AUTHORIZE
=> [
40 ['onApiAuthorize', Events
::W_EARLY
],
46 * @var \Civi\API\Kernel
48 * Treat as private. Marked public due to PHP 5.3-compatibility issues.
53 * The entity for which we want to manage permissions.
57 protected $entityName;
60 * The actions for which we want to manage permissions
67 * SQL SELECT query - Given a file ID, determine the entity+table it's attached to.
69 * ex: "SELECT if(cf.id,1,0) as is_valid, cef.entity_table, cef.entity_id
70 * FROM civicrm_file cf
71 * INNER JOIN civicrm_entity_file cef ON cf.id = cef.file_id
74 * Note: %1 is a parameter
75 * Note: There are three parameters
76 * - is_valid: "1" if %1 identifies an actual record; otherwise "0"
77 * - entity_table: NULL or the name of a related table
78 * - entity_id: NULL or the ID of a row in the related table
82 protected $lookupDelegateSql;
85 * SQL SELECT query. Get a list of (field_name, table_name, extends) tuples.
87 * For example, one tuple might be ("custom_123", "civicrm_value_mygroup_4",
92 protected $lookupCustomFieldSql;
97 * Each item is an array(field_name => $, table_name => $, extends => $)
99 protected $lookupCustomFieldCache;
102 * List of related tables for which FKs are allowed.
106 protected $allowedDelegates;
109 * @param \Civi\API\Kernel $kernel
111 * @param string $entityName
112 * The entity for which we want to manage permissions (e.g. "File" or
114 * @param array $actions
115 * The actions for which we want to manage permissions (e.g. "create",
117 * @param string $lookupDelegateSql
118 * See docblock in DynamicFKAuthorization::$lookupDelegateSql.
119 * @param string $lookupCustomFieldSql
120 * See docblock in DynamicFKAuthorization::$lookupCustomFieldSql.
121 * @param array|NULL $allowedDelegates
122 * e.g. "civicrm_mailing","civicrm_activity"; NULL to allow any.
124 public function __construct($kernel, $entityName, $actions, $lookupDelegateSql, $lookupCustomFieldSql, $allowedDelegates = NULL) {
125 $this->kernel
= $kernel;
126 $this->entityName
= \CRM_Utils_String
::convertStringToCamel($entityName);
127 $this->actions
= $actions;
128 $this->lookupDelegateSql
= $lookupDelegateSql;
129 $this->lookupCustomFieldSql
= $lookupCustomFieldSql;
130 $this->allowedDelegates
= $allowedDelegates;
134 * @param \Civi\API\Event\AuthorizeEvent $event
135 * API authorization event.
136 * @throws \API_Exception
137 * @throws \Civi\API\Exception\UnauthorizedException
139 public function onApiAuthorize(\Civi\API\Event\AuthorizeEvent
$event) {
140 $apiRequest = $event->getApiRequest();
141 if ($apiRequest['version'] == 3 && \CRM_Utils_String
::convertStringToCamel($apiRequest['entity']) == $this->entityName
&& in_array(strtolower($apiRequest['action']), $this->actions
)) {
142 if (isset($apiRequest['params']['field_name'])) {
143 $fldIdx = \CRM_Utils_Array
::index(['field_name'], $this->getCustomFields());
144 if (empty($fldIdx[$apiRequest['params']['field_name']])) {
145 throw new \
Exception("Failed to map custom field to entity table");
147 $apiRequest['params']['entity_table'] = $fldIdx[$apiRequest['params']['field_name']]['entity_table'];
148 unset($apiRequest['params']['field_name']);
152 empty($apiRequest['params']['id']) && empty($apiRequest['params']['entity_table'])
154 throw new \
API_Exception("Mandatory key(s) missing from params array: 'id' or 'entity_table'");
157 if (isset($apiRequest['params']['id'])) {
158 list($isValidId, $entityTable, $entityId) = $this->getDelegate($apiRequest['params']['id']);
159 if ($isValidId && $entityTable && $entityId) {
160 $this->authorizeDelegate($apiRequest['action'], $entityTable, $entityId, $apiRequest);
161 $this->preventReassignment($apiRequest['params']['id'], $entityTable, $entityId, $apiRequest);
164 elseif ($isValidId) {
165 throw new \
API_Exception("Failed to match record to related entity");
167 elseif (!$isValidId && strtolower($apiRequest['action']) == 'get') {
168 // The matches will be an empty set; doesn't make a difference if we
170 // To pass SyntaxConformanceTest, we won't veto "get" on empty-set.
175 if (isset($apiRequest['params']['entity_table'])) {
176 if (!\CRM_Core_DAO_AllCoreTables
::isCoreTable($apiRequest['params']['entity_table'])) {
177 throw new \
API_Exception("Unrecognized target entity table {$apiRequest['params']['entity_table']}");
179 $this->authorizeDelegate(
180 $apiRequest['action'],
181 $apiRequest['params']['entity_table'],
182 \CRM_Utils_Array
::value('entity_id', $apiRequest['params'], NULL),
188 throw new \
API_Exception("Failed to run permission check");
193 * @param string $action
194 * The API action (e.g. "create").
195 * @param string $entityTable
196 * The target entity table (e.g. "civicrm_mailing").
197 * @param int|null $entityId
198 * The target entity ID.
199 * @param array $apiRequest
200 * The full API request.
202 * @throws \API_Exception
203 * @throws \Civi\API\Exception\UnauthorizedException
205 public function authorizeDelegate($action, $entityTable, $entityId, $apiRequest) {
206 if ($this->isTrusted($apiRequest)) {
210 $entity = $this->getDelegatedEntityName($entityTable);
212 throw new \
API_Exception("Failed to run permission check: Unrecognized target entity table ($entityTable)");
215 throw new \Civi\API\Exception\
UnauthorizedException("Authorization failed on ($entity): Missing entity_id");
219 * @var \Exception $exception
223 \CRM_Core_Transaction
::create(TRUE)->run(function($tx) use ($entity, $action, $entityId, &$exception, $self) {
229 'check_permissions' => 1,
233 $result = $self->kernel
->runSafe($entity, $self->getDelegatedAction($action), $params);
234 if ($result['is_error'] ||
empty($result['values'])) {
235 $exception = new \Civi\API\Exception\
UnauthorizedException("Authorization failed on ($entity,$entityId)", [
247 * If the request attempts to change the entity_table/entity_id of an
248 * existing record, then generate an error.
251 * The main record being changed.
252 * @param string $entityTable
254 * @param int $entityId
256 * @param array $apiRequest
257 * The full API request.
258 * @throws \API_Exception
260 public function preventReassignment($fileId, $entityTable, $entityId, $apiRequest) {
261 if (strtolower($apiRequest['action']) == 'create' && $fileId && !$this->isTrusted($apiRequest)) {
262 // TODO: no change in field_name?
263 if (isset($apiRequest['params']['entity_table']) && $entityTable != $apiRequest['params']['entity_table']) {
264 throw new \
API_Exception("Cannot modify entity_table");
266 if (isset($apiRequest['params']['entity_id']) && $entityId != $apiRequest['params']['entity_id']) {
267 throw new \
API_Exception("Cannot modify entity_id");
273 * @param string $entityTable
274 * The target entity table (e.g. "civicrm_mailing" or "civicrm_activity").
275 * @return string|NULL
276 * The target entity name (e.g. "Mailing" or "Activity").
278 public function getDelegatedEntityName($entityTable) {
279 if ($this->allowedDelegates
=== NULL ||
in_array($entityTable, $this->allowedDelegates
)) {
280 $className = \CRM_Core_DAO_AllCoreTables
::getClassForTable($entityTable);
282 $entityName = \CRM_Core_DAO_AllCoreTables
::getBriefName($className);
292 * @param string $action
293 * API action name -- e.g. "create" ("When running *create* on a file...").
295 * e.g. "create" ("Check for *create* permission on the mailing to which
298 public function getDelegatedAction($action) {
301 // reading attachments requires reading the other entity
306 // creating/updating/deleting an attachment requires editing
319 * (0 => bool $isValid, 1 => string $entityTable, 2 => int $entityId)
322 public function getDelegate($id) {
323 $query = \CRM_Core_DAO
::executeQuery($this->lookupDelegateSql
, [
324 1 => [$id, 'Positive'],
326 if ($query->fetch()) {
327 if (!preg_match('/^civicrm_value_/', $query->entity_table
)) {
328 // A normal attachment directly on its entity.
329 return [$query->is_valid
, $query->entity_table
, $query->entity_id
];
332 // Ex: Translate custom-field table ("civicrm_value_foo_4") to
333 // entity table ("civicrm_activity").
334 $tblIdx = \CRM_Utils_Array
::index(['table_name'], $this->getCustomFields());
335 if (isset($tblIdx[$query->entity_table
])) {
336 return [$query->is_valid
, $tblIdx[$query->entity_table
]['entity_table'], $query->entity_id
];
338 throw new \
Exception('Failed to lookup entity table for custom field.');
341 return [FALSE, NULL, NULL];
346 * @param array $apiRequest
347 * The full API request.
350 public function isTrusted($apiRequest) {
351 // isn't this redundant?
352 return empty($apiRequest['params']['check_permissions']) or $apiRequest['params']['check_permissions'] == FALSE;
357 * Each item has keys 'field_name', 'table_name', 'extends', 'entity_table'
359 public function getCustomFields() {
360 $query = \CRM_Core_DAO
::executeQuery($this->lookupCustomFieldSql
);
362 while ($query->fetch()) {
364 'field_name' => $query->field_name
,
365 'table_name' => $query->table_name
,
366 'extends' => $query->extends,
367 'entity_table' => \CRM_Core_BAO_CustomGroup
::getTableNameByEntityName($query->extends),