diff options
| author | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | 2012-04-02 20:41:13 +0200 |
|---|---|---|
| committer | Matthias Andreas Benkard <code@mail.matthias.benkard.de> | 2012-04-02 20:41:13 +0200 |
| commit | b67d1c4229c2fa2e21af9a451eec16322e4ee204 (patch) | |
| tree | dd491d4809bceb491e7fc3177ea4459e92f7b037 /README | |
| parent | 11c1c31584c80e2dfd4bfc4dae6a81ce3547573b (diff) | |
Rename README -> README.md.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 72 |
1 files changed, 0 insertions, 72 deletions
@@ -1,72 +0,0 @@ -<!--- -*- mode: markdown; coding: utf-8 -*- ---> - -# Mulky IMAP BrowserID Primary - -## Introduction - -This software provides a simple BrowserID primary (authenticating -party) based on an existing local IMAP server setup. Users use their -IMAP login and password to authenticate themselves as the owner of -their email address. - -The primary is implemented as a set of simple CGI scripts. - - -## Assumptions About Your E-Mail Setup - -This software assumes that email addresses can be resolved to user -names by way of `/etc/aliases` and that the user names provided -therein are identical to those accepted by your IMAP server for -purposes of authenticating. - -If this is not true for your setup, you will need to hack the source -code. - - -## Installation - -### Prerequisites - -The following CPAN modules need to be installed: - - * `CGI` - * `CGI::Fast` - * `CGI::Session` - * `common::sense` - * `Crypt::OpenSSL::RSA` - * `File::Slurp` - * `JSON` - * `MIME::Base64` - * `Mail::ExpandAliases` - * `Mail::IMAPTalk` - * `Modern::Perl` - * `Time::HiRes` - -### Key Setup and jQuery Download - -In order to generate an RSA private key and download necessary -third-party components, run `setup.sh`. - -`setup.sh` will also generate a `browserid.json` file and prompt you -to put it wherever your web server will be able to serve it as -`/.well-known/browserid`. **It is very important to do this now**, -because `browserid.org` will look at that location and *cache* the -response, even if it is just a 404. - - -## License - -Copyright 2012, Matthias Andreas Benkard. - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. |