Apache Roller
  1. Apache Roller
  2. ROL-1933

Crowd Login Authentication Roller Integration

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: 5.1
    • Component/s: None
    • Level of effort:
      Just add my work to an existing build.

      Description

      CROWD:
      1. First off how do we want to handle the demotion or elevation of permissions,groups rather. Say an admin goes to just an editor or an editor goes to admin, currently there will be no change on Roller.
      2. If user has permissions for the application but is not part of a group, currently it gives editor roles; does that work? If not we need to make a that change.
      3. Old users can continue to use thier Roller accounts, if the user is a user of the Roller application in Crowd they will authenticate through Crowd. This is as long as the two accounts have the same
      user name. Once authenticated through Crowd, Roller Authentication will not work. So if Crowd goes down and all users are in Crowd then no one will be able to enter the site. Recommendation is to have
      at least one admin user that doesn't have an account in Crowd, this way there will always be a way in.
      4. If the crowd.properties file is not on the classpath then we never use crowd to authenticate, however if you have users that were authenticated through crowd then they will not be able to login.
      5. If the user exists in Crowd and has permissions to access Roller and Roller doesn't contain this user account then a new user will be registered automatically; if no groups are setup then the user
      will have editor role, if the user is part of a group that contains the string "admin" or "ADMIN" then that user will be given Admin rights.
      6. Here is an example crowd.properties file, currently we get the file every time there is a need for it; so that resource will be continually accessed. If this is problem, which I can understand I can
      create a singleton that will hanlde the crowd.properties file and only load it once. This means if any changes are made to the file we have to restart the application.

      #required fields
      crowd.application.name=roller
      crowd.application.password=password
      crowd.port=8095
      crowd.host=localhost
      crowd.context=crowd
      #end required fields
      #this setting allows the use of https, defaults to false; not present we will use plain socket.
      crowd.useSecureConnection=false
      crowd.default.timezone=
      crowd.default.locale=

      You can add this file the same way you add the roller-custom.properties. TimeZone and Locale are not required, but standard format.
      7. These are the settings that need to be set in the roller-custom.properties to enable the use of Crowd Authentication:

      1. Crowd Auth, need these settings to be enabled
        users.sso.enabled=true
        users.sso.autoProvision.enabled=true

      If these are not set Crowd authentication will not work correctly. The AutoProvision is what makes this all work, the users from Crowd and not in Roller will be saved to Rollers db the first time the log in. The reason this is needed
      is so that permissions can be written for Roller. Will still need to add some code to ensure when users get promoted or demoted, those changes make it to the Roller DB.

      Please see attached files as they contain these changes and are in sync with Trunk, as of today. We can extend this functionality but here is working starting point.

      1. 2-security-xml.txt
        0.7 kB
        Nick Padilla
      2. 2-roller-properties.txt
        1.0 kB
        Nick Padilla
      3. 2-pom.xml
        1 kB
        Nick Padilla
      4. 2-CrowdRollerUserDetails.java
        4 kB
        Nick Padilla
      5. 2-CrowdAuthenticationProvider.java
        10 kB
        Nick Padilla
      6. 2-BasicUserAutoProvision.txt
        2 kB
        Nick Padilla
      7. pox-xml.txt
        1 kB
        Nick Padilla
      8. security-xml.txt
        0.7 kB
        Nick Padilla
      9. CrowdRollerUserDetails.java
        4 kB
        Nick Padilla
      10. CrowdAuthenticationProvider.java
        11 kB
        Nick Padilla
      11. crowd.properties
        0.3 kB
        Nick Padilla
      12. BasicUserAutoProvision.txt
        2 kB
        Nick Padilla

        Activity

        Hide
        Nick Padilla added a comment -

        Files to enable functionality - remember to add your crowd.properties to the classpath!

        Show
        Nick Padilla added a comment - Files to enable functionality - remember to add your crowd.properties to the classpath!
        Hide
        Nick Padilla added a comment -

        Sorry for the delay on getting this out here, if anyone has any questions please let me know.

        Show
        Nick Padilla added a comment - Sorry for the delay on getting this out here, if anyone has any questions please let me know.
        Hide
        Nick Padilla added a comment -

        Sorry forgot to add the pom.xml! Again, hope i got the diff files right!

        Show
        Nick Padilla added a comment - Sorry forgot to add the pom.xml! Again, hope i got the diff files right!
        Hide
        Nick Padilla added a comment -

        Any idea when this new feature will be added to roller? Just wanted to check in.

        Show
        Nick Padilla added a comment - Any idea when this new feature will be added to roller? Just wanted to check in.
        Hide
        Dave Johnson (Inactive) added a comment -

        Nick, thanks so much for this work. I plan to take a look at it this week and if it doesn't break things I will add it in.

        It appears that you already have an ICLA on file with Apache as a Nicolas Padilla is listed here http://people.apache.org/committer-index.html, can you confirm that's you on the list?

        Show
        Dave Johnson (Inactive) added a comment - Nick, thanks so much for this work. I plan to take a look at it this week and if it doesn't break things I will add it in. It appears that you already have an ICLA on file with Apache as a Nicolas Padilla is listed here http://people.apache.org/committer-index.html , can you confirm that's you on the list?
        Hide
        Dave Johnson (Inactive) added a comment -

        This looks pretty good, code-wise, but I would like to see a couple of changes before I introduce it into the Roller code-base:

        1) There are a couple of e.printStackTrace() statements that should be replaced with log.debug() or log.error() depending on what is appropriate.

        2) Instead of introducing a new properties file, the Crowd properties should be added into roller.properties and the normal Roller properties classes should be used to access them.

        Show
        Dave Johnson (Inactive) added a comment - This looks pretty good, code-wise, but I would like to see a couple of changes before I introduce it into the Roller code-base: 1) There are a couple of e.printStackTrace() statements that should be replaced with log.debug() or log.error() depending on what is appropriate. 2) Instead of introducing a new properties file, the Crowd properties should be added into roller.properties and the normal Roller properties classes should be used to access them.
        Hide
        Nick Padilla added a comment -

        Hey Dave!

        Sorry, been really busy and haven't had a chance to look at this until today. Yes, that is me in the Unlisted section, always wanted to contribute to the open source community. I will get these changes done and get you some diff files. I would like to take a look at the new changes, but have been super busy the last few months. Once these changes are in and I can have some ammo for upgrading and giving the new changes a try.

        Thanks for your time!

        Show
        Nick Padilla added a comment - Hey Dave! Sorry, been really busy and haven't had a chance to look at this until today. Yes, that is me in the Unlisted section, always wanted to contribute to the open source community. I will get these changes done and get you some diff files. I would like to take a look at the new changes, but have been super busy the last few months. Once these changes are in and I can have some ammo for upgrading and giving the new changes a try. Thanks for your time!
        Hide
        Nick Padilla added a comment -

        Here are the changed files, did a bit of code clean up and initialized the crowdClient in the class constructor - we will now use a cached object instead to save that bit of overhead from creating it every time. Not sure why I didn't do that in the first place. This version should perform better due to this optimization. It is a much cleaner class now. Also, I upgraded the Crowd Client to the latest build. Ran the build and everything passed, of course. I did need to add slf4j because of the upgraded crowd client.

        I did run these changes through a test in eclipse and standalone tomcat. All is well!

        Show
        Nick Padilla added a comment - Here are the changed files, did a bit of code clean up and initialized the crowdClient in the class constructor - we will now use a cached object instead to save that bit of overhead from creating it every time. Not sure why I didn't do that in the first place. This version should perform better due to this optimization. It is a much cleaner class now. Also, I upgraded the Crowd Client to the latest build. Ran the build and everything passed, of course. I did need to add slf4j because of the upgraded crowd client. I did run these changes through a test in eclipse and standalone tomcat. All is well!
        Hide
        Dave Johnson (Inactive) added a comment -

        Thanks for the patch Nick!

        Committed with this SVN rev:
        http://svn.apache.org/viewvc?view=revision&revision=1243258

        Show
        Dave Johnson (Inactive) added a comment - Thanks for the patch Nick! Committed with this SVN rev: http://svn.apache.org/viewvc?view=revision&revision=1243258
        Hide
        Nick Padilla added a comment -

        No problems! Thanks for getting it in so quickly! Which version will this make it in? 5.1.1 or 5.2.0?

        Thanks again for everything!

        Show
        Nick Padilla added a comment - No problems! Thanks for getting it in so quickly! Which version will this make it in? 5.1.1 or 5.2.0? Thanks again for everything!
        Hide
        Dave Johnson (Inactive) added a comment -

        Our last release was Roller 5.0 and I suspect that our next release will be 5.1, but I'm not sure we have consensus on release time-frame.

        Show
        Dave Johnson (Inactive) added a comment - Our last release was Roller 5.0 and I suspect that our next release will be 5.1, but I'm not sure we have consensus on release time-frame.
        Hide
        Nick Padilla added a comment -

        Thanks for the update! Sounds good, I'll be on the watch for 5.1!

        Show
        Nick Padilla added a comment - Thanks for the update! Sounds good, I'll be on the watch for 5.1!
        Hide
        Tiger Gui added a comment -

        If possible, i want to improve and complete mobile template things this summer, and Roller can have available useful mobile device template in 5.1 release

        Show
        Tiger Gui added a comment - If possible, i want to improve and complete mobile template things this summer, and Roller can have available useful mobile device template in 5.1 release
        Show
        Glen Mazza added a comment - - edited Snapshot containing Crowd classes (2 of them): http://svn.apache.org/viewvc/roller/trunk/app/src/main/java/org/apache/roller/weblogger/ui/core/security/?pathrev=1505192 With additional bean added in security.xml: http://svn.apache.org/viewvc/roller/trunk/app/src/main/webapp/WEB-INF/security.xml?r1=1160051&r2=1243258&pathrev=1505192&diff_format=h Additional settings needed in roller.properties file: http://svn.apache.org/viewvc/roller/trunk/app/src/main/resources/org/apache/roller/weblogger/config/roller.properties?r1=1242523&r2=1243258&pathrev=1505192 POM dependencies needed to add: http://svn.apache.org/viewvc/roller/trunk/app/pom.xml?r1=1510846&r2=1511052&diff_format=h
        Hide
        Glen Mazza added a comment -

        Reverting change.

        Show
        Glen Mazza added a comment - Reverting change.
        Hide
        Glen Mazza added a comment -

        Hi Nick, thanks for your contribution, however, out of fear of the library falling out-of-date (it's at 2.4 while 2.7 is soon shipping), need to bring in an additional non-Central repository to Roller to obtain the Crowd JARs, and the non-open source nature of the JARs (proprietary code, no source code available), we've decided to pull this functionality outside of Roller. Email here: http://markmail.org/message/tyxrhzclkycovd4p.

        If you wish to put these two classes in GitHub, or make a blog entry of them, and explain how to hack Roller so that those wanting this functionality (and having the proper Crowd license) can incorporate it into Roller, that would be great, and we can link to it from the Roller Wiki. (I just added in a previous comment the code changes needed in case you don't have the time.) Also, we're open to patches that facilitate such plugins generically so long as we don't need to include non-open source JARs within the distribution or need to add non-Central repos to the Roller pom.

        Show
        Glen Mazza added a comment - Hi Nick, thanks for your contribution, however, out of fear of the library falling out-of-date (it's at 2.4 while 2.7 is soon shipping), need to bring in an additional non-Central repository to Roller to obtain the Crowd JARs, and the non-open source nature of the JARs (proprietary code, no source code available), we've decided to pull this functionality outside of Roller. Email here: http://markmail.org/message/tyxrhzclkycovd4p . If you wish to put these two classes in GitHub, or make a blog entry of them, and explain how to hack Roller so that those wanting this functionality (and having the proper Crowd license) can incorporate it into Roller, that would be great, and we can link to it from the Roller Wiki. (I just added in a previous comment the code changes needed in case you don't have the time.) Also, we're open to patches that facilitate such plugins generically so long as we don't need to include non-open source JARs within the distribution or need to add non-Central repos to the Roller pom.
        Hide
        Glen Mazza added a comment -

        See last comment.

        Show
        Glen Mazza added a comment - See last comment.

          People

          • Assignee:
            Glen Mazza
            Reporter:
            Nick Padilla
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 1h
              1h
              Remaining:
              Remaining Estimate - 1h
              1h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Development