atostm 3.2.0
ATOMAS atostm
STM Token

API for the Security Token returned by the STS service. More...

Typedefs

typedef struct _ato_StmTkn ato_StmTkn
 The Security Token object.
 

Functions

ATO_STM_EXPORT ato_Stringato_stmtkn_xml (ato_StmTkn *st)
 Given a SecurityToken object, serialise the data - see also ato_stm_loadst(). More...
 
ATO_STM_EXPORT const char * ato_stmtkn_key (ato_StmTkn *st)
 Given a SecurityToken object, retrieve the key used in an ST cache. More...
 
ATO_STM_EXPORT ato_Stringato_stmtkn_prooftoken (ato_StmTkn *st)
 Given a SecurityToken object, retrieve the embedded proof token. More...
 
ATO_STM_EXPORT ato_Stringato_stmtkn_assertion (ato_StmTkn *st)
 Given a SecurityToken object, retrieve the encrypted assertion. More...
 
ATO_STM_EXPORT const char * ato_stmtkn_samlid (ato_StmTkn *st)
 Given a SecurityToken object, retrieve the Assertion (SAML) ID. More...
 
ATO_STM_EXPORT bool ato_stmtkn_isexpired (ato_StmTkn *st)
 Check if the SecurityToken has expired - see also ato_stm_setexpirytime() and ato_stmtkn_expirytime(). More...
 
ATO_STM_EXPORT time_t ato_stmtkn_expirytime (ato_StmTkn *st)
 Get the local time the SecurityToken is to expire - see also ato_stmtkn_isexpired() and ato_stm_setexpirytime(). More...
 

Detailed Description

API for the Security Token returned by the STS service.

Function Documentation

◆ ato_stmtkn_xml()

ATO_STM_EXPORT ato_String * ato_stmtkn_xml ( ato_StmTkn st)

Given a SecurityToken object, serialise the data - see also ato_stm_loadst().

Parameters
stthe SecurityToken.
Returns
The ATO RSTR serialised SecurityToken.

◆ ato_stmtkn_key()

ATO_STM_EXPORT const char * ato_stmtkn_key ( ato_StmTkn st)

Given a SecurityToken object, retrieve the key used in an ST cache.

Parameters
stthe SecurityToken.
Returns
ST key.

◆ ato_stmtkn_prooftoken()

ATO_STM_EXPORT ato_String * ato_stmtkn_prooftoken ( ato_StmTkn st)

Given a SecurityToken object, retrieve the embedded proof token.

Parameters
stthe SecurityToken.
Returns
Proof Token.

◆ ato_stmtkn_assertion()

ATO_STM_EXPORT ato_String * ato_stmtkn_assertion ( ato_StmTkn st)

Given a SecurityToken object, retrieve the encrypted assertion.

Parameters
stthe SecurityToken.
Returns
Assertion.

◆ ato_stmtkn_samlid()

ATO_STM_EXPORT const char * ato_stmtkn_samlid ( ato_StmTkn st)

Given a SecurityToken object, retrieve the Assertion (SAML) ID.

This is stored in the KeyIdentifier Element of the RSTR.

Parameters
stthe SecurityToken.
Returns
Assertion (SAML) ID.

◆ ato_stmtkn_isexpired()

ATO_STM_EXPORT bool ato_stmtkn_isexpired ( ato_StmTkn st)

Check if the SecurityToken has expired - see also ato_stm_setexpirytime() and ato_stmtkn_expirytime().

Parameters
stthe SecurityToken.
Returns
TRUE or FALSE.

◆ ato_stmtkn_expirytime()

ATO_STM_EXPORT time_t ato_stmtkn_expirytime ( ato_StmTkn st)

Get the local time the SecurityToken is to expire - see also ato_stmtkn_isexpired() and ato_stm_setexpirytime().

Parameters
stthe SecurityToken.
Returns
the expiry time (granularity is seconds).