Shared classes for interacting with Cesium ion and iTwin APIs. More...

Classes
struct	OAuth2ClientOptions
	Options used to configure the OAuth2 authentication process. More...

class	OAuth2PKCE
	Class for authenticating with an API that uses OAuth2 Proof of Key Code Exchange (PKCE). More...

struct	OAuth2TokenResponse
	Tokens obtained from a successful OAuth2 authentication operation. More...

Functions
bool	parseErrorResponse (const std::span< const std::byte > &body, std::string &outError, std::string &outErrorDesc)
	Attempts to parse a JSON error response from the provided buffer.

void	fillWithRandomBytes (const std::span< uint8_t > &buffer)
	Fills the provided buffer with random bytes using a cryptographically secure psuedorandom number generator (CSPRNG).

Detailed Description

Shared classes for interacting with Cesium ion and iTwin APIs.

--- comment: This file was generated by dep-graph-gen. DO NOT EDIT THIS FILE! title: CesiumClientCommon Dependency Graph --- graph TD classDef dependencyNode fill:#fff,stroke:#ccc,color:#666,font-weight:bold,font-size:28px classDef libraryNode fill:#9f9,font-weight:bold,font-size:28px CesiumClientCommon[CesiumClientCommon] --> CesiumAsync[CesiumAsync] CesiumClientCommon[CesiumClientCommon] --> CesiumUtility[CesiumUtility] CesiumClientCommon[CesiumClientCommon] --> OpenSSL_Crypto{{OpenSSL::Crypto}} CesiumClientCommon[CesiumClientCommon] --> httplib_httplib{{httplib::httplib}} CesiumClientCommon[CesiumClientCommon] --> modp_b64_modp_b64{{modp_b64::modp_b64}} CesiumClientCommon[CesiumClientCommon] --> picosha2_picosha2{{picosha2::picosha2}} class OpenSSL_Crypto,httplib_httplib,modp_b64_modp_b64,picosha2_picosha2 dependencyNode class CesiumAsync,CesiumUtility,CesiumClientCommon libraryNode

Function Documentation

◆ fillWithRandomBytes()

void CesiumClientCommon::fillWithRandomBytes ( const std::span< uint8_t > & buffer )

Fills the provided buffer with random bytes using a cryptographically secure psuedorandom number generator (CSPRNG).

Parameters

buffer The buffer to fill with bytes.

Exceptions

std::runtime_error Throws a runtime error if the call to the CSPRNG fails.

◆ parseErrorResponse()

bool CesiumClientCommon::parseErrorResponse	(	const std::span< const std::byte > &	body,
		std::string &	outError,
		std::string &	outErrorDesc )

Attempts to parse a JSON error response from the provided buffer.

Two schemas of JSON error document are supported.

Simple

{
    "error": "error_code",
    "error_description": "A longer user-friendly error message."
}

error becomes outError and error_description becomes outErrorDesc.

Detailed

{
    "error": {
        "code": "error_code",
        "message": "A longer user-friendly error message.",
        "details": [
            {
                "code": "error_code",
                "message": "A longer user-friendly error message.",
                "target": "field_name"
            }
        ]
    }
}

error.code becomes outError. error.message and any entries in error.details are combined together into outErrorDesc.