From 65c7b8ae061963b0ccedc15e46bea7cfb4edd81a Mon Sep 17 00:00:00 2001 From: Nils Gillmann Date: Sat, 10 Nov 2018 16:20:03 +0000 Subject: Add page for gnurl, so far an import of https://gnunet.org/gnurl Signed-off-by: Nils Gillmann --- common/navigation.j2.inc | 1 + gnurl.html.j2 | 188 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 189 insertions(+) create mode 100644 gnurl.html.j2 diff --git a/common/navigation.j2.inc b/common/navigation.j2.inc index 2df4814c..66c070d1 100644 --- a/common/navigation.j2.inc +++ b/common/navigation.j2.inc @@ -21,6 +21,7 @@
  • {{ _("Bugtracker") }}
  • {{ _("Source Code") }}
  • {{ _("Continuous Integration") }}
    • +
  • {{ _("libgnurl") }}
  • diff --git a/gnurl.html.j2 b/gnurl.html.j2 new file mode 100644 index 00000000..ed73b57e --- /dev/null +++ b/gnurl.html.j2 @@ -0,0 +1,188 @@ +{% extends "common/base.j2" %} +{% block body_content %} +
    +
    +

    {{ _("gnurl / libgnurl") }}

    +

    + {% trans %} + libgnurl is a fork of libcurl, which is mostly for GNUnet but it might + be usable for others, hence we're releasing the code on this website + to the general public. Please read the README for instructions, as you + must supply the correct options to configure to get a proper build of + libgnurl. In addition to the source as a TAR, we also offer the + changes we made against libcurl's Git repository to create + libgnurl. In the following, I will explain the motiviations behind + this fork. + {% endtrans %} +

    +

    {{_("Motivation") }}

    +

    + {% trans %} + cURL supports a bunch of crypto backends. GNUnet requires the use of + GnuTLS, but other variants are used by some distributions. Supporting + other crypto backends would again expose us to a wider array of + security issues, may create licensing issues and most importantly + introduce new bugs as some crypto backends are known to introduce + subtle runtime issues. While it is possible to have two versions of + libcurl installed on the same system, this is error-prone, especially + as if we are linked against the wrong version, the bugs that arise + might be rather subtle. + {% endtrans %} +

    +

    + {% trans %} + For GNUnet, we also need a particularly modern version of + GnuTLS. Thus, it would anyway be necessary to recompile cURL for + GNUnet. But what happens if one links cURL against this version of + GnuTLS? Well, first one would install GnuTLS by hand in the + system. Then, we build cURL. cURL will build against it just fine, but + the linker will eventually complain bitterly. The reason is that cURL + also links against a bunch of other system libraries (gssapi, ldap, + ssh2, rtmp, krb5, sasl2, see discussion on obscure protocols above), + which --- as they are part of the distribution --- were linked against + an older version of GnuTLS. As a result, the same binary would be + linked against two different versions of GnuTLS. That is typically a + recipe for disaster. Thus, in order to avoid updating a dozen system + libraries (and having two versions of those installed), it is + necessary to disable all of those cURL features that GNUnet does not + use, and there are many of those. For GNUnet, the more obscure + protocols supported by cURL are close to dead code --- mostly + harmless, but not useful. However, as some application may use one of + those features, distributions are typically forced to enable all of + those features, and thus including security issues that might arise + from that code. + {% endtrans %} +

    +

    + {% trans %} + So to use a modern version of GnuTLS, a sane approach is to disable + all of the "optional" features of cURL that drag in system libraries + that link against the older GnuTLS. That works, except that one should + then NEVER install that version of libcurl in say /usr or /usr/local, + as that may break other parts of the system that might depend on these + features that we just disabled. Libtool versioning doesn't help here, + as it is not intended to deal with libraries that have optional + features. Naturally, installing cURL somewhere else is also + problematic, as we now need to be really careful that the linker will + link GNUnet against the right version. Note that none of this can + really be trivially fixed by the cURL developers. + {% endtrans %} +

    +

    {{_("Rename to fix") }}

    +

    + {% trans %} + At this point, developers that don't want to rebuild an entire + distribution from scratch get grumpy. Grumpy developers do silly + things, like forking code to fix it. I called the fork gnurl (to be + pronounced with a grumpy voice and an emphasis on the R) as it is bits + of cURL, a bit more GNUish, for GnuNet, and gnurl can be pronounced to + indicate the grumpy origins. + {% endtrans %} +

    +

    + {% trans %} + How does forking fix it? Easy. First, we can get rid of all of the + compatibility issues --- if you use libgnurl, you state that you don't + need anything but HTTP/HTTPS. Those applications that need more, + should stick with the original cURL. Those that do not, can choose to + move to something simpler. As the library gets a new name, we do not + have to worry about tons of packages breaking as soon as one rebuilds + it. So renaming itself and saying that "libgnurl = libcurl with only + HTTP/HTTPS support and GnuTLS" fixes 99% of the problems that darkened + my mood. Note that this pretty much CANNOT be done without a fork, as + renaming is an essential part of the fix. Now, there might be creative + solutions to achieve the same thing within the standard cURL build + system, but I'm not happy to wait for a decade for Daniel to review + the patches. The changes libgnurl makes to curl are miniscule and can + easily be applied again and again whenever libcurl makes a new + release. + {% endtrans %} +

    +

    {{_("Summary") }}

    +

    + {% trans %} + At this point, developers that don't want to rebuild an entire + distribution from scratch get grumpy. Grumpy developers do silly + things, like forking code to fix it. I called the fork gnurl (to be + pronounced with a grumpy voice and an emphasis on the R) as it is bits + of cURL, a bit more GNUish, for GnuNet, and gnurl can be pronounced to + indicate the grumpy origins. + {% endtrans %} +

    +

    {{_("Using libgnurl") }}

    +

    + {% trans %} + Projects that use cURL only for HTTP/HTTPS and that would work + with GnuTLS should be able to switch to libgnurl by changing + "-lcurl" to "-lgnurl". That's it. No changes to the source code + should be required. Continue to read the cURL documentation --- + as libgnurl strives for bug-for-bug compatibility with the + HTTP/HTTPS/GnuTLS subset of cURL. However, we're happy to add + new features relating to this core subset and might be easier to + convince than the cURL developers. + {% endtrans %} +

    +

    + {% trans %} + libgnurl and gnurl are not intended to be used as a replacement + for curl for users. Since no conflicts in filenames should occur + you are not expected to remove curl to make use of gnurl and + viceversa. + {% endtrans %} +

    +
    +
    + +
    +
    +
    +

    {{ _("Source Code") }}

    +

    + {% trans %} + You can get the Gnurl Git repository using: + git clone https://git.taler.net/gnurl.git/ + The versions are checked in as signed git tags. + {% endtrans %} +

    +
    +
    +

    {{ _("Downloads") }}

    +

    + {% trans %} + Releases are published on ftp.gnu.org/gnu/gnunet. + gnURL is available from within a variety of distributions and package managers. + To some extent officially supported and maintained is gnURL within GNU Guix, the package manager (available as "gnurl"), + as well as the collaborative Gentoo ebuild collection (overlay) + youbroketheinternet. + {% endtrans %} +

    +
    +
    +
    +
    +

    {{ _("Reporting Bugs") }}

    +

    + {% trans %} + You can report bugs on our bug tracker: + gnunet.org/bugs. Alternatively + you can use our bug mailinglist, but we prefer to track bugs + on the bugtracker. + {% endtrans %} +

    +
    +
    +

    {{ _("Maintainer and Cryptographic signatures") }}

    +

    + {% trans %} + libgnurl is maintained by Nils Gillmann. + Releases are signed + with the OpenPG Key A88C8ADD129828D7EAC02E52E22F9BBFEE348588, + with the key fingerprint A88C 8ADD 1298 28D7 EAC0 2E52 E22F 9BBF EE34 8588. + {% endtrans %} +

    +
    +
    +
    + + +{% endblock body_content %} -- cgit v1.2.3 From dff4935c47c14c5705625cec7d50f4ed77b6e311 Mon Sep 17 00:00:00 2001 From: Nils Gillmann Date: Sat, 10 Nov 2018 16:24:35 +0000 Subject: TODO note Signed-off-by: Nils Gillmann --- TODO | 3 +++ 1 file changed, 3 insertions(+) diff --git a/TODO b/TODO index 4b418a98..95aecae9 100644 --- a/TODO +++ b/TODO @@ -5,6 +5,9 @@ - Do we need ALL the boilerplate of bootstrap css? +* Layout / CSS: +- Firefox Reader Mode does not display all of our pages in full. + - architecture-page: * The graph image does not really display well on small screens. -- cgit v1.2.3