Skip to content

Commit

Permalink
PY-132: Fix to fit the standard for readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
hman523 committed Aug 24, 2023
1 parent fba8396 commit e2155f6
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 16 deletions.
26 changes: 14 additions & 12 deletions examples/connext_dds/basic_security/README.md
Original file line number Diff line number Diff line change
@@ -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 `<homedirectory>/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
Expand All @@ -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
Expand All @@ -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)
[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 `<homedirectory>/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.
2 changes: 0 additions & 2 deletions examples/connext_dds/basic_security/py/secure_pub.py
Original file line number Diff line number Diff line change
Expand Up @@ -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())
Expand Down
2 changes: 0 additions & 2 deletions examples/connext_dds/basic_security/py/secure_sub.py
Original file line number Diff line number Diff line change
Expand Up @@ -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())
Expand Down

0 comments on commit e2155f6

Please sign in to comment.