https://github.com/bestpractical/rt-authen-oauth2

https://github.com/bestpractical/rt-authen-oauth2

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/bestpractical/rt-authen-oauth2
• Owner: bestpractical
• License: gpl-2.0
• Created: 2016-12-16T17:34:19.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T22:08:08.000Z (4 months ago)
• Last Synced: 2024-08-12T23:14:41.264Z (4 months ago)
• Language: Perl
• Homepage: http://metacpan.org/release/rt-authen-oauth2
• Size: 74.2 KB
• Stars: 7
• Watchers: 19
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
NAME

    RT-Authen-OAuth2 - External authentication for OAuth 2 sources, like

    Google, Twitter, GitHub, etc.

DESCRIPTION

    External authentication for OAuth2 sources.

RT VERSION

    Works with RT 4.4 and 5

DEPENDENCIES

    Requires Net::OAuth2::Profile::WebServer

INSTALLATION

    perl Makefile.PL

    make

    make install

        May need root permissions

    Edit your /opt/rt4/etc/RT_SiteConfig.pm

        Add this line:

            Plugin('RT::Authen::OAuth2');

    Add / Edit OAuth2 configs found in OAuth2_Config.pm

    Clear your mason cache

            rm -rf /opt/rt4/var/mason_data/obj

    Restart your webserver

AUTHOR

    Best Practical Solutions, LLC 

BUGS

    All bugs should be reported via email to

        L

    or via the web at

        L.

LICENSE AND COPYRIGHT

    This software is Copyright (c) 2016-2024 by Best Practical Solutions LLC

    This is free software, licensed under:

      The GNU General Public License, Version 2, June 1991

METHODS

  RequestAuthorization()

        Creates an Authorization Request on behalf of the Resource Owner

        (user), and initiates the OAuth 2 protocol with the Authorization

        Server. The browser will redirect to the $OAuthRedirect endpoint

        specified in the config.

  LogUserIn()

        Called from the $OAuthRedirect endpoint handler element. Validates

        the user exists and is allowed to log in, auto-populates user

        metadata returned from the OAuth 2 server, and sets up a session. If

        successful, returns to the handler template element to redirect to

        the final destination.

  IDPLoginButtonImage()

        Returns the appropriate login button image for the active OAuth 2

        server. This is displayed on the RT login page.

  LogOutURL()

        Returns the appropriate logout URL active OAuth 2 server.