gnunet_abd_service.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2012-2014 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_ABD_SERVICE_H
#define GNUNET_ABD_SERVICE_H
 
#include "gnunet_util_lib.h"
#include "gnunet_gns_service.h"
#include "gnunet_identity_service.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
struct GNUNET_ABD_Handle;
 
struct GNUNET_ABD_Request;
 
/*
* Enum used for checking whether the issuer has the authority to issue credentials or is just a subject
*/
enum GNUNET_ABD_CredentialFlags
{
 
  // Subject had credentials before, but have been revoked now
  GNUNET_ABD_FLAG_REVOKED=0,
 
  // Subject flag indicates that the subject is a holder of this credential and may present it as such
  GNUNET_ABD_FLAG_SUBJECT=1,
 
  // Issuer flag is used to signify that the subject is allowed to issue this credential and delegate issuance
  GNUNET_ABD_FLAG_ISSUER=2
 
};
 
GNUNET_NETWORK_STRUCT_BEGIN
struct GNUNET_ABD_DelegationRecord
{
 
  uint32_t set_count;
 
  uint64_t data_size;
};
 
struct GNUNET_ABD_DelegationRecordSet
{
 
  struct GNUNET_IDENTITY_PublicKey subject_key;
 
  uint32_t subject_attribute_len;
};
 
 
GNUNET_NETWORK_STRUCT_END
 
struct GNUNET_ABD_DelegationSet
{
 
  struct GNUNET_IDENTITY_PublicKey subject_key;
 
  uint32_t subject_attribute_len;
 
  const char *subject_attribute;
};
 
 
struct GNUNET_ABD_Delegation
{
 
  struct GNUNET_IDENTITY_PublicKey issuer_key;
 
  struct GNUNET_IDENTITY_PublicKey subject_key;
 
  uint32_t issuer_attribute_len;
 
  const char *issuer_attribute;
 
  uint32_t subject_attribute_len;
 
  const char *subject_attribute;
};
 
 
struct GNUNET_ABD_Delegate
{
 
  struct GNUNET_IDENTITY_PublicKey issuer_key;
 
  struct GNUNET_IDENTITY_PublicKey subject_key;
 
  struct GNUNET_IDENTITY_Signature signature;
 
  struct GNUNET_TIME_Absolute expiration;
 
  uint32_t issuer_attribute_len;
 
  const char *issuer_attribute;
 
  uint32_t subject_attribute_len;
 
  const char *subject_attribute;
 
};
 
/*
* Enum used for checking whether the issuer has the authority to issue credentials or is just a subject
*/
enum GNUNET_ABD_AlgoDirectionFlags
{
 
  // Subject had credentials before, but have been revoked now
  GNUNET_ABD_FLAG_FORWARD=1 << 0,
 
  // Subject flag indicates that the subject is a holder of this credential and may present it as such
  GNUNET_ABD_FLAG_BACKWARD=1 << 1
 
};
 
struct GNUNET_ABD_Handle *
GNUNET_ABD_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
void
GNUNET_ABD_disconnect (struct GNUNET_ABD_Handle *handle);
 
 
typedef void (*GNUNET_ABD_CredentialResultProcessor) (void *cls,
                                                      unsigned int d_count,
                                                      struct
                                                      GNUNET_ABD_Delegation *
                                                      delegation_chain,
                                                      unsigned int c_count,
                                                      struct GNUNET_ABD_Delegate
                                                      *delegte);
 
typedef void (*GNUNET_ABD_IntermediateResultProcessor) (void *cls,
                                                        struct
                                                        GNUNET_ABD_Delegation *
                                                        delegation,
                                                        bool is_bw);
 
typedef void (*GNUNET_ABD_DelegateResultProcessor) (void *cls,
                                                    uint32_t success);
 
typedef void (*GNUNET_ABD_RemoveDelegateResultProcessor) (void *cls,
                                                          uint32_t success);
 
 
struct GNUNET_ABD_Request*
  GNUNET_ABD_verify (struct GNUNET_ABD_Handle *handle,
                     const struct GNUNET_IDENTITY_PublicKey *issuer_key,
                     const char *issuer_attribute,
                     const struct GNUNET_IDENTITY_PublicKey *subject_key,
                     uint32_t delegate_count,
                     const struct GNUNET_ABD_Delegate *delegates,
                     enum GNUNET_ABD_AlgoDirectionFlags direction,
                     GNUNET_ABD_CredentialResultProcessor proc,
                     void *proc_cls,
                     GNUNET_ABD_IntermediateResultProcessor,
                     void *proc2_cls);
 
struct GNUNET_ABD_Request*
  GNUNET_ABD_collect (struct GNUNET_ABD_Handle *handle,
                      const struct GNUNET_IDENTITY_PublicKey *issuer_key,
                      const char *issuer_attribute,
                      const struct GNUNET_IDENTITY_PrivateKey *subject_key,
                      enum GNUNET_ABD_AlgoDirectionFlags direction,
                      GNUNET_ABD_CredentialResultProcessor proc,
                      void *proc_cls,
                      GNUNET_ABD_IntermediateResultProcessor,
                      void *proc2_cls);
 
struct GNUNET_ABD_Request *
GNUNET_ABD_add_delegation (struct GNUNET_ABD_Handle *handle,
                           struct GNUNET_IDENTITY_Ego *issuer,
                           const char *attribute,
                           struct GNUNET_IDENTITY_PublicKey *subject,
                           const char *delegated_attribute,
                           GNUNET_ABD_DelegateResultProcessor proc,
                           void *proc_cls);
 
struct GNUNET_ABD_Request *
GNUNET_ABD_remove_delegation (struct GNUNET_ABD_Handle *handle,
                              struct GNUNET_IDENTITY_Ego *issuer,
                              const char *attribute,
                              GNUNET_ABD_RemoveDelegateResultProcessor proc,
                              void *proc_cls);
 
 
struct GNUNET_ABD_Delegate*
GNUNET_ABD_delegate_issue (const struct GNUNET_IDENTITY_PrivateKey *issuer,
                           struct GNUNET_IDENTITY_PublicKey *subject,
                           const char *iss_attr,
                           const char *sub_attr,
                           struct GNUNET_TIME_Absolute *expiration);
 
 
void
GNUNET_ABD_request_cancel (struct GNUNET_ABD_Request *lr);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */