OpenDOF Project
Modules | Files | Data Structures | Typedefs | Enumerations | Functions
DOFAuthenticator
Distributed Object Framework (DOF)

This class represents security support in the DOF. More...

Modules

 DOFAuthenticatorConfig
 This class represents an authenticator configuration.
 
 DOFAuthenticatorNode
 This class represents a authenticator node, an authenticating entity with assigned credentials and permissions.
 
 DOFAuthenticatorState
 Represents the instantaneous state of a DOFAuthenticator.
 
 DOFAuthenticatorStorage
 This class represents the back-end storage of authenticator nodes.
 

Files

file  oal.h
 Header file for the C OAL functions, defines and data types.
 

Data Structures

struct  DOFAuthenticatorNodePermissionSetMapElement
 DOFAuthenticatorNodePermissionSetMapElement contains the set of permissions associated with a Permission Group ID. More...
 
struct  DOFAuthenticatorNodePermissionSetMap
 DOFAuthenticatorNodePermissionSetMap_t represents the permissions for a node. More...
 
struct  DOFAuthenticatorList
 DOF Authenticators List structure. More...
 

Typedefs

typedef struct DOFAuthenticator_t * DOFAuthenticator
 A representation of a standard DOF Authenticator.
 
typedef struct
DOFAuthenticatorConfig_t * 
DOFAuthenticatorConfig
 Authenticator configuration.
 
typedef struct
DOFAuthenticatorConfigBuilder_t * 
DOFAuthenticatorConfigBuilder
 Authenticator configuration Builder.
 
typedef struct
DOFAuthenticatorState_t * 
DOFAuthenticatorState
 Authenticator state.
 

Enumerations

enum  DOFAuthenticatorSecurityType {
  DOFAUTHENTICATORSECURITYTYPE_UNDEFINED,
  DOFAUTHENTICATORSECURITYTYPE_TWO_POINT,
  DOFAUTHENTICATORSECURITYTYPE_MULTI_POINT,
  DOFAUTHENTICATORSECURITYTYPE_ANY
}
 The type of security associated with a security request. More...
 

Functions

void DOFAuthenticator_Destroy (DOFAuthenticator self)
 Destroy a DOFAuthenticator.
 
DOFAuthenticatorState DOFAuthenticator_CreateState (const DOFAuthenticator self)
 Create a authenticator state from the given authenticator.
 
uint8DOFAuthenticator_CreateSessionKey (void)
 Generates a new, random, secure session key.
 
void DOFAuthenticatorList_Destroy (DOFAuthenticatorList self)
 Destroy a DOFAuthenticatorList.
 

Detailed Description

This class represents security support in the DOF.

Security in the DOF is tied to a domain, which consists of at least a domain identifier and some credentials. This class also manages callbacks represents a domains storage.

Without at least a single domain or authenticator, a DOF cannot accept secure connections.

Each Authenticator that is created must be destroyed using DOFAuthenticator_Destroy.

core-c-dof-oal Version 7.1.5 Build 0
2017-01-25