FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor

    owaspHeaderDefinition


    owaspHeaderDefinition will check that headers have been defined with the supplied headers.

    How do I use this function?

    This function is configured by the following functionOptions.

    NAME TYPE REQUIRED? DESCRIPTION
    headers []string yes An array of all the headers to check for

    Example ruleset configuration

    my-security-rule:
      description: Check for the following rate limiting headers.
      type: validation
      given: $
      then:
        function: owaspHeaderDefinition
        functionOptions:
          headers:
            - X-RateLimit-Limit
            - RateLimit-Limit
            - RateLimit-Reset