RavenSanitizeIntegration.php in Raven: Sentry Integration 7.4

File

RavenSanitizeIntegration.php

<?php

declare (strict_types=1);
use Sentry\Event;
use Sentry\Integration\IntegrationInterface;
use Sentry\Options;
use Sentry\SentrySdk;
use Sentry\State\Scope;

/**
 * Sanitizes sensitive data, such as passwords, before sending to Sentry.
 */
class RavenSanitizeIntegration implements IntegrationInterface {

  /**
   * This constant defines the mask string used to strip sensitive information.
   */
  const STRING_MASK = '********';

  /**
   * {@inheritdoc}
   */
  public function setupOnce() : void {
    Scope::addGlobalEventProcessor(function (Event $event) : Event {
      $currentHub = SentrySdk::getCurrentHub();
      $integration = $currentHub
        ->getIntegration(self::class);
      $client = $currentHub
        ->getClient();

      // The client bound to the current hub, if any, could not have this
      // integration enabled. If this is the case, bail out.
      if (NULL === $integration || NULL === $client) {
        return $event;
      }
      $this
        ->processEvent($event, $client
        ->getOptions());
      return $event;
    });
  }

  /**
   * {@inheritdoc}
   */
  private function processEvent(Event $event, Options $options) : void {

    // Scrub the pass field from the request body.
    $request = $event
      ->getRequest();
    if (!empty($request['data']['pass'])) {
      $request['data']['pass'] = self::STRING_MASK;
    }
    $event
      ->setRequest($request);

    // Scrub sensitive properties of user object.
    foreach ($event
      ->getExceptions() as $exception) {
      foreach ($exception
        ->getStacktrace()
        ->getFrames() as $frame) {
        $vars = $frame
          ->getVars();
        array_walk_recursive($vars, function (&$value, $key) {
          if (($key === 'pass' || $key === 'sid' || $key === 'ssid') && is_string($value) && $value) {
            $value = self::STRING_MASK;
          }
        });
        $frame
          ->setVars($vars);
      }
    }
  }

}

Classes

Name	Description
RavenSanitizeIntegration	Sanitizes sensitive data, such as passwords, before sending to Sentry.