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

Pluggable Auth policy follow up items #2032

Closed
4 tasks done
achamayou opened this issue Dec 17, 2020 · 3 comments
Closed
4 tasks done

Pluggable Auth policy follow up items #2032

achamayou opened this issue Dec 17, 2020 · 3 comments
Assignees

Comments

@achamayou
Copy link
Member

achamayou commented Dec 17, 2020

  • Listing these auth policies in OpenAPI. I've sketched the correct type of JSON objects, but not added them yet. A slight annoyance here is it looks like there's not a way to describe our 'cert auth' policy in OpenAPI? If anyone can see a better solution than "don't mention it in the OpenAPI", please let me know. (Document auth policies in OpenAPI #2049)
  • Exposing these auth policies through js_generic by name (in app.json and the user object). On the C++ side I've opted entirely for type-based comparisons, but since we need unique names for JS we should see if it makes sense to use these in C++ as well.
  • A test demonstrating a custom policy. (Add example of custom auth policy, and documentation of new auth types #2050)
  • installing endpoints without any policy should give a clear error, as early as possible, to avoid accidentally unauthenticated enpoints. Endpoints that deliberately want no authentication should set empty_auth_policy. (Set auth policies at construction #2048)
@lynshi
Copy link
Contributor

lynshi commented Dec 17, 2020

Regarding your first point, we have come across the same thing - OpenAPI doesn't support cert-based auth. However, the feature request for it has been open for a while, and it looks like a mutualTLS option has made it into 3.1: OAI/OpenAPI-Specification#1764.

@achamayou
Copy link
Member Author

@lynshi what’s your view on CCF using OpenAPI 3.1 as soon as it is released?

@lynshi
Copy link
Contributor

lynshi commented Dec 17, 2020

I think that's fine. Using the latest specification can't hurt for readability/maintenance going forward.

We have to write our own Swagger anyway to submit to the Azure REST API specs repo, which basically decouples us from CCF for anything documentation related.

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

No branches or pull requests

3 participants