front_end/models/issues_manager/SRIMessageSignatureIssue.ts

// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import * as i18n from '../../core/i18n/i18n.js';
import type * as SDK from '../../core/sdk/sdk.js';
import * as Protocol from '../../generated/protocol.js';

import {Issue, IssueCategory, IssueKind} from './Issue.js';
import {
  type LazyMarkdownIssueDescription,
  type MarkdownIssueDescription,
  resolveLazyDescription,
} from './MarkdownIssueDescription.js';

const UIStrings = {
  /**
   * @description Title for HTTP Message Signatures specification url
   */
  httpMessageSignatures: 'HTTP Message Signatures (RFC9421)',
  /**
   * @description Title for Signature-based Integrity specification url
   */
  signatureBasedIntegrity: 'Signature-based Integrity',
} as const;
const str_ = i18n.i18n.registerUIStrings('models/issues_manager/SRIMessageSignatureIssue.ts', UIStrings);
const i18nLazyString = i18n.i18n.getLazilyComputedLocalizedString.bind(undefined, str_);

function generateGroupingIssueCode(details: Protocol.Audits.SRIMessageSignatureIssueDetails): string {
  const issueCode = `${Protocol.Audits.InspectorIssueCode.SRIMessageSignatureIssue}::${details.error}`;
  if (details.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch) {
    // Signature mismatch errors should be grouped by "signature base".
    return issueCode + details.signatureBase;
  }
  if (details.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedIntegrityMismatch) {
    // Integrity mismatch errors should be grouped by integrity assertion.
    return issueCode + details.integrityAssertions.join();
  }

  // Otherwise, simply group by issue type:
  return issueCode;
}

export class SRIMessageSignatureIssue extends Issue<Protocol.Audits.SRIMessageSignatureIssueDetails, string> {
  constructor(
      issueDetails: Protocol.Audits.SRIMessageSignatureIssueDetails, issuesModel: SDK.IssuesModel.IssuesModel|null) {
    super(
        {
          code: generateGroupingIssueCode(issueDetails),
          umaCode: `${Protocol.Audits.InspectorIssueCode.SRIMessageSignatureIssue}::${issueDetails.error}`,
        },
        issueDetails, issuesModel);
  }

  // Overriding `Issue<String>`:
  override primaryKey(): string {
    return JSON.stringify(this.details());
  }

  override getDescription(): MarkdownIssueDescription|null {
    const details = this.details();
    const description: LazyMarkdownIssueDescription = {
      file: `sri${details.error}.md`,
      links: [
        {
          link: 'https://www.rfc-editor.org/rfc/rfc9421.html',
          linkTitle: i18nLazyString(UIStrings.httpMessageSignatures),
        },
        {
          link: 'https://wicg.github.io/signature-based-sri/',
          linkTitle: i18nLazyString(UIStrings.signatureBasedIntegrity),
        }
      ],
      substitutions: new Map()
    };
    if (details.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedSignatureMismatch) {
      description.substitutions?.set('PLACEHOLDER_signatureBase', () => details.signatureBase);
    }
    if (details.error === Protocol.Audits.SRIMessageSignatureError.ValidationFailedIntegrityMismatch) {
      description.substitutions?.set('PLACEHOLDER_integrityAssertions', () => {
        const prefix = '\n* ';
        return prefix + this.details().integrityAssertions.join(prefix);
      });
    }
    return resolveLazyDescription(description);
  }

  override getCategory(): IssueCategory {
    return IssueCategory.OTHER;
  }

  override getKind(): IssueKind {
    return IssueKind.PAGE_ERROR;
  }

  override requests(): Iterable<Protocol.Audits.AffectedRequest> {
    return this.details().request ? [this.details().request] : [];
  }

  static fromInspectorIssue(
      issuesModel: SDK.IssuesModel.IssuesModel|null,
      inspectorIssue: Protocol.Audits.InspectorIssue): SRIMessageSignatureIssue[] {
    const details = inspectorIssue.details.sriMessageSignatureIssueDetails;
    if (!details) {
      console.warn('SRI Message Signature issue without details received.');
      return [];
    }
    return [new SRIMessageSignatureIssue(details, issuesModel)];
  }
}