10Duke Enterprise C++ SDK
Loading...
Searching...
No Matches
tenduke::oidc::BaseOIDCRequest Class Reference

#include <BaseOIDCRequest.h>

Detailed Description

Base class for OIDC requests.

Inheritance diagram for tenduke::oidc::BaseOIDCRequest:
tenduke::oidc::DefaultOIDCBrowserFlowAuthenticationRequest tenduke::oidc::DefaultOIDCRefreshRequest tenduke::oidc::device::DefaultOIDCDeviceAuthenticationRequest tenduke::oidc::ropg::OIDCResourceOwnerPasswordRequest

Public Member Functions

 BaseOIDCRequest (const std::shared_ptr< const tenduke::oidc::OIDCConfiguration > &oidcConfiguration, std::string clientId, const std::shared_ptr< const tenduke::jwt::JWTParser > &jwtParser, const std::shared_ptr< tenduke::time::Clock > &clock, std::string nonce)
 Constructs new instance.

Protected Member Functions

virtual std::unique_ptr< tenduke::oidc::OIDCState > toOIDCState (tenduke::oauth::OAuthState &oauthState) const
 Creates OIDCState from OAuthState.
virtual tenduke::oidc::IdToken parseIdToken (const std::string &serializedIdToken, const std::string &expectedNonce) const
 Parses id token.
virtual void validateAudience (const tenduke::oidc::IdToken &idToken) const
 Validates ID-token "aud" and "azp" claims against the client id.
virtual void validateTimes (const tenduke::oidc::IdToken &idToken) const
 Validates ID-token time claims "exp" (required), "nbf" and "iat" against current time, allowing clock skew of OIDCConfiguration::allowedClockSkewS.

Static Protected Member Functions

static std::vector< std::string > getAudiences (const tenduke::oidc::IdToken &idToken)
 Returns the ID-token audiences: "aud" can be a single string or an array of strings.

Protected Attributes

const std::shared_ptr< const tenduke::oidc::OIDCConfiguration > oidcConfiguration
 OIDC-configuration.
const std::string clientId
 OAuth client id of this client, expected in ID-token "aud" (and "azp") claim.
const std::shared_ptr< const tenduke::jwt::JWTParser > parseJWT
 JWT parser.
const std::shared_ptr< tenduke::time::Clock > clock
 Clock for validating ID-token time claims.

Constructor & Destructor Documentation

◆ BaseOIDCRequest()

tenduke::oidc::BaseOIDCRequest::BaseOIDCRequest ( const std::shared_ptr< const tenduke::oidc::OIDCConfiguration > & oidcConfiguration,
std::string clientId,
const std::shared_ptr< const tenduke::jwt::JWTParser > & jwtParser,
const std::shared_ptr< tenduke::time::Clock > & clock,
std::string nonce )

Constructs new instance.

Parameters
oidcConfiguration-
clientIdOAuth client id of this client. The ID-token audience must contain it.
jwtParser-
clockclock for validating ID-token time claims
nonce-

Member Function Documentation

◆ getAudiences()

std::vector< std::string > tenduke::oidc::BaseOIDCRequest::getAudiences ( const tenduke::oidc::IdToken & idToken)
staticprotected

Returns the ID-token audiences: "aud" can be a single string or an array of strings.

Parameters
idToken-
Returns
the audiences, empty if "aud" is not present

◆ parseIdToken()

IdToken tenduke::oidc::BaseOIDCRequest::parseIdToken ( const std::string & serializedIdToken,
const std::string & expectedNonce ) const
protectedvirtual

Parses id token.

Parameters
serializedIdToken-
expectedNonce-
Returns
-

◆ toOIDCState()

std::unique_ptr<::OIDCState > tenduke::oidc::BaseOIDCRequest::toOIDCState ( tenduke::oauth::OAuthState & oauthState) const
protectedvirtual

Creates OIDCState from OAuthState.

Parameters
oauthState-
Returns
-

◆ validateAudience()

void tenduke::oidc::BaseOIDCRequest::validateAudience ( const tenduke::oidc::IdToken & idToken) const
protectedvirtual

Validates ID-token "aud" and "azp" claims against the client id.

Parameters
idToken-
Exceptions
tenduke::oidc::OIDCExceptionif the ID-token is not issued to this client

◆ validateTimes()

void tenduke::oidc::BaseOIDCRequest::validateTimes ( const tenduke::oidc::IdToken & idToken) const
protectedvirtual

Validates ID-token time claims "exp" (required), "nbf" and "iat" against current time, allowing clock skew of OIDCConfiguration::allowedClockSkewS.

Parameters
idToken-
Exceptions
tenduke::oidc::OIDCExceptionif the ID-token is expired, not yet valid or issued in the future

The documentation for this class was generated from the following files:
  • core/oidc/core/src/oidc/impl/BaseOIDCRequest.h
  • core/oidc/core/src/oidc/impl/BaseOIDCRequest.cpp