From: Alberto Leiva Popper Date: Mon, 25 Mar 2019 22:58:10 +0000 (-0600) Subject: Update the READMEs X-Git-Tag: v0.0.2~55 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c53e3b8f4b701f8abf243cda73e778314aa97058;p=thirdparty%2FFORT-validator.git Update the READMEs --- diff --git a/README.md b/README.md index 08529810..c0379a5b 100644 --- a/README.md +++ b/README.md @@ -20,49 +20,4 @@ make make install ``` -## Compliance - -Further information can be found in the subsections below. - -| RFC | Implemented | -|----------------------------------------------------------------------------|-------------| -| [3779](https://tools.ietf.org/html/rfc3779) (IP & AS Extensions) | 100% | -| [6350](https://tools.ietf.org/html/rfc6350) (vCard) | 0% | -| [6482](https://tools.ietf.org/html/rfc6482) (ROA) | 100% | -| [6486](https://tools.ietf.org/html/rfc6486) (Manifests) | 75% | -| [6487](https://tools.ietf.org/html/rfc6487) (Resource Certificates & CRLs) | 100% | -| [6488](https://tools.ietf.org/html/rfc6488) (Signed Objects) | 90% | -| [6493](https://tools.ietf.org/html/rfc6493) (Ghostbusters) | 100% | -| [7318](https://tools.ietf.org/html/rfc7318) (Policy Qualifiers) | 100% | -| [7730](https://tools.ietf.org/html/rfc7730) (TALs) | 100% | -| [7935](https://tools.ietf.org/html/rfc7935) (RPKI algorithms) | 100% | -| [8182](https://tools.ietf.org/html/rfc8182) (RRDP) | 0% | -| [8209](https://tools.ietf.org/html/rfc8209) (BGPSec Certificates) | 0% | -| [8360](https://tools.ietf.org/html/rfc8360) (Validation Reconsidered) | 100% | - -### RFC 6350 (vCard) - -The vCard format is only used by Ghostbusters records. 6350 defines the basic vCard format, while 6493 defines additional requirements for Ghostbusters-specific vCard. - -The specific validations have been implemented, while the basic ones have not. - -### RFC 6486 (Manifests) - -This RFC states a bunch of rules that allow some level of tolerance to missing, invalid or stale manifests. Here's an example: - -> signed objects (...) issued by the entity that has published the stale manifest (...) SHOULD be viewed as somewhat suspect, but MAY be used by the RP as per local policy. - -These constitute the approximate missing 25%. - -### RFC 6488 (Signed Objects) - -6488 mandates that all signed objects must be DER-encoded. Fort's current parser cannot tell the difference between BER and DER. - -### RFC 8182 (RRDP) - -RRDP is a protocol intended to replace RSYNC in the RPKI. Fort only implements RSYNC, currently. - -## TO-DO - -- Reach full 100% RFC compliance. -- Maybe a few optimizations, marked as `TODO` in the code. +More documentation at [https://nicmx.github.io/FORT-validator/](https://nicmx.github.io/FORT-validator/). diff --git a/docs/README.md b/docs/README.md index 8b090981..281e8a99 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ -# Fort's website +# FORT's website -This directory contains the source files of Fort's site and documentation. +This directory contains the source files of FORT's site and documentation. -On account on not being finished, Github does not automatically compile+serve this yet. +Github automatically compiles and publishes it at [https://nicmx.github.io/FORT-validator/](https://nicmx.github.io/FORT-validator/). **It's still under construction**. -You can compile the documentation yourself by running [Jekyll](http://jekyllrb.com/) right here. +You can also compile the documentation yourself by running [Jekyll](http://jekyllrb.com/) right here. ```bash $ jekyll build