rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
security_options.h
Go to the documentation of this file.
1 // Copyright 2020 Open Source Robotics Foundation, Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef RMW__SECURITY_OPTIONS_H_
16 #define RMW__SECURITY_OPTIONS_H_
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include <stdbool.h>
24 
25 #include "rcutils/allocator.h"
26 
27 #include "rmw/ret_types.h"
28 #include "rmw/visibility_control.h"
29 
31 {
35 
37 {
38  enum rmw_security_enforcement_policy_t enforce_security;
41 
46 
51 
53 
63  const rmw_security_options_t * src,
64  const rcutils_allocator_t * allocator,
66 
68 
79  const char * security_root_path,
80  const rcutils_allocator_t * allocator,
81  rmw_security_options_t * security_options);
82 
84 
93  rmw_security_options_t * security_options,
94  const rcutils_allocator_t * allocator);
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 #endif // RMW__SECURITY_OPTIONS_H_
rmw_get_zero_initialized_security_options
rmw_security_options_t rmw_get_zero_initialized_security_options()
Get zero initialized security options.
RMW_PUBLIC
#define RMW_PUBLIC
Definition: visibility_control.h:48
rmw_security_options_copy
rmw_ret_t rmw_security_options_copy(const rmw_security_options_t *src, const rcutils_allocator_t *allocator, rmw_security_options_t *dst)
Copy the given security options.
RMW_PUBLIC_TYPE
RMW_PUBLIC_TYPE
Type mapping of rcutils log severity types to rmw specific types.
Definition: types.h:499
rmw_security_options_t
Definition: security_options.h:36
ret_types.h
rmw_security_options_fini
rmw_ret_t rmw_security_options_fini(rmw_security_options_t *security_options, const rcutils_allocator_t *allocator)
Finalize the given security_options.
RMW_SECURITY_ENFORCEMENT_PERMISSIVE
RMW_SECURITY_ENFORCEMENT_PERMISSIVE
Definition: security_options.h:32
allocator.h
rmw_security_options_set_root_path
rmw_ret_t rmw_security_options_set_root_path(const char *security_root_path, const rcutils_allocator_t *allocator, rmw_security_options_t *security_options)
Set the security root path for the given security options.
rmw_ret_t
int32_t rmw_ret_t
Return code for rmw functions.
Definition: ret_types.h:26
rmw_security_enforcement_policy_t
enum RMW_PUBLIC_TYPE rmw_security_enforcement_policy_t rmw_security_enforcement_policy_t
Definition: security_options.h:30
rmw_get_default_security_options
rmw_security_options_t rmw_get_default_security_options()
Get default initialized security options.
visibility_control.h
rmw_security_options_t
struct RMW_PUBLIC_TYPE rmw_security_options_t rmw_security_options_t
RMW_SECURITY_ENFORCEMENT_ENFORCE
RMW_SECURITY_ENFORCEMENT_ENFORCE
Definition: security_options.h:33
rcutils_allocator_t
rmw_security_options_t::security_root_path
char * security_root_path
Definition: security_options.h:39