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

Publish rest API spec for SAML, OIDC and PKI service-provider oriented APIs #67189

Open
albertzaharovits opened this issue Jan 7, 2021 · 4 comments
Labels
>enhancement :Security/Security Security issues without another label Team:Security Meta label for security team team-discuss

Comments

@albertzaharovits
Copy link
Contributor

We have a couple of APIs that are not intended to be used by regular clients, i.e. clients that are interested in accessing or administering ES.
The following APIs are low level in the sense that they are used by Kibana, in cases where the responsibilities of authentication flows are divided between Kibana and Elasticsearch. Elasticsearch cannot assume all responsibilities in those cases because it is not a HTTP Server.

Delegate PKI authentication

OpenID Connect Prepare Authentication API
OpenID Connect authenticate API
OpenID Connect logout API

SAML prepare authentication API
SAML authenticate API
SAML logout API
SAML invalidate API
SAML service provider metadata API

In general, a client that calls such APIs takes the role of the smart HTTP proxy to Elasticsearch.

Given the limited use cases of such APIs, we initially made the conscious decision to not publish the REST spec which is the template for language client's request objects. This way, language clients don't expose dedicated methods for low level actions.

But we do document the APIs, and internal APIs such as autoscaling also publish their rest spec.

On consistency grounds, should we backtrack on the original decision, and expose the rest spec for the above APIs?

@albertzaharovits albertzaharovits added >enhancement :Security/Security Security issues without another label team-discuss labels Jan 7, 2021
@elasticmachine elasticmachine added the Team:Security Meta label for security team label Jan 7, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@albertzaharovits
Copy link
Contributor Author

CC @azasypkin

@azasypkin
Copy link
Member

Hey! Have you made any decision on that one already?

@jkakavas
Copy link
Member

jkakavas commented May 7, 2021

Hi @azasypkin , we discussed this in a team meeting recently and we agree we need to do this. I will take care of the SAML APIs and @albertzaharovits will write the OIDC APIs specs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>enhancement :Security/Security Security issues without another label Team:Security Meta label for security team team-discuss
Projects
None yet
Development

No branches or pull requests

4 participants