summaryrefslogtreecommitdiff
path: root/src/identity-provider/identity_attribute.h
blob: 3e8fadccf7e7dd2eb75091c1114fd6e3a0070d39 (plain) (blame)
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
   This file is part of GNUnet.
   Copyright (C) 2012-2015 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.
   */
/**
 * @author Martin Schanzenbach
 * @file identity-provider/identity_attribute.h
 * @brief GNUnet Identity Provider library
 *
 */
#ifndef IDENTITY_ATTRIBUTE_H
#define IDENTITY_ATTRIBUTE_H

#include "gnunet_identity_provider_service.h"

struct Attribute
{
  /**
   * Attribute type
   */
  uint32_t attribute_type;

  /**
   * Attribute version
   */
  uint32_t attribute_version;
  
  /**
   * Name length
   */
  uint32_t name_len;
  
  /**
   * Data size
   */
  uint32_t data_size;

  //followed by data_size Attribute value data
};

/**
 * Get required size for serialization buffer
 *
 * @param attrs the attribute list to serialize
 *
 * @return the required buffer size
 */
size_t
attribute_list_serialize_get_size (const struct GNUNET_IDENTITY_PROVIDER_AttributeList *attrs);

void
attribute_list_destroy (struct GNUNET_IDENTITY_PROVIDER_AttributeList *attrs);


/**
 * Serialize an attribute list
 *
 * @param attrs the attribute list to serialize
 * @param result the serialized attribute
 *
 * @return length of serialized data
 */
size_t
attribute_list_serialize (const struct GNUNET_IDENTITY_PROVIDER_AttributeList *attrs,
                     char *result);

/**
 * Deserialize an attribute list
 *
 * @param data the serialized attribute list
 * @param data_size the length of the serialized data
 *
 * @return a GNUNET_IDENTITY_PROVIDER_AttributeList, must be free'd by caller
 */
struct GNUNET_IDENTITY_PROVIDER_AttributeList *
attribute_list_deserialize (const char* data,
                            size_t data_size);


/**
 * Get required size for serialization buffer
 *
 * @param attr the attribute to serialize
 *
 * @return the required buffer size
 */
size_t
attribute_serialize_get_size (const struct GNUNET_IDENTITY_PROVIDER_Attribute *attr);



/**
 * Serialize an attribute
 *
 * @param attr the attribute to serialize
 * @param result the serialized attribute
 *
 * @return length of serialized data
 */
size_t
attribute_serialize (const struct GNUNET_IDENTITY_PROVIDER_Attribute *attr,
                     char *result);

/**
 * Deserialize an attribute
 *
 * @param data the serialized attribute
 * @param data_size the length of the serialized data
 *
 * @return a GNUNET_IDENTITY_PROVIDER_Attribute, must be free'd by caller
 */
struct GNUNET_IDENTITY_PROVIDER_Attribute *
attribute_deserialize (const char* data,
                       size_t data_size);

/**
 * Create a new attribute.
 *
 * @param name the attribute name
 * @param type the attribute type
 * @param data the attribute value
 * @param data_size the attribute value size
 * @return the new attribute
 */
struct GNUNET_IDENTITY_PROVIDER_Attribute *
attribute_new (const char* attr_name,
               uint32_t attr_type,
               const void* data,
               size_t data_size);

struct GNUNET_IDENTITY_PROVIDER_AttributeList*
attribute_list_dup (const struct GNUNET_IDENTITY_PROVIDER_AttributeList *attrs);

#endif