2 * This file is part of GNUnet
3 * Copyright (C) 2009-2013, 2016-2018 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.
17 * @file namestore/plugin_namestore_postgres.c
18 * @brief postgres-based namestore backend
19 * @author Christian Grothoff
22 #include "gnunet_namestore_plugin.h"
23 #include "gnunet_namestore_service.h"
24 #include "gnunet_gnsrecord_lib.h"
25 #include "gnunet_pq_lib.h"
26 #include "namestore.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-postgres", __VA_ARGS__)
33 * Context for all functions in this plugin.
41 const struct GNUNET_CONFIGURATION_Handle *cfg;
44 * Native Postgres database handle.
52 * Initialize the database connections and associated
53 * data structures (create tables and indices
56 * @param plugin the plugin context (state for this module)
57 * @return #GNUNET_OK on success
60 database_setup (struct Plugin *plugin)
62 struct GNUNET_PQ_ExecuteStatement es_temporary =
63 GNUNET_PQ_make_execute ("CREATE TEMPORARY TABLE IF NOT EXISTS ns098records ("
64 " seq BIGSERIAL PRIMARY KEY,"
65 " zone_private_key BYTEA NOT NULL DEFAULT '',"
66 " pkey BYTEA DEFAULT '',"
67 " rvalue BYTEA NOT NULL DEFAULT '',"
68 " record_count INTEGER NOT NULL DEFAULT 0,"
69 " record_data BYTEA NOT NULL DEFAULT '',"
70 " label TEXT NOT NULL DEFAULT '',"
71 " CONSTRAINT zl UNIQUE (zone_private_key,label)"
74 struct GNUNET_PQ_ExecuteStatement es_default =
75 GNUNET_PQ_make_execute ("CREATE TABLE IF NOT EXISTS ns098records ("
76 " seq BIGSERIAL PRIMARY KEY,"
77 " zone_private_key BYTEA NOT NULL DEFAULT '',"
78 " pkey BYTEA DEFAULT '',"
79 " rvalue BYTEA NOT NULL DEFAULT '',"
80 " record_count INTEGER NOT NULL DEFAULT 0,"
81 " record_data BYTEA NOT NULL DEFAULT '',"
82 " label TEXT NOT NULL DEFAULT '',"
83 " CONSTRAINT zl UNIQUE (zone_private_key,label)"
86 const struct GNUNET_PQ_ExecuteStatement *cr;
88 plugin->dbh = GNUNET_PQ_connect_with_cfg (plugin->cfg,
89 "namestore-postgres");
90 if (NULL == plugin->dbh)
93 GNUNET_CONFIGURATION_get_value_yesno (plugin->cfg,
97 struct GNUNET_PQ_ExecuteStatement es[] = {
98 GNUNET_PQ_make_try_execute ("SET synchronous_commit TO off"),
99 GNUNET_PQ_EXECUTE_STATEMENT_END
103 GNUNET_PQ_exec_statements (plugin->dbh,
106 PQfinish (plugin->dbh);
108 return GNUNET_SYSERR;
112 GNUNET_CONFIGURATION_get_value_yesno (plugin->cfg,
113 "namestore-postgres",
124 struct GNUNET_PQ_ExecuteStatement es[] = {
126 GNUNET_PQ_make_try_execute ("CREATE INDEX IF NOT EXISTS ir_pkey_reverse "
127 "ON ns098records (zone_private_key,pkey)"),
128 GNUNET_PQ_make_try_execute ("CREATE INDEX IF NOT EXISTS ir_pkey_iter "
129 "ON ns098records (zone_private_key,seq)"),
130 GNUNET_PQ_make_try_execute ("CREATE INDEX IF NOT EXISTS ir_label "
131 "ON ns098records (label)"),
132 GNUNET_PQ_make_try_execute ("CREATE INDEX IF NOT EXISTS zone_label "
133 "ON ns098records (zone_private_key,label)"),
134 GNUNET_PQ_EXECUTE_STATEMENT_END
138 GNUNET_PQ_exec_statements (plugin->dbh,
141 PQfinish (plugin->dbh);
143 return GNUNET_SYSERR;
148 struct GNUNET_PQ_PreparedStatement ps[] = {
149 GNUNET_PQ_make_prepare ("store_records",
150 "INSERT INTO ns098records"
151 " (zone_private_key, pkey, rvalue, record_count, record_data, label)"
152 " VALUES ($1, $2, $3, $4, $5, $6)"
153 " ON CONFLICT ON CONSTRAINT zl"
155 " SET pkey=$2,rvalue=$3,record_count=$4,record_data=$5"
156 " WHERE ns098records.zone_private_key = $1"
157 " AND ns098records.label = $6",
159 GNUNET_PQ_make_prepare ("delete_records",
160 "DELETE FROM ns098records "
161 "WHERE zone_private_key=$1 AND label=$2",
163 GNUNET_PQ_make_prepare ("zone_to_name",
164 "SELECT seq,record_count,record_data,label FROM ns098records"
165 " WHERE zone_private_key=$1 AND pkey=$2",
167 GNUNET_PQ_make_prepare ("iterate_zone",
168 "SELECT seq,record_count,record_data,label FROM ns098records "
169 "WHERE zone_private_key=$1 AND seq > $2 ORDER BY seq ASC LIMIT $3",
171 GNUNET_PQ_make_prepare ("iterate_all_zones",
172 "SELECT seq,record_count,record_data,label,zone_private_key"
173 " FROM ns098records WHERE seq > $1 ORDER BY seq ASC LIMIT $2",
175 GNUNET_PQ_make_prepare ("lookup_label",
176 "SELECT seq,record_count,record_data,label "
177 "FROM ns098records WHERE zone_private_key=$1 AND label=$2",
179 GNUNET_PQ_PREPARED_STATEMENT_END
183 GNUNET_PQ_prepare_statements (plugin->dbh,
186 PQfinish (plugin->dbh);
188 return GNUNET_SYSERR;
197 * Store a record in the datastore. Removes any existing record in the
198 * same zone with the same name.
200 * @param cls closure (internal context for the plugin)
201 * @param zone_key private key of the zone
202 * @param label name that is being mapped (at most 255 characters long)
203 * @param rd_count number of entries in @a rd array
204 * @param rd array of records with data to store
205 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
208 namestore_postgres_store_records (void *cls,
209 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
211 unsigned int rd_count,
212 const struct GNUNET_GNSRECORD_Data *rd)
214 struct Plugin *plugin = cls;
215 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
217 uint32_t rd_count32 = (uint32_t) rd_count;
223 for (unsigned int i=0;i<rd_count;i++)
224 if (GNUNET_GNSRECORD_TYPE_PKEY == rd[i].record_type)
226 GNUNET_break (sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) == rd[i].data_size);
227 GNUNET_memcpy (&pkey,
232 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
234 data_size = GNUNET_GNSRECORD_records_get_size (rd_count,
239 return GNUNET_SYSERR;
241 if (data_size >= UINT16_MAX)
244 return GNUNET_SYSERR;
246 /* if record set is empty, delete existing records */
249 struct GNUNET_PQ_QueryParam params[] = {
250 GNUNET_PQ_query_param_auto_from_type (zone_key),
251 GNUNET_PQ_query_param_string (label),
252 GNUNET_PQ_query_param_end
254 enum GNUNET_DB_QueryStatus res;
256 res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
259 if ( (GNUNET_DB_STATUS_SUCCESS_ONE_RESULT != res) &&
260 (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS != res) )
263 return GNUNET_SYSERR;
265 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
270 /* otherwise, UPSERT (i.e. UPDATE if exists, otherwise INSERT) */
272 char data[data_size];
273 struct GNUNET_PQ_QueryParam params[] = {
274 GNUNET_PQ_query_param_auto_from_type (zone_key),
275 GNUNET_PQ_query_param_auto_from_type (&pkey),
276 GNUNET_PQ_query_param_uint64 (&rvalue),
277 GNUNET_PQ_query_param_uint32 (&rd_count32),
278 GNUNET_PQ_query_param_fixed_size (data, data_size),
279 GNUNET_PQ_query_param_string (label),
280 GNUNET_PQ_query_param_end
282 enum GNUNET_DB_QueryStatus res;
285 ret = GNUNET_GNSRECORD_records_serialize (rd_count,
293 return GNUNET_SYSERR;
296 res = GNUNET_PQ_eval_prepared_non_select (plugin->dbh,
299 if (GNUNET_DB_STATUS_SUCCESS_ONE_RESULT != res)
300 return GNUNET_SYSERR;
307 * Closure for #parse_result_call_iterator.
312 * Function to call for each result.
314 GNUNET_NAMESTORE_RecordIterator iter;
317 * Closure for @e iter.
322 * Zone key, NULL if part of record.
324 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key;
327 * Number of results still to return (counted down by
328 * number of results given to iterator).
335 * A statement has been run. We should evaluate the result, and if possible
336 * call the @a iter in @a cls with the result.
338 * @param cls closure of type `struct ParserContext *`
339 * @param result the postgres result
340 * @param num_result the number of results in @a result
343 parse_result_call_iterator (void *cls,
345 unsigned int num_results)
347 struct ParserContext *pc = cls;
349 if (NULL == pc->iter)
350 return; /* no need to do more work */
351 for (unsigned int i=0;i<num_results;i++)
356 uint32_t record_count;
358 struct GNUNET_CRYPTO_EcdsaPrivateKey zk;
359 struct GNUNET_PQ_ResultSpec rs_with_zone[] = {
360 GNUNET_PQ_result_spec_uint64 ("seq", &serial),
361 GNUNET_PQ_result_spec_uint32 ("record_count", &record_count),
362 GNUNET_PQ_result_spec_variable_size ("record_data", &data, &data_size),
363 GNUNET_PQ_result_spec_string ("label", &label),
364 GNUNET_PQ_result_spec_auto_from_type ("zone_private_key", &zk),
365 GNUNET_PQ_result_spec_end
367 struct GNUNET_PQ_ResultSpec rs_without_zone[] = {
368 GNUNET_PQ_result_spec_uint64 ("seq", &serial),
369 GNUNET_PQ_result_spec_uint32 ("record_count", &record_count),
370 GNUNET_PQ_result_spec_variable_size ("record_data", &data, &data_size),
371 GNUNET_PQ_result_spec_string ("label", &label),
372 GNUNET_PQ_result_spec_end
374 struct GNUNET_PQ_ResultSpec *rs;
376 rs = (NULL == pc->zone_key) ? rs_with_zone : rs_without_zone;
378 GNUNET_PQ_extract_result (res,
386 if (record_count > 64 * 1024)
388 /* sanity check, don't stack allocate far too much just
389 because database might contain a large value here */
391 GNUNET_PQ_cleanup_result (rs);
396 struct GNUNET_GNSRECORD_Data rd[GNUNET_NZL(record_count)];
399 GNUNET_GNSRECORD_records_deserialize (data_size,
405 GNUNET_PQ_cleanup_result (rs);
408 pc->iter (pc->iter_cls,
410 (NULL == pc->zone_key) ? &zk : pc->zone_key,
415 GNUNET_PQ_cleanup_result (rs);
417 pc->limit -= num_results;
422 * Lookup records in the datastore for which we are the authority.
424 * @param cls closure (internal context for the plugin)
425 * @param zone private key of the zone
426 * @param label name of the record in the zone
427 * @param iter function to call with the result
428 * @param iter_cls closure for @a iter
429 * @return #GNUNET_OK on success, #GNUNET_NO for no results, else #GNUNET_SYSERR
432 namestore_postgres_lookup_records (void *cls,
433 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
435 GNUNET_NAMESTORE_RecordIterator iter,
438 struct Plugin *plugin = cls;
439 struct GNUNET_PQ_QueryParam params[] = {
440 GNUNET_PQ_query_param_auto_from_type (zone),
441 GNUNET_PQ_query_param_string (label),
442 GNUNET_PQ_query_param_end
444 struct ParserContext pc;
445 enum GNUNET_DB_QueryStatus res;
450 return GNUNET_SYSERR;
453 pc.iter_cls = iter_cls;
455 res = GNUNET_PQ_eval_prepared_multi_select (plugin->dbh,
458 &parse_result_call_iterator,
461 return GNUNET_SYSERR;
462 if (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS == res)
469 * Iterate over the results for a particular key and zone in the
470 * datastore. Will return at most one result to the iterator.
472 * @param cls closure (internal context for the plugin)
473 * @param zone hash of public key of the zone, NULL to iterate over all zones
474 * @param serial serial number to exclude in the list of all matching records
475 * @param limit maximum number of results to fetch
476 * @param iter function to call with the result
477 * @param iter_cls closure for @a iter
478 * @return #GNUNET_OK on success, #GNUNET_NO if there were no more results, #GNUNET_SYSERR on error
481 namestore_postgres_iterate_records (void *cls,
482 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
485 GNUNET_NAMESTORE_RecordIterator iter,
488 struct Plugin *plugin = cls;
489 enum GNUNET_DB_QueryStatus res;
490 struct ParserContext pc;
493 pc.iter_cls = iter_cls;
498 struct GNUNET_PQ_QueryParam params_without_zone[] = {
499 GNUNET_PQ_query_param_uint64 (&serial),
500 GNUNET_PQ_query_param_uint64 (&limit),
501 GNUNET_PQ_query_param_end
504 res = GNUNET_PQ_eval_prepared_multi_select (plugin->dbh,
507 &parse_result_call_iterator,
512 struct GNUNET_PQ_QueryParam params_with_zone[] = {
513 GNUNET_PQ_query_param_auto_from_type (zone),
514 GNUNET_PQ_query_param_uint64 (&serial),
515 GNUNET_PQ_query_param_uint64 (&limit),
516 GNUNET_PQ_query_param_end
519 res = GNUNET_PQ_eval_prepared_multi_select (plugin->dbh,
522 &parse_result_call_iterator,
526 return GNUNET_SYSERR;
528 if ( (GNUNET_DB_STATUS_SUCCESS_NO_RESULTS == res) ||
536 * Look for an existing PKEY delegation record for a given public key.
537 * Returns at most one result to the iterator.
539 * @param cls closure (internal context for the plugin)
540 * @param zone private key of the zone to look up in, never NULL
541 * @param value_zone public key of the target zone (value), never NULL
542 * @param iter function to call with the result
543 * @param iter_cls closure for @a iter
544 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
547 namestore_postgres_zone_to_name (void *cls,
548 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
549 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
550 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
552 struct Plugin *plugin = cls;
553 struct GNUNET_PQ_QueryParam params[] = {
554 GNUNET_PQ_query_param_auto_from_type (zone),
555 GNUNET_PQ_query_param_auto_from_type (value_zone),
556 GNUNET_PQ_query_param_end
558 enum GNUNET_DB_QueryStatus res;
559 struct ParserContext pc;
562 pc.iter_cls = iter_cls;
564 res = GNUNET_PQ_eval_prepared_multi_select (plugin->dbh,
567 &parse_result_call_iterator,
570 return GNUNET_SYSERR;
576 * Shutdown database connection and associate data
579 * @param plugin the plugin context (state for this module)
582 database_shutdown (struct Plugin *plugin)
584 PQfinish (plugin->dbh);
590 * Entry point for the plugin.
592 * @param cls the `struct GNUNET_NAMESTORE_PluginEnvironment*`
593 * @return NULL on error, othrewise the plugin context
596 libgnunet_plugin_namestore_postgres_init (void *cls)
598 static struct Plugin plugin;
599 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
600 struct GNUNET_NAMESTORE_PluginFunctions *api;
602 if (NULL != plugin.cfg)
603 return NULL; /* can only initialize once! */
604 memset (&plugin, 0, sizeof (struct Plugin));
606 if (GNUNET_OK != database_setup (&plugin))
608 database_shutdown (&plugin);
611 api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
613 api->store_records = &namestore_postgres_store_records;
614 api->iterate_records = &namestore_postgres_iterate_records;
615 api->zone_to_name = &namestore_postgres_zone_to_name;
616 api->lookup_records = &namestore_postgres_lookup_records;
617 LOG (GNUNET_ERROR_TYPE_INFO,
618 "Postgres namestore plugin running\n");
624 * Exit point from the plugin.
626 * @param cls the plugin context (as returned by "init")
627 * @return always NULL
630 libgnunet_plugin_namestore_postgres_done (void *cls)
632 struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
633 struct Plugin *plugin = api->cls;
635 database_shutdown (plugin);
638 LOG (GNUNET_ERROR_TYPE_DEBUG,
639 "Postgres namestore plugin is finished\n");
643 /* end of plugin_namestore_postgres.c */