## About bsdcontrol.rb provides Ruby bindings for libhbsdcontrol from the [HardenedBSD](https://HardenedBSD.org) project. ## Examples __Features__ The first example prints a list of HardenedBSD features that can be enabled, disabled or restored to the system default: ``` ruby #!/usr/bin/env ruby # Required privileges: user, superuser require "bsdcontrol" BSD::Control .available_features .each do print "The ", _1.name, " feature is available", "\n" end ``` __Enable__ The following example enables the mprotect feature for the emacs binary. When a feature is enabled for a given file, that setting takes precendence over the system default. The system default can be restored with [BSD::Control::Feature#sysdef!](http://0x1eef.github.io/x/bsdcontrol.rb/BSD/Control/Feature.html#sysdef!-instance_method): ``` ruby #!/usr/bin/env ruby # Required privileges: superuser require "bsdcontrol" BSD::Control .feature(:mprotect) .enable!("/usr/local/bin/emacs-29.2") ``` __Status__ There are five recognized statuses: `unknown`, `enabled`, `disabled`, `sysdef`, and `invalid`. The `sysdef` status indicates that a feature is configured to use the system default, and it is the most common status: ``` ruby #!/usr/bin/env ruby # Required privileges: superuser require "bsdcontrol" BSD::Control .feature(:mprotect) .status("/bin/ls") # => :sysdef ``` ## Documentation A complete API reference is available at [0x1eef.github.io/x/bsdcontrol.rb](https://0x1eef.github.io/x/bsdcontrol.rb). ## Install **Rubygems.org** bsdcontrol.rb can be installed via rubygems.org: gem install bsdcontrol.rb ## Sources * [GitHub](https://github.com/0x1eef/bsdcontrol.rb) * [GitLab](https://gitlab.com/0x1eef/bsdcontrol.rb) * [git.HardenedBSD.org](https://git.HardenedBSD.org/0x1eef/bsdcontrol.rb) ## License [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
See [LICENSE](./LICENSE).