mirror of
https://github.com/elyby/oauth2-server.git
synced 2024-12-23 05:29:52 +05:30
Merge branch 'release/0.1' into develop
This commit is contained in:
commit
c92dc8f759
44
README.md
44
README.md
@ -1,7 +1,43 @@
|
|||||||
# PHP OAuth server
|
# PHP OAuth Framework
|
||||||
|
|
||||||
The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) server that supports a number of different authentication flows, and two extensions, [JSON web tokens](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-json-web-token/) and [SAML assertions](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-saml2-bearer/).
|
The goal of this project is to develop a standards compliant [OAuth 2](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-v2/) authentication server, resource server and client library with support for a major OAuth 2 providers.
|
||||||
|
|
||||||
The library will be a [composer](http://getcomposer.org/) package and will be framework agnostic.
|
## Package Installation
|
||||||
|
|
||||||
This code will be developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which has been funded by [JISC](http://jisc.ac.uk) under the access and identity management programme.
|
The framework is provided as a Composer package which can be installed by adding the package to your composer.json file:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
"require": {
|
||||||
|
"lncd\Oauth2": "*"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Package Integration
|
||||||
|
|
||||||
|
Check out the [wiki](https://github.com/lncd/OAuth2/wiki)
|
||||||
|
|
||||||
|
## Current Features
|
||||||
|
|
||||||
|
### Authentication Server
|
||||||
|
|
||||||
|
The authentication server is a flexible class that supports the standard authorization code grant.
|
||||||
|
|
||||||
|
### Resource Server
|
||||||
|
|
||||||
|
The resource server allows you to secure your API endpoints by checking for a valid OAuth access token in the request and ensuring the token has the correct permission to access resources.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Future Goals
|
||||||
|
|
||||||
|
### Authentication Server
|
||||||
|
|
||||||
|
* Support for [JSON web tokens](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-json-web-token/).
|
||||||
|
* Support for [SAML assertions](http://tools.ietf.org/wg/oauth/draft-ietf-oauth-saml2-bearer/).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This code will be developed as part of the [Linkey](http://linkey.blogs.lincoln.ac.uk) project which has been funded by [JISC](http://jisc.ac.uk) under the Access and Identity Management programme.
|
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "lncd/Oauth2",
|
"name": "lncd/Oauth2",
|
||||||
"description": "OAuth 2.0 server - UNDER DEVELOPMENT - NOT READY FOR PRIMETIME",
|
"description": "OAuth 2.0 Framework",
|
||||||
"version": "0.0.1",
|
"version": "0.1",
|
||||||
"homepage": "https://github.com/lncd/OAuth2",
|
"homepage": "https://github.com/lncd/OAuth2",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"require": {
|
"require": {
|
||||||
@ -19,7 +19,10 @@
|
|||||||
"keywords": [
|
"keywords": [
|
||||||
"oauth",
|
"oauth",
|
||||||
"oauth2",
|
"oauth2",
|
||||||
"server"
|
"server",
|
||||||
|
"authorization",
|
||||||
|
"authentication",
|
||||||
|
"resource"
|
||||||
],
|
],
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user