WordPress.org

Ready to get started?Download WordPress

Plugin Directory

Keyring

An authentication framework that handles authorization with external web services.

How Do I Use Keyring in my Plugin?

Check out the Keyring Developer's Guide.

See Keyring Social Importers for an example. You can also extend Keyring Service classes directly, rather than attaching the service as a property to an object (like the Importers do).

Will Keyring work on my WordPress?

Keyring requires PHP 5.3+ to work, because it makes use of some modern features in PHP like late static binding and abstract classes. Other than that, as long as you meet the minimum required WP version, you should be OK to get started. If you get a cryptic "T_PAAMAYIM_NEKUDOTAYIM" error, you need to upgrade to PHP 5.3+.

Your webserver will also need to be able to make outbound HTTPS requests for some operations with some services to work correctly.

How do I configure Services?

Most services within Keyring require some sort of API key/secret before you can connect to them.

  1. Go to Tools > Keyring > Add New
  2. Click the name of a service in the bottom section, or 'Manage' next to one of the services in the top section
  3. Enter your API details (you will need to get those from the specific service)
  4. Click 'Save Changes'
  5. Now you should be able to create a new connection to that service

How do I connect to 'x' service?

  1. Go to Tools > Keyring > Add New
  2. Click the name of the service in the top section (if it's in the bottom section, then that service has not been configured for API access yet, see above)
  3. Follow through any authentication prompts to connect
  4. You should now be connected, and your connection details should be listed on the Keyring admin page (which you will be redirected to once authentication is complete)

Now what?

Keyring just provides a framework for handling connections to external services. You need to download another plugin which makes use of Keyring to do anything useful (e.g. an importer or content-syncing plugin).

How does Keyring store tokens?

  • By default, on a single-site install, Keyring stores tokens in your wp_posts table with a custom post type of 'keyring_token'
  • Coming soon, Keyring will store tokens for a multi-site install in a specified blog/site's wp_posts (so you can set a single site aside for just token storage if you like)
  • Keyring provides a framework for you to write your own token storage engine (see store.php and includes/stores/).

How do I add to the list of services Keyring can connect to?

Add files to includes/services/extended/ that either implement one of the includes/services/core/ service foundations, or start from scratch. Follow one of the existing service definitions for a template, and see service.php in the root of Keyring for some detail on methods you need to define, and optional ones that might make your life easier.

Requires: 3.3 or higher
Compatible up to: 4.0
Last Updated: 2014-8-19
Downloads: 3,988

Ratings

5 stars
5 out of 5 stars

Support

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

100,1,1
100,1,1
100,1,1
100,1,1 100,1,1
100,1,1
100,1,1 100,1,1
100,1,1 100,2,2 100,1,1 100,1,1
100,1,1 100,1,1 100,1,1 100,1,1 100,3,3
100,1,1
100,1,1
100,1,1 100,1,1
100,2,2 100,1,1
100,1,1
100,1,1 100,1,1
100,1,1
100,1,1
100,1,1
100,1,1