mirror of
https://cagebreak.project-repo.co/cagebreak.git
synced 2026-08-21 13:04:18 +02:00
Add 2.2.2 adaptions
- README improvements - SECURITY.md improvements - updated dependencies in meson.build
This commit is contained in:
project-repo
parent
c693ba56e8
commit
0a0d67e802
3 changed files with 43 additions and 55 deletions
49
README.md
49
README.md
|
|
@ -9,25 +9,21 @@ based on [Cage](https://github.com/Hjdskes/cage) and inspired by [ratpoison](htt
|
|||
|
||||
### Purpose
|
||||
|
||||
The goal of this project is to provide a successor to ratpoison for Wayland.
|
||||
This project provides a successor to ratpoison for Wayland.
|
||||
However, this is no reimplementation of ratpoison.
|
||||
|
||||
#### New Features, Bugs and Contact Information
|
||||
|
||||
Should you want to know if a feature will be implemented, file a bug or
|
||||
get in touch, [open an issue](https://github.com/project-repo/cagebreak/issues/new)
|
||||
You can [open an issue](https://github.com/project-repo/cagebreak/issues/new)
|
||||
or write an e-mail (See [SECURITY.md](SECURITY.md) for details.).
|
||||
|
||||
The Roadmap section outlines what is planned for the future.
|
||||
The Roadmap section outlines our plans.
|
||||
|
||||
#### Compatibility & Development Distribution
|
||||
|
||||
Cagebreak supports [Arch Linux](https://archlinux.org/) and uses the libraries
|
||||
(and software versions) as they are obtained through [pacman](https://wiki.archlinux.org/title/Pacman)
|
||||
at the time of release. Any other use is out of scope.
|
||||
|
||||
Most other setups probably work with a bit of luck. We
|
||||
make no guarantees.
|
||||
and versions from extra and core at the time of release.
|
||||
Most other setups work with a bit of luck.
|
||||
|
||||
### Quick Installation
|
||||
|
||||
|
|
@ -42,17 +38,12 @@ details on getting started and the documentation for everything else.
|
|||
|
||||
### Documentation
|
||||
|
||||
* the rest of this file
|
||||
* the man pages:
|
||||
* [cagebreak](man/cagebreak.1.md)
|
||||
* [configuration](man/cagebreak-config.5.md)
|
||||
* [socket](man/cagebreak-socket.7.md)
|
||||
* the [FAQ](FAQ.md)
|
||||
* [SECURITY.md](SECURITY.md)
|
||||
* the man pages: [cagebreak](man/cagebreak.1.md), [configuration](man/cagebreak-config.5.md) & [socket](man/cagebreak-socket.7.md)
|
||||
* the [README](README.md), [FAQ](FAQ.md) & [SECURITY.md](SECURITY.md)
|
||||
|
||||
#### What's new?
|
||||
|
||||
See the [Changelog](Changelog.md).
|
||||
Check the [Changelog](Changelog.md).
|
||||
|
||||
### Uninstallation
|
||||
|
||||
|
|
@ -60,9 +51,9 @@ See the [Changelog](Changelog.md).
|
|||
|
||||
### Contributing
|
||||
|
||||
* Just [open an issue](https://github.com/project-repo/cagebreak/issues/new) and state your idea.
|
||||
We will consider the proposal and get back to you.
|
||||
* Don't open a pull request. We might not accept your code and
|
||||
* [Open an issue](https://github.com/project-repo/cagebreak/issues/new) and state your idea.
|
||||
We will get back to you.
|
||||
* Ask before you open a pull request. We might not accept your code and
|
||||
it would be sad to waste the effort.
|
||||
* Respect the [Code of Conduct](CODE_OF_CONDUCT.md) (To date, we never
|
||||
had to intervene - Keep it that way!)
|
||||
|
|
@ -208,16 +199,16 @@ as a source of inspiration and explanations for certain particularities.
|
|||
## Contributing
|
||||
|
||||
* Read this document.
|
||||
* Just [open an issue](https://github.com/project-repo/cagebreak/issues/new) and state your feature request.
|
||||
We will consider the proposal and get back to you.
|
||||
* Don't open a pull request without asking first. We might not accept your
|
||||
* [Open an issue](https://github.com/project-repo/cagebreak/issues/new) and state your feature request.
|
||||
We will get back to you.
|
||||
* Ask before opening a pull request. We might not accept your
|
||||
code and it would be sad to waste the effort.
|
||||
* Respect the [Code of Conduct](CODE_OF_CONDUCT.md) (To date, we never
|
||||
had to intervene - Please keep it that way!)
|
||||
|
||||
### Good First Contributions
|
||||
|
||||
* Reviewing the project is always welcome.
|
||||
* Reviews are always welcome.
|
||||
* Read the code.
|
||||
* Read the documentation.
|
||||
* Test whether the documentation matches the code.
|
||||
|
|
@ -225,12 +216,12 @@ as a source of inspiration and explanations for certain particularities.
|
|||
* Compile the code.
|
||||
* Ideas on improving the testing and quality assurance are particularly
|
||||
welcome.
|
||||
* If you want, you can share your cagebreak scripts and we might include them
|
||||
in the repository provided you agree to release them under MIT and we agree
|
||||
with the use case and coding style.
|
||||
* Iff you are happy with Cagebreak and use Arch Linux, you may vote for
|
||||
* You can share your cagebreak scripts and we might include them with Cagebreak
|
||||
provided you agree to release them under MIT and we agree with the
|
||||
use case and coding style.
|
||||
* If you are happy with Cagebreak under Arch Linux, you may vote for
|
||||
[Cagebreak in the AUR](https://aur.archlinux.org/packages/cagebreak).
|
||||
* The points above still apply.
|
||||
* The points from the Contributing section above still apply.
|
||||
|
||||
### Philosophy
|
||||
|
||||
|
|
|
|||
33
SECURITY.md
33
SECURITY.md
|
|
@ -51,11 +51,10 @@ public key or provide the fingerprint and directions to obtain the key.
|
|||
|
||||
## Threat Model
|
||||
|
||||
Cagebreak is a wayland compositor run by the user of the system
|
||||
and thus has access to whichever resources this user has access to.
|
||||
Cagebreak can restrict other programs in no way, because this would hamper
|
||||
usability (consider a web browser unable to write a downloaded file to disk
|
||||
for instance).
|
||||
Cagebreak is a wayland compositor run by a user and has access to
|
||||
the resources the user has access to.
|
||||
Cagebreak cannot restrict other programs (consider a web browser
|
||||
unable to write a downloaded file for instance).
|
||||
|
||||
There is no transmission of information by cagebreak other than to the
|
||||
screens, ipc and potentially other documented local channels.
|
||||
|
|
@ -63,38 +62,36 @@ screens, ipc and potentially other documented local channels.
|
|||
### STRIDE Threat List
|
||||
|
||||
This is not a thorough analysis, just an overview of the ways in which cagebreak
|
||||
has (no) attack surface. Please reference the man pages for details but especially
|
||||
the -e and --bs options.
|
||||
has (no) attack surface. Please reference the man pages (especially options -e and --bs ).
|
||||
|
||||
#### Spoofing
|
||||
|
||||
Not applicable - Using Cagebreak already requires a login as a user.
|
||||
Not applicable - Cagebreak is executed after user login.
|
||||
|
||||
#### Tampering
|
||||
|
||||
Not applicable - Cagebreak must allow system manipulation for user software.
|
||||
Not applicable - Cagebreak allows system manipulation for user software.
|
||||
|
||||
#### Repudiation
|
||||
|
||||
Not applicable - There are no prohibited operations (See Tampering above.).
|
||||
While cagebreak does send events over documented channels there is no logging
|
||||
activated by default, though, of course, this can be changed by the user
|
||||
by logging socket output (if enabled) for example.
|
||||
Cagebreak sends events over documented channels. There is no logging
|
||||
activated by default - this can be changed by logging the socket (if enabled) for example.
|
||||
|
||||
#### Information Disclosure
|
||||
|
||||
Not applicable - Information disclosure over documented channels is a feature
|
||||
and any software run by the user may exfiltrate any data the user has access to.
|
||||
Not applicable - Information disclosure over documented channels is a feature.
|
||||
Any user software may exfiltrate any data the user has access to.
|
||||
|
||||
#### Denial of Service
|
||||
|
||||
Not applicable - Cagebreak offers functionality to terminate itself, which is
|
||||
available to all user software over the socket if the socket is enabled.
|
||||
Not applicable - Cagebreak offers functionality to terminate itself. This is
|
||||
available to user software over the socket (if enabled).
|
||||
|
||||
#### Elevation of Privilege
|
||||
|
||||
Software may gain arbitrary code execution rights if it has access to the
|
||||
Cagebreak socket. Privilege escalation to root is unlikely since privileges
|
||||
Software may gain arbitrary code execution if it has access to the
|
||||
socket (if enabled). Privilege escalation to root is unlikely since privileges
|
||||
are dropped before any user input is accepted.
|
||||
|
||||
## GPG Keys of the Cagebreak Repository
|
||||
|
|
|
|||
16
meson.build
16
meson.build
|
|
@ -3,7 +3,7 @@
|
|||
project(
|
||||
'cagebreak',
|
||||
'c',
|
||||
version : '2.2.1',
|
||||
version : '2.2.2',
|
||||
license : 'MIT',
|
||||
default_options : ['c_std=c11', 'warning_level=3']
|
||||
)
|
||||
|
|
@ -55,7 +55,7 @@ if is_freebsd
|
|||
)
|
||||
endif
|
||||
|
||||
wlroots = dependency('wlroots', version: ['>=0.16.1', '< 0.18.0'])
|
||||
wlroots = dependency('wlroots', version: ['>=0.16.1', '< 0.17.1'])
|
||||
wayland_protos = dependency('wayland-protocols', version: '>=1.14')
|
||||
wayland_server = dependency('wayland-server')
|
||||
wayland_cursor = dependency('wayland-cursor')
|
||||
|
|
@ -204,15 +204,15 @@ reproducible_build_versions = {
|
|||
'wayland_server': '1.19.0',
|
||||
'wayland_client': '1.22.0',
|
||||
'wayland_cursor': '1.22.0',
|
||||
'wlroots': '0.16.2',
|
||||
'xkbcommon': '1.5.0',
|
||||
'wlroots': '0.17.0',
|
||||
'xkbcommon': '1.6.0',
|
||||
'fontconfig': '2.14.2',
|
||||
'libinput': '1.23.0',
|
||||
'libinput': '1.24.0',
|
||||
'libevdev': '1.13.1',
|
||||
'libudev': '254',
|
||||
'pango': '1.50.14',
|
||||
'cairo': '1.17.8',
|
||||
'pangocairo': '1.50.14',
|
||||
'pango': '1.51.0',
|
||||
'cairo': '1.18.0',
|
||||
'pangocairo': '1.51.0',
|
||||
'math': '-1'
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue