ikiwiki/doc/plugins/emailauth.mdwn

[[!template id=plugin name=emailauth core=1 author="[[Joey]]"]]
[[!tag type/auth]]

This plugin lets users log into ikiwiki using any email address. To complete
the login, a one-time-use link is emailed to the user, and they can simply
open that link in their browser.

It is (indirectly) enabled by default, but can be turned off if you want to
only use some other form of authentication, such as [[passwordauth]] or
[[openid]].

Users who have logged in using emailauth will have their email address used as
their username. In places where the username is displayed, like the
RecentChanges page, the domain will be omitted, to avoid exposing the
user's email address. In places where the full username needs to be put,
like commits of changes, the email address is cloaked using
<a href="http://xmlns.com/foaf/spec/#term_mbox_sha1sum">the
foaf:mbox_sha1sum spec</a>.

This plugin needs the [[!cpan Mail::SendMail]] perl module installed,
and able to send outgoing email.
email auth plugin now works through email address entry 2015-05-14 00:50:40 +02:00			`[[!template id=plugin name=emailauth core=1 author="[[Joey]]"]]`
			`[[!tag type/auth]]`

			`This plugin lets users log into ikiwiki using any email address. To complete`
			`the login, a one-time-use link is emailed to the user, and they can simply`
			`open that link in their browser.`

Do not directly enable emailauth by default, only indirectly via openid This avoids nasty surprises on upgrade if a site is using httpauth, or passwordauth with an account_creation_password, and relying on only a select group of users being able to edit the site. We can revisit this for ikiwiki 4. 2015-05-27 09:52:01 +02:00			`It is (indirectly) enabled by default, but can be turned off if you want to`
			`only use some other form of authentication, such as [[passwordauth]] or`
			`[[openid]].`
email auth plugin now works through email address entry 2015-05-14 00:50:40 +02:00
			`Users who have logged in using emailauth will have their email address used as`
			`their username. In places where the username is displayed, like the`
			`RecentChanges page, the domain will be omitted, to avoid exposing the`
cloak user PII when making commits etc, and let cloaked PII be used in banned_users This was needed due to emailauth, but I've also wrapped all IP address exposure in cloak(), although the function doesn't yet cloak IP addresses. (One IP address I didn't cloak is the one that appears on the password reset email template. That is expected to be the user's own IP address, so ok to show it to them.) Thanks to smcv for the pointer to http://xmlns.com/foaf/spec/#term_mbox_sha1sum 2015-05-14 17:37:47 +02:00			`user's email address. In places where the full username needs to be put,`
			`like commits of changes, the email address is cloaked using`
			`<a href="http://xmlns.com/foaf/spec/#term_mbox_sha1sum">the`
			`foaf:mbox_sha1sum spec</a>.`
emailauth link sent and verified; user login works Still some work to do since the user name is an email address and should not be leaked. 2015-05-14 04:27:03 +02:00
			`This plugin needs the [[!cpan Mail::SendMail]] perl module installed,`
			`and able to send outgoing email.`