aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joeyh@joeyh.name>2015-05-14 11:37:47 -0400
committerJoey Hess <joeyh@joeyh.name>2015-05-14 11:58:21 -0400
commitab1bba9daba5500e1b154579518369974cc6041a (patch)
treee4684113a149c92ba09fd7217c6a85d6f040d6d6 /doc
parent2a64eea0f51a431abe9c0a7c73a61f3177977790 (diff)
downloadikiwiki-ab1bba9daba5500e1b154579518369974cc6041a.tar
ikiwiki-ab1bba9daba5500e1b154579518369974cc6041a.tar.gz
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
Diffstat (limited to 'doc')
-rw-r--r--doc/banned_users.mdwn4
-rw-r--r--doc/plugins/emailauth.mdwn6
-rw-r--r--doc/todo/emailauth.mdwn4
3 files changed, 11 insertions, 3 deletions
diff --git a/doc/banned_users.mdwn b/doc/banned_users.mdwn
index c44f8c587..23433b15b 100644
--- a/doc/banned_users.mdwn
+++ b/doc/banned_users.mdwn
@@ -8,3 +8,7 @@ For example:
If a banned user attempts to use the ikiwiki CGI, they will receive a 403
Forbidden webpage indicating they are banned.
+
+Note that when [[plugins/emailauth]] is used, the user's email address
+is displayed in cloaked form in commits of their edits. This cloaked email
+address can be used as-is in the `banned_users` setting.
diff --git a/doc/plugins/emailauth.mdwn b/doc/plugins/emailauth.mdwn
index db22e2931..74097d2cc 100644
--- a/doc/plugins/emailauth.mdwn
+++ b/doc/plugins/emailauth.mdwn
@@ -11,8 +11,10 @@ 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. Note though that the email address will be visible
-when looking at eg, commits in the git repository.
+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.
diff --git a/doc/todo/emailauth.mdwn b/doc/todo/emailauth.mdwn
index 357a4ad9b..4683bbad2 100644
--- a/doc/todo/emailauth.mdwn
+++ b/doc/todo/emailauth.mdwn
@@ -131,4 +131,6 @@ Thoughts anyone? --[[Joey]]
>>> 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]]
+>>> --[[smcv]]a
+
+>>> Email addresses are now cloaked in commits, using foaf:mbox_sha1sum. --[[Joey]]