indieweb/wordpress-indieauth

IndieAuth Endpoints and Authentication for WordPress

4.5.2 2024-08-26 02:14 UTC

Requires

• php: >=5.6.0
• composer/installers: ~1.0 || ~2.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• mf2/mf2: ^0.5.0
• phpcompatibility/php-compatibility: *
• phpcompatibility/phpcompatibility-wp: *
• sebastian/phpcpd: ^3.0 || ^4.0 || ^6.0
• squizlabs/php_codesniffer: ^2.2 || ^3.5
• wp-coding-standards/wpcs: *
• yoast/phpunit-polyfills: ^2.0

MIT

• Matthias Pfefferle
• David Shanske

README

Contributors: indieweb, pfefferle, dshanske
Tags: IndieAuth, IndieWeb, IndieWebCamp, login
Requires at least: 4.9.9
Requires PHP: 7.2
Tested up to: 6.6
Stable tag: 4.5.2
License: MIT
License URI: http://opensource.org/licenses/MIT
Donate link: https://opencollective.com/indieweb

IndieAuth is a way to allow users to use their own domain to sign into other websites and services.

Description

The plugin turns WordPress into an IndieAuth endpoint. This can be used to act as an authentication mechanism for WordPress and its REST API, as well as an identity mechanism for other sites. It uses the URL from the profile page to identify the blog user or your author url. We recommend your site be served over https to use this.

You can also install this plugin to enable web sign-in for your site using your domain.

Installation

1. Upload the indieauth directory to your /wp-content/plugins/ directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. That's it

Frequently Asked Questions

What is IndieAuth?

IndieAuth is a way for doing Web sign-in, where you use your own homepage or author post URL( usually /author/authorname ) to sign in to other places. It is built on top of OAuth 2.0, which is used by many websites.

Why IndieAuth?

IndieAuth is an extension to OAuth. If you are a developer, you have probably used OAuth to get access to APIs. As a user, if you have given an application access to your account on a service, you probably used OAuth. One advantage of IndieAuth is how easily it allows everyone's website to be their own OAuth Server without needing applications to register with each site.

How is IndieAuth different from OAuth?

IndieAuth was built on top of OAuth 2.0 and differs in that users and clients are represented by URLs. Clients can verify the identity of a user and obtain an OAuth 2.0 Bearer token that can be used to access user resources.

You can read the specification for implementation details.

How is Web Sign In different from OpenID?

The goals of OpenID and Web Sign In are similar. Both encourage you to sign in to a website using your own domain name. However, OpenID has failed to gain wide adoption. Web sign-in prompts a user to enter a URL to sign on. Upon submission, it tries to discover the URL's authorization endpoint, and authenticate to that. If none is found, it falls back on other options.

This plugin only supports searching an external site for an authorization endpoint, allowing you to log into one site with the credentials of another site if that site is listed as the website URL in your user profile.

What is IndieAuth.com?

Indieauth.com is the reference implementation of the IndieAuth Protocol. If you activate this plugin you do not need to use this site. IndieAuth.com uses rel-me links on your website to determine your identity for authentication, but this is not required to use this plugin which uses your WordPress login to verify your identity.

How does the application know my name and avatar?

As of version 3.2, the endpoints return the display name, avatar, and URL from your user profile.

Does this require each user to have their own unique domain name?

No. When you provide the URL of the WordPress site and authenticate to WordPress, it will return the URL of your author profile as your unique URL. Only one user may use the URL of the site itself. This setting is set in the plugin settings page, or if there is only a single user, it will default to them.

How do I authenticate myself to an Indieauth server?

That, as mentioned, depends on the server. By default, the built-in IndieAuth server uses the WordPress login.

By adding Indieauth support, you can log into sites simply by providing your URL.

How secure is this?

We recommend your site uses HTTPS to ensure your credentials are not sent in cleartext. As of Version 3.3, this plugin supports Proof Key for Code Exchange(PKCE), if the client supports it.

What is a token endpoint?

Once you have proven your identity, the token endpoint issues a token, which applications can use to authenticate as you to your site.

You can manage and revoke tokens under User->Manage Tokens. You will only see tokens for the currently logged in user.

How do I incorporate this into my plugin?

The WordPress function, get_current_user_id works to retrieve the current user ID if logged in via IndieAuth. The plugin offers the following functions to assist you in using IndieAuth for your service. We suggest you check on activation for the IndieAuth plugin by asking if ( class_exists( 'IndieAuth_Plugin') )

• indieauth_get_scopes() - Retrieves an array of scopes for the auth request.
• indieauth_check_scope( $scope ) - Checks if the provided scope is in the current available scopes
• indieauth_get_response() - Returns the entire IndieAuth token response
• indieauth_get_client_id() - Returns the client ID
• indieauth_get_me() - Return the me property for the current session.
• new IndieAuth_Client_Discovery( $client_id ) - Class that allows you to discover information about a client
  • $client->get_name() - Once the class is instantiated, retrieve the name
  • $client->get_icon() - Once the class is instantiated, retrieve an icon

If any of these return null, the value was not set, and IndieAuth is not being used. Scopes and user permissions are not enforced by the IndieAuth plugin and must be enforced by whatever is using them. The plugin does contain a list of permission descriptions to display when authorizing, but this is solely to aid the user in understanding what the scope is for.

The scope description can be customized with the filter indieauth_scope_description( $description, $scope )

What if I just want to use the REST API without OAuth exchange?

The plugin allows you to generate a token under User->Manage Tokens with access. You can provide this to an application manually.

I keep getting the response that my request is Unauthorized

Many server configurations will not pass bearer tokens. The plugin attempts to work with this as best possible, but there may be cases we have not encountered. The first step is to try running the diagnostic script linked to in the settings page. It will tell you whether tokens can be passed.

Temporarily enable WP_DEBUG which will surface some errors in your logs.

If you feel comfortable with command line entries, you can request a token under Users->Manage Tokens and use curl or similar to test logins. Replace example.com with your site and TOKEN with your bearer token.

curl -i -H 'Authorization: Bearer TOKEN' 'https://example.com/wp-json/indieauth/1.0/test
curl -i -H 'Authorization: Bearer test' 'https://tiny.n9n.us/wp-json/indieauth/1.0/test?access_token=TOKEN'

This will quickly test your ability to authenticate to the server. Additional diagnostic tools may be available in future.

If this does not work, you can add define( 'INDIEAUTH_TOKEN_ERROR', true ); to your wp-config.php file. The INDIEAUTH_TOKEN_ERROR flag will return an error if there is not a token passed allowing you to troubleshoot this issue, however it will require authentication for all REST API functions even those that do not require them, therefore this is off by default.

If your Micropub client includes an Authorization HTTP request header but you still get an HTTP 401 response with body missing access token, your server may be stripping the Authorization header. If you're on Apache, try adding this line to your .htaccess file:

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

If you are not running the latest version of WordPress, try this line. It is added automatically as of 5.6:

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

You can also try:

CGIPassAuth On

If that doesn't work either, you may need to ask your hosting provider to whitelist the Authorization header for your account. If they refuse, you can pass it through Apache with an alternate name. The plugin searches for the header in REDIRECT_HTTP_AUTHORIZATION, as some FastCGI implementations store the header in this location.

I get an error that parameter redirect_uri is missing but I see it in the URL

Some hosting providers filter this out using mod_security. For one user, they needed Rule 340162 whitelisted as it detects the use of a URL as an argument.

What is the Ticketing extension and how do I enable it?

Ticketing for IndieAuth is a developing extension to OAuth2/IndieAuth. It creates a ticket endpoint on your site where other sites can send you a ticket, which can be redeemed for a token to access private resources on that other site. You can enable the experimental endpoint functionality by adding the below to your wp-config.php. If this becomes more established, it will be added in the settings page.

define( 'INDIEAUTH_TICKET_ENDPOINT', true );

At this time, the functionality is limited to the receiving of tickets, not the sending of same. It enables a new tab under the User called Manage External Tokens, which allows you to see which external tokens are stored. Tokens are stored per user.

Since the extension is developing, there is currently not a specified way to transfer this token to a client to be used.

Upgrade Notice

4.5.0

4.5.0 removes support for client discovery using a manifest file. This was never part of the official specification and has been superseded by the newly added client json metadata option.

4.4.0

4.4.0 removes the remote endpoint functionality, which will be archived as a separate plugin in future. It was already disabled by default. It also removes the ability to login via URL and password. Websignin login is the only login enhancement.

4.3.0

4.3.0 changes the storage of client application data from being embedded in every token to being stored in a hidden taxonomy. Older tokens will not be automatically updated. It also sideloads the application icon

4.2.0

Changes in the 4.2.0 branch implement future breaking changes to IndieAuth. Backward compatibility will be maintained for the foreseeable future, but clients are advised to update to the latest version of the standard to take advantage of the latest opportunities. Old methods will remain until adoption of the metadata endpoint is sufficient.

4.1.0

Introduces experimental Ticket Auth Endpoint, which allows the receipt of tickets and the storage of external tokens. This is disabled by default and can only be enabled through a flag.

4.0.0

This version enables expiring tokens. All existing tokens will remain as they were. New tokens will expire in 14 days by default. You can change this in settings.

3.6.0

Due to the fact that this upgrades the spec adherence to address the changes in the IndieAuth Living Standard as of November 26, 2020, there may be unanticipated issues with clients not meeting the changes. Until such a time as more IndieAuth clients adopt the changes, some elements of the changes will not be mandatory, such as PKCE compliance.

3.4.0

Due to the possibility of someone setting the url in their user profile to the same as another account, you will no longer be able to save the exact same url into two accounts. If you already set two accounts to the same URL one will be wiped the next time you save a conflicting user profile.

3.3.2

Due to issues people have experienced with their hosting provider stripping Authorization headers. The plugin will now nag you to run the test for this.

3.0.0

In version 2.0, we added an IndieAuth endpoint to this plugin, which previously only supported IndieAuth for web sign-in. Version 3.0.0 separates the endpoint code from the web sign-in code and removes the ability to use a third-party IndieAuth endpoint with your site. If you use the sign-in feature, it will look for the IndieAuth endpoint for the URL you provide. If you use Micropub for WordPress, enabling the plugin will use the built-in endpoint for WordPress. If you wish to use Indieauth.com or another endpoint, you can disable this plugin and Micropub will use Indieauth.com by default.

Changelog

Project and support maintained on github at indieweb/wordpress-indieauth.

4.5.2

• Fix issue with loop on adding new clients
• Store client_uri and last modified date for new clients.

4.5.1

• Fix issue with failure if logo_uri is not a URL
• Fix conflict with Jetpack plugin due not returning error property (props @janboddez)

4.5.0

• Remove experimental manifest searching code for client discovery
• Add support for client json metadata files recently added to specification with fallback to MF2 HTML
• Fix declaration issue(props @janboddez)

4.4.2

• Prevent returning 401 for other successful OAuth2 plugins

4.4.1

• Add MF2 Parser for Client Information Discovery
• Fix ticket endpoint and add additional checks
• Fix issue with discovery not checking html links if there were any http links
• Add hooks for Ticket redemption flow
• Add email notification when ticket received

4.4.0

• Remove remote endpoint functionality already disabled
• Rearrange so each endpoint is more independent and registers its own parameters
• Add way to register new grant types.
• Rewrite Web Signin to support latest version of flow.
• Add PKCE support to websignin flow
• Fix issue with PKCE support where it would not actually verify PKCE for token flow because PKCE is optional
• Invert PKCE message to highlight when PKCE is not being used over it being used.
• Do not do client discovery on a non-retrievable URL
• Validate identifiers to IndieAuth Spec
• Remove URL plus password login as part of effort to simplify code.
• Fix error message surfacing in websignin form
• Fix CSS on websignin and authorization forms to not misrender the language bar.

4.3.0

• Introduce Client Taxonomy to store client data so it is not stored individually
• Sideload Client Application icons

4.2.1

• Fix issue with not loading User Token library with old remote endpoint code
• Fix issue with not loading metadata endpoint when not logging in

4.2.0

• Add Server Metadata Endpoint
• Add Issuer Property to Authorization Response
• In 4.1.0, introspection endpoint was introduced and shared an endpoint with the token endpoint. This approach was abandoned with the metadata endpoint and the introspection endpoint no longer shares. As this was only in for a short time deprecation is immediate.
• Revocation endpoint added. Old revocation method will remain until metadata endpoint adoption is sufficient.
• User Info Endpoint added. This returns the user profile offered during the authorization flow.

4.1.1

• Fix issue where class from ticket auth was being called even though ticket auth was not enabled.

4.1.0

• Add experimental ticket auth endpoint
• Bug fix on endpoint discovery discovered during ticket auth development
• Introduce Token Introspection Endpoint as per proposal to integrate RFC7662. For now, will exist concurrently with the older token verification response until it is deprecated.
• Ensure profile responses are returned when appropriate.
• Misc Bug Fixes discovered in unit testing
• Updating of settings configuration
• Improved default for user who gets to identify as root of site.
• Introduce Refresh Token Functionality
• Create was not pre-checked in new selections when offered as an option.

4.0.0

• Add default expiry time.
• Ensure tokens expire at their proper time.
• Cleanup related to expiry

3.6.2

• Fix missing argument, props @chee
• Fix issue with new sanitization, props @akirk
• Fix issue with improperly encoded HTML in JSON
• Switch test token to mirror length of real token to properly test servers who may use mod_security.

3.6.1

• Clean up template pages in order to remove HTML from i18n strings.

3.6.0

• Adopt changes to the living spec as of the November 26, 2020 version.
• Drop explicit support for response_type=id. Endpoint will convert to type code for backcompat until further notice.
• Change experimental profile return behavior to match newly documented behavior in spec.
• Support profile and email scopes, to be handled within this plugin.
• Add additional code comments
• Remove unique URL code as looking for user URLs is no longer supported
• Add UUID to tokens as used in the WP5.6 Application Password feature.
• Add Last IP Accessed to storage as used in the WP5.6 Application Password feature.

3.5.1

• Make Site Health More Explicit
• Update scope descriptions
• Adjust scope capabilities to be more consistent

3.5.0

• Restore ability to use a remote endpoint but keep this feature hidden for now.
• Add load function and config setting in order to load the files appropriate for your configuration
• Create Authorization plugin base class that can be used to create different IndieAuth configurations
• Add Site Health Check for SSL and Unique Users
• Create local and remote classes that can be instantiated depending on configuration

3.4.2

• Repair issue with other flow caused by function name issue

3.4.1

• Add setting to set the user who will be using the site URL as their URL as opposed to their author URL which removes dependency on Indieweb plugin for this.

3.4.0

• Enforce unique URLs for user accounts
• Add user url to user table
• Redo association for URL to user account. At this time, only the root path and the author archive URLs are allowed as a return. Hoping to add more options in future
• Add Site Health Check
• Improve text and links for authorization failure

3.3.2

• Add new diagnostic script that will nag you until you run it at least once
• Add cache control headers on return from endpoint
• Verifying the token at the token endpoint did not use REDIRECT_HTTP_AUTHORIZATION now added
• Add header check to settings page
• Add option to generate tokens on the backend with any scope
• Add option to bulk expire tokens
• Add cleanup option

3.3.1

• Add definition of profile scope
• Improve documentation in README

3.3

• Switch to SHA256 hashing from built in salted hash used by WordPress passwords
• Add PKCE Support

3.2

• Only add headers to front page and author archive pages
• Return basic profile data in returns so the client can display the name and avatar of the user

3.1.11

• Fix issue with silent conversion when not array
• Add client name and icon automatically on setting token

3.1.10

• Fixed PHP notice with icon determination
• Silently convert requests for the post scope to the create update scope
• Update tagline

3.1.9

• Fixed PHP warnings

3.1.8

• When local verification is performed the code was not updating the profile URL and passing through the URL from the original request. This code was in the remote verification portion of the token endpoint and is now mirrored in the verify local code.

3.1.7

• Add authdiag.php script written by @Zegnat

3.1.6

• Add ability to generate a token on the backend
• Added a test endpoint that tests whether the authentication provider for the REST API is working and tries to return useful errors

3.1.5

• Add Client Information Discovery to search for names and icon for clients
• Add icon and client name to Manage Token page
• Add action to refresh icon and other information in the Manage Token interface

3.1.4

• Rearrange token logic so that if a token is provided the system will fail if it is invalid
• Add last accessed field to token and add that to token management table

3.1.3

• Allow selection of scopes and add stock descriptions
• Update Manage Token Page to use WP_List_Table

3.1.2

• Fix issue with scope encoding
• Fix issue where function returned differently than parent function

3.1.1

• Fixed PHP error with version < PHP 5.4

3.1.0

• Fixed state param handling

3.0.4

• Fixed admin settings

3.0.3

• Verify user ID directly from the token endpoint rather than mapping URL.
• Display $me parameter instead of user_url on authenticate screen
• Remove deprecated functions and parameters

3.0.2

• Automatically rewrite local URLs to https if the local site is site to SSL

3.0.1

• In previous version fixed issue where error message was not returned if there was a missing bearer token. This was needed due fact that some servers filter tokens. However, this meant that it would do this for all API requests, even ones not requiring authentication such as webmentions. Reverted change with flag
• Added constant INDIEAUTH_TOKEN_ERROR which if set to true will return an error if it cannot find a token.

3.0.0

• Major refactor to abstract out and improve token generation code
• Set one cookie with the state instead of multiple cookies.
• Store other parameters as a transient
• Remove extra settings

2.1.1

• Bug Fix

2.1.0

• Refactor to change load order
• Textual fix
• Add defaults when core functions not yet enabled
• Rework of the admin-interface

2.0.3

• Add improved getallheaders polyfill
• Check for missing cookie
• Check for alternate authorization location

2.0.2

• If using local endpoint verify token locally without making remote call
• Add filters for scope and response so they can be accessed elsewhere
• urlencode state as some encode information into state that was being lost
• Switch from failure to warning message for different domains for redirect
• Hide token endpoint management page if local endpoint not enabled

2.0.1

• Improve error handling if null endpoint sent through
• Adjust cookie to GMT
• Add whitepace to form

2.0.0

• Support author profiles in addition to user URLs
• Change token verification method to match current Indieauth specification
• Add support for token verification to act as a WordPress authentication mechanism.
• Add ability to set any token or authorization endpoint
• Add authorization and token endpoint headers to the site
• Discover and use authorization endpoint for provided URL when logging in
• Allow login using URL
• Add built-in token endpoint ( props to @aaronpk for support on this )
• Add built-in authorization endpoint ( props to @aaronpk for support on this )
• Hide option to login with your domain by default
• Option to sign into your domain is now a separate form
• Automatically add trailing slash to user_url

1.1.3

• update README

1.1.2

• fixed redirect URL

1.1.1

• WordPress coding style

1.1.0

• fixed critical bug

1.0.0

• initial