.. _program_listing_file_include_rcl_security.h:

Program Listing for File security.h
===================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_rcl_security.h>` (``include/rcl/security.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018-2020 Open Source Robotics Foundation, Inc.
   //
   // 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.
   
   
   #ifndef RCL__SECURITY_H_
   #define RCL__SECURITY_H_
   
   #ifdef __cplusplus
   extern "C"
   {
   #endif
   
   #include <stdbool.h>
   
   #include "rcl/allocator.h"
   #include "rcl/types.h"
   #include "rcl/visibility_control.h"
   #include "rmw/security_options.h"
   
   #ifndef ROS_SECURITY_ENCLAVE_OVERRIDE
   # define ROS_SECURITY_ENCLAVE_OVERRIDE "ROS_SECURITY_ENCLAVE_OVERRIDE"
   #endif
   
   #ifndef ROS_SECURITY_KEYSTORE_VAR_NAME
   # define ROS_SECURITY_KEYSTORE_VAR_NAME "ROS_SECURITY_KEYSTORE"
   #endif
   
   #ifndef ROS_SECURITY_STRATEGY_VAR_NAME
   # define ROS_SECURITY_STRATEGY_VAR_NAME "ROS_SECURITY_STRATEGY"
   #endif
   
   #ifndef ROS_SECURITY_ENABLE_VAR_NAME
   # define ROS_SECURITY_ENABLE_VAR_NAME "ROS_SECURITY_ENABLE"
   #endif
   
   
   RCL_PUBLIC
   rcl_ret_t
   rcl_get_security_options_from_environment(
     const char * name,
     const rcutils_allocator_t * allocator,
     rmw_security_options_t * security_options);
   
   
   RCL_PUBLIC
   rcl_ret_t
   rcl_security_enabled(bool * use_security);
   
   
   RCL_PUBLIC
   rcl_ret_t
   rcl_get_enforcement_policy(rmw_security_enforcement_policy_t * policy);
   
   
   RCL_PUBLIC
   char *
   rcl_get_secure_root(const char * name, const rcl_allocator_t * allocator);
   
   #ifdef __cplusplus
   }
   #endif
   
   #endif  // RCL__SECURITY_H_