Download the PHP package bayfrontmedia/php-jwt without Composer
On this page you can find all versions of the php package bayfrontmedia/php-jwt. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bayfrontmedia/php-jwt
More information about bayfrontmedia/php-jwt
Files in bayfrontmedia/php-jwt
Package php-jwt
Short Description A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519.
License MIT
Homepage https://github.com/bayfrontmedia/php-jwt
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-jwt
PHP-JWT
A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to RFC 7519.
Currently, the only supported algorithm is "HS256". Support for additional algorithms is planned for future versions.
- License
- Author
- Requirements
- Installation
- Usage
License
This project is open source and available under the MIT License.
Author
Requirements
- PHP
^8.0 - JSON PHP extension
Installation
Usage
A private, reproducible secret must be passed to the constructor. The same secret used to encode the JWT must also be used when decoding in order to verify the signature.
A cryptographically secure secret can be generated using the static createSecret() method, if needed.
Public methods
- createSecret
- getHeader
- setHeader
- removeHeader
- getPayload
- setPayload
- removePayload
- aud
- exp
- iat
- iss
- jti
- nbf
- sub
- encode
- decode
- validateSignature
- validateClaims
createSecret
Description:
Create a cryptographically secure secret of random bytes.
NOTE: Secrets are meant to be stored, as the same secret used to encode a JWT must be used to decode it.
Parameters:
$characters = 32(int): Number of characters
Returns:
- (string)
Throws:
Exception
Example:
getHeader
Description:
Returns current header array.
Parameters:
- None
Returns:
- (array)
Example:
setHeader
Description:
Set custom value(s) to the current header array.
Parameters:
$header(array): Key/value pairs to set to the header array
Returns:
- (self)
Example:
removeHeader
Description:
Remove header key, if existing.
Parameters:
$key(string)
Returns:
- (self)
Example:
getPayload
Description:
Returns current payload array.
Parameters:
- None
Returns:
- (array)
Example:
setPayload
Description:
Set custom value(s) to the current payload array.
Parameters:
$payload(array): Key/value pairs to set to the payload array
Returns:
- (self)
Example:
removePayload
Description:
Remove payload key, if existing.
Parameters:
$key(string)
Returns:
- (self)
Example:
aud
Description:
Set audience.
Parameters:
$aud(string)
Returns:
- (self)
exp
Description:
Set expiration time.
Parameters:
$exp(int)
Returns:
- (self)
iat
Description:
Set issued at time.
Parameters:
$iat(int)
Returns:
- (self)
iss
Description:
Set issuer.
Parameters:
$iss(string)
Returns:
- (self)
jti
Description:
Set JWT ID.
Parameters:
$jti(string)
Returns:
- (self)
nbf
Description:
Set not before time.
Parameters:
$nbf(int)
Returns:
- (self)
sub
Description:
Set subject.
Parameters:
$sub(string)
Returns:
- (self)
encode
Description:
Encode and return a signed JWT.
Parameters:
$payload = [](array)
Returns:
- (string)
Example:
decode
Description:
Decode a JWT.
This method validates the token structure as three segments separated by dots.
The returned array will contain the keys header, payload and signature.
If $validate = true, the signature and claims will also be validated.
Parameters:
$jwt(string): The JWT itself or the entireAuthorizationheader can be used$validate = true(bool): Validate signature and claims
Returns:
- (array)
Throws:
Bayfront\JWT\TokenException
Example:
validateSignature
Description:
Validate signature.
Parameters:
$jwt(string): The JWT itself or the entireAuthorizationheader can be used
Returns:
- (self)
Throws:
Bayfront\JWT\TokenException
Example:
validateClaims
Description:
Validate the claims "iat", "nbf" and "exp", if existing.
Parameters:
$jwt(string): The JWT itself or the entireAuthorizationheader can be used
Returns:
- (self)
Throws:
Bayfront\JWT\TokenException
Example:
All versions of php-jwt with dependencies
ext-json Version *