summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos Garnacho <carlosg@gnome.org>2022-03-18 16:27:47 +0100
committerCarlos Garnacho <carlosg@gnome.org>2022-04-03 18:47:17 +0000
commit0e8d238bfda556175fd8ea8fcf9da0a458d2b115 (patch)
tree414b1a118f1ac800322834ca6e6a29729ae851be
parentb909267bcecf74defce95fb967782a952f5d00b6 (diff)
downloadtracker-0e8d238bfda556175fd8ea8fcf9da0a458d2b115.tar.gz
libtracker-sparql: Add further docs to TrackerEndpointHttp
Stress further the importance around ::block-remote-address and GTlsCertificate, and mention that HTTP endpoints do not implement updates.
-rw-r--r--src/libtracker-sparql/tracker-endpoint-http.c12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/libtracker-sparql/tracker-endpoint-http.c b/src/libtracker-sparql/tracker-endpoint-http.c
index 03a7eb4ea..6248284e9 100644
--- a/src/libtracker-sparql/tracker-endpoint-http.c
+++ b/src/libtracker-sparql/tracker-endpoint-http.c
@@ -33,7 +33,17 @@
* Access to these endpoints may be managed via the
* #TrackerEndpointHttp::block-remote-address signal, the boolean
* return value expressing whether the connection is blocked or not.
- * Inspection of the requester address is left up to the user.
+ * Inspection of the requester address is left up to the user. The
+ * default value allows all requests independently of their provenance,
+ * users are encouraged to add a handler.
+ *
+ * If the provided #GTlsCertificate is %NULL, the endpoint will allow
+ * plain HTTP connections. Users are encouraged to provide a certificate
+ * in order to use HTTPS.
+ *
+ * As a security measure, and in compliance with the SPARQL 1.1 specifications,
+ * the HTTP endpoint does not support database updates or modifications in any
+ * way. The database is completely owned by the host.
*
* A #TrackerEndpointHttp may be created on a different thread/main
* context than the one creating the #TrackerSparqlConnection.