=== JWT Auth - WordPress JSON Web Token Authentication ===

Contributors: contactjavas
Donate link: https://www.paypal.me/bagusjavas
Tags: jwt, jwt-auth, token-authentication, json-web-token
Requires at least: 5.2
Tested up to: 5.8
Stable tag: trunk
Requires PHP: 7.2
License: GPLv3
License URI: https://oss.ninja/gpl-3.0?organization=Useful%20Team&project=WordPress%20JWT%20Auth

Create JSON Web Token Authentication in WordPress.

== Description ==
WordPress JSON Web Token Authentication allows you to do REST API authentication via token. It is a simple, non-complex, and easy to use. This plugin probably is the most convenient way to do JWT Authentication in WordPress. 

- Support & question: [WordPress support forum](https://wordpress.org/support/plugin/jwt-auth/)
- Reporting plugin's bug: [GitHub issues tracker](https://github.com/usefulteam/jwt-auth/issues)
- [Discord channel](https://discord.gg/DgECpEg) also available for faster response.

## Enable PHP HTTP Authorization Header

= Shared Hosts =

Most shared hosts have disabled the **HTTP Authorization Header** by default.

To enable this option you'll need to edit your **.htaccess** file by adding the following:

`
RewriteEngine on
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
`

= WPEngine =

To enable this option you'll need to edit your **.htaccess** file by adding the following (see [this issue](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 be 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 =

This plugin has the option to activate [CORs](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) 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);
`

## Namespace and Endpoints

When the plugin is activated, a new namespace is added.

`
/jwt-auth/v1
`

Also, two new *POST* endpoints are added to this namespace.

`
/wp-json/jwt-auth/v1/token
/wp-json/jwt-auth/v1/token/validate
`

## Requesting/ Generating Token

`
/wp-json/jwt-auth/v1/token
`

To generate token, submit a POST request to this endpoint. With `username` and `password` as the parameters.

It will validates the user credentials, and returns success response including a token if the authentication is correct or returns an error response if the authentication is failed.

= Sample of success response when trying to generate token: =

`
{
	"success": true,
	"statusCode": 200,
	"code": "jwt_auth_valid_credential",
	"message": "Credential is valid",
	"data": {
		"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvcG9pbnRzLmNvdXZlZS5jby5pZCIsImlhdCI6MTU4ODQ5OTE0OSwibmJmIjoxNTg4NDk5MTQ5LCJleHAiOjE1ODkxMDM5NDksImRhdGEiOnsidXNlciI6eyJpZCI6MX19fQ.w3pf5PslhviHohmiGF-JlPZV00XWE9c2MfvBK7Su9Fw",
		"id": 1,
		"email": "contactjavas@gmail.com",
		"nicename": "contactjavas",
		"firstName": "Bagus Javas",
		"lastName": "Heruyanto",
		"displayName": "contactjavas"
	}
}
`

= Sample of error response when trying to generate token: =

`
{
	"success": false,
	"statusCode": 403,
	"code": "invalid_username",
	"message": "Unknown username. Check again or try your email address.",
	"data": []
}
`

Once you get the token, you must store it somewhere in your application. It can be:
- using **cookie** 
- or using **localstorage** 
- or using a wrapper like [localForage](https://localforage.github.io/localForage/) or [PouchDB](https://pouchdb.com/)
- or using local database like SQLite or [Hive](https://docs.hivedb.dev/#/)
- or your choice based on app you develop ;)

Then you should pass this token as _Bearer Authentication_ header to every API call. The header format is:

`Authorization: Bearer your-generated-token`

and here's an example:

`
"Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvcG9pbnRzLmNvdXZlZS5jby5pZCIsImlhdCI6MTU4ODQ5OTE0OSwibmJmIjoxNTg4NDk5MTQ5LCJleHAiOjE1ODkxMDM5NDksImRhdGEiOnsidXNlciI6eyJpZCI6MX19fQ.w3pf5PslhviHohmiGF-JlPZV00XWE9c2MfvBK7Su9Fw";
`

The **jwt-auth** will intercept every call to the server and will look for the authorization header, if the authorization header is present, it 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.

## Whitelisting Endpoints

Every call to the server (except the token creation some default whitelist) will be intercepted. However, you might need to whitelist some endpoints. You can use `jwt_auth_whitelist` filter to do it. Please simply add this filter directly (without hook). Or, you can add it to `plugins_loaded`. Adding this filter inside `init` (or later) will not work. 

If you're adding the filter inside theme and the whitelisting doesn't work, please create a small 1 file plugin and add your filter there.

`
add_filter( 'jwt_auth_whitelist', function ( $endpoints ) {
	$your_endpoints = array(
		'/wp-json/custom/v1/webhook/*',
		'/wp-json/custom/v1/otp/*',
		'/wp-json/custom/v1/account/check',
		'/wp-json/custom/v1/register',
	);

	return array_unique( array_merge( $endpoints, $your_endpoints ) );
} );
`

## Default Whitelisted Endpoints

We whitelist some endpoints by default. This is to prevent error regarding WordPress & WooCommerce. These are the default whitelisted endpoints (without trailing *&#42;* char):

`
// Whitelist some endpoints by default (without trailing * char).
$default_whitelist = array(
	// WooCommerce namespace.
	$rest_api_slug . '/wc/',
	$rest_api_slug . '/wc-auth/',
	$rest_api_slug . '/wc-analytics/',

	// WordPress namespace.
	$rest_api_slug . '/wp/v2/',
);
`

You might want to **remove** or modify the existing **default whitelist**. You can use `jwt_auth_default_whitelist` filter to do it. Please simply add this filter directly (without hook). Or, you can add it to `plugins_loaded`. Adding this filter inside `init` (or later) will not work. 

If you're adding the filter inside theme and the it doesn't work, please create a small 1 file plugin and add your filter there. It should fix the issue.

`
add_filter( 'jwt_auth_default_whitelist', function ( $default_whitelist ) {
	// Modify the $default_whitelist here.
	return $default_whitelist;
} );
`

## Validating Token

You likely **don't need** to validate the token your self. The plugin handle it for you like explained above.

But if you want to test or validate the token manually, then send a **POST** request to this endpoint (don't forget to set your _Bearer Authorization_ header):

`
/wp-json/jwt-auth/v1/token/validate
`

= Valid Token Response: =

`
{
	"success": true,
	"statusCode": 200,
	"code": "jwt_auth_valid_token",
	"message": "Token is valid",
	"data": []
}
`

## Errors

If the token is invalid an error will be returned. Here are some samples of errors:

= No Secret Key =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_bad_config",
	"message": "JWT is not configured properly.",
	"data": []
}
`

= No HTTP_AUTHORIZATION Header =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_no_auth_header",
	"message": "Authorization header not found.",
	"data": []
}
`

= Bad Iss =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_bad_iss",
	"message": "The iss do not match with this server.",
	"data": []
}
`

= Invalid Signature =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_invalid_token",
	"message": "Signature verification failed",
	"data": []
}
`

= Bad Request =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_bad_request",
	"message": "User ID not found in the token.",
	"data": []
}
`

= User Not Found =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_user_not_found",
	"message": "User doesn't exist",
	"data": []
}
`

= Expired Token =

`
{
	"success": false,
	"statusCode": 403,
	"code": "jwt_auth_invalid_token",
	"message": "Expired token",
	"data": []
}
`

## Available Filter Hooks

**JWT Auth** is developer friendly and has some 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:

`
'X-Requested-With, Content-Type, Accept, Origin, Authorization'
`

Usage example:

`
/**
 * Change the allowed CORS headers.
 *
 * @param string $headers The allowed headers.
 * @return string The allowed headers.
 */
add_filter(
	'jwt_auth_cors_allow_headers',
	function ( $headers ) {
		// Modify the headers here.
		return $headers;
	}
);
`

= jwt_auth_iss =

The **jwt_auth_iss** allows you to change the [**iss**](https://tools.ietf.org/html/rfc7519#section-4.1.1) value before the payload is encoded to be a token.

Default Value:

`
get_bloginfo( 'url' )
`

Usage example:

`
/**
 * Change the token issuer.
 *
 * @param string $iss The token issuer.
 * @return string The token issuer.
 */
add_filter(
	'jwt_auth_iss',
	function ( $iss ) {
		// Modify the "iss" here.
		return $iss;
	}
);
`

= jwt_auth_not_before =

The `jwt_auth_not_before` allows you to change the [**nbf**](https://tools.ietf.org/html/rfc7519#section-4.1.5) value before the payload is encoded to be a token.

Default Value:

`
// Creation time.
time()
`

Usage example:

`
/**
 * Change the token's nbf value.
 *
 * @param int $not_before The default "nbf" value in timestamp.
 * @param int $issued_at The "iat" value in timestamp.
 *
 * @return int The "nbf" value.
 */
add_filter(
	'jwt_auth_not_before',
	function ( $not_before, $issued_at ) {
		// Modify the "not_before" here.
		return $not_before;
	},
	10,
	2
);
`

= jwt_auth_expire =

The `jwt_auth_expire` allows you to change the value [**exp**](https://tools.ietf.org/html/rfc7519#section-4.1.4) before the payload is encoded to be a token.

Default Value:

`
time() + (DAY_IN_SECONDS * 7)
`

Usage example:

`
/**
 * Change the token's expire value.
 *
 * @param int $expire The default "exp" value in timestamp.
 * @param int $issued_at The "iat" value in timestamp.
 *
 * @return int The "nbf" value.
 */
add_filter(
	'jwt_auth_expire',
	function ( $expire, $issued_at ) {
		// Modify the "expire" here.
		return $expire;
	},
	10,
	2
);
`

= jwt_auth_alg =

The `jwt_auth_alg` allows you to change the supported signing [algorithm](https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40) for your application.

Default Value:

`
'HS256'
`

Usage example:

`
/**
 * Change the token's signing algorithm.
 *
 * @param string $alg The default supported signing algorithm.
 * @return string The supported signing algorithm.
 */
add_filter(
	'jwt_auth_alg',
	function ( $alg ) {
		// Change the signing algorithm here.
		return $alg;
	}
);
`

= jwt_auth_payload =

The `jwt_auth_payload` allows you to modify all the payload / token data before being encoded and signed.

Default value:

`
<?php
$token = array(
    'iss' => get_bloginfo('url'),
    'iat' => $issued_at,
    'nbf' => $not_before,
    'exp' => $expire,
    'data' => array(
        'user' => array(
            'id' => $user->ID,
        )
    )
);
`

Usage example:

`
/**
 * Modify the payload/ token's data before being encoded & signed.
 *
 * @param array $payload The default payload
 * @param WP_User $user The authenticated user.
 * .
 * @return array The payload/ token's data.
 */
add_filter(
	'jwt_auth_payload',
	function ( $payload, $user ) {
		// Modify the payload here.
		return $payload;
	},
	10,
	2
);
`

= jwt_auth_valid_credential_response =

The `jwt_auth_valid_credential_response` allows you to modify the valid credential response when generating a token.

Default value:

`
<?php
$response = array(
    'success'    => true,
    'statusCode' => 200,
    'code'       => 'jwt_auth_valid_credential',
    'message'    => __( 'Credential is valid', 'jwt-auth' ),
    'data'       => array(
        'token'       => $token,
        'id'          => $user->ID,
        'email'       => $user->user_email,
        'nicename'    => $user->user_nicename,
        'firstName'   => $user->first_name,
        'lastName'    => $user->last_name,
        'displayName' => $user->display_name,
    ),
);
`

Usage example:

`
/**
 * Modify the response of valid credential.
 *
 * @param array $response The default valid credential response.
 * @param WP_User $user The authenticated user.
 * .
 * @return array The valid credential response.
 */
add_filter(
	'jwt_auth_valid_credential_response',
	function ( $response, $user ) {
		// Modify the response here.
		return $response;
	},
	10,
	2
);
`

### jwt_auth_valid_token_response

The **jwt_auth_valid_token_response** allows you to modify the valid token response when validating a token.

Default value:

`
<?php
$response = array(
	'success'    => true,
	'statusCode' => 200,
	'code'       => 'jwt_auth_valid_token',
	'message'    => __( 'Token is valid', 'jwt-auth' ),
	'data'       => array(),
);
`

Usage example:

`
/**
 * Modify the response of valid token.
 *
 * @param array $response The default valid token response.
 * @param WP_User $user The authenticated user.
 * @param string $token The raw token.
 * @param array $payload The token data.
 * .
 * @return array The valid token response.
 */
add_filter(
	'jwt_auth_valid_token_response',
	function ( $response, $user, $token, $payload ) {
		// Modify the response here.
		return $response;
	},
	10,
	4
);
`

### jwt_auth_extra_token_check

The **jwt_auth_extra_token_check** allows you to add extra criterias to validate the token. If empty, has no problem to proceed. Use empty value to bypass the filter. Any other value will block the token access and returns response with code `jwt_auth_obsolete_token`.

Default value:

`
''
`

Usage example:

`
/**
 * Modify the validation of token. No-empty values block token validation.
 *
 * @param array $response An empty value ''.
 * @param WP_User $user The authenticated user.
 * @param string $token The raw token.
 * @param array $payload The token data.
 * .
 * @return array The valid token response.
 */
add_filter(
	'jwt_auth_extra_token_check',
	function ( $response, $user, $token, $payload ) {
		// Modify the response here.
		return $response;
	},
	10,
	4
);
`

## Credits
[PHP-JWT from firebase](https://github.com/firebase/php-jwt)
[JWT Authentication for WP REST API](https://wordpress.org/plugins/jwt-authentication-for-wp-rest-api/)
[Devices utility by pesseba](https://github.com/pesseba)

== Installation ==

**Enable PHP HTTP Authorization Header**

= Shared Hosts =

Most shared hosts have disabled the **HTTP Authorization Header** by default.

To enable this option you'll need to edit your **.htaccess** file by adding the following:

`
RewriteEngine on
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1]
`

= WPEngine =

To enable this option you'll need to edit your **.htaccess** file by adding the following (see [this issue](https://github.com/Tmeister/wp-api-jwt-auth/issues/1)):

`
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
`

= Installing Through the WordPress Administrative Area: =
- From WordPress administrative area, go to Plugins -> Add New
- Search for _JWT Auth_
- Install it
- Easily configure it (see "Configuration" below)
- and then activate it

= Installing by Downloading Manually: =
- Download the plugin from [WordPress plugins page](https://wordpress.org/plugins/jwt-auth/)
- Upload to your wp-content directory
- Easily configure it (see "Configuration" below)
- Activate it from _Plugins_ menu in admin area

**Configuration**

= Configurate the Secret Key =

The JWT needs a **secret key** to sign the token. It must be unique and never be 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 =

This plugin has the option to enable [CORs](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) 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 the plugin dashboard.

== Frequently Asked Questions ==
= Now almost all REST routes are intercepted. How to exclude some routes/ endpoints? =

There's `jwt_auth_whitelist` that you can use to whitelist specific endpoints. For more information, pease read **Whitelisting Endpoints** section in the Description tab.

= Do you have GitHub repository for this plugin? =

You can visit the GitHub repository [here](https://github.com/usefulteam/jwt-auth/)

= I use this plugin on my projects. I want this plugin to keep alive and maintained, how can i help? =

You can help this plugin stay alive and maintained by giving **5 Stars** Rating/ Review or donating me via:
- [PayPal](https://paypal.me/bagusjavas)
- [Patreon](https://www.patreon.com/bagus)

== Screenshots ==
1. Success response when trying to generate token
2. Error response when trying to generate token
3. Other error responses

== Changelog ==
= 2.0.0 =
- Breaking change: rename `jwt_auth_valid_token_extra` filter to `jwt_auth_extra_token_check`. Please check if you use this filter.
- Breaking bugfix: the actual http statusCode didn't follow the response statusCode. Now the actual http statusCode follows the response statusCode.
- New feature: connected device. Thanks @pesseba.
- Might be a breaking change: Add WordPress & WC default endpoints to `jwt_auth_default_whitelist` to prevent error when visiting WordPress admin area.
- Documentation: prevent misleading example by updating the `jwt_auth_whitelist` usage.

= 1.4.2 =
- Bugfix: add `permission_callback` argument since it's required in WP 5.5

= 1.4.1 =
- Bugfix: the previous `/wp-json/wp/v2/*` whitelisting didn't work. It should be `/wp-json/wp/v2/` (without the star char).

= 1.4.0 =
- Whitelist `/wp-json/wp/v2/*` by default. This will prevent the plugin from breaking the default WordPress administration (gutenberg, etc).
- Bugfix: fix the problem with WordPress subdir installation. [See issue](https://github.com/usefulteam/jwt-auth/issues/2).

= 1.3.0 =
- **Filter Change**: `jwt_auth_valid_token_response` should only filter the $response array instead of the whole `WP_REST_Response`. Please check if you use this filter :)
- README update about `jwt_auth_whitelist` filter usage. That filter should be added directly (without hook) OR inside `plugins_loaded`. Adding it to `init` (or after that) will not work.

= 1.2.0 =
- **Critical Bugfix**: WooCommerce admin breaks. With this change, WooCommerce admin should be good.
- New Filter: We whitelist some endpoints by default to support common plugin like WooCommerce. These default whitelisted endpoints are change-able via `jwt_auth_default_whitelist` filter.

= 1.1.0 =
- Support WooCommerce by ignoring `/wp-json/wc/` and `/wp-json/wc-auth/` namespace. You can use `jwt_auth_whitelist` filter if you want to whiteist other endpoints. See **Whitelisting Endpoints** section in the description tab.

= 1.0.0 =
- **Filter Change**: Rename `jwt_auth_token_payload` filter to `jwt_auth_payload`
- **Filter Change**: Rename `jwt_auth_token_response` filter to `jwt_auth_valid_credential_response`
- **Critical Bugfix**: The auth only restricted wp-json/jwt-auth/v1/* endpoints. So endpoints under other namespace were not restricted. With this change, other endpoints are restricted now. If you need to whitelist some endpoints, please read about **Whitelisting Endpoints** section in the description tab.
- New Filter: `jwt_auth_valid_token_response`
- New Filter: Make possible to whitelist specific endpoints via `jwt_auth_whitelist` filter.
- New Filter: Make possible to change the token issuer by providing `jwt_auth_iss` filter.
- New Filter: Make possible to change the supported algorithm by providing `jwt_auth_alg` filter.
- New Filter: Make possible to change the valid token response by providing `jwt_auth_valid_token_response` filter.
- Add support for site with disabled permalink.

= 0.1.3 =
- Add `jwt_auth_do_custom_auth` filter so that developer can use custom authentication like OTP authentication or any other.

= 0.1.2 =
- Working version.

== Upgrade Notice ==
Just update the plugin
