Add security logging base class

include/fastdds/rtps/security/logging/BuiltinLoggingType.h

@@ -0,0 +1,57 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file BuiltinLoggingType.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_BUILTINLOGGINGTYPE_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_BUILTINLOGGINGTYPE_H_
+
+#include "fastdds/rtps/common/Types.h"
+#include "fastdds/rtps/common/Time_t.h"
+#include "fastdds/rtps/security/logging/LoggingLevel.h"
+#include "fastdds/rtps/security/logging/NameValuePair.h"
+
+#include <map>
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The BuiltinLoggingType struct
+ *
+ * @note Definition in DDS-Sec v1.1 9.6
+ */
+struct BuiltinLoggingType final {
+ octet facility;              // Set to 0x0A (10). Indicates sec/auth msgs
+ LoggingLevel severity;
+ rtps::Time_t timestamp;      // Since epoch 1970-01-01 00:00:00 +0000 (UTC)
+ std::string hostname;        // IP host name of originator
+ std::string hostip;          // IP address of originator
+ std::string appname;         // Identify the device or application
+ std::string procid;          // Process name/ID for syslog system
+ std::string msgid;           // Identify the type of message
+ std::string message;         // Free-form message
+ // Note that certain string keys (SD-IDs) are reserved by IANA
+ std::map<std::string, NameValuePairSeq> structured_data;
+};
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_BUILTINLOGGINGTYPE_H_

include/fastdds/rtps/security/logging/EventLogLevel.h

@@ -0,0 +1,48 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file EventLogLevel.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_EVENTLOGLEVEL_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_EVENTLOGLEVEL_H_
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The EventLogLevel enum
+ *
+ * @note Definition in DDS-Sec v1.1 8.6.2.1.1
+ */
+enum struct EventLogLevel : long
+{
+  FATAL_LEVEL = 0,  // security error causing a shutdown or failure of the Domain Participant
+  SEVERE_LEVEL,     // major security error or fault
+  ERROR_LEVEL,      // minor security error or fault
+  WARNING_LEVEL,    // undesirable or unexpected behavior
+  NOTICE_LEVEL,     // important security event
+  INFO_LEVEL,       // interesting security event
+  DEBUG_LEVEL,      // detailed information on the flow of the security events
+  TRACE_LEVEL       // even more detailed information
+};
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_EVENTLOGLEVEL_H_

include/fastdds/rtps/security/logging/LogOptions.h

@@ -0,0 +1,51 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file LogOptions.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_LOGOPTIONS_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_LOGOPTIONS_H_
+
+#include <string>
+
+#include "fastdds/rtps/security/logging/EventLogLevel.h"
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The LogOptions struct
+ */
+struct LogOptions
+{
+  //! Whether the log events should be distributed over DDS
+  bool distribute;
+
+  //! Level at which log messages will be logged.
+  //! Messages at or below the log_level are logged.
+  EventLogLevel event_log_level;
+
+  //! Full path to a local file
+  std::string log_file;
+};
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_LOGOPTIONS_H_

include/fastdds/rtps/security/logging/Logging.h

@@ -0,0 +1,115 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file Logging.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_LOGGING_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_LOGGING_H_
+
+#include "fastdds/rtps/security/logging/LogOptions.h"
+#include "fastdds/rtps/security/exceptions/SecurityException.h"
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The LoggerListener class
+ */
+class LoggerListener
+{
+  LoggerListener() = default;
+  ~LoggerListener() = default;
+};
+
+/**
+ * @brief Base class for all security logging plugins.
+ */
+class Logging
+{
+public:
+
+  Logging();
+  virtual ~Logging() = default;
+
+  /**
+   * @brief set_log_options
+   * @param log_options
+   * @return TRUE if successful
+   */
+  bool set_log_options(const LogOptions& log_options, SecurityException& exception);
+
+  /**
+   * @brief get_log_options
+   * @param log_options
+   * @param exception
+   * @return
+   */
+  bool get_log_options(LogOptions& log_options, SecurityException& exception) const;
+
+  /**
+   * @brief enable_logging
+   */
+  bool enable_logging(SecurityException& exception);
+
+  /**
+   * @brief set_listener
+   * @param listener
+   * @return
+   */
+  bool set_listener(LoggerListener* listener, SecurityException& exception);
+
+  /**
+   * @brief log
+   * @param log_level
+   * @param message
+   * @param category
+   */
+  void log(const EventLogLevel event_log_level,
+           const std::string& message,
+           const std::string& category,
+           SecurityException& exception);
+
+protected:
+
+  /**
+   * @brief log_impl
+   * @param message
+   * @param category
+   * @param exception
+   */
+  virtual void log_impl(const std::string& message,
+                        const std::string& category,
+                        SecurityException& exception);
+
+  LoggerListener* listener_;
+
+  bool logging_enabled_ = false;
+  bool options_set_ = false;
+
+  LogOptions log_options_;
+
+  //TODO(artivis):figure out which to use
+  // Publisher* publisher_; // publisher_ = DomainParticipant::create_publisher(...)
+  // DataWriter* data_writer_;
+};
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_LOGGING_H_

include/fastdds/rtps/security/logging/LoggingLevel.h

@@ -0,0 +1,48 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file LoggingLevel.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_LOGGINGLEVEL_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_LOGGINGLEVEL_H_
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The LoggingLevel enum
+ *
+ * @note Definition in DDS-Sec v1.1 9.6
+ */
+enum struct LoggingLevel : long
+{
+  EMERGENCY_LEVEL,      // System is unusable. Should not continue use.
+  ALERT_LEVEL,          // Should be corrected immediately
+  CRITICAL_LEVEL,       // A failure in primary application.
+  ERROR_LEVEL,          // General error conditions
+  WARNING_LEVEL,        // May indicate future error if action not taken.
+  NOTICE_LEVEL,         // Unusual, but nor erroneous event or condition.
+  INFORMATIONAL_LEVEL,  // Normal operational. Requires no action.
+  DEBUG_LEVEL
+};
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_LOGGINGLEVEL_H_

include/fastdds/rtps/security/logging/NameValuePair.h

@@ -0,0 +1,46 @@
+// Copyright 2020 Canonical ltd.
+//
+// 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.
+
+/*!
+ * @file NameValuePair.h
+ */
+#ifndef _FASTDDS_RTPS_SECURITY_LOGGING_NAMEVALUEPAIR_H_
+#define _FASTDDS_RTPS_SECURITY_LOGGING_NAMEVALUEPAIR_H_
+
+#include <string>
+#include <vector>
+
+namespace eprosima {
+namespace fastrtps {
+namespace rtps {
+namespace security {
+
+/**
+ * @brief The NameValuePair struct
+ *
+ * @note Definition in DDS-Sec v1.1 9.6
+ */
+struct NameValuePair final {
+ std::string name;
+ std::string value;
+};
+
+using NameValuePairSeq = std::vector<NameValuePair>;
+
+} //namespace security
+} //namespace rtps
+} //namespace fastrtps
+} //namespace eprosima
+
+#endif // _FASTDDS_RTPS_SECURITY_LOGGING_NAMEVALUEPAIR_H_

src/cpp/CMakeLists.txt

@@ -208,6 +208,7 @@ set_sources(${${PROJECT_NAME}_source_files})
 set(${PROJECT_NAME}_security_source_files
     rtps/security/exceptions/SecurityException.cpp
     rtps/security/common/SharedSecretHandle.cpp
+    rtps/security/logging/Logging.cpp
     rtps/security/SecurityManager.cpp
     rtps/security/SecurityPluginFactory.cpp
     fastrtps_deprecated/security/OpenSSLInit.cpp