swagger-api / swagger-api/swagger-codegen

[Python] Enhancement- Support http signing

Open
#8,090 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

There's authorization based on headers or query params, but not based on: https://datatracker.ietf.org/doc/draft-cavage-http-signatures

Enhancement would be to support this as a code generation option, -Dhttpsig, with the auth_settings, then set to auth_setting['in'] == 'httpsig' to trigger it.

Swagger-codegen version

This is an enhancement, filing issue prior to filing PR.

Swagger declaration file content or url

N/A

Command line used for generation

./bin/python-httpsig-petstore.sh in associated PR.

Steps to reproduce

N/A

Related issues/PRs

Will supply PR in moments.

Suggest a fix/enhancement

Will supply PR in moments.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Python generator entry point and the ./bin/python-httpsig-petstore.sh command mentioned in the issue, then trace how auth_settings are handled for generated clients. Compare the HTTP Signatures draft with the existing authorization paths; done means the -Dhttpsig option generates signing behavior for auth_settings entries using in == httpsig.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, authentication
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.