class CspSubscriber in Raven: Sentry Integration 8.2

Subscriber for CSP events.

Hierarchy

• class \Drupal\raven\EventSubscriber\CspSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'CspSubscriber'

raven.services.yml in ./raven.services.yml

raven.services.yml

1 service uses CspSubscriber

raven.csp_subscriber in ./raven.services.yml

Drupal\raven\EventSubscriber\CspSubscriber

File

src/EventSubscriber/CspSubscriber.php, line 14

Namespace

Drupal\raven\EventSubscriber

class CspSubscriber implements EventSubscriberInterface {

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  private $configFactory;

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    if (!class_exists(CspEvents::class)) {
      return [];
    }
    $events[CspEvents::POLICY_ALTER] = [
      'onCspPolicyAlter',
    ];
    return $events;
  }

  /**
   * CspSubscriber constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory service.
   */
  public function __construct(ConfigFactoryInterface $configFactory) {
    $this->configFactory = $configFactory;
  }

  /**
   * Alter CSP policy to allow Sentry to send JS errors.
   *
   * @param \Drupal\csp\Event\PolicyAlterEvent $alterEvent
   *   The Policy Alter event.
   */
  public function onCspPolicyAlter(PolicyAlterEvent $alterEvent) {
    $config = $this->configFactory
      ->get('raven.settings');
    if (!$config
      ->get('javascript_error_handler')) {
      return;
    }
    if (!class_exists(\Raven_Client::class)) {
      return;
    }
    try {
      $dsn = \Raven_Client::parseDSN(empty($_SERVER['SENTRY_DSN']) ? $config
        ->get('public_dsn') : $_SERVER['SENTRY_DSN']);
    } catch (\InvalidArgumentException $e) {

      // Raven is incorrectly configured.
      return;
    }
    self::fallbackAwareAppendIfEnabled($alterEvent
      ->getPolicy(), 'connect-src', [
      $dsn['server'],
      str_replace('/store/', '/envelope/', $dsn['server']),
    ]);
  }

  /**
   * Append to a directive if it or a fallback directive is enabled.
   *
   * If the specified directive is not enabled but one of its fallback
   * directives is, it will be initialized with the same value as the fallback
   * before appending the new value.
   *
   * If none of the specified directive's fallbacks are enabled, the directive
   * will not be enabled.
   *
   * @param \Drupal\csp\Csp $policy
   *   The CSP directive to alter.
   * @param string $directive
   *   The directive name.
   * @param array|string $value
   *   The directive value.
   */
  private static function fallbackAwareAppendIfEnabled(Csp $policy, $directive, $value) {
    if ($policy
      ->hasDirective($directive)) {
      $policy
        ->appendDirective($directive, $value);
      return;
    }

    // Duplicate the closest fallback directive with a value.
    foreach (Csp::getDirectiveFallbackList($directive) as $fallback) {
      if ($policy
        ->hasDirective($fallback)) {
        $policy
          ->setDirective($directive, $policy
          ->getDirective($fallback));
        $policy
          ->appendDirective($directive, $value);
        return;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CspSubscriber::$configFactory	private	property	The configuration factory.
CspSubscriber::fallbackAwareAppendIfEnabled	private static	function	Append to a directive if it or a fallback directive is enabled.
CspSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
CspSubscriber::onCspPolicyAlter	public	function	Alter CSP policy to allow Sentry to send JS errors.
CspSubscriber::__construct	public	function	CspSubscriber constructor.