gnunet_reclaim_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2017 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_RECLAIM_ATTRIBUTE_LIB_H
#define GNUNET_RECLAIM_ATTRIBUTE_LIB_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
enum GNUNET_RECLAIM_AttributeType {
  GNUNET_RECLAIM_ATTRIBUTE_TYPE_NONE = 0,
 
  GNUNET_RECLAIM_ATTRIBUTE_TYPE_STRING = 1
};
 
enum GNUNET_RECLAIM_CredentialType {
  GNUNET_RECLAIM_CREDENTIAL_TYPE_NONE = 0,
 
  GNUNET_RECLAIM_CREDENTIAL_TYPE_JWT = 1,
 
  GNUNET_RECLAIM_CREDENTIAL_TYPE_PABC = 2
};
 
#define GNUNET_RECLAIM_ID_LENGTH (256 / 8)
 
GNUNET_NETWORK_STRUCT_BEGIN
struct GNUNET_RECLAIM_Identifier
{
  char id[GNUNET_RECLAIM_ID_LENGTH];
};
 
GNUNET_NETWORK_STRUCT_END
 
static const struct GNUNET_RECLAIM_Identifier GNUNET_RECLAIM_ID_ZERO;
 
#define GNUNET_RECLAIM_id_is_equal(a,b) ((0 == \
                                          memcmp (a, \
                                                  b, \
                                                  sizeof (GNUNET_RECLAIM_ID_ZERO))) \
                                         ? \
                                         GNUNET_YES : GNUNET_NO)
 
 
#define GNUNET_RECLAIM_id_is_zero(a) GNUNET_RECLAIM_id_is_equal (a, \
                                                                 & \
                                                                 GNUNET_RECLAIM_ID_ZERO)
 
#define GNUNET_RECLAIM_id_generate(id) \
  (GNUNET_CRYPTO_random_block (GNUNET_CRYPTO_QUALITY_STRONG, \
                               id, \
                               sizeof (GNUNET_RECLAIM_ID_ZERO)))
 
struct GNUNET_RECLAIM_Attribute
{
  struct GNUNET_RECLAIM_Identifier id;
 
  struct GNUNET_RECLAIM_Identifier credential;
 
  uint32_t type;
 
  uint32_t flag;
 
  const char *name;
 
  size_t data_size;
 
  const void *data;
};
 
struct GNUNET_RECLAIM_Credential
{
  struct GNUNET_RECLAIM_Identifier id;
 
  uint32_t type;
 
  uint32_t flag;
 
  const char *name;
 
  size_t data_size;
 
  const void *data;
};
 
 
struct GNUNET_RECLAIM_Presentation
{
  struct GNUNET_RECLAIM_Identifier credential_id;
 
  uint32_t type;
 
  size_t data_size;
 
  const void *data;
};
 
 
 
struct GNUNET_RECLAIM_AttributeList
{
  struct GNUNET_RECLAIM_AttributeListEntry *list_head;
 
  struct GNUNET_RECLAIM_AttributeListEntry *list_tail;
};
 
 
struct GNUNET_RECLAIM_AttributeListEntry
{
  struct GNUNET_RECLAIM_AttributeListEntry *prev;
 
  struct GNUNET_RECLAIM_AttributeListEntry *next;
 
  struct GNUNET_RECLAIM_Attribute *attribute;
 
};
 
struct GNUNET_RECLAIM_CredentialList
{
  struct GNUNET_RECLAIM_CredentialListEntry *list_head;
 
  struct GNUNET_RECLAIM_CredentialListEntry *list_tail;
};
 
 
struct GNUNET_RECLAIM_CredentialListEntry
{
  struct GNUNET_RECLAIM_CredentialListEntry *prev;
 
  struct GNUNET_RECLAIM_CredentialListEntry *next;
 
  struct GNUNET_RECLAIM_Credential *credential;
 
};
 
 
struct GNUNET_RECLAIM_PresentationList
{
  struct GNUNET_RECLAIM_PresentationListEntry *list_head;
 
  struct GNUNET_RECLAIM_PresentationListEntry *list_tail;
};
 
 
struct GNUNET_RECLAIM_PresentationListEntry
{
  struct GNUNET_RECLAIM_PresentationListEntry *prev;
 
  struct GNUNET_RECLAIM_PresentationListEntry *next;
 
  struct GNUNET_RECLAIM_Presentation *presentation;
 
};
 
 
 
struct GNUNET_RECLAIM_Attribute *
GNUNET_RECLAIM_attribute_new (const char *attr_name,
                              const struct
                              GNUNET_RECLAIM_Identifier *credential,
                              uint32_t type,
                              const void *data,
                              size_t data_size);
 
 
size_t
GNUNET_RECLAIM_attribute_list_serialize_get_size (
  const struct GNUNET_RECLAIM_AttributeList *attrs);
 
 
void
GNUNET_RECLAIM_attribute_list_destroy (
  struct GNUNET_RECLAIM_AttributeList *attrs);
 
 
void
GNUNET_RECLAIM_attribute_list_add (
  struct GNUNET_RECLAIM_AttributeList *attrs,
  const char *attr_name,
  const struct GNUNET_RECLAIM_Identifier *credential,
  uint32_t type,
  const void *data,
  size_t data_size);
 
 
size_t
GNUNET_RECLAIM_attribute_list_serialize (
  const struct GNUNET_RECLAIM_AttributeList *attrs,
  char *result);
 
 
struct GNUNET_RECLAIM_AttributeList *
GNUNET_RECLAIM_attribute_list_deserialize (const char *data, size_t data_size);
 
size_t
GNUNET_RECLAIM_attribute_serialize_get_size (
  const struct GNUNET_RECLAIM_Attribute *attr);
 
 
size_t
GNUNET_RECLAIM_attribute_serialize (const struct GNUNET_RECLAIM_Attribute *attr,
                                    char *result);
 
 
ssize_t
GNUNET_RECLAIM_attribute_deserialize (const char *data, size_t data_size,
                                      struct GNUNET_RECLAIM_Attribute **attr);
 
 
struct GNUNET_RECLAIM_AttributeList *
GNUNET_RECLAIM_attribute_list_dup (
  const struct GNUNET_RECLAIM_AttributeList *attrs);
 
 
uint32_t
GNUNET_RECLAIM_attribute_typename_to_number (const char *typename);
 
int
GNUNET_RECLAIM_attribute_string_to_value (uint32_t type,
                                          const char *s,
                                          void **data,
                                          size_t *data_size);
 
 
char *
GNUNET_RECLAIM_attribute_value_to_string (uint32_t type,
                                          const void *data,
                                          size_t data_size);
 
const char *
GNUNET_RECLAIM_attribute_number_to_typename (uint32_t type);
 
 
size_t
GNUNET_RECLAIM_credential_list_serialize_get_size (
  const struct GNUNET_RECLAIM_CredentialList *credentials);
 
 
void
GNUNET_RECLAIM_credential_list_destroy (
  struct GNUNET_RECLAIM_CredentialList *credentials);
 
 
void
GNUNET_RECLAIM_credential_list_add (
  struct GNUNET_RECLAIM_CredentialList *attrs,
  const char *att_name,
  uint32_t type,
  const void *data,
  size_t data_size);
 
 
size_t
GNUNET_RECLAIM_credential_list_serialize (
  const struct GNUNET_RECLAIM_CredentialList *credentials,
  char *result);
 
 
struct GNUNET_RECLAIM_CredentialList *
GNUNET_RECLAIM_credential_list_deserialize (const char *data,
                                             size_t data_size);
 
 
size_t
GNUNET_RECLAIM_credential_serialize_get_size (
  const struct GNUNET_RECLAIM_Credential *credential);
 
 
size_t
GNUNET_RECLAIM_credential_serialize (
  const struct GNUNET_RECLAIM_Credential *credential,
  char *result);
 
 
struct GNUNET_RECLAIM_Credential *
GNUNET_RECLAIM_credential_deserialize (const char *data, size_t data_size);
 
 
struct GNUNET_RECLAIM_Credential *
GNUNET_RECLAIM_credential_new (const char *name,
                                uint32_t type,
                                const void *data,
                                size_t data_size);
 
char *
GNUNET_RECLAIM_credential_value_to_string (uint32_t type,
                                            const void *data,
                                            size_t data_size);
 
int
GNUNET_RECLAIM_credential_string_to_value (uint32_t type,
                                            const char *s,
                                            void **data,
                                            size_t *data_size);
 
const char *
GNUNET_RECLAIM_credential_number_to_typename (uint32_t type);
 
uint32_t
GNUNET_RECLAIM_credential_typename_to_number (const char *typename);
 
struct GNUNET_RECLAIM_AttributeList*
GNUNET_RECLAIM_credential_get_attributes (const struct
                                           GNUNET_RECLAIM_Credential *cred);
 
char*
GNUNET_RECLAIM_credential_get_issuer (const struct
                                       GNUNET_RECLAIM_Credential *cred);
 
int
GNUNET_RECLAIM_credential_get_expiration (const struct
                                           GNUNET_RECLAIM_Credential *cred,
                                           struct GNUNET_TIME_Absolute *exp);
 
size_t
GNUNET_RECLAIM_presentation_list_serialize_get_size (
  const struct GNUNET_RECLAIM_PresentationList *presentations);
 
 
void
GNUNET_RECLAIM_presentation_list_destroy (
  struct GNUNET_RECLAIM_PresentationList *presentations);
 
 
size_t
GNUNET_RECLAIM_presentation_list_serialize (
  const struct GNUNET_RECLAIM_PresentationList *presentations,
  char *result);
 
 
struct GNUNET_RECLAIM_PresentationList *
GNUNET_RECLAIM_presentation_list_deserialize (const char *data,
                                              size_t data_size);
 
 
size_t
GNUNET_RECLAIM_presentation_serialize_get_size (
  const struct GNUNET_RECLAIM_Presentation *presentation);
 
 
size_t
GNUNET_RECLAIM_presentation_serialize (
  const struct GNUNET_RECLAIM_Presentation *presentation,
  char *result);
 
 
struct GNUNET_RECLAIM_Presentation *
GNUNET_RECLAIM_presentation_deserialize (const char *data, size_t data_size);
 
 
char *
GNUNET_RECLAIM_presentation_value_to_string (uint32_t type,
                                             const void *data,
                                             size_t data_size);
 
struct GNUNET_RECLAIM_Presentation *
GNUNET_RECLAIM_presentation_new (uint32_t type,
                                 const void *data,
                                 size_t data_size);
 
int
GNUNET_RECLAIM_presentation_string_to_value (uint32_t type,
                                             const char *s,
                                             void **data,
                                             size_t *data_size);
 
const char *
GNUNET_RECLAIM_presentation_number_to_typename (uint32_t type);
 
uint32_t
GNUNET_RECLAIM_presentation_typename_to_number (const char *typename);
 
struct GNUNET_RECLAIM_AttributeList*
GNUNET_RECLAIM_presentation_get_attributes (const struct
                                           GNUNET_RECLAIM_Presentation *cred);
 
char*
GNUNET_RECLAIM_presentation_get_issuer (const struct
                                       GNUNET_RECLAIM_Presentation *cred);
 
int
GNUNET_RECLAIM_presentation_get_expiration (const struct
                                           GNUNET_RECLAIM_Presentation *cred,
                                           struct GNUNET_TIME_Absolute *exp);
 
 
struct GNUNET_RECLAIM_PresentationList *
GNUNET_RECLAIM_presentation_list_dup (
  const struct GNUNET_RECLAIM_PresentationList *al);
 
int
GNUNET_RECLAIM_credential_get_presentation (
                              const struct GNUNET_RECLAIM_Credential *cred,
                              const struct GNUNET_RECLAIM_AttributeList *attrs,
                              struct GNUNET_RECLAIM_Presentation **presentation);
 
struct GNUNET_RECLAIM_CredentialList *
GNUNET_RECLAIM_credential_list_dup (
  const struct GNUNET_RECLAIM_CredentialList *al);
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
 
/* ifndef GNUNET_RECLAIM_ATTRIBUTE_LIB_H */
#endif
 /* end of group reclaim-attribute */
 /* end of group addition */
 
/* end of gnunet_reclaim_attribute_lib.h */