# Authpack

*Package of distributed client and server OAuth2 API's*

### Under development!!! By far not stable yet!!!

TODO:

  - Implement more tests, check latest OAuth2 draft and compare to current implementation 
  - Add more documentation
  - Add example(s)
  - Add OpenId connect implementation
  - Add client implementations (javascript server, browser, maybe others)

## What is Authpack?

Authpack is an open-source project that uses User Agents (i.e. browsers), [node.js](http://nodejs.org) and Open Source Packages to implement the OAuth 2.0 Authorization Protocol as defined by the IETF. Later also OpenID Connect will be added.  

## How does it work?

TODO

## Where can I run Authpack?

Authpack can be used as Authentication and Authorization building block for client and server applications. 

## Installation

Get Authpack from NPM with:

````
npm install authpack
````

Or get Authpack from GitHub and then install the start scripts and all needed packages with:

````
git clone git://github.com/stolsma/authpack.git
cd authpack
npm install
````

# User Documentation

Authpack user documentation is still very much a work in progress. We'll be actively updating the documentation in the upcoming months to make it easier to get acclimated with `Authpack`.

*To be added*

# Authpack API

*To be added*


Documentation License
=====================

Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License

http://creativecommons.org/licenses/by-nc-sa/3.0/

Copyright (c)2011 [TTC](http://www.tolsma.net)/[Sander Tolsma](http://sander.tolsma.net/)


Code License
============

[MIT License](http://www.opensource.org/licenses/mit-license.php)

Copyright (c)2011 [TTC](http://www.tolsma.net)/[Sander Tolsma](http://sander.tolsma.net/)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.