Rename keystore root env from ROS_SECURITY_ROOT_DIRECTORY to ROS_SECU…

…RITY_KEYSTORE (#200)

Signed-off-by: ruffsl <[email protected]>

SROS2_Linux.md

@@ -76,7 +76,7 @@ ros2 security create_key demo_keys /listener
 ### Define the SROS2 environment variables
 
 ```bash
-export ROS_SECURITY_ROOT_DIRECTORY=~/sros2_demo/demo_keys
+export ROS_SECURITY_KEYSTORE=~/sros2_demo/demo_keys
 export ROS_SECURITY_ENABLE=true
 export ROS_SECURITY_STRATEGY=Enforce
 ```

SROS2_MacOS.md

@@ -85,7 +85,7 @@ ros2 security create_key demo_keys /listener
 ### Define the SROS2 environment variables
 
 ```bash
-export ROS_SECURITY_ROOT_DIRECTORY=$(pwd)/demo_keys
+export ROS_SECURITY_KEYSTORE=$(pwd)/demo_keys
 export ROS_SECURITY_ENABLE=true
 export ROS_SECURITY_STRATEGY=Enforce
 ```

SROS2_Windows.md

@@ -76,7 +76,7 @@ Then re-run the commands above.
 Prepare your environment by setting three following environment variables as follows
 
 ```bat
-set ROS_SECURITY_ROOT_DIRECTORY=%cd%/demo_keys
+set ROS_SECURITY_KEYSTORE=%cd%/demo_keys
 set ROS_SECURITY_ENABLE=true
 set ROS_SECURITY_STRATEGY=Enforce
 ```
@@ -102,7 +102,7 @@ Open a new terminal:
 
 ```bat
 call <path_to_ros2_install>/setup.bat
-set ROS_SECURITY_ROOT_DIRECTORY=%cd%/demo_keys
+set ROS_SECURITY_KEYSTORE=%cd%/demo_keys
 set ROS_SECURITY_ENABLE=true
 set ROS_SECURITY_STRATEGY=Enforce
 ros2 run demo_nodes_py talker
@@ -112,7 +112,7 @@ Open another terminal:
 
 ```bat
 call <path_to_ros2_install>/setup.bat
-set ROS_SECURITY_ROOT_DIRECTORY=%cd%/demo_keys
+set ROS_SECURITY_KEYSTORE=%cd%/demo_keys
 set ROS_SECURITY_ENABLE=true
 set ROS_SECURITY_STRATEGY=Enforce
 ros2 run demo_nodes_py listener

sros2/sros2/api/_utilities.py

@@ -25,7 +25,7 @@
 from cryptography.hazmat.primitives.asymmetric import ec
 
 _DOMAIN_ID_ENV = 'ROS_DOMAIN_ID'
-_KEYSTORE_DIR_ENV = 'ROS_SECURITY_ROOT_DIRECTORY'
+_KEYSTORE_DIR_ENV = 'ROS_SECURITY_KEYSTORE'
 
 
 def create_symlink(*, src, dst):

sros2_cmake/README.md

@@ -16,6 +16,6 @@ Macro definition:
     #   Executables can use a different or the same enclaves.
     #   All nodes in the same process use the same enclave.
     # SECURITY (cmake arg) if not define or OFF, will not generate key/keystores
-    # ROS_SECURITY_ROOT_DIRECTORY (env variable) the location of the keystore
+    # ROS_SECURITY_KEYSTORE (env variable) the location of the keystore
     # POLICY_FILE (cmake arg) if defined, will generate security artifacts for each enclave defined in the policy file.
 ```

sros2_cmake/cmake/sros2_generate_artifacts.cmake

@@ -19,15 +19,15 @@ macro(sros2_generate_artifacts)
   # SECURITY (cmake arg) if not defined or OFF, will not generate keystore/keys/permissions
   # POLICY_FILE (cmake arg) if defined, policies defined in the file will used to generate
   #   permission files for all the enclaves listed in the policy file.
-  # ROS_SECURITY_ROOT_DIRECTORY (env variable) will be the location of the keystore
+  # ROS_SECURITY_KEYSTORE (env variable) will be the location of the keystore
   if(NOT SECURITY)
     message(STATUS "Not generating security files")
     return()
   endif()
   find_program(PROGRAM ros2)
 
-  if(DEFINED ENV{ROS_SECURITY_ROOT_DIRECTORY})
-    set(SECURITY_KEYSTORE $ENV{ROS_SECURITY_ROOT_DIRECTORY})
+  if(DEFINED ENV{ROS_SECURITY_KEYSTORE})
+    set(SECURITY_KEYSTORE $ENV{ROS_SECURITY_KEYSTORE})
   else()
     set(SECURITY_KEYSTORE ${DEFAULT_KEYSTORE})
   endif()