security_options.h File Reference

#include <stdbool.h>
#include "rcutils/allocator.h"
#include "rmw/ret_types.h"
#include "rmw/visibility_control.h"

Include dependency graph for security_options.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	rmw_security_options_t

Typedefs
typedef enum RMW_PUBLIC_TYPE rmw_security_enforcement_policy_t	rmw_security_enforcement_policy_t
typedef struct RMW_PUBLIC_TYPE rmw_security_options_t	rmw_security_options_t

Functions
rmw_security_options_t	rmw_get_zero_initialized_security_options ()
	Get zero initialized security options. More...
rmw_security_options_t	rmw_get_default_security_options ()
	Get default initialized security options. More...
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. More...
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. More...
rmw_ret_t	rmw_security_options_fini (rmw_security_options_t *security_options, const rcutils_allocator_t *allocator)
	Finalize the given security_options. More...

Variables
	RMW_SECURITY_ENFORCEMENT_PERMISSIVE
	RMW_SECURITY_ENFORCEMENT_ENFORCE

Typedef Documentation

rmw_security_enforcement_policy_t

enum RMW_PUBLIC_TYPE rmw_security_enforcement_policy_t

rmw_security_options_t

typedef struct RMW_PUBLIC_TYPE rmw_security_options_t rmw_security_options_t

Function Documentation

rmw_get_zero_initialized_security_options()

rmw_security_options_t rmw_get_zero_initialized_security_options

(

)

Get zero initialized security options.

rmw_get_default_security_options()

rmw_security_options_t rmw_get_default_security_options

(

)

Get default initialized security options.

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.

Parameters

[in]	src	security options to be copied.
[in]	allocator	allocator used when copying data to the new security options.
[out]	dst	security options to be set.

Returns

RMW_RET_BAD_ALLOC, or

RMW_RET_OK

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.

The provided security_root_path will be copied into allocated memory.

Parameters

[in]	security_root_path	path to be set.
[in]	allocator	allocator used to allocate the new path.
	[in|out]	security_options security options to be set.

Returns

RMW_RET_BAD_ALLOC, or

RMW_RET_OK

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.

Parameters

[in]	security_options	security options to be finalized.
[in]	allocator	allocator used to deallocate the root path.

Returns

RMW_RET_ERROR, or

RMW_RET_OK

Variable Documentation

RMW_SECURITY_ENFORCEMENT_PERMISSIVE

RMW_SECURITY_ENFORCEMENT_PERMISSIVE

RMW_SECURITY_ENFORCEMENT_ENFORCE

RMW_SECURITY_ENFORCEMENT_ENFORCE