Function validateHeaderSignature

  • validateHeaderSignature(signature, expirationInSeconds?, shouldLogMessageHash?): ValidationResult

  • Verify Client's signature in request's header

    Parameters

    • signature: {
          headerSignature: string;
          payloadSerialization?: string;
          starkKey: string;
          timestamp: number;
          url?: string;
      }

      The serialized signature in string format

      • headerSignature: string
      • OptionalpayloadSerialization?: string
      • starkKey: string
      • timestamp: number
      • Optionalurl?: string
    • OptionalexpirationInSeconds: number

      The duration for a request to be considered expired

    • shouldLogMessageHash: boolean = true

      Whether to log the messageHash when verifier regenerate from request's input

    Returns ValidationResult

    The ValidationResult whether VALID | INVALID | EXPIRED

    Example

    import { Signature } from '@myria/crypto-js';

    const headerSignature = Signature.validateHeaderSignature(
      signature,
      starkKey,
      timestamp,
      expireInSeconds,
      url,
      payloadSerialization
    );

Settings

Member Visibility