OpenDOF Project
Macros | Functions
DOFAuthenticatorConfig
DOFAuthenticator

This class represents an authenticator configuration. More...

Macros

#define DOFAUTHENTICATORCONFIG_DEFAULT_MAX_GRANT_LIFETIME
 Default maximum grant lifetime.
 

Functions

void DOFAuthenticatorConfig_Destroy (DOFAuthenticatorConfig self)
 Destroy a DOFAuthenticatorConfig.
 
DOFObjectIDDomain DOFAuthenticatorConfig_GetDomainID (const DOFAuthenticatorConfig self)
 Get the domain ID associated with the authenticator configuration.
 
uint8 DOFAuthenticatorConfig_GetNodeIdentifier (const DOFAuthenticatorConfig self)
 Get the node identifier associated with the authenticator configuration.
 
DOFAuthenticatorStorage DOFAuthenticatorConfig_GetStorage (const DOFAuthenticatorConfig self)
 Get the storage associated with the authenticator configuration.
 
uint16 DOFAuthenticatorConfig_GetMaxGrantLifetime (const DOFAuthenticatorConfig self)
 Get the maximum grant lifetime associated with the authenticator configuration.
 
const uint8DOFAuthenticatorConfig_GetDebugKey (const DOFAuthenticatorConfig self)
 Get the debug key associated with the authenticator configuration, if any.
 
boolean DOFAuthenticatorConfig_IsDebug (const DOFAuthenticatorConfig self)
 Get the debug mode flag associated with the authenticator configuration.
 

Builder

DOFAuthenticatorConfigBuilder DOFAuthenticatorConfigBuilder_Create (DOFObjectIDDomain domainID, uint8 id, DOFAuthenticatorStorage storage)
 Create a new DOFAuthenticatorConfigBuilder.
 
DOFAuthenticatorConfigBuilder DOFAuthenticatorConfigBuilder_Create_State (DOFAuthenticatorState self)
 Creates a DOFAuthenticatorConfigBuilder from a given state.
 
DOFAuthenticatorConfigBuilder DOFAuthenticatorConfigBuilder_Create_Config (DOFAuthenticatorConfig self)
 Creates a DOFAuthenticatorConfigBuilder from a given config.
 
boolean DOFAuthenticatorConfigBuilder_SetDomainID (DOFAuthenticatorConfigBuilder self, DOFObjectIDDomain domainID)
 Sets the Domain ID for the domain.
 
boolean DOFAuthenticatorConfigBuilder_SetStorage (DOFAuthenticatorConfigBuilder self, DOFAuthenticatorStorage storage)
 Sets the Storage for the authenticator.
 
boolean DOFAuthenticatorConfigBuilder_SetMaxGrantLifetime (DOFAuthenticatorConfigBuilder self, uint16 max)
 Sets the maximum grant lifetime for the authenticator.
 
boolean DOFAuthenticatorConfigBuilder_SetNodeIdentifier (DOFAuthenticatorConfigBuilder self, uint8 id)
 Sets the node identifier for the authenticator.
 
boolean DOFAuthenticatorConfigBuilder_SetDebugKey (DOFAuthenticatorConfigBuilder self, const uint8 key[32])
 Sets the debug mode session key for the authenticator.
 
boolean DOFAuthenticatorConfigBuilder_SetDebug (DOFAuthenticatorConfigBuilder self, boolean isDebug)
 Sets the debug mode flag for the authenticator.
 
DOFAuthenticatorConfig DOFAuthenticatorConfigBuilder_Build (DOFAuthenticatorConfigBuilder self)
 Creates a DOFAuthenticatorConfig from the builder.
 
DOFAuthenticatorConfig DOFAuthenticatorConfigBuilder_BuildAndDestroy (DOFAuthenticatorConfigBuilder self)
 Creates a DOFAuthenticatorConfig from the builder and destroys the builder passed in.
 
void DOFAuthenticatorConfigBuilder_Destroy (DOFAuthenticatorConfigBuilder self)
 Destroy a DOFAuthenticatorConfigBuilder.
 

Detailed Description

This class represents an authenticator configuration.

Each authenticator configuration that is created must be destroyed using DOFAuthenticatorConfig_Destroy.

core-c-dof-oal Version 8.0.1 Build 0
2018-01-22