Skip to content

Commit 559b4f2

Browse files
committed
Protocolary updates for release 1.6.0
1 parent 63e7194 commit 559b4f2

23 files changed

+110
-156
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
# FORT Validator
22

3-
An RPKI Validator and RTR Server, part of the [FORT project](https://www.fortproject.net).
3+
An RPKI Relying Party and RTR Server.
44

55
## Documentation
66

7-
FORT Validator's documentation (installation, usage, etc.) can be found at [https://nicmx.github.io/FORT-validator/](https://nicmx.github.io/FORT-validator/).
8-
9-
If you wish to generate the docs by yourself, visit the [docs directory](docs/).
7+
- [Home](https://nicmx.github.io/FORT-validator/index.html)
8+
- [Installation](https://nicmx.github.io/FORT-validator/installation.html)
9+
- [Usage](https://nicmx.github.io/FORT-validator/run.html)
10+
- [Arguments](https://nicmx.github.io/FORT-validator/usage.html)
1011

1112
## Docker image
1213

13-
A Dockerfile to build the image is located at the [docker directory](docker/).
14-
15-
## Quick start
16-
17-
TL;DR all the docs, probably you just want to read:
18-
- How to install? Visit [Compilation and Installation](https://nicmx.github.io/FORT-validator/installation.html).
19-
- How to execute? Visit [Basic Usage](https://nicmx.github.io/FORT-validator/run.html) and [Program Arguments](https://nicmx.github.io/FORT-validator/usage.html).
20-
- How to configure the router(s)? Visit [Routers](https://nicmx.github.io/FORT-validator/routers.html).
14+
See the [docker/ directory](docker/).

docs/usage.md

Lines changed: 33 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,6 @@ description: Guide to use arguments of FORT Validator.
8686
[--configuration-file=<file>]
8787
[--tal=<file>|<directory>]
8888
[--local-repository=<directory>]
89-
[--sync-strategy=off|root|root-except-ta]
90-
[--shuffle-uris=true|false]
9189
[--maximum-certificate-depth=<unsigned integer>]
9290
[--slurm=<file>|<directory>]
9391
[--mode=server|standalone]
@@ -102,19 +100,15 @@ description: Guide to use arguments of FORT Validator.
102100
[--server.interval.expire=<unsigned integer>]
103101
[--server.deltas.lifetime=<unsigned integer>]
104102
[--rsync.enabled=true|false]
105-
[--rsync.priority=<32-bit unsigned integer>]
106-
[--rsync.strategy=root|root-except-ta]
103+
[--rsync.priority=<unsigned integer>]
107104
[--rsync.retry.count=<unsigned integer>]
108105
[--rsync.retry.interval=<unsigned integer>]
109-
[--rrdp.enabled=true|false]
110-
[--rrdp.priority=<32-bit unsigned integer>]
111-
[--rrdp.retry.count=<unsigned integer>]
112-
[--rrdp.retry.interval=<unsigned integer>]
113106
[--http.enabled=true|false]
114-
[--http.priority=<32-bit unsigned integer>]
107+
[--http.priority=<unsigned integer>]
115108
[--http.retry.count=<unsigned integer>]
116109
[--http.retry.interval=<unsigned integer>]
117110
[--http.user-agent=<string>]
111+
[--http.max-redirs=<unsigned integer>]
118112
[--http.connect-timeout=<unsigned integer>]
119113
[--http.transfer-timeout=<unsigned integer>]
120114
[--http.low-speed-limit=<unsigned integer>]
@@ -139,11 +133,9 @@ description: Guide to use arguments of FORT Validator.
139133
[--output.bgpsec=<file>]
140134
[--output.format=csv|json]
141135
[--asn1-decode-max-stack=<unsigned integer>]
142-
[--stale-repository-period=<unsigned integer>]
143136
[--init-tals=true|false]
144137
[--init-as0-tals=true|false]
145138
[--thread-pool.server.max=<unsigned integer>]
146-
[--thread-pool.validation.max=<unsigned integer>]
147139
```
148140

149141
If an argument is specified more than once, the last one takes precedence:
@@ -942,91 +934,91 @@ The configuration options are mostly the same as the ones from the `argv` interf
942934

943935
<pre><code>{
944936
"<a href="#--tal">tal</a>": "/tmp/fort/tal/",
945-
"<a href="#--local-repository">local-repository</a>": "/tmp/fort/repository/",
937+
"<a href="#--local-repository">local-repository</a>": "/tmp/fort/repository",
946938
"<a href="#--work-offline">work-offline</a>": false,
947-
"<a href="#--shuffle-uris">shuffle-uris</a>": true,
948939
"<a href="#--maximum-certificate-depth">maximum-certificate-depth</a>": 32,
949940
"<a href="#--mode">mode</a>": "server",
950941
"<a href="#--daemon">daemon</a>": false,
951942
"<a href="#--slurm">slurm</a>": "/tmp/fort/test.slurm",
943+
"<a href="#--asn1-decode-max-stack">asn1-decode-max-stack</a>": 4096,
952944

953945
"server": {
954946
"<a href="#--serveraddress">address</a>": [
955947
"192.0.2.1",
956948
"2001:db8::1"
957949
],
958950
"<a href="#--serverport">port</a>": "8323",
959-
"<a href="#--serverbacklog">backlog</a>": 16,
951+
"<a href="#--serverbacklog">backlog</a>": 4096,
960952
"interval": {
961953
"<a href="#--serverintervalvalidation">validation</a>": 3600,
962954
"<a href="#--serverintervalrefresh">refresh</a>": 3600,
963955
"<a href="#--serverintervalretry">retry</a>": 600,
964956
"<a href="#--serverintervalexpire">expire</a>": 7200
965957
},
966958
"deltas": {
967-
"<a href="#--serverdeltaslifetime">lifetime</a>": 4
959+
"<a href="#--serverdeltaslifetime">lifetime</a>": 2
968960
}
969961
},
970962

971963
"log": {
972964
"<a href="#--logenabled">enabled</a>": true,
973-
"<a href="#--loglevel">level</a>": "warning",
974965
"<a href="#--logoutput">output</a>": "console",
975-
"<a href="#--logcolor-output">color-output</a>": true,
976-
"<a href="#--logfile-name-format">file-name-format</a>": "file-name",
966+
"<a href="#--loglevel">level</a>": "info",
967+
"<a href="#--logtag">tag</a>": "Operation",
977968
"<a href="#--logfacility">facility</a>": "daemon",
978-
"<a href="#--logtag">tag</a>": "Operation"
969+
"<a href="#--logfile-name-format">file-name-format</a>": "global-url",
970+
"<a href="#--logcolor-output">color-output</a>": false
979971
},
980972

981973
"validation-log": {
982974
"<a href="#--validation-logenabled">enabled</a>": false,
983-
"<a href="#--validation-loglevel">level</a>": "warning",
984975
"<a href="#--validation-logoutput">output</a>": "console",
985-
"<a href="#--validation-logcolor-output">color-output</a>": true,
986-
"<a href="#--validation-logfile-name-format">file-name-format</a>": "global-url",
976+
"<a href="#--validation-loglevel">level</a>": "warning",
977+
"<a href="#--validation-logtag">tag</a>": "Validation",
987978
"<a href="#--validation-logfacility">facility</a>": "daemon",
988-
"<a href="#--validation-logtag">tag</a>": "Validation"
979+
"<a href="#--validation-logfile-name-format">file-name-format</a>": "global-url",
980+
"<a href="#--validation-logcolor-output">color-output</a>": false
989981
},
990982

991983
"http": {
992984
"<a href="#--httpenabled">enabled</a>": true,
993985
"<a href="#--httppriority">priority</a>": 60,
994986
"retry": {
995-
"<a href="#--httpretrycount">count</a>": 2,
996-
"<a href="#--httpretryinterval">interval</a>": 5
987+
"<a href="#--httpretrycount">count</a>": 1,
988+
"<a href="#--httpretryinterval">interval</a>": 4
997989
},
998990
"<a href="#--httpuser-agent">user-agent</a>": "{{ page.command }}/{{ site.fort-latest-version }}",
991+
"<a href="#--httpconnect-timeout">max-redirs</a>": 10,
999992
"<a href="#--httpconnect-timeout">connect-timeout</a>": 30,
1000993
"<a href="#--httptransfer-timeout">transfer-timeout</a>": 0,
1001-
"<a href="#--httplow-speed-limit">low-speed-limit</a>": 30,
994+
"<a href="#--httplow-speed-limit">low-speed-limit</a>": 100000,
1002995
"<a href="#--httplow-speed-time">low-speed-time</a>": 10,
1003-
"<a href="#--httpmax-file-size">max-file-size</a>": 10000000,
996+
"<a href="#--httpmax-file-size">max-file-size</a>": 1000000000,
1004997
"<a href="#--httpca-path">ca-path</a>": "/usr/local/ssl/certs"
1005998
},
1006999

10071000
"rsync": {
10081001
"<a href="#--rsyncenabled">enabled</a>": true,
10091002
"<a href="#--rsyncpriority">priority</a>": 50,
1010-
"<a href="#--rsyncstrategy">strategy</a>": "root-except-ta",
10111003
"retry": {
1012-
"<a href="#--rsyncretrycount">count</a>": 2,
1013-
"<a href="#--rsyncretryinterval">interval</a>": 5
1004+
"<a href="#--rsyncretrycount">count</a>": 1,
1005+
"<a href="#--rsyncretryinterval">interval</a>": 4
10141006
},
10151007
"<a href="#rsyncprogram">program</a>": "rsync",
10161008
"<a href="#rsyncarguments-recursive">arguments-recursive</a>": [
1017-
"--recursive",
1009+
"-rtz",
10181010
"--delete",
1019-
"--times",
1011+
"--omit-dir-times",
10201012
"--contimeout=20",
1013+
"--max-size=20MB",
10211014
"--timeout=15",
1022-
"$REMOTE",
1023-
"$LOCAL"
1024-
],
1025-
"<a href="#rsyncarguments-flat">arguments-flat</a>": [
1026-
"--times",
1027-
"--contimeout=20",
1028-
"--timeout=15",
1029-
"--dirs",
1015+
"--include=*/",
1016+
"--include=*.cer",
1017+
"--include=*.crl",
1018+
"--include=*.gbr",
1019+
"--include=*.mft",
1020+
"--include=*.roa",
1021+
"--exclude=*",
10301022
"$REMOTE",
10311023
"$LOCAL"
10321024
]
@@ -1068,14 +1060,8 @@ The configuration options are mostly the same as the ones from the `argv` interf
10681060
"thread-pool": {
10691061
"server": {
10701062
"<a href="#--thread-poolservermax">max</a>": 20
1071-
},
1072-
"validation": {
1073-
"<a href="#--thread-poolvalidationmax">max</a>": 5
10741063
}
1075-
},
1076-
1077-
"<a href="#--asn1-decode-max-stack">asn1-decode-max-stack</a>": 4096,
1078-
"<a href="#--stale-repository-period">stale-repository-period</a>": 43200
1064+
}
10791065
}
10801066
</code></pre>
10811067

man/fort.8

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH fort 8 "2023-11-16" "v1.6.0" "FORT validator"
1+
.TH fort 8 "2023-11-30" "v1.6.0" "FORT validator"
22

33
.SH NAME
44
fort \- RPKI validator and RTR server
@@ -1187,91 +1187,98 @@ validating every 30 minutes, and printing the ROAs CSV in a file.
11871187
This is an example of a valid JSON configuration file with all its members set
11881188
to a specific value:
11891189
.nf
1190-
11911190
{
11921191
"tal": "/tmp/fort/tal/",
1193-
"local-repository": "/tmp/fort/repository/",
1192+
"local-repository": "/tmp/fort/repository",
11941193
"work-offline": false,
1195-
"shuffle-uris": true,
11961194
"maximum-certificate-depth": 32,
11971195
"mode": "server",
11981196
"daemon": false,
11991197
"slurm": "/tmp/fort/test.slurm",
1198+
"asn1-decode-max-stack": 4096,
1199+
12001200
"server": {
12011201
"address": [
12021202
"192.0.2.1",
12031203
"2001:db8::1"
12041204
],
12051205
"port": "8323",
1206-
"backlog": 64,
1206+
"backlog": 4096,
12071207
"interval": {
12081208
"validation": 3600,
12091209
"refresh": 3600,
12101210
"retry": 600,
12111211
"expire": 7200
12121212
},
12131213
"deltas": {
1214-
"lifetime": 4
1214+
"lifetime": 2
12151215
}
12161216
},
1217+
12171218
"log": {
12181219
"enabled": true,
1219-
"level": "warning",
12201220
"output": "console",
1221-
"color-output": true,
1222-
"file-name-format": "local-path",
1221+
"level": "info",
1222+
"tag": "Operation",
12231223
"facility": "daemon",
1224-
"tag": "Operation"
1224+
"file-name-format": "global-url",
1225+
"color-output": false
12251226
},
1227+
12261228
"validation-log": {
12271229
"enabled": false,
1228-
"level": "warning",
12291230
"output": "console",
1230-
"color-output": true,
1231-
"file-name-format": "local-path",
1231+
"level": "warning",
1232+
"tag": "Validation",
12321233
"facility": "daemon",
1233-
"tag": "Validation"
1234+
"file-name-format": "global-url",
1235+
"color-output": false
12341236
},
1237+
12351238
"http": {
12361239
"enabled": true,
12371240
"priority": 60,
12381241
"retry": {
1239-
"count": 2,
1240-
"interval": 5
1242+
"count": 1,
1243+
"interval": 4
12411244
},
1242-
"user-agent": "fort/1.5.1",
1245+
"user-agent": "fort/1.6.0",
1246+
"max-redirs": 10,
12431247
"connect-timeout": 30,
12441248
"transfer-timeout": 0,
1245-
"idle-timeout": 15,
1249+
"low-speed-limit": 100000,
1250+
"low-speed-time": 10,
1251+
"max-file-size": 1000000000,
12461252
"ca-path": "/usr/local/ssl/certs"
12471253
},
1254+
12481255
"rsync": {
12491256
"enabled": true,
12501257
"priority": 50,
1251-
"strategy": "root-except-ta",
12521258
"retry": {
1253-
"count": 2,
1254-
"interval": 5
1259+
"count": 1,
1260+
"interval": 4
12551261
},
12561262
"program": "rsync",
12571263
"arguments-recursive": [
1258-
"--recursive",
1264+
"-rtz",
12591265
"--delete",
1260-
"--times",
1261-
"--contimeout=20",
1262-
"--timeout=15",
1263-
"$REMOTE",
1264-
"$LOCAL"
1265-
],
1266-
"arguments-flat": [
1267-
"--times",
1266+
"--omit-dir-times",
12681267
"--contimeout=20",
1268+
"--max-size=20MB",
12691269
"--timeout=15",
1270-
"--dirs",
1270+
"--include=*/",
1271+
"--include=*.cer",
1272+
"--include=*.crl",
1273+
"--include=*.gbr",
1274+
"--include=*.mft",
1275+
"--include=*.roa",
1276+
"--exclude=*",
12711277
"$REMOTE",
12721278
"$LOCAL"
12731279
]
12741280
},
1281+
12751282
"incidences": [
12761283
{
12771284
"name": "incid-hashalg-has-params",
@@ -1298,20 +1305,18 @@ to a specific value:
12981305
"action": "error"
12991306
}
13001307
],
1308+
13011309
"output": {
13021310
"roa": "/tmp/fort/roas.csv",
13031311
"bgpsec": "/tmp/fort/bgpsec.csv",
13041312
"format": "csv"
13051313
},
1314+
13061315
"thread-pool": {
13071316
"server": {
13081317
"max": 20
1309-
},
1310-
"validation": {
1311-
"max": 5
13121318
}
1313-
},
1314-
"asn1-decode-max-stack": 4096
1319+
}
13151320
}
13161321
.fi
13171322
.RE

test/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ vrps_test_LDADD = ${MY_LDADD} ${JANSSON_LIBS}
9292
xml_test_SOURCES = xml_test.c
9393
xml_test_LDADD = ${MY_LDADD} ${XML2_LIBS}
9494

95-
EXTRA_DIST = mock.c
95+
EXTRA_DIST = mock.c mock.h
9696
EXTRA_DIST += line_file/core.txt
9797
EXTRA_DIST += line_file/empty.txt
9898
EXTRA_DIST += line_file/error.txt

0 commit comments

Comments
 (0)