LTI Integration Library 5.2.0
PHP class library for building LTI integrations
 
Loading...
Searching...
No Matches
ceLTIc\LTI\Jwt\Jwt Class Reference

Class to represent an HTTP message request. More...

Public Member Functions

 __construct ()
 Class constructor.
 

Static Public Member Functions

static void setJwtClient (?ClientInterface $jwtClient=null)
 Set the JWT client to use for handling JWTs.
 
static ClientInterface null getJwtClient ()
 Get the JWT client to use for handling JWTs.
 

Static Public Attributes

static int $life = 60
 Life (in seconds) of an issued JWT (default is 1 minute).
 
static int $leeway = 180
 Leeway (in seconds) to allow when checking timestamps (default is 3 minutes).
 
static bool $allowJkuHeader = false
 Allow use of jku header in JWT.
 

Detailed Description

Class to represent an HTTP message request.

Author
Stephen P Vickers steph.nosp@m.en@s.nosp@m.pvsof.nosp@m.twar.nosp@m.eprod.nosp@m.ucts.nosp@m..com
Licence: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3

Constructor & Destructor Documentation

◆ __construct()

ceLTIc\LTI\Jwt\Jwt::__construct ( )

Class constructor.

Member Function Documentation

◆ getJwtClient()

static ClientInterface null ceLTIc\LTI\Jwt\Jwt::getJwtClient ( )
static

Get the JWT client to use for handling JWTs.

If one is not set, a default client is created.

Returns
ClientInterface|null The JWT client

◆ setJwtClient()

static void ceLTIc\LTI\Jwt\Jwt::setJwtClient ( ?ClientInterface $jwtClient = null)
static

Set the JWT client to use for handling JWTs.

Parameters
ClientInterface | null$jwtClient

Member Data Documentation

◆ $allowJkuHeader

bool ceLTIc\LTI\Jwt\Jwt::$allowJkuHeader = false
static

Allow use of jku header in JWT.

$allowJkuHeader

Referenced by ceLTIc\LTI\Jwt\WebTokenClient\verify().

◆ $leeway

int ceLTIc\LTI\Jwt\Jwt::$leeway = 180
static

Leeway (in seconds) to allow when checking timestamps (default is 3 minutes).

$leeway

Referenced by ceLTIc\LTI\Jwt\WebTokenClient\getPayload(), and ceLTIc\LTI\Jwt\FirebaseClient\verify().

◆ $life

int ceLTIc\LTI\Jwt\Jwt::$life = 60
static

Life (in seconds) of an issued JWT (default is 1 minute).

$life