ikiwiki/doc/todo/emailauth.mdwn

With many users no longer having an openid account, and Persona seeming to
be dying on the vine, and no other replacements looking very likely (except
for Oauth type stuff perhaps), it would be good to have a new easy way to
log into ikiwiki, that doesn't need pre-registration.

Importantly, I want something that is not going to go
the way of openid in the future. I think that email is here to stay; at
least anyone who wants an email address is going to be able to get one in
the forseeable future. (Google and large providers are making it harder to
run small email systems, but it's still very possible, and there are at
worst many large providers.)

I've read about email being used for login auth, and seen it once or twice.
While I can't remember any links right now, the basic idea is:

1. user enters email address into form
2. response page says "a login link has been emailed to you"
3. user opens email and clicks login link
4. user is logged in until the cookie expires or is cleared

A few points to make this more secure:

* Only 1 login link should be active at a time; old ones won't work to log in.
* A login link is only valid for a single login. Once it's used, it cannot
  be used to log in again.
* A login link is only valid for a certain period of time. 24 hours seems
  like more than enough, and 12 hours would probably be plenty too.
  This timeout means a user doesn't need to worry about their email
  archives being used to log in.

Still, this could be attacked:

* If an attacker can access a user's inbox, they can generate a new login
  link, and log in as them. They are probably busy draining their bank
  account by this method and not logging into some wiki though.
* If TLS is not used for the email transport, a MITM can snoop login links
  and use them. Again probably more lucrative ways to exploit such a MITM.
* If https is not used for the login link, a MITM can intercept and proxy
  web traffic and either steal a copy of the cookie, or use the login
  link themselves without letting the user log in. This attack seems no
  worse than using password authentication w/o https, and the solution is
  of course https.
* If an attacker wants to DOS a wiki, they can try to get its domain, IP,
  whatever blacklisted as a spam source.

These attacks don't seem worth not doing it; many of the same attacks can
be performed against openid, or passwordauth. Eg, reset password and
intercept email.

Implementation notes:

* Use the email address as the username.
* Sanitize the email for display in recentchanges etc.
* The login link should be as short an url as possible, while containing
  sufficient entropy. Some email clients will let the user click on it,
  but some users will need to cut and paste.
* The `adminemail` config setting has a bit of overlap with an `adminuser`
  set to an email address. Probably worth keeping them separae though;
  the `adminemail` is an email address to display, and we may not want to
  let anyone who can read the adminemail's mailbox to log into the wiki.
* Will want to make passwordauth reject registrations that contain `@`.
  Otherwise, someone could use passwordauth to register as a username that
  looks like an email address, which would be confusing to possibly a
  security hole. Probably best to keep passwordauth and emailauth accounts
  entirely distinct. Update: passwordauth never allowed `@` in usernames.
* Currently, subscription to comments w/o registering is handled by
  passwordauth, by creating a passwordless account (making up a username,
  not using the email address as the username thankfully). That account can be
  upgraded to a passworded account if the user follows a link in comment
  mails to login. So there is considerable overlap between that and
  emailauth.
* Adapting the passwordauth reset code is probably the simplest way to
  implement emailauth. That uses a CGI::Session id as the entropy.

----

So this all seems doable. What I'm unsure about is this: Is emailauth going
to be sufficiently easier than passwordauth that it will let users
contribute to wikis who otherwise wouldn't?

Using passwordauth, the user can register by just picking a password, and
username, and entering email. That's 2 more things that need to be entered,
but then there is no need to wait for an email link to arrive. Which can
take a while, or be an unreliable, opaque process for users.

OTOH, maybe some users don't want to have to make up a username and
password, or pchycologically don't want to register. emailauth would then
let them contiribute.

I also have a motivation for ikiwiki-hosting/branchable. That needs the
user to be able to log into the site, create their own wiki, and then log
into their own wiki. Currently, openid is the only way to do that;
emailauth would be another way.

Another motivation from ikiwiki-hosting/branchable is that with google
openid going away, many sites can have only google openids as adminusers, and
that has to be manually dealt with. But if emailauth is added, those
adminusers can be converted, perhaps automatically, to use the email
addresses on record.

Thoughts anyone? --[[Joey]]

> I had looked at something like this before, through [[todo/indyauth_support]] - which basically turned out to outsource their own auth to http://intridea.github.io/omniauth/ and http://indiewebcamp.com/RelMeAuth...
> 
> But it seems to me that your proposal is basic "email opt-in".. the one impact this has on (drupal) sites i know is that spammers use even those forms to send random emails to users. it's weird, but it seems that some bots simply try to shove victim's emails into forms with the spam data as they can and hope for the best... it seems this could be vulnerable as well... - [[anarcat]]

>> Implemented now. [[done]]
>> 
>> Only thing that we might want to revisit sometime is that the email address
>> is used in git commits. While it won't be displayed on any static wiki 
>> pages (AFAICS), spammers could find it in the git commit log.
>>
>> Of course, spammers can troll git repos for emails anyway, so maybe
>> this is fine. --[[Joey]]

>>> I'm not so sure this is OK: user expectations for "a random wiki/blog"
>>> are not the same as for direct git contributions. Common practice for
>>> websites is for email addresses to be only available to the site owner
>>> and/or outsourced services - if ikiwiki doesn't work like this,
>>> I think wiki contributors/blog commenters are going to blame ikiwiki,
>>> not themselves.
>>>
>>> One way to avoid this would be to
>>> [[separate authentication from authorization]], so our account names
>>> would be smcv and joey even on a purely emailauth wiki, with the
>>> fact that we authenticate via email being an implementation detail.
>>>
>>> Another way to do it would be to hash the email address,
>>> so the commit appears to come from
>>> `smcv <smcv@02f3eecb59311fc89970578832b63d57a071579e>` instead of
>>> from `smcv <smcv@debian.org>` - if the hash is of `mailto:whatever`
>>> (like my example one) then it's compatible with
>>> [FOAF](http://xmlns.com/foaf/spec/#term_mbox_sha1sum).
>>> --[[smcv]]a

>>> Email addresses are now cloaked in commits, using foaf:mbox_sha1sum. --[[Joey]]

Note that the implementation of this lives in [[plugins/emailauth]].

Also, I have found a similar system called [Portier](https://portier.github.io) that enables email-based auth but enhances it with [[plugins/openid]] connect... Maybe ikiwiki's authentication system could follow the standards set by Portier? OpenID connect discovery is particularly interesting, as it could mean that using your GMail address to login to ikiwiki would mean that you go straight to the more secure OpenID / Oauth authentication instead of relying on the slow "send email and click link" system... --[[anarcat]]