wamp::Challenge Class Reference

Provides the AuthMethod and Extra dictionary contained within WAMP CHALLENGE messages. More...

#include <cppwamp/peerdata.hpp>

Inheritance diagram for wamp::Challenge:

Public Member Functions
	Challenge ()
	Constructs an empty challenge.
bool	challengeeHasExpired () const
	Determines if the Session object that dispatched this invocation still exists or has expired.
const String &	method () const
	Obtains the authentication method string.
Variant	challenge () const
	Returns an optional challenge string. More...
Variant	salt () const
	Returns an optional salt string. More...
Variant	keyLength () const
	Returns an optional key length. More...
Variant	iterations () const
	Returns an optional iteration count. More...
Variant	kdf () const
	Returns an optional key derivation function (KDF) identifier. More...
Variant	memory () const
	Returns an optional KDF memory cost factor integer. More...
void	authenticate (Authentication auth)
	Sends an AUTHENTICATE message back in response to the challenge.

Detailed Description

Provides the AuthMethod and Extra dictionary contained within WAMP CHALLENGE messages.

See Authentication in the WAMP specification

Member Function Documentation

challenge()

Variant wamp::Challenge::challenge

(

)

const

Returns an optional challenge string.

This function returns the value of the CHALLENGE.Details.challenge|string detail used by the WAMP-CRA authentication method.

Returns

A string variant if the challenge string is available. Otherwise, a null variant is returned.

salt()

Variant wamp::Challenge::salt

(

)

const

Returns an optional salt string.

This function returns the value of the CHALLENGE.Details.salt|string detail used by the WAMP-CRA authentication method.

Returns

A string variant if the salt is available. Otherwise, a null variant is returned.

keyLength()

Variant wamp::Challenge::keyLength

(

)

const

Returns an optional key length.

This function returns the value of the CHALLENGE.Details.keylen|integer detail used by the WAMP-CRA authentication method.

Returns

An integer variant if the key length is available. Otherwise, a null variant is returned.

iterations()

Variant wamp::Challenge::iterations

(

)

const

Returns an optional iteration count.

This function returns the value of the CHALLENGE.Details.iterations|integer detail used by the WAMP-CRA and WAMP-SCRAM authentication methods.

Returns

An integer variant if the iteration count is available. Otherwise, a null variant is returned.

kdf()

Variant wamp::Challenge::kdf

(

)

const

Returns an optional key derivation function (KDF) identifier.

This function returns the value of the CHALLENGE.Details.kdf|string detail used by the WAMP-SCRAM authentication method.

Returns

A string variant if the KDF identifier is available. Otherwise, a null variant is returned.

memory()

Variant wamp::Challenge::memory

(

)

const

Returns an optional KDF memory cost factor integer.

This function returns the value of the CHALLENGE.Details.memory|integer detail used by the WAMP-SCRAM authentication method for the Argon2 KDF.

Returns

An integer variant if the memory cost factor is available. Otherwise, a null variant is returned.

---

The documentation for this class was generated from the following files:

• cppwamp/peerdata.hpp
• cppwamp/internal/peerdata.ipp