From e2155f68927d3f9ad30ed9d42850d3889cb57db9 Mon Sep 17 00:00:00 2001 From: Hunter Barbella Date: Thu, 24 Aug 2023 15:08:29 -0400 Subject: [PATCH] PY-132: Fix to fit the standard for readmes --- examples/connext_dds/basic_security/README.md | 26 ++++++++++--------- .../basic_security/py/secure_pub.py | 2 -- .../basic_security/py/secure_sub.py | 2 -- 3 files changed, 14 insertions(+), 16 deletions(-) diff --git a/examples/connext_dds/basic_security/README.md b/examples/connext_dds/basic_security/README.md index 2e552a8d4..7f0daac7a 100644 --- a/examples/connext_dds/basic_security/README.md +++ b/examples/connext_dds/basic_security/README.md @@ -1,12 +1,6 @@ # Example Code: Basic Security -## Welcome to Connext! - -This is the same example as seen in hello_security in the examples in the -rti_workspace. The other APIs examples are available when RTI Connext is -installed in the `/rti_workspace` folder. - -## About Security Plugins +## Concept RTI Security Plugins allow you to address your security requirements in a granular way. It is assumed that you have a familiarity with RTI Connext for @@ -32,8 +26,6 @@ applications to define different security policies based on the nature of the shared data. This gives the benefits of no single point of failure, high performance, and high scalability -## Securing a DDS Domain - In a DDS Secure system, a Governance Document defines the security requirements for communication. This file contains a mapping between Domain IDs and the security policies that DomainParticipants must follow to interact in that @@ -49,7 +41,17 @@ Document, every DomainParticipant joining a Secure Domain must be associated with a Permissions Document. This Permissions Document contains a set of grants, which determine what the local participant is allowed to do in the Domain. -## More information - For more information about using RTI Connext with security, follow the -[Getting Started Guide](https://community.rti.com/static/documentation/connext-dds/current/doc/manuals/connext_dds_secure/getting_started_guide/index.html) \ No newline at end of file +[Getting Started Guide](https://community.rti.com/static/documentation/connext-dds/current/doc/manuals/connext_dds_secure/getting_started_guide/index.html) + +## Example Description + +This is the same example as seen in hello_security in the examples in the +rti_workspace. The other APIs examples are available when RTI Connext is +installed in the `/rti_workspace` folder. + +In this example, the publisher application sends a message of "Hello World" with +a number to indicate which sample it is. This number increments by one and by +default will go until the user stops the programs. By default, the messages are +sent using ecdsa but can be set to rsa or ecdsa secp384r1 by providing an +argument at run time. \ No newline at end of file diff --git a/examples/connext_dds/basic_security/py/secure_pub.py b/examples/connext_dds/basic_security/py/secure_pub.py index 5af18a3a7..2f8b9d20b 100644 --- a/examples/connext_dds/basic_security/py/secure_pub.py +++ b/examples/connext_dds/basic_security/py/secure_pub.py @@ -73,8 +73,6 @@ def publisher_main(domain_id, sample_count, profile): ) args = parser.parse_args() - if args.count < 0: - raise argparse.ArgumentTypeError("Count must be >= 0") try: publisher_main(args.domain, args.count, args.profile.upper()) diff --git a/examples/connext_dds/basic_security/py/secure_sub.py b/examples/connext_dds/basic_security/py/secure_sub.py index def5ce5ef..1f6eb1a1c 100644 --- a/examples/connext_dds/basic_security/py/secure_sub.py +++ b/examples/connext_dds/basic_security/py/secure_sub.py @@ -84,8 +84,6 @@ def subscriber_main(domain_id, sample_count, profile): ) args = parser.parse_args() - if args.count < 0: - raise argparse.ArgumentTypeError("Count must be >= 0") try: subscriber_main(args.domain, args.count, args.profile.upper())