2008-07-21 13:31:57 +02:00
|
|
|
[[!template id=plugin name=openid core=1 author="[[Joey]]"]]
|
|
|
|
|
[[!tag type/auth]]
|
2006-11-20 02:52:18 +01:00
|
|
|
|
|
|
|
|
This plugin allows users to use their [OpenID](http://openid.net/) to log
|
|
|
|
|
into the wiki.
|
|
|
|
|
|
2009-06-03 21:42:04 +02:00
|
|
|
The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module.
|
|
|
|
|
Version 1.x is needed in order for OpenID v2 to work.
|
|
|
|
|
|
2019-02-10 17:56:41 +01:00
|
|
|
The [[!cpan LWPx::ParanoidAgent]] Perl module is strongly recommended.
|
|
|
|
|
The [[!cpan LWP]] module can also be used, but is susceptible to
|
|
|
|
|
server-side request forgery.
|
|
|
|
|
|
|
|
|
|
The [[!cpan Crypt::SSLeay]] Perl module is needed
|
2009-06-03 21:42:04 +02:00
|
|
|
to support users entering "https" OpenID urls.
|
2006-11-20 02:52:18 +01:00
|
|
|
|
2007-04-30 00:54:14 +02:00
|
|
|
This plugin is enabled by default, but can be turned off if you want to
|
|
|
|
|
only use some other form of authentication, such as [[passwordauth]].
|
2010-06-11 19:53:56 +02:00
|
|
|
|
|
|
|
|
## options
|
|
|
|
|
|
|
|
|
|
These options do not normally need to be set, but can be useful in
|
2011-06-25 01:42:02 +02:00
|
|
|
certain setups.
|
2010-06-11 19:53:56 +02:00
|
|
|
|
|
|
|
|
* `openid_realm` can be used to control the scope of the openid request.
|
|
|
|
|
It defaults to the `cgiurl` (or `openid_cgiurl` if set); only allowing
|
|
|
|
|
ikiwiki's [[CGI]] to authenticate. If you have multiple ikiwiki instances,
|
|
|
|
|
or other things using openid on the same site, you may choose to put them
|
2010-06-11 20:14:20 +02:00
|
|
|
all in the same realm to improve the user's openid experience. It is an
|
|
|
|
|
url pattern, so can be set to eg "http://*.example.com/"
|
2010-06-11 19:53:56 +02:00
|
|
|
|
|
|
|
|
* `openid_cgiurl` can be used to cause a different than usual `cgiurl`
|
|
|
|
|
to be used when doing openid authentication. The `openid_cgiurl` must
|
|
|
|
|
point to an ikiwiki [[CGI]], and it will need to match the `openid_realm`
|
|
|
|
|
to work.
|
2014-09-15 00:04:06 +02:00
|
|
|
|
|
|
|
|
## troubleshooting
|
|
|
|
|
|
|
|
|
|
See [[plugins/openid/troubleshooting]] for a number of issues that may
|
|
|
|
|
need to be addressed when setting up ikiwiki to accept OpenID logins reliably.
|
2016-06-04 00:54:46 +02:00
|
|
|
|
|
|
|
|
## delegation
|
|
|
|
|
|
|
|
|
|
This plugin does not take care of doing the "server" part of the
|
|
|
|
|
OpenID protocol, only the "client" part. In other words, it allows
|
|
|
|
|
users to login to your site through OpenID, but is not in itself an
|
|
|
|
|
OpenID provider.
|
|
|
|
|
|
|
|
|
|
It is possible, however, to use your Ikiwiki site as a delegation
|
|
|
|
|
point to another OpenID provider. For this, use the
|
|
|
|
|
[[ikiwiki/directive/meta/]] directive with the `openid` parameter.
|
