OAuth2 Proxy

Component ID

2572153

Component name

OAuth2 Proxy

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Component created

Component changed

Component body

OAuth Proxy is a Module to make a secure OAuth2 connection with an endpoint but without you having to worry about how getting the tokens.

Targeted audience:
This module is targeted at Standalone Drupal site's with need for a OAuth2 connection to another site (this is a 'consumer' or 'client' side of an OAuth2 connection). It should not be used on a shared environment due to security implications see the security bulletin below and the READ ME.

Summary

Ever needed to request some data from an API that is secured with OAuth2?

Did you wish you had a simple way to request data from it, without all the difficulties that OAuth2 entails?

Or have you ever just wanted to check a request without jumping through all the OAuth2 'hoops'?

Well now we have the OAuth2 proxy module.
The OAuth2 Proxy can do all that for you. It does all that pesky OAuth 2 stuff and lets you fly on with a clearly defined local endpoint that simply proxies the request for you.
Ideally when you want to employ local caching like though a Redis or other technique that can cache the output returned so only new or stale data is requested over the line.

Requirements

This module has 2 sets of requirements.

  1. Operation.
    • cURL HTTP Request This is to ensure we have cUrl, which is a requirement for the library we use.
    • Composer Manager we use composer to manage the external libraries required, in this case the 'adoy/oauth2' library
    • php >= 5.4, this is also a requirement of the library to work properly.
  2. Environment.
    • A OAuth2 'server' or 'services'. (We need some place to connect too)
    • Something that connects to the service, this can be anything from a simple cUrl command to a cache backend all the way to a drupal module like restclient/wsdata

Information

This module is developed to work with the OAuth2 Server module running on a second Drupal site.
In theory it can work with any OAuth2 Provider.

Additional Security recommendations

Since this module essentially dilutes the security that OAuth2 provides it is important that anyone using this module improve there security through:

  • Using the Services API Key Authentication module can improve security and add the ability to do actions as a specific user.
  • This module adds some protection by default only allowing the Localhost to use it. When you add more locations to this list, it also increases the security risk. We recommend you consult an security expert before you change this setting.