bsdcontrol.rb/README.md
2024-03-07 22:57:24 -03:00

1.5 KiB

About

hbsdctl.rb is a C extension that binds libhbsdcontrol from the hardenedbsd project to Ruby. Through this library, you can query what features are available and if root, enable or disable those features for a given file.

Examples

Available features

As a regular user account, you can obtain a list of available features. But to enable or disable those features a superuser account is required:

#!/usr/bin/env ruby
# As a regular user account
require 'hbsdctl'
BSD::Control
  .available_features
  .each do
  print "The ", _1.name, " feature is available", "\n"
end

Enable feature

As a superuser account, you can enable or disable features for a given file. The example enables the mprotect feature for the emacs binary:

#!/usr/bin/env ruby
# As a root account
require 'hbsdctl'
BSD::Control
  .feature!(:mprotect)
  .enable!("/usr/local/bin/emacs-29.2")

Documentation

A complete API reference is available at 0x1eef.github.io/x/hbsdctl.rb.

Install

Git

hbsdctl.rb is distributed as a RubyGem through its git repositories.
GitHub, and GitLab are available as sources.

Rubygems.org

hbsdctl.rb can also be installed via rubygems.org.

gem install hbsdctl.rb

License

BSD Zero Clause.
See LICENSE.