[Bug]: content-length-guardrail policy schema accepts a configuration with neither request nor response

Abierto Apto para principiantes
#4,329 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
83/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
go, yaml
Área
api, backend

Línea de trabajo

Localiza el policy-definition.yaml de la política content-length-guardrail y compara su esquema con los esquemas de word-count-guardrail, sentence-count-guardrail, regex-guardrail y url-guardrail. Añade el requisito de request o response descrito en el issue y confirma que el esquema rechaza params vacíos y acepta una configuración con request o response. El issue también apunta a la aserción de integración en wso2/gateway-controllers#415.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Area/Policies Aspect/API Aspect/Configuration Severity/Minor Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI), Aspect/Configuration (Config files, settings, env vars, defaults)

Description

The content-length-guardrail documentation says: "At least one of request or response must be provided." The policy refuses a configuration with neither. Its schema does not enforce the rule, so such a configuration passes API creation and fails at runtime instead.

The API is created, and every request to the operation then gets HTTP 500. A mistake that should fail the deployment breaks the operation.

Other guardrails in the repository enforce this rule in their schema, for example word-count-guardrail, sentence-count-guardrail, regex-guardrail and url-guardrail:

anyOf:
  - required: [ request ]
  - required: [ response ]

A fix could add the same rule to the policy's policy-definition.yaml.

The integration suite in wso2/gateway-controllers#415 asserts this behaviour.

Steps to Reproduce
  1. Create a REST API with an operation that attaches the policy with empty parameters:
    {"name":"content-length-guardrail","version":"v1","params":{}}
    
  2. The API is created.
  3. Every request to that operation gets HTTP 500. An operation on the same API with a valid configuration still works.
Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)
  • Policy: content-length-guardrail v1.1.0, wso2/gateway-controllers main (4f1520a8)
  • Gateway versions: 1.1.0 (patched), 1.2.0 and latest (main-59dcd51)
Lenguaje dominante
Go
Estrellas
85
Forks
137
Merge medio
1 d 12 h
PR fusionados (30 d)
247

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de wso2/api-platform

Todos los issues de wso2/api-platform

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.