Add examples
This commit is contained in:
parent
4ca4a06896
commit
a34fc3ff6c
3 changed files with 20 additions and 5 deletions
|
@ -5,7 +5,7 @@ bsdcontrol.rb provides Ruby bindings for
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
__Features__
|
### Features
|
||||||
|
|
||||||
The first example prints a list of HardenedBSD features that
|
The first example prints a list of HardenedBSD features that
|
||||||
can be enabled, disabled or restored to the system default
|
can be enabled, disabled or restored to the system default
|
||||||
|
@ -22,7 +22,7 @@ BSD::Control
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
__Enable__
|
### Enable
|
||||||
|
|
||||||
The following example enables the mprotect feature for the emacs binary. When
|
The following example enables the mprotect feature for the emacs binary. When
|
||||||
a feature is enabled for a given file, that setting takes precendence
|
a feature is enabled for a given file, that setting takes precendence
|
||||||
|
@ -35,10 +35,10 @@ over the system default. The system default can be restored with
|
||||||
require "bsdcontrol"
|
require "bsdcontrol"
|
||||||
BSD::Control
|
BSD::Control
|
||||||
.feature(:mprotect)
|
.feature(:mprotect)
|
||||||
.enable!("/usr/local/bin/emacs-29.2")
|
.enable! File.realpath("/usr/local/bin/emacs")
|
||||||
```
|
```
|
||||||
|
|
||||||
__Status__
|
### Status
|
||||||
|
|
||||||
There are five recognized statuses: `unknown`, `enabled`, `disabled`,
|
There are five recognized statuses: `unknown`, `enabled`, `disabled`,
|
||||||
`sysdef`, and `invalid`. The `sysdef` status indicates that a feature
|
`sysdef`, and `invalid`. The `sysdef` status indicates that a feature
|
||||||
|
@ -77,4 +77,3 @@ bsdcontrol.rb can be installed via rubygems.org:
|
||||||
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
|
||||||
<br>
|
<br>
|
||||||
See [LICENSE](./LICENSE)
|
See [LICENSE](./LICENSE)
|
||||||
|
|
||||||
|
|
8
share/bsdcontrol.rb/examples/2_feature_enable.rb
Normal file
8
share/bsdcontrol.rb/examples/2_feature_enable.rb
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
#!/usr/bin/env ruby
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
# Required privileges: superuser
|
||||||
|
require "bsdcontrol"
|
||||||
|
BSD::Control
|
||||||
|
.feature(:mprotect)
|
||||||
|
.enable! File.realpath("/usr/local/bin/emacs")
|
8
share/bsdcontrol.rb/examples/3_feature_status.rb
Normal file
8
share/bsdcontrol.rb/examples/3_feature_status.rb
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
#!/usr/bin/env ruby
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
# Required privileges: superuser
|
||||||
|
require "bsdcontrol"
|
||||||
|
BSD::Control
|
||||||
|
.feature(:mprotect)
|
||||||
|
.status("/bin/ls") # => :sysdef
|
Loading…
Reference in a new issue