<?xml version="1.0" encoding="utf-8"?>
<!-- name="GENERATOR" content="github.com/mmarkdown/mmark Mmark Markdown Processor - mmark.miek.nl" -->
<rfc version="3" ipr="trust200902" docName="draft-timbru-sidrops-publication-server-bcp-01" submissionType="IETF" category="bcp" xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude" obsoletes="8416" indexInclude="true" consensus="true">

<front>
<title abbrev="RPKI Publication Server Operations">RPKI Publication Server Best Current Practices</title><seriesInfo value="draft-timbru-sidrops-publication-server-bcp-01" status="bcp" name="Internet-Draft"></seriesInfo>
<author initials="T." surname="Bruijnzeels" fullname="Tim Bruijnzeels"><organization>NLnet Labs</organization><address><postal><street></street>
</postal><email>tim@nlnetlabs.nl</email>
<uri>https://www.nlnetlabs.nl/</uri>
</address></author><author initials="T." surname="de Kock" fullname="Ties de Kock"><organization>RIPE NCC</organization><address><postal><street></street>
</postal><email>tdekock@ripe.net</email>
</address></author><author initials="F." surname="Hill" fullname="Frank Hill"><organization>ARIN</organization><address><postal><street></street>
</postal><email>frank@arin.net</email>
</address></author><author initials="T." surname="Harrison" fullname="Tom Harrison"><organization>APNIC</organization><address><postal><street></street>
</postal><email>tomh@apnic.net</email>
</address></author><date/>
<area>Internet</area>
<workgroup></workgroup>

<abstract>
<t>This document describes best current practices for operating an RFC 8181
RPKI Publication Server and its rsync (RFC 5781) and RRDP (RFC 8182) public
repositories.</t>
</abstract>

</front>

<middle>

<section anchor="requirements-notation"><name>Requirements notation</name>
<t>The key words &quot;MUST&quot;, &quot;MUST NOT&quot;, &quot;REQUIRED&quot;, &quot;SHALL&quot;, &quot;SHALL NOT&quot;, &quot;SHOULD&quot;,
&quot;SHOULD NOT&quot;, &quot;RECOMMENDED&quot;, &quot;NOT RECOMMENDED&quot;, &quot;MAY&quot;, and &quot;OPTIONAL&quot; in
this document are to be interpreted as described in BCP 14 <xref target="RFC2119"></xref>
<xref target="RFC8174"></xref> when, and only when, they appear in all capitals, as shown here.</t>
</section>

<section anchor="introduction"><name>Introduction</name>
<t><xref target="RFC8181"></xref> describes the RPKI Publication Protocol used between
RPKI Certificate Authorities (CAs) and their Publication Repository server.
The server is responsible for handling publication requests sent by the
CAs, called Publishers in this context, and ensuring that their data is
made available to RPKI Relying Parties (RPs) in (public) rsync and RRDP
<xref target="RFC8182"></xref> publication points.</t>
<t>In this document, we will describe best current practices based on the
operational experience of several implementers and operators.</t>
</section>

<section anchor="glossary"><name>Glossary</name>
<table>
<thead>
<tr>
<th>Term</th>
<th>Description</th>
</tr>
</thead>

<tbody>
<tr>
<td>Publication Server</td>
<td><xref target="RFC8181"></xref> Publication Repository server</td>
</tr>

<tr>
<td>Publishers</td>
<td><xref target="RFC8181"></xref> Publishers (Certificate Authorities)</td>
</tr>

<tr>
<td>RRDP Repository</td>
<td>Public facing <xref target="RFC8182"></xref> RRDP repository</td>
</tr>

<tr>
<td>Rsync Repository</td>
<td>Public facing rsync server</td>
</tr>
</tbody>
</table></section>

<section anchor="publication-server"><name>Publication Server</name>
<t>The Publication Server handles the server side of the <xref target="RFC8181"></xref> Publication
Protocol. The Publication Server generates the content for the public-facing
RRDP and Rsync Repositories. It is strongly RECOMMENDED that these functions
are separated from serving the repository content.</t>

<section anchor="availability"><name>Availability</name>
<t>The Publication Server and repository content have different demands on their
availability and reachability. While the repository content MUST be highly
available to any RP worldwide, only publishers need to access the Publication
Server. Dependent on the specific setup, this may allow for additional access
restrictions in this context. For example, the Publication Server can limit
access to known source IP addresses or apply rate limits.</t>
<t>If the Publication Server is unavailable for some reason, this will prevent
Publishers from publishing any updated RPKI objects. The most immediate impact
of this is that the publisher cannot update their ROAs, ASPAs or BGPSec Router
Certificates during this outage. Thus, it cannot authorise changes in its
routing operations. If the outage persists for a more extended period, then the
RPKI manifests and CRLs published will expire, resulting in the RPs rejecting
CA publication points.</t>
<t>For this reason, the Publication Server MUST be operated in a highly available
fashion. Maintenance windows SHOULD be planned and communicated to publishers,
so they can avoid - if possible - that changes in published RPKI objects are
needed during these windows.</t>
</section>
</section>

<section anchor="rrdp-repository"><name>RRDP Repository</name>
<t>In this section, we will elaborate on the following recommendations:</t>

<ul spacing="compact">
<li>Use a separate hostname: do not share fate with rsync or the Publication Server.</li>
<li>Use a CDN if possible</li>
<li>Use randomized filenames for Snapshot and Delta Files</li>
<li>Limit the size of the Notification File</li>
<li>Combine deltas to limit the size of the Notification File</li>
<li>Timing of publication of Notification File</li>
</ul>

<section anchor="unique-hostname"><name>Unique Hostname</name>
<t>It is RECOMMENDED that the public RRDP Repository URIs use a hostname different
from both the <xref target="RFC8181"></xref> service_uri used by publishers, and the hostname used
in rsync URIs (<tt>sia_base</tt>).</t>
<t>Using a unique hostname will allow the operator to use dedicated infrastructure
and/or a Content Delivery Network for its RRDP content without interfering with
the other functions.</t>
</section>

<section anchor="content-delivery-network"><name>Content Delivery Network</name>
<t>If possible, it is strongly RECOMMENDED that a Content Delivery Network is used
to serve the RRDP content. Care MUST BE taken to ensure that the Notification
File is not cached for longer than 1 minute unless the back-end RRDP Repository
is unavailable, in which case it is RECOMMENDED that stale files are served.</t>
<t>When using a CDN, it will likely cache 404s for files not found on the back-end
server. Because of this, the Publication Server SHOULD use randomized,
unpredictable paths for Snapshot and Delta Files to avoid the CDN caching such
404s for future updates.</t>
<t>Alternatively, the Publication Server can delay writing the notification file
for this duration or clear the CDN cache for any new files it publishes.</t>
</section>

<section anchor="limit-notification-file-size"><name>Limit Notification File Size</name>
<t>The size of the RRDP Notification File can significantly impact RRDP
operations. If this file becomes too large, then it can easily result in
significant traffic if the RRDP Repository does not use any CDN or in high
costs if it does.</t>
<t><xref target="RFC8182"></xref> stipulated that any deltas that, combined with all more recent
delta, will result in the total size of deltas exceeding the snapshot size MUST
be excluded to avoid Relying Parties downloading more data than necessary.</t>
<t>In addition to the restriction described above, we RECOMMEND that the
Notification File size is reduced by removing delta files that have been
available for more than 75 minutes. As RP typically refresh their caches every
10 minutes, this will ensure that deltas are available for the vast majority of
RPs, while limiting the size of the Notification File.</t>
<t>Furthermore, we RECOMMEND that Publication Servers with many, e.g. 1000s of,
Publishers ensure they do not produce Delta Files more frequently than once per
minute. A possible approach for this is that the Publication Server SHOULD
publish changes at a regular (one-minute) interval. The Publication Server then
publishes the updates received from all Publishers in this interval in a single
RRDP Delta File.</t>
</section>

<section anchor="consistent-load-balancing-and-notification-file-timing"><name>Consistent load-balancing and Notification File Timing</name>
<t>Notification Files MUST NOT be available to RPs before the referenced snapshot
and delta files are available.</t>
<t>As a result, when using a load-balancing setup, care SHOULD be taken to ensure
that RPs that make multiple subsequent requests receive content from the same
node (e.g. consistent hashing). This way, clients view the timeline on one node
where the referenced snapshot and delta files are available. Alternatively,
publication infrastructure SHOULD ensure a particular ordering of the
visibility of the snapshot plus delta and notification file. All nodes should
receive the new snapshot and delta files before any node receives the new
notification file.</t>
<t>When using a load-balancing setup with multiple backends, each backend MUST
provide a consistent view and MUST update more frequently than the typical
refresh rate for rsync repositories used by RPs. When these conditions hold,
RPs observe the same RRDP session with the serial monotonically increasing.
Unfortunately, <xref target="RFC8182"></xref> does not specify RP behavior if the serial regresses. A
s a result, some RPs download the snapshot to re-sync if they observe a serial
regression.</t>
</section>

<section anchor="l4-load-balancing"><name>L4 load-balancing</name>
<t>If an RRDP repository uses L4 load-balancing, some load-balancer
implementations will keep connections to a node in the pool that is no longer
active (e.g. disabled because of maintenance). Due to HTTP keepalive, requests
from an RP (or CDN) may continue to use the disabled node for an extended
period. This issue is especially prominent with CDNs that use HTTP proxies
internally when connecting to the origin while also load-balancing over
multiple proxies. As a result, some requests may use a connection to the
disabled server and retrieve stale content, while other connections load data
from another server. Depending on the exact configuration <u format="char-num">–</u> for example, nodes
behind the LB may have different RRDP sessions <u format="char-num">–</u> this can lead to an
inconsistent RRDP repository.</t>
<t>Because of this issue, we RECOMMEND to (1) limit HTTP keepalive to a short
period on the webservers in the pool and (2) limit the number of HTTP requests
per connection. When applying these recommendations, this issue is limited (and
effectively less impactful when using a CDN due to caching) to a fail-over
between RRDP sessions, where clients also risk reading a notification file for
which some of the content is unavailable.</t>
</section>
</section>

<section anchor="rsync-repository"><name>Rsync Repository</name>
<t>In this section, we will elaborate on the following recommendations:</t>

<ul spacing="compact">
<li>Use symlinks to provide consistent content</li>
<li>Use deterministic timestamps for files</li>
<li>Load balancing and testing</li>
</ul>

<section anchor="consistent-content"><name>Consistent Content</name>
<t>A naive implementation of the Rsync Repository might change the repository
content while RPs transfer files. Even when the repository is consistent from
the repository server's point of view, clients may read an inconsistent set of
files. Clients may get a combination of newer and older files. This &quot;phantom
read&quot; can lead to unpredictable and unreliable results. While modern RPs will
treat such inconsistencies as a &quot;Failed Fetch&quot; (<xref target="RFC9286"></xref>), it is best to
avoid this situation since a failed fetch for one repository can cause the
rejection of the publication point for a sub-CA when resources change.</t>
<t>One way to ensure that rsyncd serves connected clients (RPs) with a consistent
view of the repository is by configuring the rsyncd 'module' path to a path
that contains a symlink that the repository-writing process updates for every
repository publication.</t>
<t>Following this process, when an update is published:</t>

<ol spacing="compact">
<li>write the complete updated repository into a new directory</li>
<li>fix the timestamps of files (see next section)</li>
<li>change the symlink to point to the new directory</li>
</ol>
<t>Multiple implementations implement this behavior (<xref target="krill-sync"></xref>, <xref target="rpki-core"></xref>,
<xref target="rsyncit"></xref>, a supporting shellscript <xref target="rsync-move"></xref>).</t>
<t>Because rsyncd resolves this symlink when it <tt>chdir</tt>s into the module directory
when a client connects, any connected RPs can read a consistent state. To limit
the amount of disk space a repository uses, a Rsync Repository must clean up
copies of the repository; this is a trade-off between providing service to slow
clients and disk space.</t>
<t>A repository can safely remove old directories when no RP fetching at a
reasonable rate is reading that data. Since the last moment an RP can start
reading from a copy is when it last &quot;current&quot;, the time a client has to read a
copy begins when it was last current (c.f. since written).</t>
<t>Empirical data suggests that Rsync Repositories MAY assume it is safe to do so
after one hour. We recommend monitoring for &quot;file has vanished&quot; lines in the
rsync log file to detect how many clients are affected by this cleanup process.</t>
</section>

<section anchor="deterministic-timestamps"><name>Deterministic Timestamps</name>
<t>By default, rsync uses the modification time and file size to determine if it
should transfer a file. Therefore, throughout a file's lifetime, the
modification time SHOULD NOT change unless the file's content changes.</t>
<t>We RECOMMEND the following deterministic heuristics for objects' timestamps
when written to disk. These heuristics assume that a CA is compliant with
<xref target="RFC9286"></xref> and uses &quot;one-time-use&quot; EE certificates:</t>

<ul spacing="compact">
<li>For CRLs, use the value of thisUpdate.</li>
<li>For RPKI Signed Objects, use the CMS signing-time (see
(<xref target="I-D.spaghetti-sidrops-cms-signing-time"></xref>))</li>
<li>For CA and BGPSec Router Certificates, use the value of notBefore</li>
<li>For directories, use any constant value.</li>
</ul>
</section>

<section anchor="load-balancing-and-testing"><name>Load Balancing and Testing</name>
<t>To increase availability, during both regular maintenance and exceptional
situations, a rsync repository that strives for high availability should be
deployed on multiple nodes load-balanced by an L4 load-balancer.  Because Rsync
sessions use a single TCP connection per session, there is no need for
consistent load-balancing between multiple rsyncd servers as long as they each
provide a consistent view. While it is RECOMMENDED that repositories are
updated more frequently than the typical refresh rate for rsync repositories
used by RPs to ensure that the repository continuously moves forward from a
client's point of view, breaking not holding this constraint does not cause
degraded behavior.</t>
<t>It is RECOMMENDED that the Rsync Repository is load tested to ensure that it
can handle the requests by all RPs in case they need to fall back from using
RRDP (as is currently preferred).</t>
<t>We RECOMMEND serving rsync repositories from local storage so the host
operating system can optimally use its I/O cache. Using network storage is NOT
RECOMMENDED because it may not benefit from this cache. For example, when using
NFS, the operating system cannot cache the directory listing(s) of the repository.</t>
<t>We RECOMMENDED setting the &quot;max connections&quot; to a value that a single node can
handle with (1) the available memory and (2) the IO performance available to
be able to serve this number of connections in the time RPs allow for rsync to
fetch data. Load-testing results show that machine memory is likely the limiting
factor for large repositories that are not IO limited.</t>
<t>The number of rsyncd servers needed depends on the number of RPs, their refresh
rate, and the &quot;max connections&quot; used. These values are subject to change over
time, so we cannot give clear recommendations here except to restate that we
RECOMMEND load-testing rsync and re-evaluating these parameters over time.</t>
</section>
</section>

<section anchor="single-ca-repositories"><name>Single CA Repositories</name>
<t>Some delegated CAs in the RPKI use their own dedicated Repository.</t>
<t>Operating a small repository is much easier than operating a large one.
There may not be a need to use a CDN for RRDP because the notification,
snapshot and delta are relatively small. Also, the performance issues of
rscynd for recursive fetches are far less of a problem for small and flat
repositories.</t>
<t>Because RPs will use cached data, short outages don't need to cause
immediate issues if CAs fix their Repository before objects expire and
ensure that their Publication Server (<xref target="RFC8181"></xref>) is available when there
is a need to update RPKI objects such as ROAs.</t>
<t>However, availability issues with such repositories are frequent, which
can negatively impact Relying Party software. Therefore, it is strongly
RECOMMENDED that CAs use a publication service provided by their RIR,
NIR or other parent as much as possible. And it is RECOMMENDED that CAs
that act as a parent make a Publication Service available to their
children.</t>
</section>

<section anchor="acknowledgments"><name>Acknowledgments</name>
<t>This document is the result of many informal discussions between implementers.</t>
<t>The authors would like to thank Job Snijders for their helpful review of this document.</t>
</section>

</middle>

<back>
<references><name>Normative References</name>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml-ids/reference.I-D.spaghetti-sidrops-cms-signing-time.xml"/>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"/>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"/>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8181.xml"/>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8182.xml"/>
<xi:include href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.9286.xml"/>
</references>
<references><name>Informative References</name>
<reference anchor="krill-sync" target="https://github.com/NLnetLabs/krill-sync">
  <front>
    <title>krill-sync</title>
    <author fullname="Tim Bruijnzeels" initials="T." surname="Bruijnzeels">
      <organization>NLnet Labs</organization>
    </author>
    <date year="2023"></date>
  </front>
</reference>
<reference anchor="rpki-core" target="https://github.com/RIPE-NCC/rpki-core">
  <front>
    <title>rpki-core</title>
    <author fullname="RPKI Team">
      <organization>RIPE NCC</organization>
    </author>
    <date year="2023"></date>
  </front>
</reference>
<reference anchor="rsync-move" target="http://sobornost.net/~job/rpki-rsync-move.sh.txt">
  <front>
    <title>rpki-rsync-move.sh.txt</title>
    <author fullname="Job Snijders" initials="J." surname="Snijders">
      <organization>Fastly</organization>
    </author>
    <date year="2023"></date>
  </front>
</reference>
<reference anchor="rsyncit" target="https://github.com/RIPE-NCC/rsyncit">
  <front>
    <title>rpki-core</title>
    <author fullname="RPKI Team">
      <organization>RIPE NCC</organization>
    </author>
    <date year="2023"></date>
  </front>
</reference>
</references>

</back>

</rfc>
