git.roojs.org Git - web.mtrack/blob - defaults/help/plugin/OpenID

   1 = MTrackAuth_OpenID =
   2
   3 When used in a public facing environment, where you desire to have external
   4 users contributing to your project in terms of bug reports or wiki content, you
   5 may want to enable OpenID as an authentication mechanism.
   6
   7 This allows users to access your site without having to request credentials and remember passwords and such for your site.
   8
   9 The OpenID implementation in mtrack classes users as anonymous until they
  10 either explicitly log in or arrive at a page that throws a privilege exception.
  11 If a privilege exception is raised while the user is anonymous, they will be
  12 redirected to the OpenID login page to authenticate.
  13
  14 mtrack will not automatically create a local user record for OpenID users as
  15 they log in.  This is for security purposes; even though the authentication is
  16 outsourced, the mechanism does not prevent the user from sending erroneous
  17 information as part of the sign in, and this could potentially be used to
  18 hijack a pre-existing local user record.
  19
  20 The impact of this is that an OpenID user can comment and contribute to the
  21 wiki (assuming that permissions are set accordingly; by default the OpenID user
  22 will be classified as an authenticated user class and thus have rights to the
  23 wiki and tickets), and their contributions will be attributed to their OpenID
  24 identity URL.
  25
  26 To establish a local user identity for the OpenID user, an admin user can edit the OpenID user by clicking on their name in the UI.  When the edits are saved, the user will become a local user.
  27
  28 If the OpenID user is also a contributor to the code via the SCM, the admin
  29 user can add an alias for that user.  For example, the user "wez" is a code
  30 contributor and also has the OpenID identity URL "http://netevil.org/".  The
  31 recommended approach for configuring mtrack is to edit the "wez" user details
  32 and add an alias for "http://netevil.org/".  Now, when "wez" logs in via OpenID
  33 he will be recognized as "wez" throughout the system, rather then
  34 "http://netevil.org/" because "wez" is the canonical identifier for that user.
  35
  36 Because OpenID is not a guarantee that the user is trustworthy, you may also want to consider [help:plugin/Recaptcha enabling captcha support].
  37
  38 == configuration ==
  39
  40 The plugin is loaded by adding a line like the following to your [help:ConfigIni config.ini]:
  41
  42 {{{
  43 [plugins]
  44 MTrackAuth_OpenID =
  45 }}}
  46
  47 You may also assign user_classes to OpenID URLs; for instance, the following
  48 configuration gives Wez Furlong admin rights to your mtrack instance:
  49
  50 {{{
  51 [user_classes]
  52 http://netevil.org/ = admin
  53 }}}
  54
  55 Note that the trailing slash character in the URL is significant.
  56