Excessive Data Exposure (Java)

ID

excessive_data_exposure_java

Severity

high

Remediation Complexity

medium

Remediation Risk

high

Remediation Effort

medium

Family

API3:2023 - Broken Object Property Level Authorization

CWE

CWE-213, CWE-200

Resource

data_exposure

Language

Spring MVC, JAX-RS

Description

Walks each endpoint’s response model and classifies every field into one of three confidence tiers, based on whether the field is sensitivity-tagged (PII / PCI / PHI / credentials by the sensitivity classifier) and whether the same field name appears in the request:

  • HIGH — sensitive AND not referenced in the request. The caller never asked for the field; returning it is over-fetch.

  • MEDIUM — sensitive AND referenced in the request. Possibly a legitimate field-by-field update — surfaced for review.

  • LOW — not sensitivity-tagged AND not referenced in the request. Mild signal of over-fetching.

Only the HIGH tier fires by default. The detector is per-language because the framework idioms differ — JSON-annotation models in Java / C#, dataclass / Pydantic models in Python, plain-object / class-transformer in JS/TS, struct tags in Go, Eloquent / Symfony serializer groups in PHP.

Rationale

Excessive Data Exposure is the read side of OWASP API3:2023 — the API returns more than the client needs, because the implementation returned a persistence model directly and the persistence model has more fields than the contract. The risk is twofold:

  • Direct data leak — the extra fields contain credentials (passwordHash, apiToken), PII (email, phone, ssn), or PCI (cardLastFour, accountNumber). Anyone reading the response sees them.

  • Object-property authorization bypass — even if the endpoint is authorised to return the object, individual fields on that object should be scoped. A "GET my profile" endpoint authorised for the user should not expose the user’s isAdmin flag, lastLoginIp, or internalNotes. API3 separates these from API1 (object-level) for exactly this reason.

The pattern is endemic in single-page-app backends, where the same User / Order / Patient entity is reused across all read endpoints, with the client deciding which fields to show. The "client filters out the bad fields" defence does not work — anyone can read the network response.

A susceptible Spring controller might look like this:

@RestController
public class UserController {

  @GetMapping("/users/{id}")
  public User getUser(@PathVariable Long id) {
    return userRepository.findById(id).orElseThrow();
  }
}

@Entity
class User {
  @Id Long id;
  String username;
  String email;          // PII
  String passwordHash;   // CREDENTIAL
  String ssn;            // PII
  boolean isAdmin;       // PRIVILEGE
  // ... and 20 more fields
}

The handler returns the persistence entity, so every field — including passwordHash, ssn, and isAdmin — is serialised into the response.

Remediation

The fix is to return a dedicated response model per operation, narrow to the fields the operation actually needs to expose. Specific per-language patterns are in the language pages.

Beyond per-route DTOs:

  • If the sensitivity tag is wrong for your project — for example, an email-newsletter app whose User.email field is intentionally public — exclude the field via per-project sensitivity overrides rather than suppressing the finding.

  • Pair this detector with pii_leak_in_response (focuses on PII / PCI / PHI specifically, with stricter severity).

  • Server-side response filtering is the only effective control. Anything that depends on the client hiding fields is not a remediation.

Here is a revised handler returning a dedicated DTO:

public record PublicUser(Long id, String username) {
  static PublicUser from(User u) { return new PublicUser(u.getId(), u.getUsername()); }
}

@RestController
public class UserController {

  @GetMapping("/users/{id}")
  public PublicUser getUser(@PathVariable Long id) {
    return userRepository.findById(id)
        .map(PublicUser::from)
        .orElseThrow();
  }
}

The response shape now contains only the fields the operation needs to expose; adding a field to User no longer leaks it through the API.

Other Java idioms that achieve the same effect:

  • Jackson @JsonView over the entity with per-view interfaces.

  • Jackson @JsonIgnore on each sensitive field — fragile (every new sensitive field must be annotated).

  • MapStruct mappers + a per-operation response interface.

Configuration

The detector accepts:

  • minConfidence — the minimum confidence tier that fires. Default high. Set to medium to include "sensitive AND referenced in request" findings. Set to low only for benchmark / audit runs (very noisy).

The set of sensitivity tags (PII / PCI / PHI / credentials) is configured globally on the sensitivity classifier, not per-detector.

References