Skip to content

Commit ee95bb6

Browse files
authored
Fix keystore dir name (ros2#3634)
Signed-off-by: Yadunund <[email protected]>
1 parent 5945669 commit ee95bb6

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

source/Tutorials/Advanced/Security/Access-Controls.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Setting access controls
2121
Background
2222
----------
2323

24+
Before proceeding ensure you have completed the :doc:`Introducing-ros2-security` tutorial.
25+
2426
Permissions are quite flexible and can be used to control many behaviors within the ROS graph.
2527

2628
For this tutorial, we demonstrate a policy which only allows publishing messages on the default ``chatter`` topic.
@@ -37,7 +39,7 @@ Begin by making a backup of your permissions files, and open ``permissions.xml``
3739

3840
.. code-block:: bash
3941
40-
cd ~/sros2_demo/demo_keys/enclaves/talker_listener/talker
42+
cd ~/sros2_demo/demo_keystore/enclaves/talker_listener/talker
4143
mv permissions.p7s permissions.p7s~
4244
mv permissions.xml permissions.xml~
4345
vi permissions.xml
@@ -115,7 +117,7 @@ If the private key has been protected, additional steps may be required to unloc
115117
116118
openssl smime -sign -text -in permissions.xml -out permissions.p7s \
117119
--signer permissions_ca.cert.pem \
118-
-inkey ~/sros2_demo/demo_keys/private/permissions_ca.key.pem
120+
-inkey ~/sros2_demo/demo_keystore/private/permissions_ca.key.pem
119121
120122
121123
Launch the node

source/Tutorials/Advanced/Security/Security-on-Two.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Ensuring security across machines
2121
Background
2222
----------
2323

24+
Before proceeding ensure you have completed the :doc:`Introducing-ros2-security` tutorial.
25+
2426
The previous tutorials have used two ROS nodes on the same machine sending all network communications over the localhost interface.
2527
Let's extend that scenario to involve multiple machines, since the benefits of authentication and encryption then become more obvious.
2628

source/Tutorials/Advanced/Security/The-Keystore.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Understanding the security keystore
2121
Background
2222
----------
2323

24+
Before proceeding ensure you have completed the :doc:`Introducing-ros2-security` tutorial.
25+
2426
The ``sros2`` package can be used to create keys, certificates and policies necessary to enable ROS 2 security.
2527
However, the security configuration is extrememly flexible.
2628
A basic understanding of the ROS 2 Security Keystore will allow integration with an existing PKI (Public Key Infrastructure) and managment of sensitive key materials consistent with organizational policies.
@@ -41,7 +43,7 @@ For this tutorial, we use the directory ``~/sros2_demo/demo_keystore``.
4143
Public Key Materials
4244
^^^^^^^^^^^^^^^^^^^^
4345

44-
You will find three encryption certificates in the public directory at ``~/sros2_demo/demo_keys/public``; however, the identity and permissions certificates are actually just a link to the Certificate Authority (CA) certificate.
46+
You will find three encryption certificates in the public directory at ``~/sros2_demo/demo_keystore/public``; however, the identity and permissions certificates are actually just a link to the Certificate Authority (CA) certificate.
4547

4648
In a public key infrastructure, the `Certificate Authority <https://en.wikipedia.org/wiki/Certificate_authority>`_ acts as a trust anchor: it validates the identities and permissions of participants.
4749
For ROS, that means all the nodes that participate in the ROS graph (which may extend to an entire fleet of individual robots).
@@ -58,7 +60,7 @@ Use ``openssl`` to view this x509 certificate and display it as text:
5860

5961
.. code-block:: bash
6062
61-
cd ~/sros2_demo/demo_keys/public
63+
cd ~/sros2_demo/demo_keystore/public
6264
openssl x509 -in ca.cert.pem -text -noout
6365
6466
The output should look similar to the following::
@@ -106,7 +108,7 @@ Since this is a public certificate, it can be freely copied as needed to establi
106108
Private Key Materials
107109
^^^^^^^^^^^^^^^^^^^^^
108110

109-
Private key materials can be found in the keystore directory ``~/sros2_demo/demo_keys/private``.
111+
Private key materials can be found in the keystore directory ``~/sros2_demo/demo_keystore/private``.
110112
Similar to the ``public`` directory, this contains one certificate authority key ``ca.key.pem`` and symbolic links to it to be used as both an Identity and a Permissions CA private key.
111113

112114
.. warning::
@@ -128,7 +130,7 @@ Use the following command to show details about this elliptic curve private key:
128130

129131
.. code-block:: bash
130132
131-
cd ~/sros2_demo/demo_keys/private
133+
cd ~/sros2_demo/demo_keystore/private
132134
openssl ec -in ca.key.pem -text -noout
133135
134136
Your output should look similar to the following::
@@ -154,7 +156,7 @@ In addition to the private key itself, note that the public key is listed, and i
154156
Domain Governance Policy
155157
^^^^^^^^^^^^^^^^^^^^^^^^
156158

157-
Find the domain governance policy in the enclave directory within the keystore, ``~/sros2_demo/demo_keys/enclaves``.
159+
Find the domain governance policy in the enclave directory within the keystore, ``~/sros2_demo/demo_keystore/enclaves``.
158160
The ``enclave`` directory contains XML governance policy document ``governance.xml``, as well as a copy of the document which has been signed by the Permissions CA as ``governance.p7s``.
159161

160162
The ``governance.p7s`` file contains domain-wide settings such as how to handle unauthenticated participants, whether to encrypt discovery, and default rules for access to topics.
@@ -211,7 +213,7 @@ Begin with a new terminal session and enable security with the keystore created
211213
export ROS_SECURITY_ENABLE=true
212214
export ROS_SECURITY_STRATEGY=Enforce
213215
214-
cd ~/sros2_demo/demo_keys/enclaves/talker_listener/listener
216+
cd ~/sros2_demo/demo_keystore/enclaves/talker_listener/listener
215217
216218
Make a backup copy of ``permissions.p7s`` before beginning.
217219

0 commit comments

Comments
 (0)