GNUnet  0.18.1
Typedefs | Functions
Friends library
Backbone

Library to read and write the FRIENDS file. More...

Collaboration diagram for Friends library:

Typedefs

typedef void(* GNUNET_FRIENDS_Callback) (void *cls, const struct GNUNET_PeerIdentity *friend_id)
 Signature of a function called on each friend found. More...
 

Functions

int GNUNET_FRIENDS_parse (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_FRIENDS_Callback cb, void *cb_cls)
 Parse the FRIENDS file. More...
 
struct GNUNET_FRIENDS_Writer * GNUNET_FRIENDS_write_start (const struct GNUNET_CONFIGURATION_Handle *cfg)
 Start writing a fresh FRIENDS file. More...
 
int GNUNET_FRIENDS_write_stop (struct GNUNET_FRIENDS_Writer *w)
 Finish writing out the friends file. More...
 
int GNUNET_FRIENDS_write (struct GNUNET_FRIENDS_Writer *w, const struct GNUNET_PeerIdentity *friend_id)
 Add a friend to the friends file. More...
 

Detailed Description

Library to read and write the FRIENDS file.

Typedef Documentation

◆ GNUNET_FRIENDS_Callback

typedef void(* GNUNET_FRIENDS_Callback) (void *cls, const struct GNUNET_PeerIdentity *friend_id)

Signature of a function called on each friend found.

Parameters
clsclosure
friend_idpeer identity of the friend

Definition at line 55 of file gnunet_friends_lib.h.

Function Documentation

◆ GNUNET_FRIENDS_parse()

int GNUNET_FRIENDS_parse ( const struct GNUNET_CONFIGURATION_Handle *  cfg,
GNUNET_FRIENDS_Callback  cb,
void *  cb_cls 
)

Parse the FRIENDS file.

Parameters
cfgour configuration
cbfunction to call on each friend found
cb_clsclosure for cb
Returns
GNUNET_OK on success, GNUNET_SYSERR on parsing errors

Definition at line 39 of file friends.c.

42 {
43  char *fn;
44  char *data;
45  size_t pos;
46  size_t start;
47  struct GNUNET_PeerIdentity pid;
48  uint64_t fsize;
49  ssize_t ssize;
50 
51  if (GNUNET_OK !=
52  GNUNET_CONFIGURATION_get_value_filename (cfg,
53  "TOPOLOGY",
54  "FRIENDS",
55  &fn))
56  {
57  GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
58  "topology",
59  "FRIENDS");
60  return GNUNET_SYSERR;
61  }
62  if ((GNUNET_OK !=
63  GNUNET_DISK_file_test (fn)) &&
64  (GNUNET_OK !=
65  GNUNET_DISK_fn_write (fn,
66  NULL,
67  0,
68  GNUNET_DISK_PERM_USER_READ
69  | GNUNET_DISK_PERM_USER_WRITE
70  | GNUNET_DISK_OPEN_CREATE)))
71  GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
72  "write",
73  fn);
74  if ((GNUNET_OK !=
75  GNUNET_DISK_file_size (fn,
76  &fsize,
77  GNUNET_NO,
78  GNUNET_YES)) ||
79  (0 == fsize))
80  {
81  GNUNET_free (fn);
82  return GNUNET_OK;
83  }
84  data = GNUNET_malloc_large (fsize);
85  if (NULL == data)
86  {
87  GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "malloc");
88  GNUNET_free (fn);
89  return GNUNET_SYSERR;
90  }
91  ssize = GNUNET_DISK_fn_read (fn,
92  data,
93  fsize);
94  if ((ssize < 0) ||
95  (fsize != (uint64_t) ssize))
96  {
97  GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR,
98  "read",
99  "fn");
100  GNUNET_free (fn);
101  GNUNET_free (data);
102  return GNUNET_SYSERR;
103  }
104  start = 0;
105  pos = 0;
106  while (pos < fsize)
107  {
108  while ((pos < fsize) &&
109  (! isspace ((unsigned char) data[pos])))
110  pos++;
111  if (GNUNET_OK !=
112  GNUNET_CRYPTO_eddsa_public_key_from_string (&data[start],
113  pos - start,
114  &pid.public_key))
115  {
116  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
117  _ (
118  "Syntax error in FRIENDS file at offset %llu, skipping bytes `%.*s'.\n"),
119  (unsigned long long) pos,
120  (int) (pos - start),
121  &data[start]);
122  pos++;
123  start = pos;
124  continue;
125  }
126  pos++;
127  start = pos;
128  cb (cb_cls, &pid);
129  }
130  GNUNET_free (data);
131  GNUNET_free (fn);
132  return GNUNET_OK;
133 }
cfg
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
start
static int start
Set if we are to start default services (including ARM).
Definition: gnunet-arm.c:39
data
uint32_t data
The data value.
Definition: gnunet-helper-transport-wlan.c:21
pid
static struct GNUNET_PeerIdentity pid
Identity of the peer we transmit to / connect to.
Definition: gnunet-transport-profiler.c:149
GNUNET_CONFIGURATION_get_value_filename
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value)
Get a configuration value that should be the name of a file or directory.
Definition: configuration.c:2006
GNUNET_DISK_file_test
enum GNUNET_GenericReturnValue GNUNET_DISK_file_test(const char *fil)
Check that fil corresponds to a filename (of a file that exists and that is not a directory).
Definition: disk.c:481
GNUNET_DISK_file_size
enum GNUNET_GenericReturnValue GNUNET_DISK_file_size(const char *filename, uint64_t *size, int include_symbolic_links, int single_file_mode)
Get the size of the file (or directory) of the given file (in bytes).
Definition: disk.c:221
GNUNET_DISK_fn_write
enum GNUNET_GenericReturnValue GNUNET_DISK_fn_write(const char *fn, const void *buf, size_t buf_size, enum GNUNET_DISK_AccessPermissions mode)
Write a buffer to a file atomically.
Definition: disk.c:724
GNUNET_DISK_fn_read
ssize_t GNUNET_DISK_fn_read(const char *fn, void *result, size_t len)
Read the contents of a binary file into a buffer.
Definition: disk.c:663
GNUNET_DISK_OPEN_CREATE
@ GNUNET_DISK_OPEN_CREATE
Create file if it doesn't exist.
Definition: gnunet_disk_lib.h:131
GNUNET_DISK_PERM_USER_READ
@ GNUNET_DISK_PERM_USER_READ
Owner can read.
Definition: gnunet_disk_lib.h:174
GNUNET_DISK_PERM_USER_WRITE
@ GNUNET_DISK_PERM_USER_WRITE
Owner can write.
Definition: gnunet_disk_lib.h:179
GNUNET_log
#define GNUNET_log(kind,...)
Definition: gnunet_common.h:567
GNUNET_CRYPTO_eddsa_public_key_from_string
enum GNUNET_GenericReturnValue GNUNET_CRYPTO_eddsa_public_key_from_string(const char *enc, size_t enclen, struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Convert a string representing a public key to a public key.
Definition: crypto_ecc.c:357
GNUNET_OK
@ GNUNET_OK
Definition: gnunet_common.h:108
GNUNET_YES
@ GNUNET_YES
Definition: gnunet_common.h:110
GNUNET_NO
@ GNUNET_NO
Definition: gnunet_common.h:107
GNUNET_SYSERR
@ GNUNET_SYSERR
Definition: gnunet_common.h:106
GNUNET_log_config_missing
void GNUNET_log_config_missing(enum GNUNET_ErrorType kind, const char *section, const char *option)
Log error message about missing configuration option.
Definition: common_logging.c:1410
GNUNET_log_strerror
#define GNUNET_log_strerror(level, cmd)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
Definition: gnunet_common.h:1064
GNUNET_log_strerror_file
#define GNUNET_log_strerror_file(level, cmd, filename)
Log an error message at log-level 'level' that indicates a failure of the command 'cmd' with the mess...
Definition: gnunet_common.h:1101
GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_WARNING
Definition: gnunet_common.h:437
GNUNET_ERROR_TYPE_ERROR
@ GNUNET_ERROR_TYPE_ERROR
Definition: gnunet_common.h:436
GNUNET_malloc_large
#define GNUNET_malloc_large(size)
Wrapper around malloc.
Definition: gnunet_common.h:1371
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1411
_
#define _(String)
GNU gettext support macro.
Definition: platform.h:177
GNUNET_PeerIdentity
The identity of the host (wraps the signing key of the peer).
Definition: gnunet_crypto_lib.h:229
GNUNET_PeerIdentity::public_key
struct GNUNET_CRYPTO_EddsaPublicKey public_key
Definition: gnunet_crypto_lib.h:230

References _, cfg, data, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CRYPTO_eddsa_public_key_from_string(), GNUNET_DISK_file_size(), GNUNET_DISK_file_test(), GNUNET_DISK_fn_read(), GNUNET_DISK_fn_write(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_PERM_USER_READ, GNUNET_DISK_PERM_USER_WRITE, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_log_strerror, GNUNET_log_strerror_file, GNUNET_malloc_large, GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, GNUNET_YES, pid, GNUNET_PeerIdentity::public_key, and start.

Referenced by read_friends_file().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_FRIENDS_write_start()

struct GNUNET_FRIENDS_Writer* GNUNET_FRIENDS_write_start ( const struct GNUNET_CONFIGURATION_Handle *  cfg)

Start writing a fresh FRIENDS file.

Will make a backup of the old one.

Parameters
cfgconfiguration to use.
Returns
NULL on error

Definition at line 156 of file friends.c.

157 {
158  struct GNUNET_FRIENDS_Writer *w;
159  char *fn;
160 
161  if (GNUNET_OK !=
162  GNUNET_CONFIGURATION_get_value_filename (cfg, "TOPOLOGY", "FRIENDS", &fn))
163  {
164  GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
165  "topology", "FRIENDS");
166  return NULL;
167  }
168  if (GNUNET_OK !=
169  GNUNET_DISK_directory_create_for_file (fn))
170  {
171  GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
172  _ ("Directory for file `%s' does not seem to be writable.\n"),
173  fn);
174  GNUNET_free (fn);
175  return NULL;
176  }
177  if (GNUNET_OK == GNUNET_DISK_file_test (fn))
178  GNUNET_DISK_file_backup (fn);
179  w = GNUNET_new (struct GNUNET_FRIENDS_Writer);
180  w->fh = GNUNET_DISK_file_open (fn,
181  GNUNET_DISK_OPEN_CREATE
182  | GNUNET_DISK_OPEN_WRITE
183  | GNUNET_DISK_OPEN_FAILIFEXISTS,
184  GNUNET_DISK_PERM_USER_READ);
185  GNUNET_free (fn);
186  if (NULL == w->fh)
187  {
188  GNUNET_free (w);
189  return NULL;
190  }
191  return w;
192 }
GNUNET_DISK_file_open
struct GNUNET_DISK_FileHandle * GNUNET_DISK_file_open(const char *fn, enum GNUNET_DISK_OpenFlags flags, enum GNUNET_DISK_AccessPermissions perm)
Open a file.
Definition: disk.c:1234
GNUNET_DISK_file_backup
void GNUNET_DISK_file_backup(const char *fil)
Move a file out of the way (create a backup) by renaming it to "orig.NUM~" where NUM is the smallest ...
Definition: disk.c:359
GNUNET_DISK_directory_create_for_file
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create_for_file(const char *filename)
Create the directory structure for storing a file.
Definition: disk.c:581
GNUNET_DISK_OPEN_FAILIFEXISTS
@ GNUNET_DISK_OPEN_FAILIFEXISTS
Fail if file already exists.
Definition: gnunet_disk_lib.h:121
GNUNET_DISK_OPEN_WRITE
@ GNUNET_DISK_OPEN_WRITE
Open the file for writing.
Definition: gnunet_disk_lib.h:111
GNUNET_new
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition: gnunet_common.h:1213
GNUNET_FRIENDS_Writer
Handle for writing a friends file.
Definition: friends.c:140
GNUNET_FRIENDS_Writer::fh
struct GNUNET_DISK_FileHandle * fh
Handle to the file.
Definition: friends.c:144

References _, cfg, GNUNET_FRIENDS_Writer::fh, GNUNET_CONFIGURATION_get_value_filename(), GNUNET_DISK_directory_create_for_file(), GNUNET_DISK_file_backup(), GNUNET_DISK_file_open(), GNUNET_DISK_file_test(), GNUNET_DISK_OPEN_CREATE, GNUNET_DISK_OPEN_FAILIFEXISTS, GNUNET_DISK_OPEN_WRITE, GNUNET_DISK_PERM_USER_READ, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_log, GNUNET_log_config_missing(), GNUNET_new, and GNUNET_OK.

Here is the call graph for this function:

◆ GNUNET_FRIENDS_write_stop()

int GNUNET_FRIENDS_write_stop ( struct GNUNET_FRIENDS_Writer *  w)

Finish writing out the friends file.

Parameters
wwrite handle
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 202 of file friends.c.

203 {
204  int ret;
205 
206  ret = GNUNET_DISK_file_close (w->fh);
207  GNUNET_free (w);
208  return ret;
209 }
ret
static int ret
Return value of the commandline.
Definition: gnunet-abd.c:81
GNUNET_DISK_file_close
enum GNUNET_GenericReturnValue GNUNET_DISK_file_close(struct GNUNET_DISK_FileHandle *h)
Close an open file.
Definition: disk.c:1305

References GNUNET_FRIENDS_Writer::fh, GNUNET_DISK_file_close(), GNUNET_free, and ret.

Here is the call graph for this function:

◆ GNUNET_FRIENDS_write()

int GNUNET_FRIENDS_write ( struct GNUNET_FRIENDS_Writer *  w,
const struct GNUNET_PeerIdentity *  friend_id 
)

Add a friend to the friends file.

Parameters
wwrite handle
friend_idfriend to add
Returns
GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 220 of file friends.c.

222 {
223  char *buf;
224  char *ret;
225  size_t slen;
226 
227  ret = GNUNET_CRYPTO_eddsa_public_key_to_string (&friend_id->public_key);
228  GNUNET_asprintf (&buf,
229  "%s\n",
230  ret);
231  GNUNET_free (ret);
232  slen = strlen (buf);
233  if (slen !=
234  GNUNET_DISK_file_write (w->fh,
235  buf,
236  slen))
237  {
238  GNUNET_free (buf);
239  return GNUNET_SYSERR;
240  }
241  GNUNET_free (buf);
242  return GNUNET_OK;
243 }
buf
static char buf[2048]
Definition: gnunet-service-testbed_meminfo.c:64
GNUNET_DISK_file_write
ssize_t GNUNET_DISK_file_write(const struct GNUNET_DISK_FileHandle *h, const void *buffer, size_t n)
Write a buffer to a file.
Definition: disk.c:685
GNUNET_CRYPTO_eddsa_public_key_to_string
char * GNUNET_CRYPTO_eddsa_public_key_to_string(const struct GNUNET_CRYPTO_EddsaPublicKey *pub)
Convert a public key to a string.
Definition: crypto_ecc.c:251
GNUNET_asprintf
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.

References buf, GNUNET_FRIENDS_Writer::fh, GNUNET_asprintf(), GNUNET_CRYPTO_eddsa_public_key_to_string(), GNUNET_DISK_file_write(), GNUNET_free, GNUNET_OK, GNUNET_SYSERR, GNUNET_PeerIdentity::public_key, and ret.

Here is the call graph for this function: