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

Add support for Dynamically Registered Clients #3

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ plugins {
}

group = 'io.curity.identityserver.plugin.data.access.json'
version = '0.0.1'
version = '0.0.2'
description = 'JSON DAP with Clients support'

repositories {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
/*
* Copyright 2024 Curity AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.curity.identityserver.plugin.data.access.json;

import io.curity.identityserver.plugin.data.access.json.config.DynamicallyRegisteredClientConfiguration;
import io.curity.identityserver.plugin.data.access.json.config.JsonDataAccessProviderConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import se.curity.identityserver.sdk.Nullable;
import se.curity.identityserver.sdk.attribute.Attributes;
import se.curity.identityserver.sdk.attribute.scim.v2.extensions.DynamicallyRegisteredClientAttributes;
import se.curity.identityserver.sdk.datasource.DynamicallyRegisteredClientDataAccessProvider;
import se.curity.identityserver.sdk.http.HttpMethod;
import se.curity.identityserver.sdk.http.HttpRequest;
import se.curity.identityserver.sdk.http.HttpResponse;
import se.curity.identityserver.sdk.service.Json;
import se.curity.identityserver.sdk.service.WebServiceClient;

import static se.curity.identityserver.sdk.http.HttpResponse.asString;

public class JsonDynamicallyRegisteredClientDataAccessProvider implements DynamicallyRegisteredClientDataAccessProvider {

private static final Logger _logger = LoggerFactory.getLogger(JsonDynamicallyRegisteredClientDataAccessProvider.class);
private final DynamicallyRegisteredClientConfiguration _configuration;
private final WebServiceClient _webServiceClient;
private final Json _json;

public JsonDynamicallyRegisteredClientDataAccessProvider(JsonDataAccessProviderConfiguration configuration)
{
_configuration = configuration.getDynamicallyRegisterClientConfiguration();
_webServiceClient = configuration.webServiceClient();
_json = configuration.json();
}

@Override
public @Nullable DynamicallyRegisteredClientAttributes getByClientId(String clientId) {
_logger.debug("Getting dynamic client with Id: {}", clientId);
HttpResponse httpResponse = sendHttpRequest(HttpMethod.GET.getMethodString(), String.join("/", _configuration.urlPath(), clientId), (String) null);

if (httpResponse.statusCode() != 200) {
return null;
}

String responseBody = httpResponse.body(asString());
_logger.debug("Received dynamic client JSON response: {}", responseBody);

return DynamicallyRegisteredClientAttributes.of(Attributes.fromMap(_json.fromJson(responseBody)));
}

@Override
public void create(DynamicallyRegisteredClientAttributes attributes) {
_logger.debug("Creating a new dynamic client with attributes : {}", attributes);
sendHttpRequest(HttpMethod.POST.getMethodString(), _configuration.urlPath(), _json.toJson(attributes));
}

@Override
public void update(DynamicallyRegisteredClientAttributes attributes) {
String clientId = attributes.getClientId();
_logger.debug("Updating dynamic client with ID: {} and attributes : {}", clientId, attributes);
sendHttpRequest(HttpMethod.PUT.getMethodString(), String.join("/", _configuration.urlPath(), clientId), _json.toJson(attributes));
Copy link
Member

Choose a reason for hiding this comment

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

Is an update always the full client? Not a PATCH?

}

@Override
public void delete(String clientId) {
_logger.debug("Deleting dynamic client with Id: {}", clientId);
sendHttpRequest(HttpMethod.DELETE.getMethodString(), String.join("/", _configuration.urlPath(), clientId), (String) null);
}

private HttpResponse sendHttpRequest(String method, String urlPath, @Nullable String requestBody)
{
HttpRequest.Builder requestBuilder = _webServiceClient.withPath(urlPath)
.request()
.accept(JsonClientRequestContentType.APPLICATION_JSON.toString())
.contentType(JsonClientRequestContentType.APPLICATION_JSON.toString());

if (requestBody != null)
{
requestBuilder.body(HttpRequest.fromString(requestBody));
}

return requestBuilder.method(method).response();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Copyright 2024 Curity AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package io.curity.identityserver.plugin.data.access.json.config;

import se.curity.identityserver.sdk.config.annotation.DefaultString;
import se.curity.identityserver.sdk.config.annotation.Description;

public interface DynamicallyRegisteredClientConfiguration
{
@Description("The path relative to the webservice context to make the requests to the dynamically registered clients endpoint")
@DefaultString("/")
String urlPath();
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,8 @@ public interface JsonDataAccessProviderConfiguration extends Configuration
@Name("database-clients")
DatabaseClientConfiguration getDatabaseClientConfiguration();


@Name("dynamically-registered-clients")
DynamicallyRegisteredClientConfiguration getDynamicallyRegisterClientConfiguration();

}
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@
import io.curity.identityserver.plugin.data.access.json.JsonAttributeDataAccessProvider;
import io.curity.identityserver.plugin.data.access.json.JsonCredentialDataAccessProvider;
import io.curity.identityserver.plugin.data.access.json.JsonDatabaseClientDataAccessProvider;
import io.curity.identityserver.plugin.data.access.json.JsonDynamicallyRegisteredClientDataAccessProvider;
import io.curity.identityserver.plugin.data.access.json.config.JsonDataAccessProviderConfiguration;
import se.curity.identityserver.sdk.Nullable;
import se.curity.identityserver.sdk.config.Configuration;
import se.curity.identityserver.sdk.datasource.AttributeDataAccessProvider;
import se.curity.identityserver.sdk.datasource.CredentialDataAccessProvider;
import se.curity.identityserver.sdk.datasource.DatabaseClientDataAccessProvider;
import se.curity.identityserver.sdk.datasource.DynamicallyRegisteredClientDataAccessProvider;
import se.curity.identityserver.sdk.plugin.descriptor.DataAccessProviderPluginDescriptor;

@SuppressWarnings("unused")
Expand Down Expand Up @@ -61,4 +63,9 @@ public Class<? extends DatabaseClientDataAccessProvider> getDatabaseClientDataAc
{
return JsonDatabaseClientDataAccessProvider.class;
}
}

@Override
public Class<? extends DynamicallyRegisteredClientDataAccessProvider> getDynamicallyRegisteredClientDataAccessProvider() {
return JsonDynamicallyRegisteredClientDataAccessProvider.class;
}
}