Function rcl_get_security_options_from_environment

Function Documentation

rcl_ret_t rcl_get_security_options_from_environment(const char *name, const rcutils_allocator_t *allocator, rmw_security_options_t *security_options)

Initialize security options from values in the environment variables and given names.

Initialize the given security options based on the environment. For more details:

See also

rcl_security_enabled()

See also

rcl_get_enforcement_policy()

See also

rcl_get_secure_root()

Parameters:

  • name – [in] name used to find the security root path.

  • allocator – [in] used to do allocations.

  • security_options – [out] security options that will be configured according to the environment.

Returns:

RCL_RET_OK If the security options are returned properly, or

Returns:

RCL_RET_INVALID_ARGUMENT if an argument is not valid, or

Returns:

RCL_RET_ERROR if an unexpected error happened