class TfaBasicSms in TFA Basic plugins 7

Hierarchy

class \TfaBasePlugin
- class \TfaBasicSms implements TfaSendPluginInterface, TfaValidationPluginInterface

1 string reference to 'TfaBasicSms'

tfa_basic_tfa_api in ./tfa_basic.module: Implements hook_tfa_api().

File

includes/tfa_sms.inc, line 3

View source

class TfaBasicSms extends TfaBasePlugin implements TfaValidationPluginInterface, TfaSendPluginInterface {
  protected $client;
  protected $twilioNumber;
  protected $mobileNumber;
  public function __construct(array $context, $mobile_number, $twilio_client) {
    parent::__construct($context);
    if (!empty($context['validate_context']) && !empty($context['validate_context']['code'])) {
      $this->code = $context['validate_context']['code'];
    }
    $this->client = $twilio_client;
    $this->twilioNumber = variable_get('tfa_basic_twilio_account_number', '');
    $this->codeLength = 6;
    $this->messageText = variable_get('tfa_basic_twilio_message_text', 'Verification code: !code');
    $this->mobileNumber = $mobile_number;
    if (!empty($context['mobile_number'])) {
      $this->mobileNumber = $context['mobile_number'];
    }
  }

  /**
   *
   */
  public function begin() {
    if (!$this->code) {
      $this->code = $this
        ->generate();
      if (!$this
        ->sendCode($this->code)) {
        drupal_set_message(t('Unable to deliver the code. Please contact support.'), 'error');
      }
    }
  }
  public function getForm(array $form, array &$form_state) {
    $form['code'] = array(
      '#type' => 'textfield',
      '#title' => t('Verification Code'),
      '#required' => TRUE,
      '#description' => t('Enter @length-character code sent to your device.', array(
        '@length' => $this->codeLength,
      )),
    );
    if (module_exists('elements')) {
      $form['code']['#type'] = 'numberfield';
    }
    $form['actions']['#type'] = 'actions';

    // @todo optionally report on when code was sent/delivered.
    $form['actions']['login'] = array(
      '#type' => 'submit',
      '#value' => t('Verify'),
    );
    $form['actions']['resend'] = array(
      '#type' => 'submit',
      '#value' => t('Resend'),
      '#submit' => array(
        'tfa_form_submit',
      ),
      '#limit_validation_errors' => array(),
    );
    return $form;
  }
  public function validateForm(array $form, array &$form_state) {

    // If operation is resend then do not attempt to validate code.
    if ($form_state['values']['op'] === $form_state['values']['resend']) {
      return TRUE;
    }
    elseif (!parent::validate($form_state['values']['code'])) {
      $this->errorMessages['code'] = t('Invalid code.');
      return FALSE;
    }
    else {
      return TRUE;
    }
  }
  public function submitForm(array $form, array &$form_state) {

    // Resend code if pushed.
    if ($form_state['values']['op'] === $form_state['values']['resend']) {
      $this->code = $this
        ->generate();
      if (!$this
        ->sendCode($this->code)) {
        drupal_set_message(t('Unable to deliver the code. Please contact support.'), 'error');
      }
      else {
        drupal_set_message(t('Code resent'));
      }
      return FALSE;
    }
    else {
      return parent::submitForm($form, $form_state);
    }
  }

  /**
   * Return context for this plugin.
   *
   * @return array
   */
  public function getPluginContext() {
    return array(
      'code' => $this->code,
    );
  }
  protected function generate() {
    $allowable_characters = '0123456789';

    // Zero-based count of characters in the allowable list:
    $len = strlen($allowable_characters) - 1;

    // Declare the password as a blank string.
    $string = '';

    // Loop the number of times specified by codeLength.
    for ($i = 0; $i < $this->codeLength; $i++) {
      do {

        // Find a secure random number within the range needed.
        $index = ord(drupal_random_bytes(1));
      } while ($index > $len);

      // Each iteration, pick a random character from the
      // allowable string and append it to the password:
      $string .= $allowable_characters[$index];
    }
    return $string;
  }
  protected function getAccountNumber() {
    return $this->mobileNumber;
  }

  /**
   * Send the code via the client.
   *
   * @param string $code
   * @return bool
   */
  protected function sendCode($code) {
    $to = $this
      ->getAccountNumber();
    try {
      $message = $this->client->account->messages
        ->sendMessage($this->twilioNumber, $to, t($this->messageText, array(
        '!code' => $code,
      )));

      // @todo Consider storing date_sent or date_updated to inform user.
      watchdog('tfa_basic', 'Message !id sent to user !uid on @sent', array(
        '@sent' => $message->date_sent,
        '!id' => $message->sid,
        '!uid' => $this->context['uid'],
      ), WATCHDOG_INFO);
      return TRUE;
    } catch (Services_Twilio_RestException $e) {
      watchdog('tfa_basic', 'Twilio send message error to user !uid. Status code: @code, message: @message, link: @link', array(
        '!uid' => $this->context['uid'],
        '@code' => $e
          ->getStatus(),
        '@message' => $e
          ->getMessage(),
        '@link' => $e
          ->getInfo(),
      ), WATCHDOG_ERROR);
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function ready() {

    // We can only send a code if there is a phone number.
    if (!empty($this->mobileNumber)) {

      // We should only send codes if TFA is enabled for this account.
      $user_data = tfa_basic_get_tfa_data(user_load($this->context['uid']));
      if (!empty($user_data['status'])) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TfaBasePlugin::$code	protected	property	TFA code.
TfaBasePlugin::$codeLength	protected	property	Code Length.
TfaBasePlugin::$context	protected	property	Context of current TFA process.
TfaBasePlugin::$encryptionKey	protected	property	Encryption key.
TfaBasePlugin::$errorMessages	protected	property	Error messages.
TfaBasePlugin::$isValid	protected	property	Code is valid.
TfaBasePlugin::CRYPT_VERSION		constant
TfaBasePlugin::decrypt	protected	function	Decrypt a encrypted string.
TfaBasePlugin::decryptLegacyDataWithMcrypt	protected	function	Decrypt using the deprecated Mcrypt extension.
TfaBasePlugin::decryptLegacyDataWithOpenSSL	protected	function	Use OpenSSL to decrypt data that was originally encrypted with Mcrypt.
TfaBasePlugin::encrypt	protected	function	Encrypt a plaintext string.
TfaBasePlugin::encryptWithMcrypt	protected	function	Encrypt using the deprecated Mcrypt extension.
TfaBasePlugin::getErrorMessages	public	function	Get error messages suitable for form_set_error().
TfaBasePlugin::timingSafeEquals	private	function	A timing safe equals comparison.
TfaBasePlugin::validate	protected	function	Validate code.
TfaBasicSms::$client	protected	property
TfaBasicSms::$mobileNumber	protected	property
TfaBasicSms::$twilioNumber	protected	property
TfaBasicSms::begin	public	function	TFA process begin. Overrides TfaSendPluginInterface::begin	1
TfaBasicSms::generate	protected	function	Generate a random string of characters of length $this->codeLength. Overrides TfaBasePlugin::generate
TfaBasicSms::getAccountNumber	protected	function
TfaBasicSms::getForm	public	function	Get TFA process form from plugin. Overrides TfaValidationPluginInterface::getForm
TfaBasicSms::getPluginContext	public	function	Return context for this plugin.
TfaBasicSms::ready	public	function	Determine if the plugin can run for the current TFA context. Overrides TfaBasePlugin::ready
TfaBasicSms::sendCode	protected	function	Send the code via the client.
TfaBasicSms::submitForm	public	function	Submit form. Overrides TfaBasePlugin::submitForm
TfaBasicSms::validateForm	public	function	Validate form. Overrides TfaValidationPluginInterface::validateForm
TfaBasicSms::__construct	public	function	Plugin constructor. Overrides TfaBasePlugin::__construct	1

You are here

class TfaBasicSms in TFA Basic plugins 7

Hierarchy

File

Members

API Navigation