hbsdctl.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 203f2dd1be3a149109afe3b9df5238d2864d2a62e5fb719aaa805d238dcc9f50
+  data.tar.gz: 13483282dd8fd3dfe9737b06f97b893b07991301371b15b64fb1c4bb2a894a26
+SHA512:
+  metadata.gz: 9bff5a1b54943ed556b1128914383562b89bc9df011ecd685733d4046b43e301cea9f589b57d3be2c5f076d4984a9572a15b5f6d00e47a0a3957a69471df03c8
+  data.tar.gz: 680c2d5b74f0c7739abf0bbd99fd34ede735528f94fa182bcf5d2a89e9133fec785831c3c087d81ad076b5d14704cbd3769f72822cc8305c4f79c75262ea8a15

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: ".gems"

data/.gitignore

@@ -0,0 +1,3 @@
+/.gems/
+/tmp/
+*.so

data/.projectile

@@ -0,0 +1,2 @@
+-/.gems/
+-/tmp/

data/.styleguide.cfg

@@ -0,0 +1,380 @@
+# Uncrustify 0.55
+# Loosely based on the FreeBSD style guide
+newlines                                 = lf
+input_tab_size                           = 2
+output_tab_size                          = 2
+string_escape_char                       = 94
+string_escape_char2                      = 0
+indent_columns                           = 2
+indent_continue                          = 2
+indent_with_tabs                         = 0
+indent_align_string                      = false
+indent_xml_string                        = 0
+indent_brace                             = 0
+indent_braces                            = false
+indent_braces_no_func                    = false
+indent_brace_parent                      = false
+indent_namespace                         = false
+indent_namespace_level                   = 0
+indent_namespace_limit                   = 0
+indent_extern                            = false
+indent_class                             = true
+indent_class_colon                       = true
+indent_else_if                           = false
+indent_var_def_blk                       = 0
+indent_func_call_param                   = false
+indent_func_def_param                    = false
+indent_func_proto_param                  = false
+indent_func_class_param                  = false
+indent_func_ctor_var_param               = false
+indent_template_param                    = false
+indent_func_param_double                 = false
+indent_func_const                        = 0
+indent_func_throw                        = 0
+indent_member                            = 0
+indent_relative_single_line_comments     = false
+indent_switch_case                       = 0
+indent_case_shift                        = 0
+indent_case_brace                        = 0
+indent_col1_comment                      = false
+indent_label                             = 1
+indent_access_spec                       = 1
+indent_access_spec_body                  = false
+indent_paren_nl                          = false
+indent_paren_close                       = 0
+indent_comma_paren                       = 0
+indent_bool_paren                        = 0
+indent_square_nl                         = false
+indent_preserve_sql                      = false
+indent_align_assign                      = true
+indent_off_after_assign                  = false
+sp_arith                                 = ignore
+sp_assign                                = force
+sp_before_assign                         = ignore
+sp_after_assign                          = ignore
+sp_enum_assign                           = ignore
+sp_enum_before_assign                    = ignore
+sp_enum_after_assign                     = ignore
+sp_pp_concat                             = add
+sp_pp_stringify                          = add
+sp_bool                                  = force
+sp_compare                               = force
+sp_inside_paren                          = remove
+sp_paren_paren                           = remove
+sp_balance_nested_parens                 = false
+sp_paren_brace                           = ignore
+sp_before_ptr_star                       = force
+sp_before_unnamed_ptr_star               = ignore
+sp_between_ptr_star                      = remove
+sp_after_ptr_star                        = remove
+sp_after_ptr_star_func                   = ignore
+sp_before_ptr_star_func                  = ignore
+sp_before_byref                          = remove
+sp_before_unnamed_byref                  = ignore
+sp_after_byref                           = force
+sp_after_byref_func                      = ignore
+sp_before_byref_func                     = ignore
+sp_after_type                            = force
+sp_template_angle                        = ignore
+sp_before_angle                          = remove
+sp_inside_angle                          = remove
+sp_after_angle                           = force
+sp_angle_paren                           = ignore
+sp_angle_word                            = ignore
+sp_before_sparen                         = force
+sp_inside_sparen                         = remove
+sp_inside_sparen_close                   = ignore
+sp_after_sparen                          = force
+sp_sparen_brace                          = add
+sp_invariant_paren                       = ignore
+sp_after_invariant_paren                 = ignore
+sp_special_semi                          = ignore
+sp_before_semi                           = remove
+sp_before_semi_for                       = ignore
+sp_before_semi_for_empty                 = force
+sp_after_semi                            = add
+sp_after_semi_for                        = force
+sp_after_semi_for_empty                  = ignore
+sp_before_square                         = ignore
+sp_before_squares                        = ignore
+sp_inside_square                         = remove
+sp_after_comma                           = force
+sp_before_comma                          = remove
+sp_before_ellipsis                       = ignore
+sp_after_class_colon                     = ignore
+sp_before_class_colon                    = ignore
+sp_before_case_colon                     = remove
+sp_after_operator                        = ignore
+sp_after_operator_sym                    = ignore
+sp_after_cast                            = remove
+sp_inside_paren_cast                     = ignore
+sp_cpp_cast_paren                        = ignore
+sp_sizeof_paren                          = remove
+sp_after_tag                             = ignore
+sp_inside_braces_enum                    = force
+sp_inside_braces_struct                  = force
+sp_inside_braces                         = force
+sp_inside_braces_empty                   = ignore
+sp_type_func                             = force
+sp_func_proto_paren                      = remove
+sp_func_def_paren                        = remove
+sp_inside_fparens                        = ignore
+sp_inside_fparen                         = remove
+sp_square_fparen                         = ignore
+sp_fparen_brace                          = add
+sp_func_call_paren                       = remove
+sp_func_call_user_paren                  = ignore
+sp_func_class_paren                      = remove
+sp_return_paren                          = force
+sp_attribute_paren                       = ignore
+sp_defined_paren                         = ignore
+sp_throw_paren                           = ignore
+sp_macro                                 = ignore
+sp_macro_func                            = ignore
+sp_else_brace                            = ignore
+sp_brace_else                            = ignore
+sp_brace_typedef                         = force
+sp_catch_brace                           = ignore
+sp_brace_catch                           = ignore
+sp_finally_brace                         = ignore
+sp_brace_finally                         = ignore
+sp_try_brace                             = ignore
+sp_getset_brace                          = ignore
+sp_before_dc                             = remove
+sp_after_dc                              = remove
+sp_d_array_colon                         = ignore
+sp_not                                   = remove
+sp_inv                                   = remove
+sp_addr                                  = remove
+sp_member                                = remove
+sp_deref                                 = remove
+sp_sign                                  = remove
+sp_incdec                                = remove
+sp_before_nl_cont                        = add
+sp_after_oc_scope                        = ignore
+sp_after_oc_colon                        = ignore
+sp_before_oc_colon                       = ignore
+sp_after_send_oc_colon                   = ignore
+sp_before_send_oc_colon                  = ignore
+sp_after_oc_type                         = ignore
+sp_after_oc_return_type                  = ignore
+sp_after_oc_at_sel                       = ignore
+sp_before_oc_block_caret                 = ignore
+sp_after_oc_block_caret                  = ignore
+sp_cond_colon                            = ignore
+sp_cond_question                         = ignore
+sp_case_label                            = remove
+sp_range                                 = ignore
+sp_cmt_cpp_start                         = ignore
+sp_endif_cmt                             = ignore
+force_tab_after_define                   = true
+align_keep_tabs                          = false
+align_with_tabs                          = false
+align_on_tabstop                         = false
+align_number_right                       = false
+align_func_params                        = false
+align_same_func_call_params              = false
+align_same_func_call_params_span         = 0
+align_same_func_call_params_thresh       = 0
+align_var_def_span                       = 0
+align_var_def_star_style                 = 0
+align_var_def_amp_style                  = 0
+align_var_def_thresh                     = 0
+align_var_def_gap                        = 0
+align_var_def_colon                      = false
+align_var_def_attribute                  = false
+align_var_def_inline                     = false
+align_assign_span                        = 0
+align_assign_thresh                      = 12
+align_enum_equ_span                      = 16
+align_enum_equ_thresh                    = 0
+align_var_struct_span                    = 99
+align_var_struct_thresh                  = 0
+align_var_struct_gap                     = 0
+align_struct_init_span                   = 3
+align_typedef_gap                        = 3
+align_typedef_span                       = 5
+align_typedef_func                       = 0
+align_typedef_star_style                 = 0
+align_typedef_amp_style                  = 0
+align_right_cmt_span                     = 3
+align_right_cmt_mix                      = false
+align_right_cmt_gap                      = 0
+align_right_cmt_at_col                   = 0
+align_func_proto_span                    = 0
+align_func_proto_gap                     = 0
+align_on_operator                        = false
+align_mix_var_proto                      = false
+align_single_line_func                   = false
+align_single_line_brace                  = false
+align_single_line_brace_gap              = 0
+align_oc_msg_spec_span                   = 0
+align_nl_cont                            = 1
+align_pp_define_gap                      = 4
+align_pp_define_span                     = 3
+align_left_shift                         = true
+align_oc_msg_colon_span                  = 0
+nl_collapse_empty_body                   = false
+nl_assign_leave_one_liners               = true
+nl_class_leave_one_liners                = true
+nl_enum_leave_one_liners                 = false
+nl_getset_leave_one_liners               = false
+nl_func_leave_one_liners                 = true
+nl_if_leave_one_liners                   = false
+nl_start_of_file                         = remove
+nl_start_of_file_min                     = 0
+nl_end_of_file                           = force
+nl_end_of_file_min                       = 1
+nl_assign_brace                          = add
+nl_assign_square                         = ignore
+nl_after_square_assign                   = ignore
+nl_fcall_brace                           = add
+nl_enum_brace                            = remove
+nl_struct_brace                          = remove
+nl_union_brace                           = remove
+nl_if_brace                              = remove
+nl_brace_else                            = remove
+nl_elseif_brace                          = ignore
+nl_else_brace                            = remove
+nl_else_if                               = remove
+nl_brace_finally                         = ignore
+nl_finally_brace                         = ignore
+nl_try_brace                             = ignore
+nl_getset_brace                          = force
+nl_for_brace                             = add
+nl_catch_brace                           = ignore
+nl_brace_catch                           = ignore
+nl_while_brace                           = add
+nl_brace_brace                           = ignore
+nl_do_brace                              = add
+nl_brace_while                           = remove
+nl_switch_brace                          = add
+nl_multi_line_cond                       = false
+nl_multi_line_define                     = true
+nl_before_case                           = true
+nl_before_throw                          = ignore
+nl_after_case                            = true
+nl_namespace_brace                       = ignore
+nl_template_class                        = ignore
+nl_class_brace                           = ignore
+nl_class_init_args                       = ignore
+nl_func_type_name                        = ignore
+nl_func_type_name_class                  = ignore
+nl_func_scope_name                       = ignore
+nl_func_proto_type_name                  = ignore
+nl_func_paren                            = ignore
+nl_func_decl_start                       = ignore
+nl_func_decl_start_single                = ignore
+nl_func_decl_args                        = ignore
+nl_func_decl_end                         = ignore
+nl_func_decl_end_single                  = ignore
+nl_func_decl_empty                       = ignore
+nl_fdef_brace                            = add
+nl_after_return                          = true
+nl_return_expr                           = ignore
+nl_after_semicolon                       = true
+nl_after_brace_open                      = true
+nl_after_brace_open_cmt                  = false
+nl_after_vbrace_open                     = false
+nl_after_vbrace_open_empty               = false
+nl_after_brace_close                     = true
+nl_define_macro                          = false
+nl_squeeze_ifdef                         = true
+nl_before_if                             = ignore
+nl_after_if                              = ignore
+nl_before_for                            = ignore
+nl_after_for                             = ignore
+nl_before_while                          = ignore
+nl_after_while                           = ignore
+nl_before_switch                         = ignore
+nl_after_switch                          = ignore
+nl_before_do                             = ignore
+nl_after_do                              = ignore
+nl_ds_struct_enum_cmt                    = false
+nl_ds_struct_enum_close_brace            = false
+nl_class_colon                           = ignore
+nl_create_if_one_liner                   = false
+nl_create_for_one_liner                  = false
+nl_create_while_one_liner                = false
+pos_arith                                = ignore
+pos_assign                               = ignore
+pos_bool                                 = trail
+pos_compare                              = ignore
+pos_conditional                          = ignore
+pos_comma                                = ignore
+pos_class_comma                          = ignore
+pos_class_colon                          = ignore
+code_width                               = 90
+ls_for_split_full                        = false
+ls_func_split_full                       = false
+nl_max                                   = 4
+nl_after_func_proto                      = 0
+nl_after_func_proto_group                = 2
+nl_after_func_body                       = 3
+nl_after_func_body_one_liner             = 0
+nl_before_block_comment                  = 2
+nl_before_c_comment                      = 0
+nl_before_cpp_comment                    = 0
+nl_after_multiline_comment               = false
+nl_before_access_spec                    = 0
+nl_after_access_spec                     = 0
+nl_comment_func_def                      = 1
+nl_after_try_catch_finally               = 0
+nl_around_cs_property                    = 0
+nl_between_get_set                       = 0
+eat_blanks_after_open_brace              = true
+eat_blanks_before_close_brace            = true
+mod_full_brace_do                        = add
+mod_full_brace_for                       = add
+mod_full_brace_function                  = ignore
+mod_full_brace_if                        = add
+mod_full_brace_if_chain                  = 0
+mod_full_brace_nl                        = 0
+mod_full_brace_while                     = add
+mod_paren_on_return                      = add
+mod_pawn_semicolon                       = false
+mod_full_paren_if_bool                   = true
+mod_remove_extra_semicolon               = true
+mod_add_long_function_closebrace_comment = 0
+mod_add_long_switch_closebrace_comment   = 0
+mod_add_long_ifdef_endif_comment         = 0
+mod_add_long_ifdef_else_comment          = 0
+mod_sort_import                          = false
+mod_sort_using                           = false
+mod_sort_include                         = false
+mod_sort_incl_import_prioritize_filename = false
+mod_sort_incl_import_prioritize_extensionless      = false
+mod_sort_incl_import_prioritize_angle_over_quotes  = false
+mod_sort_incl_import_ignore_extension    = false
+mod_sort_incl_import_grouping_enabled    = false
+mod_move_case_break                      = false
+mod_case_brace                           = remove
+mod_remove_empty_return                  = true
+cmt_width                                = 0
+cmt_reflow_mode                          = 0
+cmt_indent_multi                         = true
+cmt_c_group                              = false
+cmt_c_nl_start                           = false
+cmt_c_nl_end                             = false
+cmt_cpp_group                            = false
+cmt_cpp_nl_start                         = false
+cmt_cpp_nl_end                           = false
+cmt_cpp_to_c                             = false
+cmt_star_cont                            = true
+cmt_sp_before_star_cont                  = 0
+cmt_sp_after_star_cont                   = 0
+cmt_multi_check_last                     = true
+cmt_insert_file_header                   = ""
+cmt_insert_file_footer                   = ""
+cmt_insert_func_header                   = ""
+cmt_insert_class_header                  = ""
+cmt_insert_before_preproc                = false
+pp_indent                                = remove
+pp_indent_at_level                       = false
+pp_indent_count                          = 1
+pp_space_count                           = 0
+pp_indent_region                         = 0
+pp_region_indent_code                    = false
+pp_indent_if                             = 0
+pp_if_indent_code                        = false
+pp_define_at_level                       = false

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    hbsdctl.rb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    power_assert (2.0.3)
+    rake (13.1.0)
+    rake-compiler (1.2.0)
+      rake
+    test-unit (3.6.2)
+      power_assert
+
+PLATFORMS
+  amd64-freebsd-14
+  ruby
+
+DEPENDENCIES
+  hbsdctl.rb!
+  rake-compiler (= 1.2.0)
+  test-unit (~> 3.6)
+
+BUNDLED WITH
+   2.5.3

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (C) 2023 by 0x1eef <0x1eef@protonmail.com>
+
+Permission to use, copy, modify, and/or distribute this
+software for any purpose with or without fee is hereby
+granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
+ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
+RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+## About
+
+hbsdctl.rb provides Ruby bindings for libhbsdcontrol from the
+[hardenedbsd](https://hardenedbsd.org) project. Through
+this library, you can query what features are available and if
+root: enable, disable or query the status of a feature for a
+given file.
+
+## Examples
+
+__Features__
+
+As an unprivileged user or as a superuser, you can obtain a list of
+available features:
+
+``` ruby
+#!/usr/bin/env ruby
+# Required privileges: unprivileged user or superuser.
+require "hbsdctl"
+BSD::Control
+  .available_features
+  .each do
+  print "The ", _1.name, " feature is available", "\n"
+end
+```
+
+__Enable__
+
+As a superuser, you can enable or disable a feature for a given file.
+The example enables the mprotect feature for the emacs binary:
+
+``` ruby
+#!/usr/bin/env ruby
+# Required privileges: superuser.
+require "hbsdctl"
+BSD::Control
+  .feature(:mprotect)
+  .enable!("/usr/local/bin/emacs-29.2")
+```
+
+__Status__
+
+As a superuser, you can query the status of a feature for a given file.
+There are four statuses that can be returned: `conflict`, `sysdef`,
+`enabled`, and `disabled`. The first status (conflict) is rare and indicates that a
+feature is both enabled and disabled. The other three are more common. The `sysdef`
+status indicates that a feature takes its settings from the system default (sysctl):
+
+``` ruby
+#!/usr/bin/env ruby
+# Required privileges: superuser.
+require "hbsdctl"
+BSD::Control
+  .feature(:mprotect)
+  .status("/bin/ls") # => :sysdef
+```
+
+## Documentation
+
+A complete API reference is available at
+[0x1eef.github.io/x/hbsdctl.rb](https://0x1eef.github.io/x/hbsdctl.rb).
+
+## Install
+
+**Rubygems.org**
+
+hbsdctl.rb can be installed via rubygems.org.
+
+    gem install hbsdctl.rb
+
+## Sources
+
+* [GitHub](https://github.com/0x1eef/hbsdctl.rb)
+* [GitLab](https://gitlab.com/0x1eef/hbsdctl.rb)
+* [git.hardenedbsd.org](https://git.hardenedbsd.org/0x1eef/hbsdctl.rb)
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+<br>
+See [LICENSE](./LICENSE).
+

data/Rakefile.rb

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require "rake/extensiontask"
+Rake::ExtensionTask.new("hbsdctl.rb")
+task default: %w[clobber compile test]
+
+desc "Run C linter"
+task :styleguide do
+  sh "uncrustify -c .styleguide.cfg --no-backup ext/hbsdctl.rb/*.c"
+end
+
+namespace :test do
+  desc "Run unprivileged tests"
+  task :unprivileged do
+    sh "./bin/run-unprivileged-tests"
+  end
+
+  desc "Run superuser tests"
+  task :superuser do
+    sh "./bin/run-superuser-tests"
+  end
+end

data/bin/run-superuser-tests

@@ -0,0 +1,12 @@
+#!/bin/sh
+set -e
+if [ $(id -u) = 0 ]; then
+    rake clean clobber compile
+    rm -rf tmp/
+    for file in test/superuser/*_test.rb; do
+        ruby -Ilib ${file} --no-use-color
+    done
+else
+    echo "You must be the root user to run these tests."
+    exit 1
+fi

data/bin/run-unprivileged-tests

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -e
+if [ $(id -u) -ne 0 ]; then
+    rake clean clobber compile
+    for file in test/unprivileged/*_test.rb; do
+        ruby -Ilib ${file} --no-use-color
+    done
+else
+    echo "You must be an unprivileged user to run these tests."
+    exit 1
+fi

data/ext/hbsdctl.rb/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+$LIBS << ' -lsbuf -lhbsdcontrol'
+create_makefile("hbsdctl.rb")

data/ext/hbsdctl.rb/feature.c

@@ -0,0 +1,34 @@
+#include <libhbsdcontrol.h>
+#include <errno.h>
+#include "include/feature.h"
+static VALUE __set(VALUE, VALUE, VALUE);
+
+/**
+ * BSD::Control::Feature#set!
+ **/
+VALUE
+feature_set(VALUE self, VALUE rb_path, VALUE rb_state)
+{
+  Check_Type(rb_path, T_STRING);
+  Check_Type(rb_state, T_FIXNUM);
+  VALUE rb_feature = rb_funcall(self, rb_intern("name"), 0);
+  Check_Type(rb_feature, T_STRING);
+  return (__set(rb_path, rb_feature, rb_state));
+}
+
+
+static VALUE
+__set(VALUE rb_path, VALUE rb_feature, VALUE rb_state)
+{
+  errno = 0;
+  int result = hbsdcontrol_set_feature_state(
+    RSTRING_PTR(rb_path),
+    RSTRING_PTR(rb_feature),
+    NUM2INT(rb_state)
+    );
+  if (result == 0) {
+    return (Qtrue);
+  } else {
+    rb_syserr_fail(errno, "hbsdcontrol_set_feature_state");
+  }
+}