[
https://issues.apache.org/jira/browse/DISPATCH-1338?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16850694#comment-16850694
]
ASF GitHub Bot commented on DISPATCH-1338:
------------------------------------------
PaulRMellor commented on pull request #512: DISPATCH-1338: Restructure Dispatch
Router book for edge router
URL: https://github.com/apache/qpid-dispatch/pull/512#discussion_r288459629
##########
File path:
docs/books/user-guide/modules/securing-connections-between-routers.adoc
##########
@@ -0,0 +1,118 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License
+////
+
+// Module is included in the following assemblies:
+//
+// securing-network-connections.adoc
+
+[id='securing-connections-between-routers-{context}']
+= Securing connections between routers
+
+Connections between interior routers should be secured with SSL/TLS encryption
and authentication (also called mutual authentication) to prevent unauthorized
routers (or endpoints pretending to be routers) from joining the network.
+
+SSL/TLS mutual authentication requires an X.509 Certificate Authority (CA)
with individual certificates generated for each interior router. Connections
between the interior routers are encrypted, and the CA authenticates each
incoming inter-router connection.
+
+This procedure describes how to secure a connection between two interior
routers using SSL/TLS mutual authentication. You can also use this method to
secure connections between edge routers and interior routers, but it is not
required.
+
+.Prerequisites
+
+* An X.509 Certificate Authority must exist for the interior routers.
+
+* A security certificate must be generated for each router and be signed by
the CA.
+
+* An inter-router connection must exist between the routers.
++
+For more information, see xref:connecting-routers-router[].
+
+.Procedure
+
+. On the router that establishes the connection, do the following:
+
+.. Open the {RouterConfigFile}.
+
+.. If the router does not contain an `sslProfile` that defines the private
keys and certificates for the inter-router network, then add one.
++
+--
+This `sslProfile` contains the locations of the private key and certificates
that the router should use to authenticate with its peer.
+
+[options="nowrap",subs="+quotes"]
+----
+sslProfile {
+ name: inter-router-tls
+ certFile: /etc/qpid-dispatch-certs/inter-router/tls.crt
+ privateKeyFile: /etc/qpid-dispatch-certs/inter-router/tls.key
+ caCertFile: /etc/qpid-dispatch-certs/inter-router/ca.crt
+ ...
+}
+----
+`name`:: A unique name that you can use to refer to this `sslProfile`.
+
+`certFile`:: The absolute path to the file containing the public certificate
for this router.
+
+`privateKeyFile`:: The absolute path to the file containing the private key
for this router's public certificate.
+
+`caCertFile`:: The absolute path to the CA certificate that was used to sign
the router's certificate.
+--
+
+.. Configure the inter-router `connector` for this connection to use the
`sslProfile` that you created.
++
+--
+[options="nowrap",subs="+quotes"]
+----
+connector {
+ host: 192.0.2.1
+ port: 5001
+ role: inter-router
+ sslProfile: inter-router-tls
+ ...
+}
+----
+`sslProfile`:: The name of the `sslProfile` that defines the SSL/TLS private
keys and certificates for the inter-router network.
+--
+
+. On the router that listens for the connection, do the following:
+
+.. Open the {RouterConfigFile}.
Review comment:
```suggestion
.. Open the `{RouterConfigFile}` configuration file.
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> Improvements to edge router documentation
> -----------------------------------------
>
> Key: DISPATCH-1338
> URL: https://issues.apache.org/jira/browse/DISPATCH-1338
> Project: Qpid Dispatch
> Issue Type: Improvement
> Components: Documentation
> Reporter: Ben Hardesty
> Priority: Major
>
> Restructure the doc for edge router.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
