atoakm  3.2.0
ATOMAS atoakm
Keystore Properties

Properties defining some keystore api behaviours. More...

Typedefs

typedef struct _ato_ksProperties ato_ksProperties
 The keystore properties object retrieved using ato_ks_properties().
 

Functions

ATO_AKM_EXPORT ato_ksPropertiesato_ksprop_create (void)
 Create a properties object. More...
 
ATO_AKM_EXPORT void * ato_ksprop_free (ato_ksProperties *ksprop)
 Free a properties object. More...
 
ATO_AKM_EXPORT const char * ato_ksprop_ver (const ato_ksProperties *ksprop)
 Get the keystore version. More...
 
ATO_AKM_EXPORT const char * ato_ksprop_salt (const ato_ksProperties *ksprop)
 Get the keystore salt. More...
 
ATO_AKM_EXPORT const char * ato_ksprop_PbeMode (const ato_ksProperties *ksprop)
 Get the pbe mode. More...
 
ATO_AKM_EXPORT void ato_ksprop_PbeMode_Set (ato_Ctx *ctx, ato_ksProperties *ksprop, const char *pbemode)
 Set the pbe mode. More...
 
ATO_AKM_EXPORT const char * ato_ksprop_var (ato_ksProperties *ksprop, const char *name)
 Get the named value (string). More...
 
ATO_AKM_EXPORT void ato_ksprop_var_set (ato_ksProperties *ksprop, const char *name, const char *value)
 Set the named value (string) More...
 
ATO_AKM_EXPORT const char * ato_ksprop_varn_checkIntegrityValue (void)
 Name for variable checkIntegrityValue. More...
 

Detailed Description

Properties defining some keystore api behaviours.

Function Documentation

◆ ato_ksprop_create()

ATO_AKM_EXPORT ato_ksProperties* ato_ksprop_create ( void  )

Create a properties object.

Returns
the newly created object or NULL if memory failure

◆ ato_ksprop_free()

ATO_AKM_EXPORT void* ato_ksprop_free ( ato_ksProperties ksprop)

Free a properties object.

Parameters
kspropthe properties object.
Returns
NULL.

◆ ato_ksprop_ver()

ATO_AKM_EXPORT const char* ato_ksprop_ver ( const ato_ksProperties ksprop)

Get the keystore version.

Parameters
kspropthe properties object associated with a keystore.
Returns
the version of the keystore or NULL if not associated with a keystore.

◆ ato_ksprop_salt()

ATO_AKM_EXPORT const char* ato_ksprop_salt ( const ato_ksProperties ksprop)

Get the keystore salt.

Parameters
kspropthe properties object.
Returns
the salt of the keystore or NULL if not associated with a keystore.

◆ ato_ksprop_PbeMode()

ATO_AKM_EXPORT const char* ato_ksprop_PbeMode ( const ato_ksProperties ksprop)

Get the pbe mode.

Parameters
kspropthe properties object.
Returns
pbemode

◆ ato_ksprop_PbeMode_Set()

ATO_AKM_EXPORT void ato_ksprop_PbeMode_Set ( ato_Ctx ctx,
ato_ksProperties ksprop,
const char *  pbemode 
)

Set the pbe mode.

Do not use unless advised as this can cause compatibility issues with the website. If pbemode is NULL then the call is ignored.

Parameters
ctxthe current thread local Context.
kspropthe properties object.
pbemodethe pbe mode as a string.

◆ ato_ksprop_var()

ATO_AKM_EXPORT const char* ato_ksprop_var ( ato_ksProperties ksprop,
const char *  name 
)

Get the named value (string).

Parameters
kspropthe properties object.
namevariable name - case sensitive.
Returns
variable value.

◆ ato_ksprop_var_set()

ATO_AKM_EXPORT void ato_ksprop_var_set ( ato_ksProperties ksprop,
const char *  name,
const char *  value 
)

Set the named value (string)

Parameters
kspropthe properties object.
namevariable name - case sensitive.
value- variable value.

◆ ato_ksprop_varn_checkIntegrityValue()

ATO_AKM_EXPORT const char* ato_ksprop_varn_checkIntegrityValue ( void  )

Name for variable checkIntegrityValue.

Returns
variable name.