Class SignedWebBundle

js/sign/src/core/signed-web-bundle.ts:22–168

  | { status: 'error'; error: string };

export class SignedWebBundle {
  private constructor(
    private integrityBlock: IntegrityBlock,
    private pureWebBundle: Uint8Array
  ) {}

  // Use with raw Singed Web Bundle data, for example read from file with fs.readFile('bundle.swbn')
  static fromBytes(signedWebBundle: Uint8Array): SignedWebBundle {
    if (!isSignedWebBundle(signedWebBundle)) {
      throw new Error('Not a signed web bundle.');
    }

    const offset = this.obtainIntegrityOffset(signedWebBundle);

    const integrityBlockBytes = signedWebBundle.slice(0, offset);
    const integrityBlock = IntegrityBlock.fromCbor(integrityBlockBytes);

    const bundle = signedWebBundle.slice(offset);

    return new SignedWebBundle(integrityBlock, bundle);
  }

  // Web bundle ID is derived from the first key if not provided
  static async fromWebBundle(
    webBundle: Uint8Array,
    signingStrategies: Array<ISigningStrategy>,
    options?: { webBundleId?: string }
  ): Promise<SignedWebBundle> {
    assert(signingStrategies.length > 0, 'No signing strategies provided');

    const publicKey = await signingStrategies[0].getPublicKey();
    const webBundleId =
      options?.webBundleId ?? new WebBundleId(publicKey).serialize();

    const { signedWebBundle } = await new IntegrityBlockSigner(
      webBundle,
      webBundleId,
      signingStrategies
    ).sign();

    return SignedWebBundle.fromBytes(signedWebBundle);
  }

  async addSignature(signingStrategy: ISigningStrategy): Promise<this> {
    this.integrityBlock = await new IntegrityBlockSigner(
      this.pureWebBundle,
      this.integrityBlock,
      [signingStrategy]
    ).signAndGetIntegrityBlock();
    return this;
  }

  removeSignature(publicKey: Uint8Array): this {
    this.integrityBlock.removeIntegritySignature(publicKey);
    return this;
  }

  printInfo(): void {