Add explanatory comments.

svn path=/rpkid/myrpki.rnc; revision=3525

1 files changed, 29 insertions, 0 deletions

diff --git a/rpkid/myrpki.rnc b/rpkid/myrpki.rnc
index bd29687e..8625d3f6 100644
--- a/rpkid/myrpki.rnc
+++ b/rpkid/myrpki.rnc
@@ -33,6 +33,14 @@ ipv4_list	= xsd:string { maxLength="512000" pattern="[\-,0-9/.]*" }
 ipv6_list	= xsd:string { maxLength="512000" pattern="[\-,0-9/:a-fA-F]*" }
 timestamp       = xsd:dateTime { pattern=".*Z" }
 
+# Message formate used between configure_resources and
+# configure_daemons.
+#
+# The <bpki_server_ta/> subelement here is a TLS relic that I missed
+# removing when I ripped out the rest of the TLS code; the only reason
+# I haven't this element is to avoid breaking interoperability with
+# code that still generates it.
+
 start |= element myrpki {
   attribute version { version },
   attribute handle { object_handle },
@@ -69,27 +77,38 @@ start |= element myrpki {
   element bpki_server_ta { base64 }?
 }
 
+# Format of an identity.xml file.
+
 start |= element identity {
   attribute version { version },
   attribute handle { object_handle },
   element bpki_ta { base64 }
 }
 
+# Format of <authorization/> element used in referrals.  The Base64
+# text is a <referral/> (q. v.) element signed with CMS.
+
 authorization = element authorization {
   attribute referrer { pubd_handle },
   base64
 }
 
+# Format of <contact_info/> element used in referrals.
+
 contact_info = element contact_info {
   attribute uri { uri }?,
   xsd:string
 }
 
+# Variant payload portion of a <repository/> element.
+
 repository_payload = (
   (attribute type { "offer" }) |
   (attribute type { "referral" }, authorization, contact_info)
 )
 
+# <parent/> element (response from configure_child).
+
 start |= element parent {
   attribute version { version },
   attribute valid_until { timestamp },
@@ -101,6 +120,9 @@ start |= element parent {
   element repository { repository_payload }?
 }
 
+# <repository/> element, types offer and referral
+# (input to configure_publication_client).
+
 start |= element repository {
   attribute version { version },
   attribute handle { object_handle },
@@ -109,6 +131,9 @@ start |= element repository {
   element bpki_client_ta { base64 }
 }
 
+# <repository/> element, confirmation type (output of
+# configure_publication_client).
+
 start |= element repository {
   attribute version { version },
   attribute type { "confirmed" },
@@ -122,6 +147,10 @@ start |= element repository {
   contact_info?
 }
 
+# <referral/> element.  This is the entirety of a separate message
+# which is signed with CMS then included ase the Base64 content of an
+# <authorization/> element in the main message.
+
 start |= element referral {
   attribute version { version },
   attribute authorized_sia_base { uri },