https://github.com/joshcanhelp/wp-rest-api-auth0

Authorize WP REST API calls with access tokens from Auth0
https://github.com/joshcanhelp/wp-rest-api-auth0

Last synced: 3 months ago
JSON representation

Authorize WP REST API calls with access tokens from Auth0

• Host: GitHub
• URL: https://github.com/joshcanhelp/wp-rest-api-auth0
• Owner: joshcanhelp
• License: mit
• Created: 2020-12-24T18:07:47.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T05:32:10.000Z (about 1 year ago)
• Last Synced: 2024-10-01T02:23:51.991Z (3 months ago)
• Language: PHP
• Size: 40 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Protect your WordPress REST API with Auth0

[![License](https://poser.pugx.org/joshcanhelp/wp-rest-api-auth0/license)](https://packagist.org/packages/joshcanhelp/wp-rest-api-auth0)

[![Total Downloads](https://poser.pugx.org/joshcanhelp/wp-rest-api-auth0/downloads)](https://packagist.org/packages/joshcanhelp/wp-rest-api-auth0)

This repo contains a working MU plugin that will receive and validate access tokens obtained from Auth0. For information on how this works and the values used within please see the post here:

**[Protect your WordPress REST API with OAuth2 using Auth0](https://www.joshcanhelp.com/protect-wordpress-rest-api-with-oauth2-auth0/)**

## Installation 

First, install the [Login by Auth0 plugin](https://wordpress.org/plugins/auth0/), then add your Auth0 credentials to `wp-config.php`, a file in `wp-content/mu-plugins`, or another location that will get loaded before this plugin.

```php

// Auth0 credentials

define( 'AUTH0_API_AUDIENCE', 'API identifier for the WP REST API' );

define( 'AUTH0_API_SIGNING_SECRET', 'API signing secret from Auth0' );

define( 'AUTH0_API_DEBUG', 'Set to `true` to add debugging log entries' );

```

### Install with Composer

Install this package:

```bash

composer require joshcanhelp/wp-rest-api-auth0

```

Require the Composer autoloader at some point when `add_action` is available, like in `wp-content/mu-plugins`. 

### Install manually

To install this manually without Composer, just download the [latest release ZIP](https://github.com/joshcanhelp/wp-rest-api-auth0/releases) and upload through the admin interface. Please note that this plugin will not update automatically; updates will need to be made by deleting and re-adding (make sure your site is in maintenance mode) or directly via an FTP client (not recommended).

### Testing with Docker

You can get this running to test it out locally with Docker using [this Gist](https://gist.github.com/joshcanhelp/0e35b657ca03142e3d79595c28bb3ed7).

## Troubleshooting

Try setting `AUTH0_API_DEBUG` to `true` and watching your WP error log for information on failures.

If API requests aren't working, Apache might not be passing authorization headers to PHP. Try adding this line (or similar methods) to `.htaccess`:

```

SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0

```

Also, make sure your WP API endpoint doesn't follow this pattern, where `/index.php/` is required before `/wp-json/`:

```

Example:

https:///index.php/wp-json/

```

See [this solution](http://dejanjanosevic.info/remove-index-php-permalink-in-wordpress/) to help resolve this index.php issue.