GNUnet 0.22.2
reclaim plugin API for attributes/claims
Collaboration diagram for reclaim plugin API for attributes/claims:

Data Structures

struct  GNUNET_RECLAIM_AttributePluginFunctions
 Each plugin is required to return a pointer to a struct of this type as the return value from its entry point. More...
 
struct  GNUNET_RECLAIM_CredentialPluginFunctions
 Each plugin is required to return a pointer to a struct of this type as the return value from its entry point. More...
 

Typedefs

typedef char *(* GNUNET_RECLAIM_AttributeValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)
 Function called to convert the binary value data of an attribute of type type to a human-readable string. More...
 
typedef int(* GNUNET_RECLAIM_AttributeStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)
 Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation. More...
 
typedef uint32_t(* GNUNET_RECLAIM_AttributeTypenameToNumberFunction) (void *cls, const char *typename)
 Function called to convert a type name to the corresponding number. More...
 
typedef const char *(* GNUNET_RECLAIM_AttributeNumberToTypenameFunction) (void *cls, uint32_t type)
 Function called to convert a type number to the corresponding type string (e.g. More...
 
typedef char *(* GNUNET_RECLAIM_CredentialValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)
 Function called to convert the binary value data of an attribute of type type to a human-readable string. More...
 
typedef int(* GNUNET_RECLAIM_CredentialStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)
 Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation. More...
 
typedef uint32_t(* GNUNET_RECLAIM_CredentialTypenameToNumberFunction) (void *cls, const char *typename)
 Function called to convert a type name to the corresponding number. More...
 
typedef const char *(* GNUNET_RECLAIM_CredentialNumberToTypenameFunction) (void *cls, uint32_t type)
 Function called to convert a type number to the corresponding type string (e.g. More...
 
typedef struct GNUNET_RECLAIM_AttributeList *(* GNUNET_RECLAIM_CredentialGetAttributesFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred)
 Function called to extract attributes from a credential. More...
 
typedef char *(* GNUNET_RECLAIM_CredentialGetIssuerFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred)
 Function called to get the issuer of the credential (as string) More...
 
typedef int(* GNUNET_RECLAIM_CredentialGetExpirationFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred, struct GNUNET_TIME_Absolute *expiration)
 Function called to get the expiration of the credential. More...
 
typedef char *(* GNUNET_RECLAIM_PresentationValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)
 Function called to convert the binary value data of an attribute of type type to a human-readable string. More...
 
typedef int(* GNUNET_RECLAIM_PresentationStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)
 Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation. More...
 
typedef uint32_t(* GNUNET_RECLAIM_PresentationTypenameToNumberFunction) (void *cls, const char *typename)
 Function called to convert a type name to the corresponding number. More...
 
typedef const char *(* GNUNET_RECLAIM_PresentationNumberToTypenameFunction) (void *cls, uint32_t type)
 Function called to convert a type number to the corresponding type string (e.g. More...
 
typedef struct GNUNET_RECLAIM_AttributeList *(* GNUNET_RECLAIM_PresentationGetAttributesFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred)
 Function called to extract attributes from a credential. More...
 
typedef char *(* GNUNET_RECLAIM_PresentationGetIssuerFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred)
 Function called to get the issuer of the credential (as string) More...
 
typedef int(* GNUNET_RECLAIM_PresentationGetExpirationFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred, struct GNUNET_TIME_Absolute *expiration)
 Function called to get the expiration of the credential. More...
 
typedef int(* GNUNET_RECLAIM_CredentialToPresentation) (void *cls, const struct GNUNET_RECLAIM_Credential *cred, const struct GNUNET_RECLAIM_AttributeList *attrs, struct GNUNET_RECLAIM_Presentation **presentation)
 

Detailed Description

Typedef Documentation

◆ GNUNET_RECLAIM_AttributeValueToStringFunction

typedef char *(* GNUNET_RECLAIM_AttributeValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)

Function called to convert the binary value data of an attribute of type type to a human-readable string.

Parameters
clsclosure
typetype of the attribute
datavalue in binary encoding
data_sizenumber of bytes in data
Returns
NULL on error, otherwise human-readable representation of the value

Definition at line 58 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_AttributeStringToValueFunction

typedef int(* GNUNET_RECLAIM_AttributeStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)

Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation.

Parameters
clsclosure
typetype of the attribute
shuman-readable string
dataset to value in binary encoding (will be allocated)
data_sizeset to number of bytes in data
Returns
GNUNET_OK on success

Definition at line 77 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_AttributeTypenameToNumberFunction

typedef uint32_t(* GNUNET_RECLAIM_AttributeTypenameToNumberFunction) (void *cls, const char *typename)

Function called to convert a type name to the corresponding number.

Parameters
clsclosure
typenamename to convert
Returns
corresponding number, UINT32_MAX on error

Definition at line 93 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_AttributeNumberToTypenameFunction

typedef const char *(* GNUNET_RECLAIM_AttributeNumberToTypenameFunction) (void *cls, uint32_t type)

Function called to convert a type number to the corresponding type string (e.g.

1 to "A")

Parameters
clsclosure
typenumber of a type to convert
Returns
corresponding typestring, NULL on error

Definition at line 106 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialValueToStringFunction

typedef char *(* GNUNET_RECLAIM_CredentialValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)

Function called to convert the binary value data of an attribute of type type to a human-readable string.

Parameters
clsclosure
typetype of the attribute
datavalue in binary encoding
data_sizenumber of bytes in data
Returns
NULL on error, otherwise human-readable representation of the value

Definition at line 120 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialStringToValueFunction

typedef int(* GNUNET_RECLAIM_CredentialStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)

Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation.

Parameters
clsclosure
typetype of the attribute
shuman-readable string
dataset to value in binary encoding (will be allocated)
data_sizeset to number of bytes in data
Returns
GNUNET_OK on success

Definition at line 139 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialTypenameToNumberFunction

typedef uint32_t(* GNUNET_RECLAIM_CredentialTypenameToNumberFunction) (void *cls, const char *typename)

Function called to convert a type name to the corresponding number.

Parameters
clsclosure
typenamename to convert
Returns
corresponding number, UINT32_MAX on error

Definition at line 155 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialNumberToTypenameFunction

typedef const char *(* GNUNET_RECLAIM_CredentialNumberToTypenameFunction) (void *cls, uint32_t type)

Function called to convert a type number to the corresponding type string (e.g.

1 to "A")

Parameters
clsclosure
typenumber of a type to convert
Returns
corresponding typestring, NULL on error

Definition at line 168 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialGetAttributesFunction

typedef struct GNUNET_RECLAIM_AttributeList *(* GNUNET_RECLAIM_CredentialGetAttributesFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred)

Function called to extract attributes from a credential.

Parameters
clsclosure
credthe credential object
Returns
an attribute list

Definition at line 168 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialGetIssuerFunction

typedef char *(* GNUNET_RECLAIM_CredentialGetIssuerFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred)

Function called to get the issuer of the credential (as string)

Parameters
clsclosure
credthe credential object
Returns
corresponding issuer string

Definition at line 192 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialGetExpirationFunction

typedef int(* GNUNET_RECLAIM_CredentialGetExpirationFunction) (void *cls, const struct GNUNET_RECLAIM_Credential *cred, struct GNUNET_TIME_Absolute *expiration)

Function called to get the expiration of the credential.

Parameters
clsclosure
credthe credential object
whereto write the value
Returns
GNUNET_OK if successful

Definition at line 204 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationValueToStringFunction

typedef char *(* GNUNET_RECLAIM_PresentationValueToStringFunction) (void *cls, uint32_t type, const void *data, size_t data_size)

Function called to convert the binary value data of an attribute of type type to a human-readable string.

Parameters
clsclosure
typetype of the attribute
datavalue in binary encoding
data_sizenumber of bytes in data
Returns
NULL on error, otherwise human-readable representation of the value

Definition at line 219 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationStringToValueFunction

typedef int(* GNUNET_RECLAIM_PresentationStringToValueFunction) (void *cls, uint32_t type, const char *s, void **data, size_t *data_size)

Function called to convert human-readable version of the value s of an attribute of type type to the respective binary representation.

Parameters
clsclosure
typetype of the attribute
shuman-readable string
dataset to value in binary encoding (will be allocated)
data_sizeset to number of bytes in data
Returns
GNUNET_OK on success

Definition at line 238 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationTypenameToNumberFunction

typedef uint32_t(* GNUNET_RECLAIM_PresentationTypenameToNumberFunction) (void *cls, const char *typename)

Function called to convert a type name to the corresponding number.

Parameters
clsclosure
typenamename to convert
Returns
corresponding number, UINT32_MAX on error

Definition at line 254 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationNumberToTypenameFunction

typedef const char *(* GNUNET_RECLAIM_PresentationNumberToTypenameFunction) (void *cls, uint32_t type)

Function called to convert a type number to the corresponding type string (e.g.

1 to "A")

Parameters
clsclosure
typenumber of a type to convert
Returns
corresponding typestring, NULL on error

Definition at line 267 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationGetAttributesFunction

typedef struct GNUNET_RECLAIM_AttributeList *(* GNUNET_RECLAIM_PresentationGetAttributesFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred)

Function called to extract attributes from a credential.

Parameters
clsclosure
credthe credential object
Returns
an attribute list

Definition at line 267 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationGetIssuerFunction

typedef char *(* GNUNET_RECLAIM_PresentationGetIssuerFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred)

Function called to get the issuer of the credential (as string)

Parameters
clsclosure
credthe credential object
Returns
corresponding issuer string

Definition at line 291 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_PresentationGetExpirationFunction

typedef int(* GNUNET_RECLAIM_PresentationGetExpirationFunction) (void *cls, const struct GNUNET_RECLAIM_Presentation *cred, struct GNUNET_TIME_Absolute *expiration)

Function called to get the expiration of the credential.

Parameters
clsclosure
credthe credential object
whereto write the value
Returns
GNUNET_OK if successful

Definition at line 303 of file gnunet_reclaim_plugin.h.

◆ GNUNET_RECLAIM_CredentialToPresentation

typedef int(* GNUNET_RECLAIM_CredentialToPresentation) (void *cls, const struct GNUNET_RECLAIM_Credential *cred, const struct GNUNET_RECLAIM_AttributeList *attrs, struct GNUNET_RECLAIM_Presentation **presentation)

Definition at line 308 of file gnunet_reclaim_plugin.h.