libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Merge pull request #79 from jenmalloy/RHSSO-942

Browse source 
fixed RHSSO-942
This commit is contained in:
Jen Malloy 2017-03-29 13:19:27 -04:00 committed by GitHub
commit 258ffca161
6 changed files with 82 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
server_development/topics/user-storage/cache.adoc
View file

@ -1,14 +1,14 @@
=== User Caches
When a user is loaded by id, username, or email queries it will be cached. When a user is cached, it iterates through
the entire `UserModel` interface and pulls this information to a local in-memory only cache. In a cluster, this cache
When a user is loaded by ID, username, or email queries it is cached. When a user is cached, it iterates through
the entire `UserModel` interface and pulls this information to a local in-memory-only cache. In a cluster, this cache
is still local, but it becomes an invalidation cache. When a user is modified, it is evicted. This eviction event
is propagated to the entire cluster so that other nodes' user cache is also invalidated.
is propagated to the entire cluster so that the other nodes' user cache is also invalidated.
==== Managing the user cache
You can get access to the user cache by calling `KeycloakSession.userCache()`.
You can access the user cache by calling `KeycloakSession.userCache()`.
[source,java]
----
@ -41,11 +41,11 @@ public interface UserCache extends UserProvider {
}
----
There are methods for evicting a specific users, users contained in a specific realm, or the entire cache.
There are methods for evicting specific users, users contained in a specific realm, or the entire cache.
==== OnUserCache Callback Interface
You may want to cache additional information that is specific to your provider implementation. The User Storage SPI
You might want to cache additional information that is specific to your provider implementation. The User Storage SPI
has a callback whenever a user is cached: `org.keycloak.models.cache.OnUserCache`.
[source,java]
@ -94,14 +94,10 @@ public interface CachedUserModel extends UserModel {
}
----
This `CachedUserModel` interface allows you to evict the user from cache and get the provider `UserModel` instance.
The most interesting method is `getCachedWith()`. This returns a map that allows you to cache additional information
pertaining to the user. For example, credentials are not part of the `UserModel` interface. If you wanted to cache
credentials in memory, you would implement `OnUserCache` and cache your user's credentials using the `getCachedWith()`
method.
This `CachedUserModel` interface allows you to evict the user from the cache and get the provider `UserModel` instance.
The `getCachedWith()` method returns a map that allows you to cache additional information pertaining to the user. For example, credentials are not part of the `UserModel` interface. If you wanted to cache credentials in memory, you would implement `OnUserCache` and cache your user's credentials using the `getCachedWith()` method.
==== Cache Policies
Each configured user storage provider can specify unique cache policies. Go to the admin console management page
for your provider to see how to do this.
On the administration console management page for your user storage provider, you can specify a unique cache policy for each configured user storage provider.

25
server_development/topics/user-storage/import.adoc
View file

@ -2,8 +2,8 @@
=== Import Implementation Strategy
When implementing a user storage provider, there's another strategy you can take. Instead of using user federated storage,
you can create a user locally in the {{book.project.name}} built in user database and copy attributes from your external
store into this local copy. There are a bunch of advantages to this approach.
you can create a user locally in the {{book.project.name}} built-in user database and copy attributes from your external
store into this local copy. There are many advantages to this approach.
* {{book.project.name}} basically becomes a persistence user cache for your external store. Once the user is imported
you'll no longer hit the external store thus taking load off of it.
@ -51,7 +51,7 @@ begin first by modifying the `createAdapter()` method.
In this method we call the `KeycloakSession.userLocalStorage()` method to obtain a reference to local {{book.project.name}}
user storage. We see if the user is stored locally, if not, we add it locally. Also note that we call
`UserModel.setFederationLink()` and pass in the id of the `ComponentModel` of our provider. This sets a link between
`UserModel.setFederationLink()` and pass in the ID of the `ComponentModel` of our provider. This sets a link between
the provider and the imported user.
NOTE: When a user storage provider is removed, any user imported by it will also be removed. This is one of the
@ -66,8 +66,8 @@ Also notice that we are proxying the local user using the `org.keycloak.models.u
This class is an implementation of `UserModel`. Every method just delegates to the `UserModel` it was instantiated with.
We override the `setUsername()` method of this delegate class to synchronize automatically with the property file.
For your providers, you can use this to _intercept_ other methods on the local `UserModel` to perform synchronization
with your extern store. For example, get methods could make sure that the local store is in sync. Set methods
keep external store in sync with local one.
with your external store. For example, get methods could make sure that the local store is in sync. Set methods
keep the external store in sync with the local one.
NOTE: If your provider is implementing the `UserRegistrationProvider` interface, your `removeUser()` method does not
need to remove the user from local storage. The runtime will automatically perform this operation. Also
@ -98,14 +98,14 @@ public interface ImportedUserValidation {
Whenever a linked local user is loaded, if the user storage provider class implements this interface, then the
`validate()` method is called. Here you can proxy the local user passed in as a parameter and return it. That
new `UserModel` will be used. You can also optionally do a check to see if the user exists still in the external store.
if `validate()` returns `null`, then the local user will be removed from the database.
new `UserModel` will be used. You can also optionally do a check to see if the user still exists in the external store.
If `validate()` returns `null`, then the local user will be removed from the database.
==== ImportSynchronization Interface
With the import strategy you can see that it would be possible for the local user copy could get out of sync with
With the import strategy you can see that it is possible for the local user copy to get out of sync with
external storage. For example, maybe a user has been removed from the external store. The User Storage SPI has
an additional interface you can implement to deal with this. `org.keycloak.storage.user.ImportSynchronization`.
an additional interface you can implement to deal with this, `org.keycloak.storage.user.ImportSynchronization`:
[source,java]
----
@ -117,8 +117,5 @@ public interface ImportSynchronization {
}
----
This interface is implemented by the provider factory. Once this interface is implemented by the provider factory,
the admin console management page for the provider will show additional options. There is a button that will allow
you to manually force a synchronization. This invokes the `ImportSynchronization.sync()` method. Also, some additional
configuration options will show up that allow you to automatically schedule a synchronization. Automatic syncs invoke
the `syncSince()` method.
This interface is implemented by the provider factory. Once this interface is implemented by the provider factory, the administration console management page for the provider shows additional options. You can manually force a synchronization by clicking a button. This invokes the `ImportSynchronization.sync()` method. Also, additional configuration options are displayed that allow you to automatically schedule a synchronization. Automatic synchronizations invoke the `syncSince()` method.

26
server_development/topics/user-storage/javaee.adoc
View file

@ -1,14 +1,14 @@
=== Leveraging Java EE
The user storage providers can be packaged within any Java EE component so long as you set up the `META-INF/services`
file correctly to point to your providers. For example, if your provider needs to use third party libraries, you
can package up your provider within an ear and store these third pary libraries in the ear's `lib/` directory.
Also note that provider jars can make use of the `jboss-deployment-structure.xml` file that EJBs, WARS, and EARs
can use in a JBoss/Wildfly environment. See the JBoss/Wildfly documentation for more details on this file. It
allows you to pull in external dependencies among other fine grain actions.
The user storage providers can be packaged within any Java EE component if you set up the `META-INF/services`
file correctly to point to your providers. For example, if your provider needs to use third-party libraries, you
can package up your provider within an EAR and store these third-party libraries in the `lib/` directory of the EAR.
Also note that provider JARs can make use of the `jboss-deployment-structure.xml` file that EJBs, WARS, and EARs
can use in a JBoss/Wildfly environment. For more details on this file, see the JBoss/Wildfly documentation. It
allows you to pull in external dependencies among other fine-grained actions.
Implementations of `UserStorageProviderFactory` are required to be plain java objects. But, we also currently support
Implementations of `UserStorageProviderFactory` are required to be plain java objects. But we also currently support
implementing `UserStorageProvider` classes as Stateful EJBs. This is especially useful if you want to use JPA
to connect to a relational store. This is how you would do it:
@ -47,11 +47,11 @@ public class EjbExampleUserStorageProvider implements UserStorageProvider,
}
----
You have to define the `@Local` annotation and specify your provider class there. If you don't do this, EJB will
You have to define the `@Local` annotation and specify your provider class there. If you do not do this, EJB will
not proxy the user correctly and your provider won't work.
You must put the `@Remove` annotation on the `close()` method of your provider. If you don't, the stateful bean
will never be cleaned up and you may eventually see error messages.
You must put the `@Remove` annotation on the `close()` method of your provider. If you do not, the stateful bean
will never be cleaned up and you might eventually see error messages.
Implementations of `UserStorageProviderFactory` are required to be plain java objects. Your factory class would
perform a JNDI lookup of the Stateful EJB in its create() method.
@ -76,12 +76,12 @@ public class EjbExampleUserStorageProviderFactory
}
----
This example also assumes that you've defined a JPA deployment in the same jar as the provider. This means a `persistence.xml`
This example also assumes that you have defined a JPA deployment in the same JAR as the provider. This means a `persistence.xml`
file as well as any JPA `@Entity` classes.
WARNING: When doing JPA any additional datasource you use must be an XA datasource. The {{book.project.name}} datasource
is non-xa. If you interact with two or more non-xa datasource in the same transaction, the server will barf with
an error message. You can only have one non-xa resource in a single transaction.
is non-xa. If you interact with two or more non-xa datasource in the same transaction, the server returns
an error message. Only one non-xa resource is permitted in a single transaction.
See the JBoss/Wildfly manual for more details on deploying an XA datasource.

8
server_development/topics/user-storage/migration.adoc
View file

@ -33,13 +33,9 @@ has capability interfaces that you can implement to support synchronization, but
==== UserFederationProvider vs. UserStorageProvider
The first thing to notice is that `UserFederationProvider` was a complete interface. You implemented every method
in this interface. However, `UserStorageProvider` has instead broken up this interface into multiple capability interfaces that
you implement as needed.
The first thing to notice is that `UserFederationProvider` was a complete interface. You implemented every method in this interface. However, `UserStorageProvider` has instead broken up this interface into multiple capability interfaces that you implement as needed.
`UserFederationProvider.getUserByUsername()` and `getUserByEmail()` have exact equivalents in the new SPI. The difference
between the two is how you import. If you are going to continue with an import strategy, you no longer call
`KeycloakSession.userStorage().addUser()' to create the user locally. Instead you call `KeycloakSession.userLocalStorage().addUser()`.
`UserFederationProvider.getUserByUsername()` and `getUserByEmail()` have exact equivalents in the new SPI. The difference between the two is how you import. If you are going to continue with an import strategy, you no longer call `KeycloakSession.userStorage().addUser()` to create the user locally. Instead you call `KeycloakSession.userLocalStorage().addUser()`.
The `userStorage()` method no longer exists.
The `UserFederationProvider.validateAndProxy()` method has been moved to an optional capability interface, `ImportedUserValidation`.

19
server_development/topics/user-storage/registration-query.adoc
View file

@ -2,7 +2,7 @@
=== Add/Remove User and Query Capability interfaces
One thing we have not done with our example is allow it to add and remove users or change passwords. Users defined in our example are
also not queryable or viewable in the admin console. To add these enhancements, our example provider must implement
also not queryable or viewable in the administration console. To add these enhancements, our example provider must implement
the `UserQueryProvider` and `UserRegistrationProvider` interfaces.
==== Implementing UserRegistrationProvider
@ -26,7 +26,7 @@ file to disk.
}
----
Then, the implementation of the `addUser()` and `removeUser()` methods becomes pretty simple.
Then, the implementation of the `addUser()` and `removeUser()` methods becomes simple.
.PropertyFileUserStorageProvider
[source,java]
@ -74,7 +74,7 @@ the next one.
}
----
Since we can now save our property file, probably also makes sense to allow password updates.
Since we can now save our property file, it also makes sense to allow password updates.
.PropertyFileUserStorageProvider
[source,java]
@ -120,11 +120,11 @@ We can now also implement disabling a password too.
}
----
With these methods implemented, you'll now be able to change and disable the password for the user in the admin console.
With these methods implemented, you'll now be able to change and disable the password for the user in the administration console.
==== Implementing UserQueryProvider
Without implementing `UserQueryProvider` the admin console would not be able to view and manage users that were loaded
Without implementing `UserQueryProvider` the administration console would not be able to view and manage users that were loaded
by our example provider. Let's look at implementing this interface.
.PropertyFileUserStorageProvider
@ -155,7 +155,7 @@ by our example provider. Let's look at implementing this interface.
}
----
The `getUser()` method simple iterates the key set of the property file delegating to `getuserByUsername` to load a user.
The `getUser()` method simple iterates over the key set of the property file delegating to `getuserByUsername` to load a user.
Notice that we are indexing this call based on the `firstResult` and `maxResults` parameter. If your external store
doesn't support pagination, you'll have to do similar logic.
@ -183,8 +183,8 @@ doesn't support pagination, you'll have to do similar logic.
}
----
The first declaration of `searchForUser()` takes a string paraeter. This is supposed to be a string that you use to
search username and email attributes to find the user. This string can be a substring which is why we use the `String.contains()`
The first declaration of `searchForUser()` takes a string parameter. This is supposed to be a string that you use to
search username and email attributes to find the user. This string can be a substring, which is why we use the `String.contains()`
method when doing our search.
.PropertyFileUserStorageProvider
@ -227,4 +227,5 @@ We only store usernames, so we only search based on usernames. We delegate to `
}
----
We don't store and groups or attributes, so the other methods just return an empty list.
We do not store groups or attributes, so the other methods return an empty list.

6
server_development/topics/user-storage/rest.adoc
View file

@ -1,7 +1,7 @@
=== REST Management API
You can create, remove, and update your user storage provider deployments through the admin REST api. The User Storage SPI
You can create, remove, and update your user storage provider deployments through the administrator REST API. The User Storage SPI
is built on top of a generic component interface so you will be using that generic API to manage your providers.
The REST Component API lives under your realm admin resource.
@ -10,8 +10,7 @@ The REST Component API lives under your realm admin resource.
/admin/realms/{realm-name}/components
----
We will only show this REST API interaction with the Java client. Hopefully you can extract how do do this from
curl from this api.
We will only show this REST API interaction with the Java client. Hopefully you can extract how to do this from curl from this API.
[source,java]
----
@ -100,3 +99,4 @@ realmResource.components().component(component.getId()).update(component);
realmREsource.components().component(component.getId()).remove();
----