README

   1 = local-openid: Single User, Ephemeral OpenID Provider
   2
   3 local-openid allows users with shell accounts on servers to authenticate
   4 with OpenID consumers by editing a YAML file in their home directory
   5 instead of authenticating through HTTP/HTTPS.
   6
   7 1. Encounter a login page that accepts OpenID (the consumer)
   8 2. Login into your own server (if you're not already logged in)
   9 3. Start the local-openid app on your server
  10 4. Login using your OpenID (on the consumer)
  11    - you should be redirected to your local-openid application
  12 5. edit ~/.local-openid/config.yml on your server to approve the consumer
  13    This config file is only created after the consumer makes a successful
  14    request to your server.
  15 6. Reload the local-openid page your browser was on.
  16    - you should be logged in to the OpenID consumer site
  17    - If not, check the error log (usually stderr) of local-openid
  18 8. Shut down the local-openid application.
  19
  20 == local-openid exists for the following reasons:
  21
  22 1. Passwords and password managers feel clumsy to me on web browsers.
  23    On the other hand; using ssh, editing text files, and running servers
  24    are second nature.  Clearly, local-openid is not for everyone.
  25 2. Identity providers may not last.  Companies die and business plans
  26    change.  I'd rather my online identity not be subject to those whims.
  27 3. OpenID providers could be compromised without disclosure.  With
  28    local-openid, I have server logs to know if somebody is even trying
  29    something fishy with my identity.  The vector for compromising my
  30    identity is greatly reduced because my local-openid instance has 99.999%
  31    downtime.
  32
  33 == Install
  34
  35 The following command should install local-openid and all dependencies:
  36
  37   gem install local-openid
  38
  39 setup.rb is also provided for non-Rubygems users.
  40
  41 == Requirements
  42
  43 local-openid is a small Sinatra application.  It requires the Ruby
  44 OpenID library (2.x), Sinatra (1.0), Rack and any Rack-enabled
  45 server.  To be useful, it also depends on having a user account on a
  46 machine with a publically-accessible IP and DNS name to use as your
  47 OpenID identity.
  48
  49 == Running
  50
  51 "local-openid" should be installed in your $PATH by RubyGems or
  52 setup.rb.  It is a Sinatra application and takes the usual
  53 command-line arguments.  It binds on all addresses (0.0.0.0) and port
  54 4567 by default, using the standard WEBrick web server.
  55
  56 You may specify a different port with the *-p* switch and address with
  57 the *-o* switch.  The following command will start local-openid on port
  58 3000 bound to localhost (useful if behind a reverse proxy like nginx).
  59
  60   local-openid -o 127.0.0.1 -p 3000
  61
  62 == Hacking
  63
  64 I don't have any plans for more development with local-openid.  It was
  65 after all, just a weekend hack.  It does what I want it to and nothing
  66 more.
  67
  68 You can use the {mailing list}[mailto:local.openid@librelist.org] to
  69 share ideas, patches, pull requests with other users.  Remember, I
  70 wrote local-openid because I find the web difficult to use.  So I'll
  71 only accept communication about local-openid via email :)
  72
  73 Feel free to fork it and customize it to your needs.  Of course, drop me
  74 a line if you fix any bugs or notice any security holes in it.
  75
  76 You can get the latest source via git from the following locations:
  77
  78   git://bogomips.org/local-openid.git
  79   http://bogomips.org/local-openid.git
  80   git://repo.or.cz/local-openid.git (mirror)
  81   http://repo.or.cz/r/local-openid.git (mirror)
  82
  83 You may browse the code from the web and download the latest tarballs here:
  84
  85 * http://bogomips.org/local-openid.git
  86 * http://repo.or.cz/w/local-openid.git (gitweb mirror)
  87
  88 == Disclaimer
  89
  90 There is NO WARRANTY whatsoever, implied or otherwise.  OpenID may not
  91 be the best choice for dealing with security-sensitive data, and this
  92 application is just a weekend hack with no real security auditing.  On
  93 the other hand, it's quite hard for somebody to steal your OpenID
  94 credentials when your provider implementation has 99.999% downtime :)
  95
  96 == Contact
  97
  98 * Original author: Eric Wong, normalperson@yhbt.net
  99 * OpenID: http://e.yhbt.net/
 100 * mailing list: local.openid@librelist.org