JWT Documentation

JWT (JSON Web Token) Documentation

JWT (JSON Web Token) is a compact, URL-safe means of representing claims to be transferred between two parties. It is commonly used for authentication and authorization purposes in web applications.

Usage

To generate and verify JWT tokens, you can follow the example below:

use webrium\Jwt;

// Create a new instance of the Jwt class
$jwt = new Jwt('your-secret-key');

// Generate a JWT token
$payload = [
    'user_id' => 123,
    'username' => 'john.doe@example.com'
];
$token = $jwt->generateToken($payload);

// Verify a JWT token
$decodedPayload = $jwt->verifyToken($token);
if ($decodedPayload) {
    // Token is valid
    echo "Token is valid!";
    print_r($decodedPayload);
} else {
    // Token is invalid
    echo "Token is invalid!";
}

Class Methods

Constructor

__construct(string $secretKey, string $algorithm = 'sha3-256')

• Creates a new instance of the Jwt class.
• Parameters:
  • $secretKey: The secret key used to sign the token.
  • $algorithm (optional): The algorithm used to sign the token (default: sha3-256).

generateToken

generateToken(array $payload): string

• Generates a JWT token.
• Parameters:
  • $payload: The payload to include in the token.
• Returns: The generated JWT token as a string.

verifyToken

verifyToken(string $jwt): mixed

• Verifies a JWT token.
• Parameters:
  • $jwt: The JWT token to verify.
• Returns:
  • If the token is valid, returns the decoded payload as an array.
  • If the token is invalid, returns false.

Important Notes

• Make sure to keep your secret key secure and do not share it.
• Always validate and sanitize user inputs before generating or verifying tokens.
• Keep your JWT library up-to-date with the latest security patches.

That's it! You can now start using the JWT library in your PHP projects. For more information and advanced usage, refer to the official JWT documentation.