OpenDOF Project
Typedefs | Enumerations | Functions
DOFCredentials
Distributed Object Framework (DOF)

Typedefs

typedef struct DOFCredentials_t * DOFCredentials
 Authentication credentials (identity, secret, etc.).
 

Enumerations

enum  DOFCredentialsType {
  DOFCREDENTIALSTYPE_NONE,
  DOFCREDENTIALSTYPE_KEY,
  DOFCREDENTIALSTYPE_PASSWORD
}
 The type of credentials (password, secret, etc.). More...
 

Functions

DOFCredentials DOFCredentialsKey_Create (const DOFObjectIDDomain domainID, const DOFObjectIDAuthentication identity, const uint8 key[32])
 Creates new credentials that use a key as the secret.
 
DOFCredentials DOFCredentialsPassword_Create (const DOFObjectIDDomain domainID, const DOFObjectIDAuthentication identity, const char *password)
 Creates new credentials that use a password as the secret.
 
DOFCredentials DOFCredentials_Create (DOFCredentials creds, DOFObjectIDDomain domainID)
 Creates a new credentials that will use the given credentials for resolution in the given domain.
 
DOFCredentials DOFCredentials_Copy (const DOFCredentials self)
 Creates a new copy of an existing DOFCredentials.
 
void DOFCredentials_Destroy (DOFCredentials self)
 Destroys a DOFCredentials object.
 
DOFCredentialsType DOFCredentials_GetType (const DOFCredentials self)
 Retrieves the type of credentials represented by the given DOFCredentials.
 
DOFObjectIDDomain DOFCredentials_GetDomainID (const DOFCredentials self)
 Returns the domain in which the credentials are valid.
 
DOFObjectIDAuthentication DOFCredentials_GetIdentity (const DOFCredentials self)
 Returns the identity of the authorized user.
 
const uint8DOFCredentials_GetStorageKey (const DOFCredentials self)
 Returns the storage key used by the credentials for lookup.
 
uint32 DOFCredentials_GetStorageKeySize (const DOFCredentials self)
 Returns the size of the storage key used by the credentials.
 
boolean DOFCredentials_IsResolved (const DOFCredentials self)
 Reports whether or not the credentials are resolved, meaning that they contain a valid (not Broadcast) domain ID, valid identity, and a 256-bit shared secret.
 
const uint8DOFCredentials_GetPrivateStorage (const DOFCredentials self)
 Returns the byte array that can be stored into an authentication server datastore and used to verify the credentials during authentication.
 
uint32 DOFCredentials_GetPrivateStorageSize (const DOFCredentials self)
 Returns size of the private storage byte array.
 
boolean DOFCredentials_SetPrivateStorage (const DOFCredentials self, uint32 dataSize, const uint8 *data)
 Sets the private storage from the AS storage.
 
uint32 DOFCredentials_GetByteSize (DOFCredentials self)
 Gets the length of a byte array for the given DOFCredentials.
 
uint8DOFCredentials_CreateBytes (DOFCredentials self)
 Creates a byte array for the given DOFCredentials that can be used to recreate it at a later time.
 
DOFCredentials DOFCredentials_Create_Bytes (uint32 size, const uint8 *buffer)
 Creates a DOFCredentials object from a properly formatted byte array.
 

Detailed Description

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