Skip to content

OpenID Connect Realm base functionality #37009

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

Merged
merged 22 commits into from
Jan 18, 2019
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
5af56b9
Add REST and Transport actions for oidc authentication
jkakavas Dec 5, 2018
c4154f6
support state
jkakavas Dec 13, 2018
8149339
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Dec 14, 2018
8d54c7c
track current changes
jkakavas Dec 21, 2018
cc68f5a
Ongoing oidc work
jkakavas Dec 24, 2018
72a2dd4
Add functionality for building Authentication Requests
jkakavas Dec 27, 2018
69fb95c
Fix formatting
jkakavas Dec 27, 2018
12dd9c0
Fix formatting
jkakavas Dec 27, 2018
6a4cac6
Fix settings
jkakavas Dec 27, 2018
aeacfc5
Correct javadoc
jkakavas Dec 27, 2018
845dc36
Add serialiazion and tests for the AuthenticateRequest
jkakavas Dec 27, 2018
687c109
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Dec 28, 2018
06c26dc
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 11, 2019
4bde32f
address feedback
jkakavas Jan 11, 2019
08be032
address feedback
jkakavas Jan 14, 2019
8ead2e5
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 15, 2019
dcf46fa
Address feedback
jkakavas Jan 15, 2019
cb35d6e
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 15, 2019
8d9dcf6
address further feedback
jkakavas Jan 15, 2019
e97097e
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 16, 2019
da98413
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 16, 2019
03d2db5
Merge remote-tracking branch 'origin/master' into oidc-realm-base
jkakavas Jan 17, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.Action;

/**
* Action for initiating an authentication process using OpenID Connect
*/
public final class OpenIdConnectAuthenticateAction extends Action<OpenIdConnectAuthenticateResponse> {

public static final OpenIdConnectAuthenticateAction INSTANCE = new OpenIdConnectAuthenticateAction();
public static final String NAME = "cluster:admin/xpack/security/oidc/authenticate";

protected OpenIdConnectAuthenticateAction() {
super(NAME);
}

public OpenIdConnectAuthenticateResponse newResponse() {
return new OpenIdConnectAuthenticateResponse();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;

import java.io.IOException;

/**
* Represents a request for authentication using OpenID Connect
*/
public class OpenIdConnectAuthenticateRequest extends ActionRequest {

/**
* The URI were the OP redirected the browser after the authentication attempt. This is passed as is from the
Copy link
Member

Choose a reason for hiding this comment

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

s/were/where

* facilitator entity (i.e. Kibana)
*/
private String redirectUri;

/**
* The state value that either we or the facilitator generated for this specific flow and that was stored at the user's session with
* the facilitator
Copy link
Contributor

Choose a reason for hiding this comment

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

These java docs ("the faciliator generated") are no longer true.

*/
private String state;

/**
* The nonce value that the facilitator generated for this specific flow and that was stored at the user's session with
* the facilitator
*/
private String nonce;

public OpenIdConnectAuthenticateRequest() {
}

public String getRedirectUri() {
return redirectUri;
}

public void setRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
}

public String getState() {
return state;
}

public void setState(String state) {
this.state = state;
}

public String getNonce() {
return nonce;
}

public void setNonce(String nonce) {
this.nonce = nonce;
}

@Override
public ActionRequestValidationException validate() {
return null;
}

@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
out.writeString(redirectUri);
out.writeString(state);
out.writeOptionalString(nonce);
}

@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
redirectUri = in.readString();
state = in.readString();
nonce = in.readOptionalString();
}

public String toString() {
return "{redirectUri=" + redirectUri + ", state=" + state + ", nonce=" + nonce + "}";
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.ActionRequestBuilder;
import org.elasticsearch.client.ElasticsearchClient;

/**
* Request builder for populating a {@link OpenIdConnectAuthenticateRequest}
*/
public class OpenIdConnectAuthenticateRequestBuilder
extends ActionRequestBuilder<OpenIdConnectAuthenticateRequest, OpenIdConnectAuthenticateResponse> {

public OpenIdConnectAuthenticateRequestBuilder(ElasticsearchClient client) {
super(client, OpenIdConnectAuthenticateAction.INSTANCE, new OpenIdConnectAuthenticateRequest());
}

public OpenIdConnectAuthenticateRequestBuilder redirectUri(String redirectUri) {
request.setRedirectUri(redirectUri);
return this;
}

public OpenIdConnectAuthenticateRequestBuilder state(String state) {
request.setState(state);
return this;
}

public OpenIdConnectAuthenticateRequestBuilder nonce(String nonce) {
request.setNonce(nonce);
return this;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.ActionResponse;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.unit.TimeValue;

import java.io.IOException;

public class OpenIdConnectAuthenticateResponse extends ActionResponse {
private String principal;
private String accessTokenString;
private String refreshTokenString;
private TimeValue expiresIn;

public OpenIdConnectAuthenticateResponse(String principal, String accessTokenString, String refreshTokenString, TimeValue expiresIn) {
this.principal = principal;
this.accessTokenString = accessTokenString;
this.refreshTokenString = refreshTokenString;
this.expiresIn = expiresIn;
}

public OpenIdConnectAuthenticateResponse() {
}

public String getPrincipal() {
return principal;
}

public String getAccessTokenString() {
return accessTokenString;
}

public String getRefreshTokenString() {
return refreshTokenString;
}

public TimeValue getExpiresIn() {
return expiresIn;
}

@Override
public void readFrom(StreamInput in) throws IOException {
Copy link
Member

Choose a reason for hiding this comment

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

I'd love to see us start using Writeable for everything new. That would make this throw a UnsupportedOperationException.

super.readFrom(in);
principal = in.readString();
accessTokenString = in.readString();
refreshTokenString = in.readString();
expiresIn = in.readTimeValue();
}

@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
out.writeString(principal);
out.writeString(accessTokenString);
out.writeString(refreshTokenString);
out.writeTimeValue(expiresIn);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.Action;

public class OpenIdConnectPrepareAuthenticationAction extends Action<OpenIdConnectPrepareAuthenticationResponse> {

public static final OpenIdConnectPrepareAuthenticationAction INSTANCE = new OpenIdConnectPrepareAuthenticationAction();
public static final String NAME = "cluster:admin/xpack/security/oidc/prepare";

protected OpenIdConnectPrepareAuthenticationAction() {
super(NAME);
}

public OpenIdConnectPrepareAuthenticationResponse newResponse() {
return new OpenIdConnectPrepareAuthenticationResponse();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;

import java.io.IOException;

import static org.elasticsearch.action.ValidateActions.addValidationError;

/**
* Represents a request to prepare an OAuth 2.0 authentication request
*/
public class OpenIdConnectPrepareAuthenticationRequest extends ActionRequest {

private String realmName;
private String state;
private String nonce;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it's easier to reason if we generate the state and nonce. OIDC allows for too much flexibility already....

Copy link
Member Author

Choose a reason for hiding this comment

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

I went back and forth on this for some time. Agreed, there is no strong argument against allowing Kibana (or any other facilitator ) to determine the nonce and state. I will address this


public String getRealmName() {
return realmName;
}

public String getState() {
return state;
}

public String getNonce() {
return nonce;
}

public void setRealmName(String realmName) {
this.realmName = realmName;
}

public void setState(String state) {
this.state = state;
}

public void setNonce(String nonce) {
this.nonce = nonce;
}

@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException validationException = null;
if (Strings.hasText(realmName) == false) {
validationException = addValidationError("realm name must be provided", null);
}
return validationException;
}

@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
out.writeString(realmName);
out.writeOptionalString(state);
out.writeOptionalString(nonce);
}

@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
realmName = in.readString();
state = in.readOptionalString();
nonce = in.readOptionalString();
}

public String toString() {
return "{realmName=" + realmName + ", state=" + state + ", nonce=" + nonce + "}";
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
package org.elasticsearch.xpack.core.security.action.oidc;

import org.elasticsearch.action.ActionRequestBuilder;
import org.elasticsearch.client.ElasticsearchClient;

/**
* Request builder for populating a {@link OpenIdConnectPrepareAuthenticationRequest}
*/
public class OpenIdConnectPrepareAuthenticationRequestBuilder
extends ActionRequestBuilder<OpenIdConnectPrepareAuthenticationRequest, OpenIdConnectPrepareAuthenticationResponse> {

public OpenIdConnectPrepareAuthenticationRequestBuilder(ElasticsearchClient client) {
super(client, OpenIdConnectPrepareAuthenticationAction.INSTANCE, new OpenIdConnectPrepareAuthenticationRequest());
}

public OpenIdConnectPrepareAuthenticationRequestBuilder realmName(String name) {
request.setRealmName(name);
return this;
}

public OpenIdConnectPrepareAuthenticationRequestBuilder state(String state) {
request.setState(state);
return this;
}

public OpenIdConnectPrepareAuthenticationRequestBuilder nonce(String nonce) {
request.setNonce(nonce);
return this;
}
}
Loading