summaryrefslogtreecommitdiff
path: root/src/credential/credential_serialization.h
blob: 7f6d0dda9f9a6912fde56cd57b983cdbd91ed91b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
     This file is part of GNUnet.
     Copyright (C) 2009-2013, 2016 GNUnet e.V.

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 3, 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
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
     Boston, MA 02110-1301, USA.
*/


/**
 * @file credential/credential_serialization.h
 * @brief API to serialize and deserialize delegation chains 
 * and credentials
 * @author Martin Schanzenbach
 */
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_constants.h"
#include "gnunet_credential_service.h"

/**
 * Calculate how many bytes we will need to serialize
 * the given delegation record
 *
 * @param ds_count number of delegation chain entries
 * @param dsr array of #GNUNET_CREDENTIAL_Delegation
 * @return the required size to serialize
 */
size_t
GNUNET_CREDENTIAL_delegation_set_get_size (unsigned int ds_count,
                                           const struct GNUNET_CREDENTIAL_DelegationSetRecord *dsr);

/**
 * Serizalize the given delegation record entries
 *
 * @param d_count number of delegation chain entries
 * @param dsr array of #GNUNET_CREDENTIAL_Delegation
 * @param dest_size size of the destination
 * @param dest where to store the result
 * @return the size of the data, -1 on failure
 */
ssize_t
GNUNET_CREDENTIAL_delegation_set_serialize (unsigned int d_count,
                                            const struct GNUNET_CREDENTIAL_DelegationSetRecord *dsr,
                                            size_t dest_size,
                                            char *dest);


/**
 * Deserialize the given destination
 *
 * @param len size of the serialized delegation recird
 * @param src the serialized data
 * @param d_count the number of delegation chain entries
 * @param dsr where to put the delegation chain entries
 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
 */
int
GNUNET_CREDENTIAL_delegation_set_deserialize (size_t len,
                                              const char *src,
                                              unsigned int d_count,
                                              struct GNUNET_CREDENTIAL_DelegationSetRecord *dsr);

  /**
   * Calculate how many bytes we will need to serialize
   * the given delegation chain and credential
   *
   * @param d_count number of delegation chain entries
   * @param dd array of #GNUNET_CREDENTIAL_Delegation
   * @param cd a #GNUNET_CREDENTIAL_Credential
   * @return the required size to serialize
   */
  size_t
    GNUNET_CREDENTIAL_delegation_chain_get_size (unsigned int d_count,
                                                 const struct GNUNET_CREDENTIAL_Delegation *dd,
                                                 const struct GNUNET_CREDENTIAL_Credential *cd);

  /**
   * Serizalize the given delegation chain entries and credential
   *
   * @param d_count number of delegation chain entries
   * @param dd array of #GNUNET_CREDENTIAL_Delegation
   * @param cd a #GNUNET_CREDENTIAL_Credential
   * @param dest_size size of the destination
   * @param dest where to store the result
   * @return the size of the data, -1 on failure
   */
  ssize_t
    GNUNET_CREDENTIAL_delegation_chain_serialize (unsigned int d_count,
                                                  const struct GNUNET_CREDENTIAL_Delegation *dd,
                                                  const struct GNUNET_CREDENTIAL_Credential *cd,
                                                  size_t dest_size,
                                                  char *dest);


  /**
   * Deserialize the given destination
   *
   * @param len size of the serialized delegation chain and cred
   * @param src the serialized data
   * @param d_count the number of delegation chain entries
   * @param dd where to put the delegation chain entries
   * @param cd where to put the credential data
   * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
   */
  int
    GNUNET_CREDENTIAL_delegation_chain_deserialize (size_t len,
                                                    const char *src,
                                                    unsigned int d_count,
                                                    struct GNUNET_CREDENTIAL_Delegation *dd,
                                                    struct GNUNET_CREDENTIAL_Credential *cd);
  /* end of credential_serialization.h */