Description
Extends the WP REST API using JSON Web Tokens Authentication as an authentication method.
JSON Web Tokens are an open, industry standard RFC 7519 method for representing claims securely between two parties.
Support and Requests please in Github: https://github.com/Tmeister/wp-api-jwt-auth
REQUIREMENTS
WP REST API V2
This plugin was conceived to extend the WP REST API V2 plugin features and, of course, was built on top of it.
So, to use the wp-api-jwt-auth you need to install and activate WP REST API.
PHP
Minimum PHP version: 7.4.0
PHP HTTP Authorization Header enable
Most of the shared hosting has disabled the HTTP Authorization Header by default.
To enable this option you’ll need to edit your .htaccess file adding the follow
RewriteEngine on
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
WPENGINE
To enable this option you’ll need to edit your .htaccess file adding the follow
See https://github.com/Tmeister/wp-api-jwt-auth/issues/1
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
CONFIGURATION
Configurate the Secret Key
The JWT needs a secret key to sign the token this secret key must be unique and never revealed.
To add the secret key edit your wp-config.php file and add a new constant called JWT_AUTH_SECRET_KEY
define('JWT_AUTH_SECRET_KEY', 'your-top-secret-key');
You can use a string from here https://api.wordpress.org/secret-key/1.1/salt/
Configurate CORs Support
The wp-api-jwt-auth plugin has the option to activate CORs support.
To enable the CORs Support edit your wp-config.php file and add a new constant called JWT_AUTH_CORS_ENABLE
define('JWT_AUTH_CORS_ENABLE', true);
Finally activate the plugin within your wp-admin.
Namespace and Endpoints
When the plugin is activated, a new namespace is added
/jwt-auth/v1
Also, two new endpoints are added to this namespace
Endpoint | HTTP Verb
/wp-json/jwt-auth/v1/token | POST
/wp-json/jwt-auth/v1/token/validate | POST
USAGE
/wp-json/jwt-auth/v1/token
This is the entry point for the JWT Authentication.
Validates the user credentials, username and password, and returns a token to use in a future request to the API if the authentication is correct or error if the authentication fails.
Sample request using AngularJS
( function() {
var app = angular.module( 'jwtAuth', [] );
app.controller( 'MainController', function( $scope, $http ) {
var apiHost = 'http://yourdomain.com/wp-json';
$http.post( apiHost + '/jwt-auth/v1/token', {
username: 'admin',
password: 'password'
} )
.then( function( response ) {
console.log( response.data )
} )
.catch( function( error ) {
console.error( 'Error', error.data[0] );
} );
} );
} )();
Success response from the server
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9qd3QuZGV2IiwiaWF0IjoxNDM4NTcxMDUwLCJuYmYiOjE0Mzg1NzEwNTAsImV4cCI6MTQzOTE3NTg1MCwiZGF0YSI6eyJ1c2VyIjp7ImlkIjoiMSJ9fX0.YNe6AyWW4B7ZwfFE5wJ0O6qQ8QFcYizimDmBy6hCH_8",
"user_display_name": "admin",
"user_email": "admin@localhost.dev",
"user_nicename": "admin"
}
Error response from the server
{
"code": "jwt_auth_failed",
"data": {
"status": 403
},
"message": "Invalid Credentials."
}
Once you get the token, you must store it somewhere in your application, ex. in a cookie or using localstorage.
From this point, you should pass this token to every API call
Sample call using the Authorization header using AngularJS
app.config( function( $httpProvider ) {
$httpProvider.interceptors.push( [ '$q', '$location', '$cookies', function( $q, $location, $cookies ) {
return {
'request': function( config ) {
config.headers = config.headers || {};
//Assume that you store the token in a cookie.
var globals = $cookies.getObject( 'globals' ) || {};
//If the cookie has the CurrentUser and the token
//add the Authorization header in each request
if ( globals.currentUser && globals.currentUser.token ) {
config.headers.Authorization = 'Bearer ' + globals.currentUser.token;
}
return config;
}
};
} ] );
} );
The wp-api-jwt-auth will intercept every call to the server and will look for the Authorization Header, if the Authorization header is present will try to decode the token and will set the user according with the data stored in it.
If the token is valid, the API call flow will continue as always.
Sample Headers
POST /resource HTTP/1.1
Host: server.example.com
Authorization: Bearer mF_s9.B5f-4.1JqM
ERRORS
If the token is invalid an error will be returned, here are some samples of errors.
Invalid Credentials
[
{
"code": "jwt_auth_failed",
"message": "Invalid Credentials.",
"data": {
"status": 403
}
}
]
Invalid Signature
[
{
"code": "jwt_auth_invalid_token",
"message": "Signature verification failed",
"data": {
"status": 403
}
}
]
Expired Token
[
{
"code": "jwt_auth_invalid_token",
"message": "Expired token",
"data": {
"status": 403
}
}
]
/wp-json/jwt-auth/v1/token/validate
This is a simple helper endpoint to validate a token; you only will need to make a POST request sending the Authorization header.
Valid Token Response
{
"code": "jwt_auth_valid_token",
"data": {
"status": 200
}
}
AVAILABLE HOOKS
The wp-api-jwt-auth is dev friendly and has five filters available to override the default settings.
jwt_auth_cors_allow_headers
The jwt_auth_cors_allow_headers allows you to modify the available headers when the CORs support is enabled.
Default Value:
'Access-Control-Allow-Headers, Content-Type, Authorization'
jwt_auth_not_before
The jwt_auth_not_before allows you to change the nbf value before the token is created.
Default Value:
Creation time - time()
jwt_auth_expire
The jwt_auth_expire allows you to change the value exp before the token is created.
Default Value:
time() + (DAY_IN_SECONDS * 7)
jwt_auth_token_before_sign
The jwt_auth_token_before_sign allows you to modify all the token data before to be encoded and signed.
Default Value
<?php
$token = array(
'iss' => get_bloginfo('url'),
'iat' => $issuedAt,
'nbf' => $notBefore,
'exp' => $expire,
'data' => array(
'user' => array(
'id' => $user->data->ID,
)
)
);
jwt_auth_token_before_dispatch
The jwt_auth_token_before_dispatch allows you to modify all the response array before to dispatch it to the client.
Default Value:
<?php
$data = array(
'token' => $token,
'user_email' => $user->data->user_email,
'user_nicename' => $user->data->user_nicename,
'user_display_name' => $user->data->display_name,
);
jwt_auth_algorithm
The jwt_auth_algorithm allows you to modify the signing algorithm.
Default value:
<?php
$token = JWT::encode(
apply_filters('jwt_auth_token_before_sign', $token, $user),
$secret_key,
apply_filters('jwt_auth_algorithm', 'HS256')
);
// ...
$token = JWT::decode(
$token,
new Key($secret_key, apply_filters('jwt_auth_algorithm', 'HS256'))
);
Testing
I’ve created a small app to test the basic functionality of the plugin; you can get the app and read all the details on the JWT-Client Repo
Installation
Using The WordPress Dashboard
- Navigate to the ‘Add New’ in the plugins dashboard
- Search for ‘jwt-authentication-for-wp-rest-api’
- Click ‘Install Now’
- Activate the plugin on the Plugin dashboard
Uploading in WordPress Dashboard
- Navigate to the ‘Add New’ in the plugins dashboard
- Navigate to the ‘Upload’ area
- Select
jwt-authentication-for-wp-rest-api.zip
from your computer - Click ‘Install Now’
- Activate the plugin in the Plugin dashboard
Please read how to configured the plugin https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/
Reviews
Contributors & Developers
“JWT Authentication for WP REST API” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “JWT Authentication for WP REST API” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.3.4
- Fix: Skip any type of validation when the authorization header is not Bearer.
- Feature: Added a setting page to share data and add information about the plugin.
1.3.3
- Update php-jwt to 6.4.0
- Fix php warnings (https://github.com/Tmeister/wp-api-jwt-auth/pull/259)
- Fix the condition where it checks if the request is a REST Request (https://github.com/Tmeister/wp-api-jwt-auth/pull/256)
1.3.2
- Fix conflicts with other plugins using the same JWT library adding a wrapper namespace to the JWT class.
1.3.1
- Updating the minimum version of PHP to 7.4
- Validate the signing algorithm against the supported algorithms @see https://www.rfc-editor.org/rfc/rfc7518#section-3
- Sanitize the REQUEST_URI and HTTP_AUTHORIZATION values before to use them
- Use get_header() instead of $_SERVER to get the Authorization header when possible
- Added typed properties to the JWT_Auth class where possible
- Along with this release, I release a new simple JWT Client App for testing purposes @see https://github.com/Tmeister/jwt-client
1.3.0
- Update firebase/php-jwt to 6.3
- Fix warning, register_rest_route was called incorrectly
- Allow for Basic Auth, by not attempting to validate Authentication Headers if a valid user has already been determined (see: https://github.com/Tmeister/wp-api-jwt-auth/issues/241)
- Added a new filter (jwt_auth_algorithm) to allow for customizing the algorithm used for signing the token
- Props: https://github.com/bradmkjr
1.2.6
- Cookies && Token compatibility
- Fix the root problem with gutenberg infinite loops and allow the token validation/generation if the WP cookie exists.
- More info (https://github.com/Tmeister/wp-api-jwt-auth/pull/138)
- Props: https://github.com/andrzejpiotrowski
1.2.5
- Add Gutenberg Compatibility
- More info (https://github.com/Tmeister/wp-api-jwt-auth/issues/126)
1.2.4
- Update firebase/php-jwt to v5.0.0 ( https://github.com/firebase/php-jwt )
- Add Requires PHP Tag
1.2.3
- Fix Max recursion error in WordPress 4.7 #44
1.2.2
- Add an extra validation to get the Authorization header
- Increase determine_current_user priority Fix #13
- Add the user object as parameter in the jwt_auth_token_before_sign hook
- Improve error message when auth fails #34
- Tested with 4.6.1
1.2.0
- Tested with 4.4.2
1.0.0
- Initial Release.