Finish merge

This commit is contained in:
Stefan Bethke 2026-07-18 15:25:13 +02:00
commit a540e63bf3
4 changed files with 77 additions and 42 deletions

View file

@ -3,13 +3,6 @@ package de.ccc.hamburg.keycloak.attribute_endpoints;
import jakarta.ws.rs.*;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import org.jboss.logging.Logger;
import org.keycloak.component.ComponentModel;
import org.keycloak.models.*;
@ -138,7 +131,6 @@ public class AttributeEndpointsResourceProvider implements RealmResourceProvider
Boolean regexIsBlank;
UserModel authUser;
List<String> attributeNames;
UserProvider userProvider;
Stream<UserModel> users;
AttributeExportContext(String slug) {
@ -196,6 +188,7 @@ public class AttributeEndpointsResourceProvider implements RealmResourceProvider
authUser = auth.getUser();
if (!authUser.hasRole(authRole)) {
LOG.info("User " + authUser.getUsername() + " does not have required role " + authRole.getName());
throw new ForbiddenException("User does not have required auth role.");
}
@ -205,33 +198,10 @@ public class AttributeEndpointsResourceProvider implements RealmResourceProvider
.map(a -> a.getName())
.toList();
UserProvider userProvider = session.users();
Stream<UserModel> users = userProvider.searchForUserStream(realm, Map.of())
.filter(user -> user.hasRole(matchRole));
List<String> attribute_list = users
.map(user -> {
Stream<String> attributeStream = attributeNames.stream()
.map(attributeName -> user.getAttributeStream(attributeName).toList())
.flatMap(Collection::stream);
return attributeStream
.filter(attribute -> !attribute.isEmpty())
.toList();
})
.flatMap(List::stream)
.filter(attribute -> {
if (regexIsBlank) {
return true;
}
final Pattern pattern = Pattern.compile(configAttributeRegex);
final Matcher matcher = pattern.matcher(attribute);
return matcher.find();
})
.toList();
return Response.ok(attribute_list).build();
UserProvider userProvider = session.users();
users = userProvider.searchForUserStream(realm, Map.of())
.filter(user -> user.hasRole(matchRole));
}
}
private static Auth getAuth(KeycloakSession session) {

View file

@ -23,12 +23,26 @@ The copying of the database is necessary to avoid locking errors.
docker compose exec -it keycloak sh -c "cp -rp /opt/keycloak/data/h2 /tmp && env -i -- /opt/keycloak/bin/kc.sh export --db dev-file --db-url 'jdbc:h2:file:/tmp/h2/keycloakdb;NON_KEYWORDS=VALUE' --file /opt/keycloak/data/import/testing.json --realm testing"
```
## Testing Realm Configuration
## Running Integration Tests
This directory also contains shell scripts that exercise the attribute endpoint.
Bring up Keycloak with `docker compose up -d`, then run one of the `client-test-export-`*`.sh` scripts.
```shell
$ ./client-test-export-dooris.sh
[
"hacker-ssh-key-1",
"hacker-ssh-key-2"
]
```
## Realm `testing` Configuration
The realm contains these objects:
* Clients:
* `export-dooris-ssh-keys` with secret `export-dooris-ssh-keys-secret` and role `export-dooris-ssh-keys`
* `export-dooris-ssh-keys` with secret `export-dooris-ssh-keys-secret` and user `service-account-export-dooris-ssh-keys`
* `export-mailing-list-addresses` with secret `export-mailing-list-addresses-secret` and role `export-mailing-list-addresses`
* Realm Roles:
* `dooris-authorized`
@ -54,3 +68,34 @@ The realm contains these objects:
* Dooris SSH Keys:
* SSH Key 1: `hacker-ssh-key-1`
* SSH Key 2: `hacker-ssh-key-2`
* `service-account-export-dooris-ssh-keys`
* Role `export-dooris-ssh-keys`
* `service-account-export-mailing-list-addresses`
* Role `export-mailing-list-addresses`
* Realm Settings:
* User Profile:
* Attribute Groups:
* `dooris-ssh-keys`
* `mailing-list-addresses`
* Attributes:
* `mailing-list-address-chaos`
* Attribute Group `mailing-list-addresses`
* `mailing-list-address-intern`
* Attribute Group `mailing-list-intern`
* `ssh-key-1`
* Attribute Group `dooris-ssh-keys`
* `ssh-key-2`
* Attribute Group `dooris-ssh-keys`
* Custom Attributes:
* Slug `dooris-ssh-keys`
* Attribute Group `dooris-ssh-keys`
* Match Role `dooris-authorized`
* Auth Role `export-dooris-ssh-keys`
* Slug `mailing-list-addresses-chaos`
* Attribute Group `mailing-list-addresses`
* Match Role `mailing-list-chaos-member`
* Auth Role `export-mailing-list-addresses`
* Slug `mailing-list-addresses-intern`
* Attribute Group `mailing-list-addresses`
* Match Role `mailing-list-intern-member`
* Auth Role `export-mailing-list-addresses`

View file

@ -0,0 +1,20 @@
#!/bin/sh
#
# Use curl to run a test export of Dooris ssh keys
#
set -e
ACCESS_TOKEN="$(curl -s --request POST \
--url http://localhost:8080/realms/testing/protocol/openid-connect/token \
--header 'content-type: application/x-www-form-urlencoded' \
--data scope=openid \
--data client_id=export-dooris-ssh-keys \
--data client_secret=export-dooris-ssh-keys-secret \
--data grant_type=client_credentials | jq --raw-output .access_token -)"
curl -s --request GET \
--url http://localhost:8080/realms/testing/attribute-endpoints-provider/export/dooris-ssh-keys \
--header "authorization: Bearer ${ACCESS_TOKEN}" \
--header "content-type: application/json" | jq . -

View file

@ -470,7 +470,7 @@
"credentials" : [ ],
"disableableCredentialTypes" : [ ],
"requiredActions" : [ ],
"realmRoles" : [ "default-roles-testing" ],
"realmRoles" : [ "export-dooris-ssh-keys", "default-roles-testing" ],
"notBefore" : 0,
"groups" : [ ]
}, {
@ -484,7 +484,7 @@
"credentials" : [ ],
"disableableCredentialTypes" : [ ],
"requiredActions" : [ ],
"realmRoles" : [ "default-roles-testing" ],
"realmRoles" : [ "export-mailing-list-addresses", "default-roles-testing" ],
"notBefore" : 0,
"groups" : [ ]
}, {
@ -1478,7 +1478,7 @@
"subType" : "authenticated",
"subComponents" : { },
"config" : {
"allowed-protocol-mapper-types" : [ "saml-user-property-mapper", "saml-user-attribute-mapper", "oidc-usermodel-attribute-mapper", "oidc-address-mapper", "oidc-full-name-mapper", "saml-role-list-mapper", "oidc-sha256-pairwise-sub-mapper", "oidc-usermodel-property-mapper" ]
"allowed-protocol-mapper-types" : [ "oidc-sha256-pairwise-sub-mapper", "saml-user-attribute-mapper", "saml-user-property-mapper", "oidc-full-name-mapper", "saml-role-list-mapper", "oidc-address-mapper", "oidc-usermodel-attribute-mapper", "oidc-usermodel-property-mapper" ]
}
}, {
"id" : "a49de9bf-462b-4c61-bb52-0373732f4b1b",
@ -1538,7 +1538,7 @@
"subType" : "anonymous",
"subComponents" : { },
"config" : {
"allowed-protocol-mapper-types" : [ "oidc-sha256-pairwise-sub-mapper", "oidc-full-name-mapper", "oidc-address-mapper", "saml-role-list-mapper", "oidc-usermodel-attribute-mapper", "saml-user-property-mapper", "oidc-usermodel-property-mapper", "saml-user-attribute-mapper" ]
"allowed-protocol-mapper-types" : [ "saml-role-list-mapper", "oidc-address-mapper", "oidc-sha256-pairwise-sub-mapper", "oidc-usermodel-attribute-mapper", "oidc-full-name-mapper", "oidc-usermodel-property-mapper", "saml-user-property-mapper", "saml-user-attribute-mapper" ]
}
}, {
"id" : "dd4024e9-f080-4319-aeb7-7f9906c345c5",
@ -1625,8 +1625,8 @@
"subComponents" : { },
"config" : {
"match-role" : [ "mailing-list-chaos-member" ],
"attribute-group" : [ "mailing-list-addresses" ],
"auth-role" : [ "export-mailing-list-addresses" ],
"attribute-group" : [ "mailing-list-addresses" ],
"slug" : [ "mailing-list-addresses-chaos" ]
}
} ]