Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[16499] Adding system test for secure discovery server #3154

Merged
merged 2 commits into from
Dec 16, 2022
Merged

[16499] Adding system test for secure discovery server #3154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
463e676
Refs #16499: Added secure ds server system test
Mario-DL Dec 14, 2022
869300f
Refs #16499: Added security props to secure_ds XML file
Mario-DL Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions test/communication/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,15 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/secure_submsg_crypto_besteffort_sub.x
${CMAKE_CURRENT_BINARY_DIR}/secure_submsg_crypto_besteffort_sub.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/shm_communication_subscriber_dies_while_processing_message.xml
${CMAKE_CURRENT_BINARY_DIR}/shm_communication_subscriber_dies_while_processing_message.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/secure_ds_pubsub_secure_crypto_communication.py
${CMAKE_CURRENT_BINARY_DIR}/secure_ds_pubsub_secure_crypto_communication.py COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/secure_ds_simple_secure_msg_crypto_pub.xml
${CMAKE_CURRENT_BINARY_DIR}/secure_ds_simple_secure_msg_crypto_pub.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/secure_ds_simple_secure_msg_crypto_sub.xml
${CMAKE_CURRENT_BINARY_DIR}/secure_ds_simple_secure_msg_crypto_sub.xml COPYONLY)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/secure_simple_ds_server.xml
${CMAKE_CURRENT_BINARY_DIR}/secure_simple_ds_server.xml COPYONLY)

if(SECURITY)
configure_file(${PROJECT_SOURCE_DIR}/test/certs/maincacert.pem
${CMAKE_CURRENT_BINARY_DIR}/maincacert.pem COPYONLY)
Expand Down Expand Up @@ -301,6 +310,27 @@ if(PYTHONINTERP_FOUND)
set_property(TEST SimpleCommunicationSecureSubmsgCryptoBestEffort APPEND PROPERTY ENVIRONMENT
"PATH=$<TARGET_FILE_DIR:${PROJECT_NAME}>\\;$<TARGET_FILE_DIR:fastcdr>\\;${WIN_PATH}")
endif()

add_test(NAME SecureDiscoverServerSimplePubSubSecureMsgCrypto
COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/secure_ds_pubsub_secure_crypto_communication.py
--pub $<TARGET_FILE:SimpleCommunicationPublisher>
--xml-pub secure_ds_simple_secure_msg_crypto_pub.xml
--sub $<TARGET_FILE:SimpleCommunicationSubscriber>
--xml-sub secure_ds_simple_secure_msg_crypto_sub.xml
--samples 10 --wait 2
--ds $<TARGET_FILE:fast-discovery-server>
--xml-ds secure_simple_ds_server.xml
--server-id 0)

# Set test with label NoMemoryCheck
set_property(TEST SecureDiscoverServerSimplePubSubSecureMsgCrypto PROPERTY LABELS "NoMemoryCheck")

if(WIN32)
string(REPLACE ";" "\\;" WIN_PATH "$ENV{PATH}")
set_property(TEST SecureDiscoverServerSimplePubSubSecureMsgCrypto APPEND PROPERTY ENVIRONMENT
"PATH=$<TARGET_FILE_DIR:${PROJECT_NAME}>\\;$<TARGET_FILE_DIR:fastcdr>\\;${WIN_PATH}")
endif()

endif()

add_test(NAME LivelinessAssertion
Expand Down
218 changes: 218 additions & 0 deletions test/communication/secure_ds_pubsub_secure_crypto_communication.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
# Copyright 2020 Proyectos y Sistemas de Mantenimiento SL (eProsima).
#
# Licensed 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.
"""Script to test the secure communication with encrypted RTPS messages
over a secure discovery server."""

import argparse
import os
import subprocess
import sys

class ParseOptions():
"""Parse arguments."""

def __init__(self):
"""Object constructor."""
self.args = self.__parse_args()

def __parse_args(self):
"""
Parse the input arguments.

:return: A dictionary containing the arguments parsed.
"""
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
add_help=True,
description=(
'Script to test the secure communication with encrypted RTPS'
'messages.'),
)
parser.add_argument(
'-p',
'--pub',
type=str,
required=True,
help='Path to the Publisher executable.'
)
parser.add_argument(
'-s',
'--sub',
type=str,
required=True,
help='Path to the Subscriber executable.'
)
parser.add_argument(
'-ds',
'--ds-server',
required=True,
type=str,
help='Path to the discovery server executable.'
)
parser.add_argument(
'-P',
'--xml-pub',
type=str,
help='Path to the publisher xml configuration file.'
)
parser.add_argument(
'-S',
'--xml-sub',
type=str,
help='Path to the subscriber xml configuration file.'
)
parser.add_argument(
'-DS',
'--xml-ds',
required=True,
type=str,
help='Path to the xml configuration file containing discovery server.'
)
parser.add_argument(
'-w',
'--wait',
type=int,
help='Time for the publisher to wait for discovery.'
)
parser.add_argument(
'-a',
'--samples',
type=int,
help='Number of samples sent by the publisher.'
)
parser.add_argument(
'-i',
'--server-id',
required=True,
type=int,
help='Unique discovery server identifier.'
)

return parser.parse_args()


def run(args):
"""
Run the publisher, susbcriber and discovery_server.

:param args: The input parameters.

:return: The return code resulting from the publisher, subscriber
and discovery server execution. It is the number of failed processes.
"""
pub_command = []
sub_command = []
ds_command = []

script_dir = os.path.dirname(os.path.realpath(__file__))

if not os.path.isfile(args.pub):
print(f'Publisher executable file does not exists: {args.pub}')
sys.exit(1)

if not os.access(args.pub, os.X_OK):
print(
'Publisher executable does not have execution permissions:'
f'{args.pub}')

pub_command.append(args.pub)

if not os.path.isfile(args.sub):
print(f'Subscriber executable file does not exists: {args.sub}')
sys.exit(1)

if not os.access(args.sub, os.X_OK):
print(
'Subscriber executable does not have execution permissions:'
f'{args.sub}')
sys.exit(1)

sub_command.append(args.sub)

if not os.path.isfile(args.ds_server):
print(f'Discovery server executable file does not exists: {args.ds_server}')
sys.exit(1)

if not os.access(args.ds_server, os.X_OK):
print(
'Discovery server executable does not have execution permissions:'
f'{args.ds_server}')
sys.exit(1)

ds_command.append(args.ds_server)

if args.xml_pub and args.xml_sub and args.xml_ds:
if args.xml_pub:
xml_file_pub = os.path.join(script_dir, args.xml_pub)
if args.xml_sub:
xml_file_sub = os.path.join(script_dir, args.xml_sub)
if args.xml_ds:
xml_file_ds = os.path.join(script_dir, args.xml_ds)
else:
print('Not provided xml configuration files.')
sys.exit(1)

pub_command.extend(['--xmlfile', xml_file_pub])
sub_command.extend(['--xmlfile', xml_file_sub])
ds_command.extend(['--xml-file', xml_file_ds])

pub_command.extend(['--seed', str(os.getpid())])
sub_command.extend(['--seed', str(os.getpid())])

if args.wait:
pub_command.extend(['--wait', str(args.wait)])

if args.samples:
pub_command.extend(['--samples', str(args.samples)])
sub_command.extend(['--samples', str(args.samples)])

if not args.server_id < 0:
ds_command.extend(['--server-id', str(args.server_id)])

ds_proc = subprocess.Popen(ds_command)
print(
'Running Discovery Server - commmand: ',
' '.join(map(str, ds_command)))

sub_proc = subprocess.Popen(sub_command)
print(
f'Running Subscriber - commmand: ',
' '.join(map(str, sub_command)))

pub_proc = subprocess.Popen(pub_command)
print(
'Running Publisher - commmand: ',
' '.join(map(str, pub_command)))

try:
outs, errs = sub_proc.communicate(timeout=10)
except subprocess.TimeoutExpired:
print('Subscriber process timed out, terminating...')
sub_proc.kill()
pub_proc.kill()
ds_proc.kill()
sys.exit(os.EX_SOFTWARE)

pub_proc.kill()
ds_proc.kill()

sys.exit(os.EX_OK)


if __name__ == '__main__':

# Parse arguments
args = ParseOptions()

run(args.args)
72 changes: 72 additions & 0 deletions test/communication/secure_ds_simple_secure_msg_crypto_pub.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8" ?>
<dds xmlns="http://www.eprosima.com/XMLSchemas/fastRTPS_Profiles" >
<profiles>
<participant profile_name="secure_ds_participant_profile" is_default_profile="true">
<rtps>
<builtin>
<discovery_config>
<discoveryProtocol>CLIENT</discoveryProtocol>
<discoveryServersList>
<RemoteServer prefix="44.53.00.5f.45.50.52.4f.53.49.4d.41">
<metatrafficUnicastLocatorList>
<locator>
<udpv4>
<address>127.0.0.1</address>
<port>11811</port>
</udpv4>
</locator>
</metatrafficUnicastLocatorList>
</RemoteServer>
</discoveryServersList>
</discovery_config>
</builtin>
<propertiesPolicy>
<properties>
<!-- Activate Auth:PKI-DH plugin -->
<property>
<name>dds.sec.auth.plugin</name>
<value>builtin.PKI-DH</value>
</property>
<!-- Configure Auth:PKI-DH plugin -->
<property>
<name>dds.sec.auth.builtin.PKI-DH.identity_ca</name>
<value>file://maincacert.pem</value>
</property>
<property>
<name>dds.sec.auth.builtin.PKI-DH.identity_certificate</name>
<value>file://mainpubcert.pem</value>
</property>
<property>
<name>dds.sec.auth.builtin.PKI-DH.private_key</name>
<value>file://mainpubkey.pem</value>
</property>
<!-- Activate Access:Permissions plugin -->
<property>
<name>dds.sec.access.plugin</name>
<value>builtin.Access-Permissions</value>
</property>
<!-- Configure Access:Permissions plugin -->
<property>
<name>dds.sec.access.builtin.Access-Permissions.permissions_ca</name>
<value>file://maincacert.pem</value>
</property>
<property>
<name>dds.sec.access.builtin.Access-Permissions.governance</name>
<value>file://governance_helloworld_all_enable.smime</value>
</property>
<property>
<name>dds.sec.access.builtin.Access-Permissions.permissions</name>
<value>file://permissions_helloworld.smime</value>
</property>
<!-- Activate Crypto:AES-GCM-GMAC plugin -->
<property>
<name>dds.sec.crypto.plugin</name>
<value>builtin.AES-GCM-GMAC</value>
</property>
</properties>
</propertiesPolicy>
</rtps>
</participant>
</profiles>
</dds>

Loading