git.fiddlerwoaroof.com
Browse code

adding some docs

fiddlerwoaroof authored on 06/11/2015 06:55:51
Showing 2 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,31 @@
1
+
2
+Copyright (c) 2015 Edward Langley
3
+All rights reserved.
4
+
5
+Redistribution and use in source and binary forms, with or without
6
+modification, are permitted provided that the following conditions
7
+are met:
8
+
9
+Redistributions of source code must retain the above copyright notice,
10
+this list of conditions and the following disclaimer.
11
+
12
+Redistributions in binary form must reproduce the above copyright
13
+notice, this list of conditions and the following disclaimer in the
14
+documentation and/or other materials provided with the distribution.
15
+
16
+Neither the name of the project's author nor the names of its
17
+contributors may be used to endorse or promote products derived from
18
+this software without specific prior written permission.
19
+
20
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES  INCLUDING, BUT NOT LIMITED
26
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
+
0 32
new file mode 100644
... ...
@@ -0,0 +1,23 @@
1
+# Introduction
2
+
3
+Eventually, this repository will just contain an implementation of various social
4
+authentication protocols in common lisp.  Right now, the only supported protocols
5
+are OpenID Connect and Facebook Login.  The OpenID Connect implementation has only
6
+been tested against Google.  More testing to follow.
7
+
8
+This repository also contains a "demo" application that uses the openid-connect
9
+library: a very simple app that just authorizes the user against the chosen provider
10
+and then dumps the info returned by that provider.
11
+
12
+# Installation notes
13
+
14
+This project implements the OpenId Connect API. In its current state, it can
15
+authenticate a user against Google and display the informaiton Google sends
16
+back. The only tricky requirement it has is cljwt, a library for parsing JSON
17
+Web Tokens, which is not in quicklisp but can be gotten from
18
+<https://github.com/fiddlerwoaroof/cljwt>. (This is my fork, I've made a couple
19
+changes since the original library didn't support the signature algorithm Google
20
+uses). Note, however, that my fork of cljwt doesn't actually verify any signatures:
21
+it just decodes the data and assumes the validity of the signature.
22
+
23
+(c) 2015 Edward Langley, distributed under a 2-clause BSD License