Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add security field at the operation level #445

Closed

Conversation

LokeshRishi3
Copy link

Description
We are using AsyncAPI specifications for publishing the subscriber specific details of our topics and associated payloads for our HTTP push use cases.

Our subscribable channels(or topics) are protected by a set of OAuth scopes (authorization code or client credentials) - that a potential subscriber needs to be aware of.

Here is a sample contract.

We are able to accommodate almost every detail of interest to an integrator/subscriber (THANK YOU) - with the exception of being able to call out the oauth scopes necessary for the subscription to the topic - i.e. the security aspect at the channel or rather channel/operation level.

The current specification is perhaps more aligned with a broker based topology - but ours is a pure push use case (to registered webhooks) and we need an ability to call out any security aspects at the channel operation level.

Related issue(s)
Resolves #434

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@LokeshRishi3 LokeshRishi3 changed the title feat: Add security field at the operation level feat: add security field at the operation level Jan 13, 2022
@derberg
Copy link
Member

derberg commented Jan 14, 2022

@LokeshRishi3 hey, thanks a lot for this one. Are you also coming from ebay with the same use case we discuss in the proposal? So far your PR follows approach when on operation level, only operation security applies, but we are getting conclusions there that server security might apply too, so server function should then return not only operation sec requirements but also the ones provided in the associated server.

Please join discussion asyncapi/spec#584

@LokeshRishi3
Copy link
Author

LokeshRishi3 commented Jan 15, 2022

@derberg Yes! 🙂
Did you mean:

server security function should then return not only operation sec requirements but also the ones provided in the associated server.

Also, I realized that I did not add additional tests for the parse method and it seems like to add those we first need to publish a new spec with operation-level security asyncapi/spec-json-schemas#148

@derberg
Copy link
Member

derberg commented Jan 15, 2022

yes, you need to wait for the outcome from the spec repo discussion

@dalelane dalelane mentioned this pull request Jan 23, 2022
39 tasks
@asyncapi-bot asyncapi-bot deleted the branch asyncapi:2022-01-release January 31, 2022 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants