ALMEFY vs API Bearer Auth

The Almefy Plugin enables secure 2FA login for your users – without passwords, just by scanning a QR code.​ Welcome to the ALMEFY experience Almefy enables a secure Two-Factor Authentication user experience in one step. No passwords needed, the users just scan to login. Your users just need to scan a QR code on your website with the Almefy App and login through our technology built on Identity Based Encryption (IBE). Almefy is the next generation of logins, taking the burden of secure passwords away from the users by eliminating them completely. We enable a secure, easy and fast Two-Factor Authentication in one step for the convenience of your users. Learn more about the Identity Based Encryption and 2FA and Almefy on our website. The ALMEFY HUB – Where you manage all accesses We offer an easy to manage setup and management of accesses through our ALMEFY HUB. The HUB gives you the possibility to setup new websites, manage admins and users and offers statistics for your reference. It is also the fastest way to get in touch with us in case you have any questions or need support! And here is how you get started with your ALMEFY Plugin: Setup To activate the plugin, please navigate to the Almefy settings in the backend. You will be required to provide a key and a secret to connect to the Almefy servers. To generate your individual key & secret, please contact us at https://almefy.com/contact/. We will send you an email with all instructions how to get access to the ALMEFY HUB where you generate your key & secret in a guided flow through our setup wizard. In the settings of the plugin you can also define a Redirect to after login url. Use a relative url like /profile-page to redirect users to a custom page. Alternatively leave the page blank to redirect users to the WordPress backend. Login To add the login code to your website add the [almefy-login] shortcode to your page. Alternatively you may add it via do_shortcode('[almefy-login]'); to your theme. If you would like to redirect users to the backend when logging in via the WordPress login at /wp-login.php but to a profile page when logging in via the the frontend you have to: – Leave the Redirect to after login empty in the plugin settings – Set the ‘redirect’ variable on the shortcode Example: [almefy-login redirect="/profile"] Device Management The built in device manager is found in the backend Users -> Profile. If you do not want your users to have access to the WordPress backend but let them manage their devices, add the [almefy-devices] shortcode to a custom profile page. Connecting new devices When creating an account, users will receive an email asking them to connect their device. Further devices may be connected in the backend Users -> Profile. To add management options like connecting and removing devices to the frontend of your website, you may include the device connection shortcode to a profile page using [almefy-connect]. Password-free Registration (Optional) You may add password free registration by adding the [almefy-register] shortcode. Disabling require_username will result in users just being prompted for an email address. The button text is customizable by setting the button_text variable. Example: [almefy-register require_username="false" button_text="Sign Up Now!"]; License GNU General Public License v2.0 – GNU Project – Free Software Foundation https://www.gnu.org Contact – Almefy : 2FA Authentication in one step https://almefy.com

The API Bearer Auth plugin enables authentication for the REST API by using JWT access an refresh tokens. After the user logs in, the access and refresh tokens are returned and can be used for the next requests. Issued tokens can be revoked from within the users admin screen. See below for the endpoints. Note that after activating this plugin, all REST API endpoints will need to be authenticated, unless the endpoint is whitelisted in the api_bearer_auth_unauthenticated_urls filter (see FAQ for how to use this filter). JWT Access tokens can be formatted as JWT tokens. For this to work, you first have to create a secret and add it to the wp-config.php file. If you don’t do this, access tokens will work also, but are just random strings. To create a random secret key, you can do for example: base64_encode(openssl_random_pseudo_bytes(64)); And then add the result to wp-config: define('API_BEARER_JWT_SECRET', 'mysecretkey'); If you have problems, you can verify your JWT tokens at: https://jwt.io/ Revoke tokens This plugin adds a column to the users table in de admin where you can see when a token expires. You can also revoke tokens by selection the “Revoke API tokens” from the bulk actions select box. API endpoints Note that all endpoints expect JSON in the POST body. Login Endpoint: POST /api-bearer-auth/v1/login Request body: Note: client_name is optional. But if you use it, make sure to use it as well for the refresh call! {"username": "my_username", "password": "my_password", "client_name": "my_app"} Response: { "wp_user": { "data": { "ID": 1, "user_login": "your_user_login", // other default WordPress user fields } }, "access_token": "your_access_token", "expires_in": 86400, // number of seconds "refresh_token": "your_refresh_token" } Make sure to save the access and refresh token! Refresh access token Endpoint: POST /api-bearer-auth/v1/tokens/refresh Request body: Note: client_name is optional. But if you did use it for the login call, make sure to use it here as well! {"token": "your_refresh_token", "client_name": "my_app"} Response success: { "access_token": "your_new_access_token", "expires_in": 86400 } Response when sending a wrong refresh token is a 401: { "code": "api_api_bearer_auth_error_invalid_token", "message": "Invalid token.", "data": { "status": 401 } } Do a request After you have the access token, you can make requests to authenticated endpoints with an Authorization header like this: Authorization: Bearer Note that Apache sometimes strips out the Authorization header. If this is the case, make sure to add this to the .htaccess file: RewriteCond %{HTTP:Authorization} ^(.*) # Don't know why, but some need the line below instead of the RewriteRule line # SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0 RewriteRule ^(.*) - [E=HTTP_AUTHORIZATION:%1] If you are not logged in or you send an invalid access token, you get a 401 response: { "code": "api_bearer_auth_not_logged_in", "message": "You are not logged in.", "data": { "status": 401 } } Important update Update immediately if you’re using a version below 20200807. Before this version all access tokens were updated when calling the refresh callback. If you are affected by this the fastest solution is to execute this query: update wp_user_tokens set access_token_valid = NOW(); This will invalidate all access tokens. This means that all users need to refresh their access token and will get a new access token and a unique one this time. A big thank to @harchvertelol for reporting this and suggesting the fix as well!