]> git.ipfire.org Git - thirdparty/FORT-validator.git/commitdiff
Patch lintian warnings, tweak documentation
authorAlberto Leiva Popper <ydahhrk@gmail.com>
Thu, 13 Jun 2019 17:42:22 +0000 (12:42 -0500)
committerAlberto Leiva Popper <ydahhrk@gmail.com>
Thu, 13 Jun 2019 17:45:50 +0000 (12:45 -0500)
.gitignore
configure.ac
docs/_layouts/default.html
docs/_layouts/home.html
docs/doc/incidence.md
docs/doc/installation.md
docs/doc/intro-fort.md
docs/doc/usage.md
docs/index.md
src/config.c
src/slurm/slurm_loader.c

index de57b6e0b02bef2809adccc79b848c15dc8a4b94..5ab788a6d88321c8bf27b9b7f8d2e5a6738a1cd8 100644 (file)
@@ -74,6 +74,8 @@ configure
 depcomp
 install-sh
 missing
+src/configure_ac.h
+src/stamp-h1
 
 # Packaging
 *.7z
index 68d13f0fbec65a0d6c1e348f852804f8a34f991d..5e37035543ef2ecb2c9c8070c6cd2dc008571bb8 100644 (file)
@@ -10,6 +10,9 @@ AM_INIT_AUTOMAKE([subdir-objects])
 # Checks for programs.
 AC_PROG_CC
 
+# Create src/configure_ac.h, put some useful macros there.
+AC_CONFIG_HEADERS([src/configure_ac.h])
+
 # Checks for header files.
 AC_CHECK_HEADERS([netinet/in.h stdlib.h string.h unistd.h])
 
index a24d7e4521801e97178ce0d31da4e2aa295e3fb1..8260e472766dc81debe4e6aedcbfe0fbf0224e0f 100644 (file)
 </header>
 
 <section class="site-section">
-       <div class="container alerta">
-               <blockquote><strong>
-                       <img src="../img/warn.svg" alt="WARNING"/> Warning: This documentation is still under construction. It's too
-                       succint for comfort still.
-               </strong></blockquote>
-       </div>
        <div class="container">
 
                {{ content }}
index d315e6e6b141bf4832c9ea3c2ad018261cb43d83..a94d9fe857da8d745464fe0e7e655eeb4e26d76f 100644 (file)
 </header>
 
 <section class="site-section">
-       <div class="container alerta">
-               <blockquote><strong>
-                       <img src="./img/warn.svg" alt="WARNING"/> Warning: This documentation is still under construction. It's too
-                       succint for comfort still.
-               </strong></blockquote>
-       </div>
        <div class="container">
 
                {{ content }}
index 0c3b3866dcdfa741d53706e909c31698703c024e..91fa9c984e3c2c9b546f76fa6ed23fb52a3e9e77 100644 (file)
@@ -15,7 +15,7 @@ title: Incidence
 
 ## Introduction
 
-The RPKI RFCs define fairly strict profiles for RPKI objects, and are unequivocal in stating that incorrectly-formed objects are supposed to be rejected by Relying Party validation. In practice, however, this does not stop a significant amount of Certificate Authorities from issuing incorrect objects.
+The RPKI RFCs define fairly strict profiles for RPKI objects, and are unequivocal in stating that incorrectly-formed objects are supposed to be rejected by Relying Party validation. In practice, however, this does not prevent a significant amount of Certificate Authorities from issuing incorrect objects.
 
 By default, Fort is as pedantic as it can possibly be. The `incidence` section of its configuration file is a means to modify its behavior upon encountering profile violations that, from experience, are often overlooked.
 
index a5e261a48a80908ff685ff2dbbe8e60563e666bf..5cdbcbb654f7a9daf49112c2abe0c3c5f8ecdacb 100644 (file)
@@ -46,7 +46,7 @@ wget https://www.dropbox.com/s/7c0rs49ewcu6m93/fort_0.0.1-1_amd64.deb
 sudo apt install ./libcmscodec1_0.0.1-1_amd64.deb ./fort_0.0.1-1_amd64.deb
 {% endhighlight %}
 
-Aside from the `fort` binary documented elsewhere in this documentation, the Debian package also ships with a systemd service, which you can [configure](usage.html#--configuration-file) at `/etc/fort/config.json`.
+Aside from the `fort` binary documented elsewhere in this documentation, the Debian package also ships with a systemd service, which is just the binary ran as a daemon. You can [configure](usage.html#--configuration-file) it at `/etc/fort/config.json`.
 
 {% highlight bash %}
 sudo service fort start
index 2a1df0de58fc1bb2eff23d3d539a90b5baa2ea81..b32bdbc3d924b80575ad16483a4b61fd1cef9d9d 100644 (file)
@@ -62,5 +62,7 @@ RRDP is a protocol intended to replace RSYNC in the RPKI. Fort only implements R
 
 ## TO-DO
 
-- Reach full 100% RFC compliance.
-- Maybe a few optimizations, marked as `TODO` in the code.
+- Reach 100% RFC compliance
+- Multithreading
+- Daemon quirks (stuff like "send self to background automatically"), maybe
+- More languages?
index ee92acf72181b4e0bf52e8273ffb6e29894db62d..98ac0cf171773279663c1f309fd4c6354905bab6 100644 (file)
@@ -127,7 +127,7 @@ Prints program version.
 
 {% highlight bash %}
 $ {{ page.command }} --version
-0.0.1-beta
+fort 0.0.1
 {% endhighlight %}
 
 ### `--tal`
@@ -141,7 +141,9 @@ A TAL is a file that points to a _Trust Anchor_ (TA). A TA is a self-signed cert
 
 The reason why you provide locators instead of anchors is to allow the latter to be officially updated without the need to awkwardly redistribute them.
 
-Whichever registry serves as root of the tree you want to validate is responsible for providing you with its TAL. For convenience, Fort currently ships with the TALs of four of the five RIRs. (The exception is ARIN's, since you need to read and accept an [agreement](https://www.arin.net/resources/manage/rpki/tal/) before you can use it.) If you are paranoid, however, you'd be advised to get your own.
+Whichever registry serves as root of the tree you want to validate is responsible for providing you with its TAL. For convenience, Fort currently ships with the TALs of four of the five RIRs. (The exception is ARIN's, since you need to read and accept an [agreement](https://www.arin.net/resources/manage/rpki/tal/) before you can use it.) If you installed the Debian package, they can be found at `/etc/fort/tal/`, otherwise it the `tal/` directory of whatever release tarball you downloaded.
+
+If you are paranoid, however, you'd be advised to get your own TALs.
 
 The TAL file format has been standardized in [RFC 7730](https://tools.ietf.org/html/rfc7730). It is a text file that contains a list of URLs (which serve as alternate access methods for the TA), followed by a blank line, followed by the Base64-encoded public key of the TA.
 
@@ -167,7 +169,7 @@ LQIDAQAB
 
 Path to the directory where Fort will store a local cache of the repository.
 
-Right now, Fort accesses RPKI repositories by way of [rsync](https://en.wikipedia.org/wiki/Rsync). (The alternate protocol [RRDP](https://tools.ietf.org/html/rfc8182) is in the road map.) During each validation cycle, Fort will literally invoke an `rsync` command (see [`rsync.program`](#rsyncprogram) and [`rsync.arguments-recursive`](#rsyncarguments-recursive)), which will download the files into `--local-repository`. Fort's validation operates on the resulting copy.
+Right now, Fort accesses RPKI repositories by way of [rsync](https://en.wikipedia.org/wiki/Rsync). (The alternate protocol [RRDP](https://tools.ietf.org/html/rfc8182) is in the road map.) During each validation cycle, Fort will literally invoke an `rsync` command (see [`rsync.program`](#rsyncprogram) and [`rsync.arguments-recursive`](#rsyncarguments-recursive)), which will download the files into `--local-repository`. Fort's entire validation process operates on the resulting copy.
 
 Because rsync uses delta encoding, you're advised to keep this cache around. It significantly speeds up subsequent validation cycles.
 
@@ -249,7 +251,7 @@ Fort's tree traversal is actually iterative (not recursive), so there should be
 
 Disable the RTR server.
 
-If the flag is set, the server is disabled, the rest of the `server.*` arguments are discarded, and Fort performs an in-place standalone RPKI validation.
+If the flag is set, the server is disabled, the rest of the `server.*` arguments are ignored, and Fort performs an in-place standalone RPKI validation.
 
 ### `--server.address`
 
@@ -269,7 +271,7 @@ If this field is omitted, Fort will attempt to bind the server using the IP addr
 
 TCP port or service the server will be bound to.
 
-This is a string because a service alias can be used as a valid value. The alias are commonly located at `/etc/services`. (See '`$ man services`'.)
+This is a string because a service alias can be used as a valid value. The available aliases are commonly located at `/etc/services`. (See '`$ man services`'.)
 
 > ![../img/warn.svg](../img/warn.svg) The default port is privileged. To improve security, either change or jail it.
 
@@ -280,7 +282,7 @@ This is a string because a service alias can be used as a valid value. The alias
 - **Default:** [`SOMAXCONN`](http://pubs.opengroup.org/onlinepubs/9699919799.2008edition/basedefs/sys_socket.h.html)
 - **Range:** 1--`SOMAXCONN`
 
-RTR server's listen queue length. It's the second argument of [`listen()`](http://pubs.opengroup.org/onlinepubs/9699919799.2008edition/functions/listen.html):
+RTR server's listen queue length. It is the second argument of [`listen()`](http://pubs.opengroup.org/onlinepubs/9699919799.2008edition/functions/listen.html):
 
 > The backlog argument provides a hint to the implementation which the implementation shall use to limit the number of outstanding connections in the socket's listen queue. Implementations may impose a limit on backlog and silently reduce the specified value. Normally, a larger backlog argument value shall result in a larger or equal length of the listen queue. Implementations shall support values of backlog up to SOMAXCONN, defined in <sys/socket.h>.
 
index 0037a55ed903eb4c6b6905df22fec39962e0de37..a3d70661876536d3d41f3aea28bca15885c13407 100644 (file)
@@ -11,4 +11,4 @@ The documentation can be found [here](doc/index.html).
 
 ## Status
 
-The first release of Fort is planned to be released later this month.
+Fort is currently in beta. Testing is underway.
index fe253e116e1cff7b5f8897c82b4df19ad91b3b30..3198944f03bd0014f4437f6b15a0e10aa2ea2504 100644 (file)
@@ -8,6 +8,7 @@
 #include <sys/socket.h>
 
 #include "common.h"
+#include "configure_ac.h"
 #include "json_handler.h"
 #include "log.h"
 #include "config/boolean.h"
@@ -342,7 +343,7 @@ handle_usage(struct option_field const *field, char *arg)
 static int
 handle_version(struct option_field const *field, char *arg)
 {
-       printf("0.0.1-beta\n");
+       printf(PACKAGE_STRING "\n");
        exit(0);
 }
 
@@ -657,9 +658,7 @@ config_get_server_port(void)
 int
 config_get_server_queue(void)
 {
-       /*
-        * The range of this is 1-<small number>, so adding signedness is safe.
-        */
+       /* The range of this is 1-<small number>, so adding sign is safe. */
        return rpki_config.server.backlog;
 }
 
index 9b504d6f71b200d5269b19c6ce42b6a48bdffbba..8b089b4e2afdf1becf2a7acba5bb77c3964e3e9b 100644 (file)
@@ -72,7 +72,7 @@ slurm_pfx_assertions_add(struct slurm_prefix *prefix, void *arg)
                    vrp.max_prefix_length);
        }
 
-       pr_crit("Unkown addr family type: %u", vrp.addr_fam);
+       pr_crit("Unknown addr family type: %u", vrp.addr_fam);
 }
 
 static int