Permalink
Browse files

Cleaned up the readme and license a bit.

  • Loading branch information...
1 parent 188deae commit ea68714fd72c654101acdd2f289d8b341e443842 @bringhurst committed Jul 1, 2013
Showing with 38 additions and 49 deletions.
  1. +0 −25 LICENSE
  2. +23 −0 LICENSE.md
  3. +15 −24 README.md
View
25 LICENSE
@@ -1,25 +0,0 @@
-/*
- * Copyright (C) 2009 Michal Kowalski <superflouos{at}gmail[dot]com>
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- *
- */
View
@@ -0,0 +1,23 @@
+Copyright (C) 2009 Michal Kowalski <superflouos{at}gmail[dot]com>.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.
View
@@ -1,29 +1,22 @@
-Nginx module to use SPNEGO+GSSAPI+Kerberos for http SSO authentication
-======================================================================
+# nginx-mod-auth-kerb
+This is an [nginx](http://nginx.org/) module to enable the use of SPNEGO,
+GSSAPI, and Kerberos for HTTP SSO authentication.
-Whatsizit
----------
-
-Code 97% stolen from mod_auth_gss_krb5 (http://modgssapache.sf.net);
-version 0.0.5.
-
-Compilation
------------
-
-First you need to compile the spnegohelp dynamic library. 'make' in that
+## Compilation
+First, you need to compile the spnegohelp dynamic library. 'make' in that
subdirectory should do it, then place it by hand somewhere where linker
and loader can find it by default (probably /usr/lib or perhaps even
/usr/local/lib depending on your setup).
When compiling from source build as usual adding the -add-module option:
+````
./configure --add-module=$PATH_TO_MODULE
+````
inside top Nginx source directory.
-Configuration
--------------
-
+## Configuration
The module has following directives:
- auth_gss: "on"/"off", for ease of unsecuring while leaving other
@@ -39,12 +32,11 @@ The module has following directives:
credentials. (TOFIX: HTTP but should be a list in case of some other
browsers wanting perhaps khttp or http)
-TOFIX: for now they are all merely location specific. i.e. no way to
+FIXME: for now they are all merely location specific. i.e. no way to
specify main or per server defaults, except for ...
-Examples
---------
-
+## Examples
+````
... current "hardcodeds" ;-}
location /topsecret {
@@ -53,10 +45,9 @@ Examples
auth_gss_keytab /etc/krb5.keytab;
auth_gss_service_name HTTP;
}
+````
-Additional steps...
--------------------
-
-pray for no segfaults...
+## Credit and License
+This code is derived from the [Apache Kerberos/SPNEGO module](http://modgssapache.sf.net).
-TOFIX: perhaps add instructions on how to create the service keytab...
+Please see the LICENSE.md file for more information.

0 comments on commit ea68714

Please sign in to comment.