Skip to content

Commit

Permalink
Merge branch 'release/1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
lcobucci committed Mar 8, 2014
2 parents cc98635 + d1d167f commit a7c2f95
Show file tree
Hide file tree
Showing 31 changed files with 3,427 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.buildpath
.project
.settings/
vendor
build
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
language: php
php:
- 5.5
before_script:
- composer selfupdate
- composer install --prefer-dist -o
49 changes: 46 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
jwt
===
# JWT

A simple library to work with JSON Web Token and JSON Web Signature
master [![Build Status](https://secure.travis-ci.org/lcobucci/jwt.png?branch=master)](http://travis-ci.org/#!/lcobucci/jwt)
develop [![Build Status](https://secure.travis-ci.org/lcobucci/jwt.png?branch=develop)](http://travis-ci.org/#!/lcobucci/jwt)

[![Total Downloads](https://poser.pugx.org/lcobucci/jwt/downloads.png)](https://packagist.org/packages/lcobucci/jwt)
[![Latest Stable Version](https://poser.pugx.org/lcobucci/jwt/v/stable.png)](https://packagist.org/packages/lcobucci/jwt)

A simple library to work with JSON Web Token and JSON Web Signature (requires PHP 5.5+)

## Instalation

Just add to your composer.json: ```"lcobucci/jwt": "1.x"```

## Basic usage

### Creating

Just use the builder to create a new JWT/JWS tokens:

```php
<?php
use Lcobucci\JWT\Builder;
use Lcobucci\JWT\Signer\Sha256;

$token = (new Builder())->setIssuer('http://example.com') // Configures the issuer (iss claim)
->setAudience('http://example.org') // Configures the audience (aud claim)
->setId('4f1g23a12aa', true) // Configures the id (jti claim), replicating as a header item
->set('uid', 1) // Configures a new claim, called "uid"
->sign(new Sha256(), 'my key') // Signs the token with HS256 using "my key" as key
->getToken(); // Retrieves the generated token

echo $token; // The string representation of the object is a JWT string (pretty easy, right?)
```
### Parsing from strings

Use the parser to create a new token from a JWT string:

```php
<?php
use Lcobucci\JWT\Parser;

$token = (new Parser())->parse('...'); // Parses from a string
$token->getHeader(); // Retrieves the token header
$token->getClaims(); // Retrieves the token claims
$token->verify('my key'); // Verifies if the signature was created with given key (if token is signed)
```
27 changes: 27 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"name" : "lcobucci/jwt",
"description" : "A simple library to work with JSON Web Token and JSON Web Signature",
"type" : "library",
"authors" : [{
"name" : "Luís Otávio Cobucci Oblonczyk",
"email" : "[email protected]",
"role": "Developer"
}
],
"keywords" : ["JWT", "JWS"],
"license" : ["BSD-3-Clause"],
"require" : {
"php" : ">=5.5"
},
"require-dev" : {
"phpunit/phpunit" : "4.0.x",
"squizlabs/php_codesniffer" : "*",
"phpmd/phpmd" : "*"
},
"autoload" : {
"psr-4" : {
"Lcobucci\\JWT\\" : "src",
"Lcobucci\\JWT\\Test\\" : "test"
}
}
}
Loading

0 comments on commit a7c2f95

Please sign in to comment.