Support for RAR
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
Support for the OAuth 2.0 Rich Authorization Requests draft specification would require the specification of the type field values required for the access token to be accepted. For each type value, there's also the usually the need to define other values or parameters within the object. The following examples show what a possible syntax could look like for the new OAS security model proposed in OAI/OpenAPI-Specification#2582.
This example shows how it could be defined for an example API using OAuth 2 bearer tokens
components:
securitySchemes:
photoApi:
type: oauth2-rar
credentials:
- in: header
name: authorization
format: ^[B|b][E|e][A|a][R|r][E|e][R|r] (.*)$
config:
types:
- type: photo-api
actions:
- read
- write
- dolphin
locations:
- <api endpoint url>
datatypes:
- image
- metadata
- type: bank-api
actions:
- read
locations:
- <api endpoint url>
identifier: <account id>
datatypes:
- account
As I'm not sure how to show placeholder values, I'm using things like <api endpoint url> here.
Furthermore, each type value could define its own schema for what's allowed and required under its config space, to make this more automated. In general, the values under the types array could be any object structure, with only the type field required. Perhaps the overlays function can help with this?
This proposed syntax is just one possible idea, and I'm looking for feedback on how this could be made to fit the OAS model better.
Addresses #6
Contributor guide
No contributing guide indexed for this repository
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
Start by reading the OAuth 2.0 Rich Authorization Requests draft and OAI/OpenAPI-Specification#2582, then compare them with the proposed YAML security scheme. Review whether the flexible types and config structures fit the OAS model and whether overlays are relevant. Done would require an agreed syntax and schema approach, but the issue currently asks for feedback rather than defining a settled change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- authentication, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100