Merge branch 'master' of github.com:miguelgrinberg/flask-httpauth

README.md

@@ -1,4 +1,98 @@
 flask-httpauth
 ==============
 
-Simple extension that provides Basic and Digest HTTP authentication for Flask routes
+Simple extension that provides Basic and Digest HTTP authentication for Flask routes.
+
+Basic authentication example
+----------------------------
+
+    from flask import Flask
+    from flask.ext.httpauth import HTTPBasicAuth
+
+    app = Flask(__name__)
+    auth = HTTPBasicAuth()
+
+    users = {
+        "john": "hello",
+        "susan": "bye"
+    }
+
+    @auth.get_password
+    def get_pw(username):
+        if username in users:
+            return users[username]
+        return None
+        
+    @app.route('/')
+    @auth.login_required
+    def index():
+        return "Hello, %s!" % auth.username
+        
+    if __name__ == '__main__':
+        app.run()
+        
+Digest authentication example
+-----------------------------
+
+    from flask import Flask
+    from flask.ext.httpauth import HTTPDigestAuth
+
+    app = Flask(__name__)
+    auth = HTTPDigestAuth()
+
+    users = {
+        "john": "hello",
+        "susan": "bye"
+    }
+
+    @auth.get_password
+    def get_pw(username):
+        if username in users:
+            return users[username]
+        return None
+        
+    @app.route('/')
+    @auth.login_required
+    def index():
+        return "Hello, %s!" % auth.username
+        
+    if __name__ == '__main__':
+        app.run()
+
+Limitations
+-----------
+
+In Digest authentication there is currently no provision to validate that the nonce sent by the client is the same one sent by the server.
+
+
+License
+-------
+
+(the BSD license)
+
+Copyright (c) 2013, Miguel Grinberg
+All rights reserved.
+
+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 THE COPYRIGHT HOLDERS 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 THE COPYRIGHT OWNER 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.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies, 
+either expressed or implied, of the Flask-HTTPAuth Project.