[keycloak-dev] Add custom REST paths? New SPI?

Tue Dec 8 15:36:33 EST 2015

Hi Erik,

Sounds like Pedro’s code will help us to do what we need to do. I am currently updating a fork of Keycloak to investigate our needs and have simply added the endpoints to the existing code while we search for a longer-term solution. This one sounds perfect!

> On 9 Dec 2015, at 3:00 AM, Erik Mulder <erik.mulder at docdatapayments.com> wrote:
> 
> Alright, I understand the wish to bring everything under a realm context. In fact, our extension indeed is also tied to the realm scope. It was implicit, but now I made it explicit, so it better fits mapping the REST paths under a realm. To prevent passing around a realm instance everywhere (besides the KeycloakSession), I use session.getContext().getRealm(). That will be filled whenever you are working ‘under’ a  …/realms/{realm}/…  path. Or is there a risk in this usage?
>  
> I did use Pedro’s code to be able to map URL’s like ‘/auth/realms/{realm}/xxxx‘ and ‘/auth/admin/realms/{realm}/xxxx’. That works fine, so it might be an option for you Greg, so you don’t have to modify the Keycloak sources directly. Or how did you solve that mapping at the moment?
>  
>  
> Van: Stian Thorgersen [mailto:sthorger at redhat.com] 
> Verzonden: dinsdag 8 december 2015 11:34
> Aan: Erik Mulder <erik.mulder at docdatapayments.com>
> CC: Greg Jones <gregj at thesoftwarecottage.com.au>; keycloak-dev at lists.jboss.org
> Onderwerp: Re: [keycloak-dev] Add custom REST paths? New SPI?
>  
> 'admin' will probably move at some point to be under the realm.
>  
> 'version' would move as well. Although this one should probably be removed altogether.
>  
> KeycloakSession and SPIs needs to be tied to a specific realm. This makes everything cleaner.
>  
> Besides it just doesn't make any sense to add arbitrary rest endpoints to Keycloak. A rest endpoint should be tied to a realm, otherwise it just doesn't make sense to host it on the Keycloak server.
>  
>  
>  
> On 8 December 2015 at 11:18, Erik Mulder <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>> wrote:
> Stian, I can see your point. Using the realm name as the root level certainly has advantages. It also really fixes everything to a realm, but I guess that is what you want. So how about the current ‘/admin’ url, how does that fit in the new picture? Because that would be my next best target to hook into. Furthermore, there’s currently a ‘/version’ root path that should end up somewhere else. Personally, I think it’s not so bad to have a descriptive root level like ‘realms’, which leaves open the possibility to add extra root level paths, like meta data (version) or special contexts (admin, customPath).
>  
>  
> Van: Stian Thorgersen [mailto:sthorger at redhat.com <mailto:sthorger at redhat.com>] 
> Verzonden: dinsdag 8 december 2015 10:32
> Aan: Greg Jones <gregj at thesoftwarecottage.com.au <mailto:gregj at thesoftwarecottage.com.au>>
> CC: Erik Mulder <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>>; keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> 
> Onderwerp: Re: [keycloak-dev] Add custom REST paths? New SPI?
>  
> -1 To adding rest endpoints to the root level. I'd like to get rid of 'realms' part as some point and have all rest endpoints sit underneath a realm. This makes sure the KeycloakSession always knows what realm is being handled, so we don't need to pass the realm around as it can be retrived from the KeycloakContext. It also means that the url can be shortened as we can drop the 'realms' part.
>  
> On 8 December 2015 at 10:22, Greg Jones <gregj at thesoftwarecottage.com.au <mailto:gregj at thesoftwarecottage.com.au>> wrote:
> +1 for these changes. We have been looking at a way to add custom REST endpoints and would be happy to use this approach.
> 
> Regards
> Greg Jones
> 
> 
> > On 8 Dec 2015, at 8:17 PM, Erik Mulder <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>> wrote:
> >
> > Pedro's change (see below) is kindof what I was looking for, but for my case and for general flexibility I think it's good to also have a more basic point to hook into the REST API's.
> > I implemented and tested my own suggestion of having an SPI to be able to add a REST resource at the root level. Combined with the (coming) ability to freely extend the JPA entities and DB schema, I think this creates a really powerful extensibility to Keycloak. When we finish these changes, I can write a blog post about what we did, why and how as a showcase for custom extensions to Keycloak.
> >
> > So are the Keycloak dev's open to a PR with a new SPI that enables you to add custom REST paths?
> > For example, you could create something like:
> > http://localhost:8080/auth/myPath/myResource <http://localhost:8080/auth/myPath/myResource>
> >
> >
> > -----Oorspronkelijk bericht-----
> > Van: Pedro Igor Silva [mailto:psilva at redhat.com <mailto:psilva at redhat.com>]
> > Verzonden: maandag 7 december 2015 22:18
> > Aan: Erik Mulder <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>>
> > Onderwerp: Re: [keycloak-dev] Add custom REST paths? New SPI?
> >
> > It is part of a working in progress around fine-grained authorization [1].
> >
> > The new SPI changes [2] specific to Keycloak are located in a specific branch [3] in my Keycloak fork.
> >
> > I need to discuss these changes with Bill and see what he thinks about it. Depending on his feedback, I can prepare a PR and send these changes to upstream.
> >
> > [1] https://github.com/pedroigor/keycloak-authz <https://github.com/pedroigor/keycloak-authz>
> > [2] https://github.com/pedroigor/keycloak/commit/5e99614aacb70f7840a5ae25cfeaf3fc9d74ac54 <https://github.com/pedroigor/keycloak/commit/5e99614aacb70f7840a5ae25cfeaf3fc9d74ac54>
> > [3] https://github.com/pedroigor/keycloak/tree/keycloak-authz-modified <https://github.com/pedroigor/keycloak/tree/keycloak-authz-modified>
> >
> > Regards.
> >
> > ----- Original Message -----
> > From: "Erik Mulder" <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>>
> > To: "Pedro Igor Silva" <psilva at redhat.com <mailto:psilva at redhat.com>>
> > Sent: Monday, December 7, 2015 5:51:26 PM
> > Subject: RE: [keycloak-dev] Add custom REST paths? New SPI?
> >
> > Great, that's probably all we need!
> > I'd like to try it out, but I cannot find any reference to what you mention on Github. Is it (going to be) a pull request? Is it going to be part of a future release?
> > Can you point me to / provide me with these changes so I can give it a spin? Thanks!
> >
> > ________________________________________
> > Van: Pedro Igor Silva [psilva at redhat.com <mailto:psilva at redhat.com>]
> > Verzonden: maandag 7 december 2015 16:03
> > Aan: Erik Mulder
> > CC: keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> > Onderwerp: Re: [keycloak-dev] Add custom REST paths? New SPI?
> >
> > I've done something at this regard, where you can use a SPI in order to plug additional APIs for:
> >
> >    * Realm Admin RESTFul API (eg.: used by admin console)
> >    * Realm RESFTFul API (eg.: to plug additional endpoints for realms)
> >
> > The two Provider interfaces are very simple and just provide a single method:
> >
> >    Object getResource(String pathName);
> >
> > Where pathName is the path that must be resolved to your custom JAX-RS resource.
> >
> > The factories are also very simple and allows you to build those resources for the current Realm and KeycloakSession. Eg.:
> >
> > RealmResourceProvider create(RealmModel realm, KeycloakSession keycloakSession);
> >
> > Do you need something other than that ?
> >
> > Regards.
> > Pedro Igor
> >
> > ----- Original Message -----
> > From: "Erik Mulder" <erik.mulder at docdatapayments.com <mailto:erik.mulder at docdatapayments.com>>
> > To: keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> > Sent: Monday, December 7, 2015 12:46:39 PM
> > Subject: [keycloak-dev] Add custom REST paths? New SPI?
> >
> > As some of you might know, our team is busy adding data to the keycloak system to incorporate some custom authorization information in the access token.
> > So far we've successfully extended the JPA entities, Liquibase table definitions and added a custom mapper to put that data in the access token. All of this without custom modifications to the original keycloak sources. This is working great, thanks for the support so far!
> > I know I've promised some PR's for this and they will come, but first we'd like to get everything fully working, so we know it's a well functioning whole.
> >
> > The last piece of the puzzle is extending the REST services to include CRUD actions for our custom resources. I've been looking into the way RESTEasy/JAX-RS works and it seems to me that in the current implementation there is no way to add extra paths. As I see it now, the KeycloakApplication class will register some singletons in it's constructor and that's that. No way to extend or to 'interfere' there.
> >
> > So my question is: is there any 'official' way to add extra REST paths to Keycloak?
> >
> > If not, is it an idea to add this as a new SPI? The current code for adding root paths in the KeycloakApplication constructor lists:
> >
> >        singletons.add(new ServerVersionResource());
> >        singletons.add(new RealmsResource());
> >        singletons.add(new AdminRoot());
> >
> > So just plain contructor calls. That seems like an easy target for 'SPI-ing' :-).
> > Or just leave the current ones 'hardcoded' and add an SPI for custom extensions.
> > Your thoughts on this please.
> >
> > As before, I'm happy to implement this myself, but I'd like to discuss it first, so a future PR will be honored.
> >
> >
> > _______________________________________________
> > keycloak-dev mailing list
> > keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> > https://lists.jboss.org/mailman/listinfo/keycloak-dev <https://lists.jboss.org/mailman/listinfo/keycloak-dev>
> >
> > _______________________________________________
> > keycloak-dev mailing list
> > keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> > https://lists.jboss.org/mailman/listinfo/keycloak-dev <https://lists.jboss.org/mailman/listinfo/keycloak-dev>
> 
> 
> _______________________________________________
> keycloak-dev mailing list
> keycloak-dev at lists.jboss.org <mailto:keycloak-dev at lists.jboss.org>
> https://lists.jboss.org/mailman/listinfo/keycloak-dev <https://lists.jboss.org/mailman/listinfo/keycloak-dev>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/keycloak-dev/attachments/20151209/8af6c7c3/attachment-0001.html 