Download the PHP package shawm11/oz-auth without Composer
On this page you can find all versions of the php package shawm11/oz-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shawm11/oz-auth
More information about shawm11/oz-auth
Files in shawm11/oz-auth
Package oz-auth
Short Description PHP implementation of the Oz web authorization protocol
License MIT
Informations about the package oz-auth
Oz Authorization PHP
A PHP implementation of the 5.0.0 version of the Oz web authorization protocol.
[!IMPORTANT] Oz is one of those rare projects that can be considered "complete". This means that changes to this repository be infrequent because only the development dependencies may need to be updated once every few years.
If there is a bug or error in the documentation, please create an issue. The issue will receive a response or be resolved as soon as possible.
Table of Contents
- What is Oz?
- Oz and OAuth 2.0
- Getting Started
- Prerequisites
- Installation
- Workflows
- Usage Examples
- Server Usage Examples
- Client Usage Examples
- Documentation
- API References
- Security Considerations
- Related Projects
- Contributing/Development
- Versioning
- License
What is Oz?
According to the Oz README:
Oz is a web authorization protocol based on industry best practices. Oz combines the Hawk authentication protocol with the Iron encryption protocol to provide a simple to use and secure solution for granting and authenticating third-party access to an API on behalf of a user or an application.
Oz and OAuth 2.0
Oz is an alternative to OAuth 1.0a and OAuth 2.0 three-legged authorization. One of the goals of Oz is to be simple to use for the most common use cases without needing to be a web security expert while being flexible enough for less common use cases that may need more advanced web security knowledge. Oz does this by providing default options that are secure for the most common use cases, in other words Oz aims to be secure by default.
All of the official three-legged OAuth 2.0 grant types have an equivalent Oz workflow. Below is table showing the Oz workflow equivalents for the OAuth 2.0 grant types.
OAuth 2.0 Grant Type | Oz Workflow |
---|---|
Authorization Code | RSVP |
Implicit/PKCE | Implicit (Not an official workflow) |
Resource Owner Password Credentials | User Credentials (Not an official workflow) |
Client Credentials | Hawk |
Getting Started
Prerequisites
- Git 2.9+
- PHP 7.2.0+
- OpenSSL PHP Extension
- JSON PHP Extension
- cURL PHP Extension (Only if using the Oz client)
- Composer
- Node 6.9.0+ (Only for development)
Installation
Download and install using Composer:
Workflows
This package includes two workflows that are not part of the official Oz web authorization protocol. These two new workflows are the User Credentials Workflow and the Implicit Workflow. The standard Oz workflow that is specified by the official protocol is referred to as the "RSVP workflow".
Usage Examples
Server Usage Examples
- RSVP Workflow — Server
- User Credentials Workflow — Server
- Implicit Workflow — Server
- All Workflows — Server
Client Usage Examples
- RSVP Workflow — Client
- User Credentials Workflow — Client
- Implicit Workflow — Client
- All Workflows — Client
Documentation
- RSVP Workflow (Without Delegation) — General overview of the RSVP (standard) workflow when delegation is not being used
- User Credentials Workflow — General overview of the User Credentials workflow
- Implicit Workflow — General overview of the Implicit workflow
API References
- Server API — API reference for the classes
in the
Shawm11\Oz\Server
namespace - Client API — API reference for the classes
in the
Shawm11\Oz\Client
namespace - Shared Arrays — Details about collections of data used in other parts of the API
Security Considerations
See the Security Considerations section of Oz's README.
Related Projects
- Hawk PHP Implementation — Hawk is an HTTP authentication scheme that is an alternative to OAuth 1.0a and OAuth 2.0 two-legged authentication.
- Iron PHP Implementation — iron (spelled with all lowercase), a cryptographic utility for sealing a JSON object into an encapsulated token. iron can be considered as an alternative to JSON Web Tokens (JWT).
Contributing/Development
Please read CONTRIBUTING.md for details on coding style, Git commit message guidelines, and other development information.
Versioning
This project using SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is open-sourced software licensed under the MIT license.
All versions of oz-auth with dependencies
nategood/httpful Version ^1.0
shawm11/hawk-auth Version ^1.0
shawm11/iron-crypto Version ^1.0