swagger-api / swagger-api/swagger-codegen
password in toString in generated model
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or target language is named in the issue. Start by locating the model-generation template and the handling of the password format, then check how toString output is tested across generated clients. Done means password-formatted fields are protected in generated toString output without changing other fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- security, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100