swagger-api/swagger-codegen

password in toString in generated model

Open

#2.662 geöffnet am 20. Apr. 2016

Auf GitHub ansehen
 (11 Kommentare) (6 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: Generalhelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

When using format "password", e.g.

  credentials:
    type: object
    properties:
      username:
        type: string
      password:
        type: string
        format: password
    required:
    - username
    - password

the field "password" is contained in the toString method of the generated model class.

In my opinion, that's a security issue (you don't want client passwords appearing in log files etc.)

Would it make sense to change the corresponding line in toString to:

sb.append(" password: ").append("<protected>").append("\n");

whenever the format "password" is used?

Contributor Guide

Research-Richtung
Finden Sie die Codegenerierungsvorlage (normalerweise eine .mustache Datei), die die toString Methode des Modells erstellt. Ändern Sie die Vorlage so, dass Felder mit dem Format 'password' erkannt und deren Werte in der toString Ausgabe durch '<protected>' ersetzt werden.
Tech Stack
java
Domain
devtools
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Java
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75