2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Christian Grothoff
25 * Identity service; implements identity management for GNUnet
27 * @defgroup identity Identity service
28 * Identity management.
30 * Egos in GNUnet are ECDSA keys. You assume an ego by using (signing
31 * with) a particular private key. As GNUnet users are expected to
32 * have many egos, we need an identity service to allow users to
33 * manage their egos. The identity service manages the egos (private
34 * keys) of the local user; it does NOT manage egos of other users
35 * (public keys). For giving names to other users and manage their
36 * public keys securely, we use GNS.
38 * @see [Documentation](https://gnunet.org/identity-subsystem)
42 #ifndef GNUNET_IDENTITY_SERVICE_H
43 #define GNUNET_IDENTITY_SERVICE_H
48 #if 0 /* keep Emacsens' auto-indent happy */
53 #include "gnunet_util_lib.h"
57 * Version number of GNUnet Identity API.
59 #define GNUNET_IDENTITY_VERSION 0x00000000
62 * Handle to access the identity service.
64 struct GNUNET_IDENTITY_Handle;
69 struct GNUNET_IDENTITY_Ego;
72 * Handle for an operation with the identity service.
74 struct GNUNET_IDENTITY_Operation;
78 * Obtain the ECC key associated with a ego.
81 * @return associated ECC key, valid as long as the ego is valid
83 const struct GNUNET_CRYPTO_EcdsaPrivateKey *
84 GNUNET_IDENTITY_ego_get_private_key (const struct GNUNET_IDENTITY_Ego *ego);
88 * Obtain the ego representing 'anonymous' users.
90 * @return handle for the anonymous user, must not be freed
92 const struct GNUNET_IDENTITY_Ego *
93 GNUNET_IDENTITY_ego_get_anonymous (void);
97 * Get the identifier (public key) of an ego.
99 * @param ego identity handle with the private key
100 * @param pk set to ego's public key
103 GNUNET_IDENTITY_ego_get_public_key (const struct GNUNET_IDENTITY_Ego *ego,
104 struct GNUNET_CRYPTO_EcdsaPublicKey *pk);
108 * Method called to inform about the egos of this peer.
110 * When used with #GNUNET_IDENTITY_connect, this function is
111 * initially called for all egos and then again whenever a
112 * ego's name changes or if it is deleted. At the end of
113 * the initial pass over all egos, the function is once called
114 * with 'NULL' for @a ego. That does NOT mean that the callback won't
115 * be invoked in the future or that there was an error.
117 * When used with #GNUNET_IDENTITY_create or #GNUNET_IDENTITY_get,
118 * this function is only called ONCE, and 'NULL' being passed in
119 * @a ego does indicate an error (i.e. name is taken or no default
120 * value is known). If @a ego is non-NULL and if '*ctx'
121 * is set in those callbacks, the value WILL be passed to a subsequent
122 * call to the identity callback of #GNUNET_IDENTITY_connect (if
123 * that one was not NULL).
125 * When an identity is renamed, this function is called with the
126 * (known) @a ego but the NEW @a name.
128 * When an identity is deleted, this function is called with the
129 * (known) ego and "NULL" for the @a name. In this case,
130 * the @a ego is henceforth invalid (and the @a ctx should also be
134 * @param ego ego handle
135 * @param ctx context for application to store data for this ego
136 * (during the lifetime of this process, initially NULL)
137 * @param name name assigned by the user for this ego,
138 * NULL if the user just deleted the ego and it
139 * must thus no longer be used
142 (*GNUNET_IDENTITY_Callback)(void *cls,
143 struct GNUNET_IDENTITY_Ego *ego,
149 * Connect to the identity service.
151 * @param cfg Configuration to contact the identity service.
152 * @param cb function to call on all identity events, can be NULL
153 * @param cb_cls closure for @a cb
154 * @return handle to communicate with identity service
156 struct GNUNET_IDENTITY_Handle *
157 GNUNET_IDENTITY_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
158 GNUNET_IDENTITY_Callback cb,
163 * Obtain the ego that is currently preferred/default for a service.
165 * @param id identity service to query
166 * @param service_name for which service is an identity wanted
167 * @param cb function to call with the result (will only be called once)
168 * @param cb_cls closure for @a cb
169 * @return handle to abort the operation
171 struct GNUNET_IDENTITY_Operation *
172 GNUNET_IDENTITY_get (struct GNUNET_IDENTITY_Handle *id,
173 const char *service_name,
174 GNUNET_IDENTITY_Callback cb,
179 * Function called once the requested operation has
183 * @param emsg NULL on success, otherwise an error message
186 (*GNUNET_IDENTITY_Continuation)(void *cls,
191 * Set the preferred/default ego for a service.
193 * @param id identity service to inform
194 * @param service_name for which service is an identity set
195 * @param ego new default identity to be set for this service
196 * @param cont function to call once the operation finished
197 * @param cont_cls closure for @a cont
198 * @return handle to abort the operation
200 struct GNUNET_IDENTITY_Operation *
201 GNUNET_IDENTITY_set (struct GNUNET_IDENTITY_Handle *id,
202 const char *service_name,
203 struct GNUNET_IDENTITY_Ego *ego,
204 GNUNET_IDENTITY_Continuation cont,
209 * Disconnect from identity service.
211 * @param h identity service to disconnect
214 GNUNET_IDENTITY_disconnect (struct GNUNET_IDENTITY_Handle *h);
218 * Create a new ego with the given name.
220 * @param id identity service to use
221 * @param name desired name
222 * @param cont function to call with the result (will only be called once)
223 * @param cont_cls closure for @a cont
224 * @return handle to abort the operation
226 struct GNUNET_IDENTITY_Operation *
227 GNUNET_IDENTITY_create (struct GNUNET_IDENTITY_Handle *id,
229 GNUNET_IDENTITY_Continuation cont,
234 * Renames an existing ego.
236 * @param id identity service to use
237 * @param old_name old name
238 * @param new_name desired new name
239 * @param cb function to call with the result (will only be called once)
240 * @param cb_cls closure for @a cb
241 * @return handle to abort the operation
243 struct GNUNET_IDENTITY_Operation *
244 GNUNET_IDENTITY_rename (struct GNUNET_IDENTITY_Handle *id,
245 const char *old_name,
246 const char *new_name,
247 GNUNET_IDENTITY_Continuation cb,
252 * Delete an existing ego.
254 * @param id identity service to use
255 * @param name name of the identity to delete
256 * @param cb function to call with the result (will only be called once)
257 * @param cb_cls closure for @a cb
258 * @return handle to abort the operation
260 struct GNUNET_IDENTITY_Operation *
261 GNUNET_IDENTITY_delete (struct GNUNET_IDENTITY_Handle *id,
263 GNUNET_IDENTITY_Continuation cb,
268 * Cancel an identity operation. Note that the operation MAY still
269 * be executed; this merely cancels the continuation; if the request
270 * was already transmitted, the service may still choose to complete
273 * @param op operation to cancel
276 GNUNET_IDENTITY_cancel (struct GNUNET_IDENTITY_Operation *op);
279 /* ************* convenience API to lookup an ego ***************** */
282 * Function called with the result.
285 * @param ego NULL on error / ego not found
288 (*GNUNET_IDENTITY_EgoCallback)(void *cls,
289 const struct GNUNET_IDENTITY_Ego *ego);
292 * Handle for ego lookup.
294 struct GNUNET_IDENTITY_EgoLookup;
298 * Lookup an ego by name.
300 * @param cfg configuration to use
301 * @param name name to look up
302 * @param cb callback to invoke with the result
303 * @param cb_cls closure for @a cb
304 * @return NULL on error
306 struct GNUNET_IDENTITY_EgoLookup *
307 GNUNET_IDENTITY_ego_lookup (const struct GNUNET_CONFIGURATION_Handle *cfg,
309 GNUNET_IDENTITY_EgoCallback cb,
314 * Abort ego lookup attempt.
316 * @param el handle for lookup to abort
319 GNUNET_IDENTITY_ego_lookup_cancel (struct GNUNET_IDENTITY_EgoLookup *el);
322 #if 0 /* keep Emacsens' auto-indent happy */
329 /* ifndef GNUNET_IDENTITY_SERVICE_H */
332 /** @} */ /* end of group identity */
334 /* end of gnunet_identity_service.h */