CRM/Core/Smarty/plugins/function.crmSigner.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Generate a secure signature
  38  *
  39  * {code}
  40  * {crmSigner var=mySig extra=123}
  41  * var urlParams = ts={$mySig.ts}&extra={$mySig.extra}&sig={$mySig.signature}
  42  * {endcode}
  43  *
  44  * @param $params array with keys:
  45  *   - var: string, a smarty variable to generate
  46  *   - ts: int, the current time (if omitted, autogenerated)
  47  *   - any other vars are put into the signature (sorted)
  48  */
  49 function smarty_function_crmSigner($params, &$smarty) {
  50   $var = $params['var'];
  51   unset($params['var']);
  52   $params['ts'] = CRM_Utils_Time::getTimeRaw();
  53
  54   $fields = array_keys($params);
  55   sort($fields);
  56
  57   $signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), $fields);
  58   $params['signature'] = $signer->sign($params);
  59   $smarty->assign($var, $params);
  60 }